@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/smartMapping/statistics/support/ageUtils.d.ts

@@ -1,3 +1,53 @@
-import "../../../interfaces";
+import type { DateType, UnitType } from "../../support/utils.js";
+import type { SupportedLayer } from "../../support/adapters/interfaces.js";
 
-export const getAgeExpressions: __esri.ageUtils["getAgeExpressions"];
+/**
+ * Returns an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression for visualizing the age of a feature based
+ * on a given start time and end time.
+ *
+ * @param params - See the table below for details of each parameter.
+ * @returns Returns an instance of [AgeExpressionsResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#AgeExpressionsResult).
+ * @example
+ * const ageExpressions = ageUtils.getAgeExpressions({
+ *   layer: featureLayer,
+ *   startTime: "Created_Date",
+ *   endTime: Date.now(),
+ *   unit: "days"
+ * });
+ *
+ * console.log(`value expression: ${ageExpressions.valueExpression}`);
+ */
+export function getAgeExpressions(params: AgeExpressionsParams): AgeExpressionsResult;
+
+export interface AgeExpressionsParams {
+  /**
+   * The end time for the age calculation. This can be a field name or a date
+   *   value, such as `Date.now()`. If a `Date` is provided, then the `startTime` parameter must be a field name.
+   */
+  endTime: DateType;
+  /** The layer from which to generate age statistics for the given `startTime` and `endTime`. */
+  layer: SupportedLayer;
+  /**
+   * The start time for the age calculation. This can be a field name or a date
+   *   value, such as `Date.now()`. If a `Date` is provided, then the `endTime` parameter must be a field name.
+   */
+  startTime: DateType;
+  /** The desired units of the age result. */
+  unit?: UnitType | null;
+}
+
+/** The result object returned from the [getAgeExpressions()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#getAgeExpressions) method. */
+export interface AgeExpressionsResult {
+  /** A SQL expression and where clause that matches the generated `valueExpression` used to query for a histogram from the layer. */
+  histogramQuery: any;
+  /** A SQL expression and where clause that matches the generated `valueExpression` used to query statistics from the layer. */
+  statisticsQuery: any;
+  /**
+   * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following
+   * the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization).
+   * The expression should be used to calculate the age of a feature
+   * based on the difference between the end time and the start time. It may reference field values using the `$feature`
+   * profile variable and must return a number.
+   */
+  valueExpression: string;
+}

package/smartMapping/statistics/support/predominanceUtils.d.ts

@@ -1,3 +1,91 @@
-import "../../../interfaces";
+import type CSVLayer from "../../../layers/CSVLayer.js";
+import type FeatureLayer from "../../../layers/FeatureLayer.js";
+import type GeoJSONLayer from "../../../layers/GeoJSONLayer.js";
+import type OGCFeatureLayer from "../../../layers/OGCFeatureLayer.js";
+import type OrientedImageryLayer from "../../../layers/OrientedImageryLayer.js";
+import type SceneLayer from "../../../layers/SceneLayer.js";
+import type StreamLayer from "../../../layers/StreamLayer.js";
+import type SubtypeGroupLayer from "../../../layers/SubtypeGroupLayer.js";
+import type WFSLayer from "../../../layers/WFSLayer.js";
+import type CatalogFootprintLayer from "../../../layers/catalog/CatalogFootprintLayer.js";
+import type KnowledgeGraphSublayer from "../../../layers/knowledgeGraph/KnowledgeGraphSublayer.js";
+import type SubtypeSublayer from "../../../layers/support/SubtypeSublayer.js";
 
