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

package/smartMapping/symbology/location.d.ts

@@ -1,5 +1,75 @@
-import "../../interfaces";
+import type Basemap from "../../Basemap.js";
+import type { LocationScheme, LocationSchemes, BasemapTheme, Theme } from "./interfaces.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
 
-export const cloneScheme: __esri.symbologyLocation["cloneScheme"];
-export const getSchemes: __esri.symbologyLocation["getSchemes"];
-export const getThemes: __esri.symbologyLocation["getThemes"];
+/**
+ * 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
+ * location-only visualizions in
+ * a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html).
+ * The `basemap` parameter determines the color 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 location scheme (and secondary schemes) to use for the given basemap.
+ * @example
+ * // gets the primary scheme for the features of the given geometry type and basemap
+ * let schemes = locationSchemes.getSchemes({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ *
+ * // the best default scheme for the layer, basemap, and theme
+ * let primaryScheme = schemes.primaryScheme;
+ */
+export function getSchemes(params: GetSchemesParams): LocationSchemes | null | undefined;
+
+/**
+ * Clones a location scheme object.
+ *
+ * @param scheme - The location scheme object to clone.
+ * @returns Returns
+ *   a clone of the given location scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * let locationScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: LocationScheme | null | undefined): LocationScheme | null | undefined;
+
+export interface GetSchemesParams {
+  /**
+   * The Esri basemap to pair with the visualization. This
+   *   value indicates the best symbol color 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 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?: MapViewOrSceneView | 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;
+}

package/smartMapping/symbology/pieChart.d.ts

@@ -1,7 +1,115 @@
-import "../../interfaces";
+import type Basemap from "../../Basemap.js";
+import type { PieChartScheme, PieChartSchemes, BasemapTheme, Theme } from "./interfaces.js";
 
-export const cloneScheme: __esri.symbologyPieChart["cloneScheme"];
-export const getSchemeByName: __esri.symbologyPieChart["getSchemeByName"];
-export const getSchemes: __esri.symbologyPieChart["getSchemes"];
-export const getSchemesByTag: __esri.symbologyPieChart["getSchemesByTag"];
-export const getThemes: __esri.symbologyPieChart["getThemes"];
+/**
+ * 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): Theme[];
+
+/**
+ * Returns a primary scheme and secondary schemes defining properties for pie chart visualizations.
+ * The `basemap` parameter determines the colors
+ * used to visualize each pie slice.
+ *
+ * @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 pie chart 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 { primaryScheme, secondarySchemes } = pieChartSchemes.getSchemes({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ *
+ * // primaryScheme is the suggested default scheme for the layer and basemap
+ */
+export function getSchemes(params: GetSchemesParams): PieChartSchemes | null | undefined;
+
+/**
+ * Returns a pie chart scheme with the given name.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns the pie chart scheme
+ *   with the given name.
+ * @example
+ * // Returns the Flower Field scheme
+ * let flowerFieldScheme = pieChartSchemes.getSchemeByName({
+ *   name: "Flower Field",
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ */
+export function getSchemeByName(params: GetSchemesByNameParams): PieChartScheme | null | undefined;
+
+/**
+ * Returns an array of pie chart schemes with the provided tags. These schemes define properties for
+ * pie charts in any layer that can be rendered with a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html).
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an array of pie chart schemes
+ *   either including or excluding the provided tags.
+ * @example
+ * let schemes = pieChartSchemes.getSchemesByTag({
+ *   includedTags: [ "types", "reds" ],
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ */
+export function getSchemesByTag(params: GetSchemesByTagParams): PieChartScheme[];
+
+/**
+ * Clones a pie chart scheme object.
+ *
+ * @param scheme - The pie chart scheme object to clone.
+ * @returns Returns a clone of the given pie chart scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * const pieChartScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: PieChartScheme | null | undefined): PieChartScheme | null | undefined;
+
+export interface GetSchemesParams {
+  /**
+   * The Esri basemap to pair with the visualization. This
+   *   value indicates the best color schemes for visualizing charts 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.
+   */
+  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" | "polygon";
+  /** The number of unique values to include in the pie chart visualization. */
+  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;
+}

package/smartMapping/symbology/predominance.d.ts

@@ -1,7 +1,137 @@
-import "../../interfaces";
+import type Basemap from "../../Basemap.js";
+import type SceneView from "../../views/SceneView.js";
+import type { PredominanceScheme, PredominanceSchemes, BasemapTheme, Theme } from "./interfaces.js";
 