-export const getPredominanceExpressions: __esri.predominanceUtils["getPredominanceExpressions"];
+/**
+ * Returns [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) and SQL expressions used for visualizing the predominant category (or field) among a set of competing fields.
+ *
+ * @param layer - The layer from which to generate the Arcade and SQL expressions for querying predominance statistics.
+ * @param fieldNames - An array of numeric field names for which to create the Arcade and SQL expressions used to build the predominance renderer.
+ * @returns Returns the Arcade and SQL expressions used for creating a predominance renderer. These expressions are used to query a feature service or the client-side layer for statistics relevant to creating the default predominance renderer for the given fields.
+ * @example
+ * const predominanceExpressions = predominanceUtils.getPredominanceExpressions({
+ *   layer: featureLayer,
+ *   fields: ["Corn", "Wheat", "Soybeans", "Vegetables", "Cotton"]
+ * });
+ *
+ * console.log(`value expression for getting the predominant category from the given fields: ${predominanceExpressions.predominantCategory.valueExpression}`);
+ */
+export function getPredominanceExpressions(layer: FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | CatalogFootprintLayer | SubtypeSublayer, fieldNames: string[]): PredominantExpressions;
+
+/** The result object returned from the {@link smartMapping/statistics/support/predominanceUtils#getAgeExpressions} method. */
+export interface PredominantExpressions {
+  /** The Arcade and SQL expressions used to query the server or client-side layer for statistics of the percentage among all competing fields comprised by the predominant category. */
+  opacity: OpacityExpressionInfo;
+  /** The Arcade expression used to get the predominant category among a set of fields. */
+  predominantCategory: PredominantCategoryInfo;
+  /** The Arcade and SQL expressions used to query the server or client-side layer for statistics of the sum of all competing fields considered for the predominance visualization. */
+  size: SizeExpressionInfo;
+}
+
+/** SQL expressions used to query feature services for predominant values and related statistics given a set of fields. */
+export interface SQLExpressionInfo {
+  /** The SQL expression used for querying the predominant category given a set of fields. This expression should match the logic of the Arcade expression in the parent info object. */
+  sqlExpression: string;
+  /** The SQL where clause used to query the predominant value. This should be used to ensure negative values are not considered in the predominance calculation. */
+  sqlWhere: string;
+}
+
+export interface PredominantCategoryInfo {
+  /**
+   * valueExpression - An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following
+   * the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization).
+   * The expression should be used to return the name of the predominant field among a set of competing fields. It may reference field values using the `$feature`
+   * profile variable and must return a string.
+   */
+  valueExpression: string;
+}
+
+/** Contains the Arcade and SQL expressions used to query feature services and client-side layers for the sum of all values considered in a predominance visualization. */
+export interface SizeExpressionInfo {
+  /** The SQL expressions used for querying the histogram for the sum of a set of fields. */
+  histogramQuery: SQLExpressionInfo;
+  /** The SQL expressions used for querying the sum of a set of fields. This expression should match the logic of the Arcade expression. */
+  statisticsQuery: SQLExpressionInfo;
+  /**
+   * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following
+   * the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization).
+   * The expression should be used to calculate the sum of a set of numeric fields.
+   * It may reference field values using the `$feature` profile variable and must return a number.
+   */
+  valueExpression: string;
+}
+
+/**
+ * Contains the Arcade and SQL expressions used to query feature services and client-side layers for the strength
+ * of the predominant category compared with all other categories. In other words, these expressions should
+ * calculate the percentage of the sum the winning value comprises.
+ */
+export interface OpacityExpressionInfo {
+  /** The SQL expressions used for querying the histogram using the percentage the predominant value comprises among of a set of fields. */
+  histogramQuery: SQLExpressionInfo;
+  /** The SQL expressions used for querying the percentage the predominant value comprises among of a set of fields. This expression should match the logic of the Arcade expression. */
+  statisticsQuery: SQLExpressionInfo;
+  /**
+   * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following
+   * the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization).
+   * The expression should be used to calculate the percentage the winning field
+   *  comprises among of a set of numeric fields.
+   * It may reference field values using the `$feature` profile variable and must return a number.
+   */
+  valueExpression: string;
+}

package/smartMapping/statistics/types.d.ts

@@ -1,4 +1,33 @@
-import "../../interfaces";
 
-export type HistogramBin = __esri.statisticsTypes.HistogramBin;
-export type HistogramResult = __esri.statisticsTypes.HistogramResult;
+/** The result returned from the {@link smartMapping/statistics/types#histogram} method. */
+export interface HistogramResult {
+  /** An array of objects representing each bin in the histogram. */
+  bins: HistogramBin[];
+  /** The maximum value returned by the field. */
+  maxValue?: number | null;
+  /** The minimum value returned by the field. */
+  minValue?: number | null;
+  /**
+   * The number used to normalize all values when `percent-of-total`
+   *   is specified as the `normalizationType`.
+   */
+  normalizationTotal?: number | null;
+}
+
+/**
+ * Represents the bin of a histogram. A bin consists of
+ * a minimum and a maximum value and a count. It indicates the
+ * number of values in a dataset that lie between the
+ * min and max values.
+ */
+export interface HistogramBin {
+  /**
+   * The number of values in a dataset that are
+   *   contained between the indicated `minValue` and `maxValue`.
+   */
+  count: number;
+  /** The maximum value (or bound) of the bin. */
+  maxValue: number;
+  /** The minimum value (or bound) of the bin. */
+  minValue: number;
+}

package/smartMapping/statistics/uniqueValues.d.ts

@@ -1,4 +1,26 @@
-import "../../interfaces";
+import type { UniqueValuesResult, UniqueValuesParams } from "./interfaces.js";
 
-import uniqueValues = __esri.uniqueValues;
-export default uniqueValues;
+/**
+ * Returns an object containing an array of unique values queried from a given field
+ * (or values returned from an expression) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) along with the total count of features that
+ * belong to the given category.
+ *
+ * @param parameters - See the table below for details of each parameter.
+ * @returns Returns a promise that resolves to [UniqueValuesResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-interfaces.html#UniqueValuesResult).
+ * @example
+ * let layer = new FeatureLayer({
+ *   portalItem: { id: "5ce5374a461e45bab714b43ffedf151d" }
+ * });
+ *
+ * uniqueValues({
+ *   layer: layer,
+ *   field: "Candidate"
+ * }).then(function(response){
+ *   // prints each unique value and the count of features containing that value
+ *   let infos = response.uniqueValueInfos;
+ *   infos.forEach(function(info){
+ *     console.log("CANDIDATE: ", info.value, " # OF CAMPAIGN STOPS: ", info.count);
+ *   });
+ * });
+ */
+export default function uniqueValues(parameters: UniqueValuesParams): Promise<UniqueValuesResult>;

package/smartMapping/support/adapters/interfaces.d.ts

@@ -0,0 +1,18 @@
+import type CatalogLayer from "../../../layers/CatalogLayer.js";
+import type CSVLayer from "../../../layers/CSVLayer.js";
+import type FeatureLayer from "../../../layers/FeatureLayer.js";
+import type GeoJSONLayer from "../../../layers/GeoJSONLayer.js";
+import type ImageryLayer from "../../../layers/ImageryLayer.js";
+import type OGCFeatureLayer from "../../../layers/OGCFeatureLayer.js";
+import type OrientedImageryLayer from "../../../layers/OrientedImageryLayer.js";
+import type ParquetLayer from "../../../layers/ParquetLayer.js";
+import type PointCloudLayer from "../../../layers/PointCloudLayer.js";
+import type SceneLayer from "../../../layers/SceneLayer.js";
+import type StreamLayer from "../../../layers/StreamLayer.js";
+import type SubtypeGroupLayer from "../../../layers/SubtypeGroupLayer.js";
+import type WFSLayer from "../../../layers/WFSLayer.js";
+import type CatalogFootprintLayer from "../../../layers/catalog/CatalogFootprintLayer.js";
+import type KnowledgeGraphSublayer from "../../../layers/knowledgeGraph/KnowledgeGraphSublayer.js";
+import type SubtypeSublayer from "../../../layers/support/SubtypeSublayer.js";
+
+export type SupportedLayer = CatalogLayer | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | OGCFeatureLayer | OrientedImageryLayer | ParquetLayer | PointCloudLayer | SceneLayer | StreamLayer | SubtypeGroupLayer | SubtypeSublayer | WFSLayer;

package/smartMapping/support/binningUtils.d.ts