-export const cloneScheme: __esri.symbologyPredominance["cloneScheme"];
-export const getSchemeByName: __esri.symbologyPredominance["getSchemeByName"];
-export const getSchemes: __esri.symbologyPredominance["getSchemes"];
-export const getSchemesByTag: __esri.symbologyPredominance["getSchemesByTag"];
-export const getThemes: __esri.symbologyPredominance["getThemes"];
+/**
+ * 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): Theme[];
+
+/**
+ * Returns a primary scheme and secondary schemes defining symbol properties for predominance-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
+ * symbols 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 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 = predominanceSchemes.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): PredominanceSchemes | null | undefined;
+
+/**
+ * Returns a predominance 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 predominance scheme
+ *   with the given name.
+ * @since 4.12
+ * @example
+ * // Returns the Flower Field scheme
+ * let flowerFieldScheme = colorSchemes.getSchemeByName({
+ *   name: "Flower Field",
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ */
+export function getSchemeByName(params: GetSchemesByNameParams): PredominanceScheme | null | undefined;
+
+/**
+ * Returns an array of predominance schemes with the provided tags. These schemes define symbol properties for
+ * predominance 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 predominance schemes
+ *   either including or excluding the provided tags.
+ * @since 4.12
+ * @example
+ * let schemes = predominanceSchemes.getSchemesByTag({
+ *   includedTags: [ "types" ],
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ */
+export function getSchemesByTag(params: GetSchemesByTagParams): PredominanceScheme[];
+
+/**
+ * Clones a predominance scheme object.
+ *
+ * @param scheme - The predominance scheme object to clone.
+ * @returns Returns a clone of the given predominance scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * const predominanceScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: PredominanceScheme | null | undefined): PredominanceScheme | 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 geometry type of the features to visualize. */
+  geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch" | null;
+  /** The number of unique values to include in the predominance visualization. */
+  numColors?: number;
+  /**
+   * Determines which set of primary and secondary color schemes to return.
+   *
+   * @default default
+   */
+  theme?: "default" | null;
+  /**
+   * 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 | 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;
+}

package/smartMapping/symbology/relationship.d.ts

@@ -1,7 +1,136 @@
-import "../../interfaces";
+import type Basemap from "../../Basemap.js";
+import type SceneView from "../../views/SceneView.js";
+import type { RelationshipSchemes, RelationshipScheme, BasemapTheme, Theme } from "./interfaces.js";
 
-export const cloneScheme: __esri.symbologyRelationship["cloneScheme"];
-export const getSchemeByName: __esri.symbologyRelationship["getSchemeByName"];
-export const getSchemes: __esri.symbologyRelationship["getSchemes"];
-export const getSchemesByTag: __esri.symbologyRelationship["getSchemesByTag"];
-export const getThemes: __esri.symbologyRelationship["getThemes"];
+/**
+ * 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): Theme[];
+
+/**
+ * Returns a primary scheme and secondary schemes defining symbol properties for relationship-based (bivariate choropleth)
+ * 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
+ * symbols 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 relationship color 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 = relationshipSchemes.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): RelationshipSchemes | null | undefined;
+
+/**
+ * Returns a relationship 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 relationship scheme
+ *   with the given name.
+ * @since 4.12
+ * @example
+ * // Returns the Blueberry Parfait scheme
+ * let blueberryScheme = relationshipSchemes.getSchemeByName({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType,
+ *   name: "Blueberry Parfait"
+ * });
+ */
+export function getSchemeByName(params: GetSchemesByNameParams): RelationshipScheme | null | undefined;
+
+/**
+ * Returns an array of relationship schemes with the provided tags. These schemes define symbol properties for
+ * relationship visualizations.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an array of relationship schemes
+ *   either including or excluding the provided tags.
+ * @since 4.12
+ * @example
+ * let schemes = relationshipSchemes.getSchemesByTag({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType,
+ *   includedTags: [ "tritanopia" ],
+ *   excludedTags: [ "grayscale" ]
+ * });
+ */
+export function getSchemesByTag(params: GetSchemesByTagParams): RelationshipScheme[];
+
+/**
+ * Clones a relationship (bivariate color) scheme object.
+ *
+ * @param scheme - The relationship scheme object to clone.
+ * @returns Returns a clone of the given relationship scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * const relationshipScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: RelationshipScheme | null | undefined): RelationshipScheme | 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 geometry type of the features to visualize. */
+  geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch" | null;
+  /**
+   * Determines which set of primary and secondary color schemes to return.
+   *
+   * @default default
+   */
+  theme?: "default" | null;
+  /**
+   * 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 | 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;
+}

package/smartMapping/symbology/size.d.ts

@@ -1,5 +1,74 @@
-import "../../interfaces";
+import type Basemap from "../../Basemap.js";
+import type SceneView from "../../views/SceneView.js";
+import type { SizeScheme, SizeSchemes, BasemapTheme, Theme } from "./interfaces.js";
 
-export const cloneScheme: __esri.symbologySize["cloneScheme"];
-export const getSchemes: __esri.symbologySize["getSchemes"];
-export const getThemes: __esri.symbologySize["getThemes"];
+/**
+ * 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 size-based
+ * data-driven visualizations in
+ * a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). The `basemap` parameter determines the color 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 size 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 = sizeSchemes.getSchemes({
+ *   basemap: map.basemap,
+ *   geometryType: featureLayer.geometryType
+ * });
+ *
+ * // the best default scheme for the layer and basemap
+ * let primaryScheme = schemes.primaryScheme;
+ */
+export function getSchemes(params: GetSchemesParams): SizeSchemes | null | undefined;
+
+/**
+ * Clones a size scheme object.
+ *
+ * @param scheme - The SizeScheme object to clone.
+ * @returns Returns a clone of the given size scheme object.
+ * @example
+ * // clones the primary scheme returned from the getSchemes() method
+ * let sizeScheme = primaryScheme.clone();
+ */
+export function cloneScheme(scheme: SizeScheme | null | undefined): SizeScheme | 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 geometry type of the features to visualize. */
+  geometryType: "point" | "multipoint" | "polyline" | "polygon" | null;
+  /**
+   * 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;
+}

package/smartMapping/symbology/support/colorRamps.d.ts

@@ -1,6 +1,85 @@
-import "../../../interfaces";
+import type { ColorRamp } from "../interfaces.js";
 
-export const all: __esri.supportColorRamps["all"];
-export const byName: __esri.supportColorRamps["byName"];
-export const byTag: __esri.supportColorRamps["byTag"];
-export const names: __esri.supportColorRamps["names"];
+/**
+ * Returns all color ramps available in smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html).
+ *
+ * @returns An array of all
+ *   color ramps available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html).
+ * @example
+ * // returns all color ramps available in the JS API
+ * const ramps = colorRamps.all();
+ * @example
+ * // Renders all color ramps as continuous color ramps in the body of the html
+ * const ramps = colorRamps.all();
+ *
+ * ramps.forEach( ramp => {
+ *   const colorRamp = symbolUtils.renderColorRampPreviewHTML(ramp.colors, {
+ *     align: "horizontal"
+ *   });
+ *   body.appendChild(colorRamp);
+ * });
+ */
+export function all(): ColorRamp[];
+
+/**
+ * Returns the names of all color ramps available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html).
+ * Any of the returned names can be used to query for color schemes using
+ * [colorSchemes.getSchemeByName()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) or
+ * the color ramp using [byName()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#byName).
+ *
+ * @returns An array of all
+ *   color ramp names available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html).
+ * @example
+ * // returns all color ramp names available in the JS API
+ * const rampNames = colorRamps.names();
+ */
+export function names(): string[];
+
+/**
+ * Returns the color ramp available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html)
+ * matching the given name.
+ *
+ * @param name - The name of the desired color ramp.
+ * @returns The
+ *   color ramp matching the given name.
+ * @example
+ * // returns the colors of the Flower Field color ramp
+ * const flowerFieldRamp = colorRamps.byName("Flower Field");
+ * const colorRamp = symbolUtils.renderColorRampPreviewHTML(flowerFieldRamp.colors, {
+ *   align: "horizontal"
+ * });
+ * body.appendChild(colorRamp);
+ */
+export function byName(name: string): ColorRamp | null | undefined;
+
+/**
+ * Returns the color ramps available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html)
+ * matching the given tags.
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns The
+ *   color ramps matching the given tags.
+ * @example
+ * // returns all bright red color ramps available in the JS API
+ * const ramps = colorRamps.byTag({
+ *   includedTags: [ "reds", "bright" ]
+ * });
+ */
+export function byTag(params: ByTagParams): ColorRamp[];
+
+export interface ByTagParams {
+  /**
+   * When provided, only ramps 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 | categorical | heatmap | 3d
+   */
+  excludedTags: string[];
+  /**
+   * When provided, only ramps 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 | categorical | heatmap | 3d
+   */
+  includedTags: string[];
+}