@@ -0,0 +1,11 @@
+import type CSVLayer from "../../layers/CSVLayer.js";
+import type FeatureLayer from "../../layers/FeatureLayer.js";
+import type GeoJSONLayer from "../../layers/GeoJSONLayer.js";
+import type OGCFeatureLayer from "../../layers/OGCFeatureLayer.js";
+import type OrientedImageryLayer from "../../layers/OrientedImageryLayer.js";
+import type ParquetLayer from "../../layers/ParquetLayer.js";
+import type StreamLayer from "../../layers/StreamLayer.js";
+import type WFSLayer from "../../layers/WFSLayer.js";
+import type KnowledgeGraphSublayer from "../../layers/knowledgeGraph/KnowledgeGraphSublayer.js";
+
+export type BinningSupportedLayer = FeatureLayer | OGCFeatureLayer | OrientedImageryLayer | GeoJSONLayer | CSVLayer | ParquetLayer | WFSLayer | StreamLayer | KnowledgeGraphSublayer;

package/smartMapping/support/clusterUtils.d.ts

@@ -0,0 +1,11 @@
+import type CSVLayer from "../../layers/CSVLayer.js";
+import type FeatureLayer from "../../layers/FeatureLayer.js";
+import type GeoJSONLayer from "../../layers/GeoJSONLayer.js";
+import type OGCFeatureLayer from "../../layers/OGCFeatureLayer.js";
+import type OrientedImageryLayer from "../../layers/OrientedImageryLayer.js";
+import type ParquetLayer from "../../layers/ParquetLayer.js";
+import type StreamLayer from "../../layers/StreamLayer.js";
+import type WFSLayer from "../../layers/WFSLayer.js";
+import type KnowledgeGraphSublayer from "../../layers/knowledgeGraph/KnowledgeGraphSublayer.js";
+
+export type SupportedLayer = FeatureLayer | OGCFeatureLayer | GeoJSONLayer | CSVLayer | WFSLayer | OrientedImageryLayer | ParquetLayer | StreamLayer | KnowledgeGraphSublayer;

package/smartMapping/support/utils.d.ts

@@ -0,0 +1,4 @@
+
+export type DateType = Date | string | number;
+
+export type UnitType = "years" | "months" | "days" | "hours" | "minutes" | "seconds";

package/smartMapping/symbology/color.d.ts

@@ -1,9 +1,184 @@
-import "../../interfaces";
-
-export const cloneScheme: __esri.symbologyColor["cloneScheme"];
-export const flipColors: __esri.symbologyColor["flipColors"];
-export const getMatchingSchemes: __esri.symbologyColor["getMatchingSchemes"];
-export const getSchemeByName: __esri.symbologyColor["getSchemeByName"];
-export const getSchemes: __esri.symbologyColor["getSchemes"];
-export const getSchemesByTag: __esri.symbologyColor["getSchemesByTag"];
-export const getThemes: __esri.symbologyColor["getThemes"];
+import type Basemap from "../../Basemap.js";
+import type Color from "../../Color.js";
+import type SceneView from "../../views/SceneView.js";
+import type { ColorScheme, ColorSchemes, BasemapTheme, Theme } from "./interfaces.js";
+
+/**
+ * Returns metadata for the available themes. If a basemap is provided, returns themes that work best
+ * with the given basemap.
+ *
+ * @param basemap - The [Esri basemap string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)
+ *   or object that will be used with the returned theme(s).
+ * @returns Returns an object containing information about the available themes for the given basemap.
+ */
+export function getThemes(basemap?: Basemap | string | null | undefined): Theme[];
+
+/**
+ * Returns a primary scheme and secondary schemes defining symbol properties for
+ * data-driven color visualizations in
+ * a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). The `basemap` parameter determines the color schemes of the
+ * graphics used to visualize each feature. The `geometryType` determines which type of symbol to return.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an object containing the optimal color scheme to use for the given
+ *   basemap and secondary schemes that may also be used.
+ * @example
+ * // gets the primary scheme for the features of the given geometry type and basemap
+ * let schemes = colorSchemes.getSchemes({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType,
+ *   theme: "extremes"
+ * });
+ *
+ * // the best default scheme for the layer, basemap, and theme
+ * let primaryScheme = schemes.primaryScheme;
+ */
+export function getSchemes(params: GetSchemesParams): ColorSchemes | null | undefined;
+
+/**
+ * Returns a color scheme with the provided name.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns the color scheme
+ *   with the given name.
+ * @since 4.12
+ * @example
+ * // Returns the Red Extremes 1 scheme
+ * const redExtremesScheme = colorSchemes.getSchemeByName({
+ *   basemapTheme: "light",
+ *   geometryType: featureLayer.geometryType,
+ *   theme: "extremes",
+ *   name: "Red Extremes 1"
+ * });
+ */
+export function getSchemeByName(params: GetSchemesByNameParams): ColorScheme | null | undefined;
+
+/**
+ * Returns an array of color schemes with the provided tags. These schemes define symbol properties for
+ * data-driven color visualizations in any layer that can be rendered with a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html).
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an array of color schemes
+ *   either including or excluding the provided tags.
+ * @since 4.12
+ * @example
+ * // Returns all the red color schemes that are color-blind friendly
+ * let schemes = colorSchemes.getSchemesByTag({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType,
+ *   theme: "extremes",
+ *   includedTags: [ "reds", "colorblind-friendly" ]
+ * });
+ */
+export function getSchemesByTag(params: GetSchemesByTagParams): ColorScheme[];
+
+/**
+ * Clones a color scheme object.
+ *
+ * @param scheme - The color scheme object to clone.
+ * @returns Returns
+ * a clone of the given color scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * let colorScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: ColorScheme | null | undefined): ColorScheme | null | undefined;
+
+/**
+ * Flips the colors in reverse order of the input color scheme.
+ *
+ * @param scheme - The color scheme to reverse.
+ * @returns Returns
+ * the input color scheme with its colors in reverse order.
+ * @example
+ * // reverses the order of colors in a primary scheme
+ * // obtained from the getSchemes() method
+ * let flippedScheme = colorSchemes.flipColors(primaryScheme);
+ */
+export function flipColors(scheme: ColorScheme): ColorScheme;
+
+/**
+ * Returns all schemes matching the given color ramp.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns An array of color schemes that match the
+ *   given colors.
+ * @since 4.9
+ */
+export function getMatchingSchemes(params: GetMatchingSchemesParams): ColorScheme[];
+
+export interface GetMatchingSchemesParams {
+  /** An array of colors used to match with schemes for the given theme. */
+  colors: Color[];
+  /** The geometry type of the layer for which the color scheme will be applied. */
+  geometryType: string;
+  /** The name of the theme from which to get color schemes. */
+  theme: string;
+  /**
+   * The [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance used to calculate
+   *   the suggested sizes of the symbols.  This is required for 3D visualizations.
+   */
+  view?: SceneView;
+  /** Indicates whether 3D volumetric symbols will be used in the visualization. */
+  worldScale?: boolean;
+}
+
+export interface GetSchemesParams {
+  /**
+   * The Esri basemap to pair with the visualization. This
+   *   value indicates the best symbol colors for visualizing features against the given basemap. If you have a
+   *   non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, then use the `basemapTheme` parameter
+   *   instead of this parameter.
+   */
+  basemap?: Basemap | string | null;
+  /**
+   * If you have a
+   *   non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, use this parameter to indicate
+   *   whether the background of the visualization is `light` or `dark`.
+   */
+  basemapTheme?: BasemapTheme | null;
+  /** The geometry type of the features to visualize. */
+  geometryType?: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch" | null;
+  /**
+   * The theme determines which values will be emphasized in the continuous ramp and the map.
+   * Possible values are listed below.
+   * | Value | Description | Example |
+   * | ----- | ----------- | ------- |
+   * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-high-to-low.png) |
+   * | 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) |
+   */
+  theme?: "high-to-low" | "above-and-below" | "centered-on" | "extremes";
+  /**
+   * The SceneView instance in which the scheme
+   * will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols.
+   */
+  view?: SceneView | null;
+  /**
+   * Indicates if the size units of the scheme will be in meters.
+   * This should be `true` when the scheme is intended for 3D volumetric symbology.
+   * A `view` must be provided if this property is set to `true`.
+   */
+  worldScale?: boolean | null;
+}
+
+export interface GetSchemesByNameParams extends GetSchemesParams {
+  /** The name of the scheme to retrieve. */
+  name: string;
+}
+
+export interface GetSchemesByTagParams extends GetSchemesParams {
+  /**
+   * When provided, only schemes missing all the provided tags will be returned.
+   *
+   * **Known Tags:** light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | 3d
+   */
+  excludedTags?: string[];
+  /**
+   * When provided, only schemes containing all the matching tags will be returned.
+   *
+   * **Known Tags:** light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | 3d
+   */
+  includedTags?: string[];
+}

package/smartMapping/symbology/dotDensity.d.ts

@@ -1,6 +1,108 @@
-import "../../interfaces";
+import type Basemap from "../../Basemap.js";
+import type { DotDensityScheme, DotDensitySchemes, BasemapTheme } from "./interfaces.js";
 
-export const cloneScheme: __esri.symbologyDotDensity["cloneScheme"];
-export const getSchemeByName: __esri.symbologyDotDensity["getSchemeByName"];
-export const getSchemes: __esri.symbologyDotDensity["getSchemes"];
-export const getSchemesByTag: __esri.symbologyDotDensity["getSchemesByTag"];
+/**
+ * Returns a primary scheme and secondary schemes defining symbol properties for dot density-based
+ * data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The `basemap` parameter determines the color of the
+ * dots used to visualize each attribute. The `geometryType` determines which type of symbol to return.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an object containing
+ *   the optimal type scheme to use for the given basemap; it also contains secondary schemes.
+ * @example
+ * // gets the primary scheme for the features of the given geometry type and basemap
+ * const schemes = dotDensitySchemes.getSchemes({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ *
+ * // the best default scheme for the layer and basemap
+ * const primaryScheme = schemes.primaryScheme;
+ */
+export function getSchemes(params: GetSchemesParams): DotDensitySchemes | null | undefined;
+
+/**
+ * Returns a dot density scheme with the provided name.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns the dot density scheme
+ *   with the given name.
+ * @since 4.12
+ * @example
+ * // Returns the Galaxy Berries scheme
+ * let galaxyBerriesScheme = dotDensitySchemes.getSchemeByName({
+ *   basemap: map.basemap,
+ *   numColors: 3,
+ *   name: "Galaxy Berries"
+ * });
+ */
+export function getSchemeByName(params: GetSchemesByNameParams): DotDensityScheme | null | undefined;
+
+/**
+ * Returns an array of dot density schemes with the provided tags. These schemes define symbol properties for
+ * dot density visualizations in any layer that can be rendered with a [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html).
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an array of dot density schemes
+ *   either including or excluding the provided tags.
+ * @since 4.12
+ * @example
+ * // Returns all the red dot density schemes
+ * let schemes = dotDensitySchemes.getSchemesByTag({
+ *   basemap: map.basemap,
+ *   numColors: 2,
+ *   includedTags: [ "reds", "dot-density" ]
+ * });
+ */
+export function getSchemesByTag(params: GetSchemesByTagParams): DotDensityScheme[];
+
+/**
+ * Clones a dot density scheme object.
+ *
+ * @param scheme - The dot density scheme object to clone.
+ * @returns Returns a clone of the given dot density scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * const dotDensityScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: DotDensityScheme | null | undefined): DotDensityScheme | null | undefined;
+
+export interface GetSchemesParams {
+  /**
+   * The Esri basemap to pair with the visualization. This
+   *   value indicates the best symbol colors for visualizing features against the given basemap. If you have a
+   *   non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, then use the `basemapTheme` parameter
+   *   instead of this parameter.
+   */
+  basemap?: Basemap | string | null;
+  /**
+   * If you have a
+   *   non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, use this parameter to indicate
+   *   whether the background of the visualization is `light` or `dark`.
+   */
+  basemapTheme?: BasemapTheme | null;
+  /** The number of colors to visualize. */
+  numColors: number;
+}
+
+export interface GetSchemesByNameParams extends GetSchemesParams {
+  /** The name of the scheme to retrieve. */
+  name: string;
+}
+
+export interface GetSchemesByTagParams extends GetSchemesParams {
+  /**
+   * When provided, only schemes missing all the provided tags will be returned.
+   *
+   * **Known Tags:** light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays |
+   * bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density
+   */
+  excludedTags?: string[] | null;
+  /**
+   * When provided, only schemes containing all the matching tags will be returned.
+   *
+   * **Known Tags:** light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays |
+   * bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density
+   */
+  includedTags?: string[] | null;
+}