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

package/smartMapping/labels/clusters.d.ts

@@ -1,3 +1,89 @@
-import "../../interfaces";
+import type LabelClass from "../../layers/support/LabelClass.js";
+import type MapView from "../../views/MapView.js";
+import type { SupportedLayer } from "../support/clusterUtils.js";
+import type { ClusterableRenderer } from "../../views/2d/layers/support/clusterUtils.js";
 
-export const getLabelSchemes: __esri.clusters["getLabelSchemes"];
+/**
+ * Generates default [FeatureReductionCluster#labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo)
+ * schemes to be set on a FeatureLayer's [FeatureLayer#featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) configuration.
+ * Returns one or more suggested LabelClasses
+ * for a given layer based on its renderer. It also returns a suggested
+ * [FeatureReductionCluster#clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) to
+ * ensure labels fit inside clusters.
+ *
+ * If a renderer has a non-scale dependent [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then the average value of the field or expression
+ * used to determine the cluster size will be suggested as the default label value. In all other scenarios,
+ * the suggested label will display the cluster count in the center of the label.
+ *
+ * @param parameters - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an object containing suggested primary
+ *   and secondary labeling schemes to be set on the layer's `featureReduction` property.
+ * @example
+ * // Sets suggested labels on the clusters based on the underlying renderer
+ * clusterLabelCreator.getLabelSchemes({
+ *   layer: featureLayer,
+ *   view: view
+ * }).then(function(labelSchemes){
+ *   const featureReduction = featureLayer.featureReduction.clone();
+ *   const { labelingInfo, clusterMinSize } = labelSchemes.primaryScheme;
+ *   featureReduction.labelingInfo = labelingInfo;
+ *   featureReduction.clusterMinSize = clusterMinSize;
+ *
+ *   featureLayer.featureReduction = featureReduction;
+ * }).catch(function(error){
+ *   console.error(error);
+ * });
+ */
+export function getLabelSchemes(parameters: SchemeParams): Promise<Schemes | null | undefined>;
+
+export interface SchemeParams {
+  /**
+   * The name of the [AggregateField#name](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#name)
+   *   to use in the primary label scheme. If not specified, then the label will be based on the data used to vary cluster size.
+   */
+  field?: string;
+  /** The point layer that has or will have clustering enabled. */
+  layer: SupportedLayer;
+  /**
+   * The renderer to set on the input layer when clustering is enabled.
+   *   Specify this parameter if the layer's renderer does not match the renderer that will be used when clustering is enabled.
+   *   This cannot be a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html).
+   */
+  renderer?: ClusterableRenderer;
+  /** The view where the input layer will be rendered. */
+  view: MapView;
+}
+
+/** Contains a suggested labelingInfo to be set on the layer's [featureReduction.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo). */
+export interface Scheme {
+  /**
+   * The suggested
+   *   [featureReduction.clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize)
+   *   required to fit labels within clusters.
+   */
+  clusterMinSize: number;
+  /**
+   * The name of the aggregate field the labeling scheme is based on.
+   *   This can be used in the UI of web map authoring apps.
+   */
+  fieldName: string;
+  /**
+   * An array of
+   *   LabelClass objects to set on the layer's [featureReduction.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo)
+   *   property.
+   */
+  labelingInfo: LabelClass[];
+  /**
+   * The name of the generated cluster labeling scheme.
+   *   This can be used in the UI of web map authoring apps.
+   */
+  name: string;
+}
+
+/** The return object of the [getLabelSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#getLabelSchemes) method. */
+export interface Schemes {
+  /** Includes the primary labeling scheme suggested for the input layer's clusters. */
+  primaryScheme: Scheme;
+  /** Includes secondary labeling schemes suggested for the input layer's clusters. */
+  secondarySchemes: Scheme[];
+}

package/smartMapping/popup/clusters.d.ts

@@ -1,3 +1,40 @@
-import "../../interfaces";
+import type SubtypeGroupLayer from "../../layers/SubtypeGroupLayer.js";
+import type SubtypeSublayer from "../../layers/support/SubtypeSublayer.js";
+import type { RendererWithVisualVariablesUnion } from "../../renderers/support/typeUtils.js";
+import type { Templates } from "./interfaces.js";
+import type { SupportedLayer } from "./support/utils.js";
 
-export const getTemplates: __esri.popupClusters["getTemplates"];
+/**
+ * Returns one or more suggested default [popupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for a given
+ * layer's [FeatureReductionCluster#popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate)
+ * configuration. The cluster popup will contain  information describing features in the cluster, including
+ * the number of features in the cluster and summary statistics based on fields and expressions used in
+ * the layer's renderer.
+ *
+ * @param parameters - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an object containing suggested primary
+ *   and secondary PopupTemplates for the input layer's `featureReduction` property.
+ * @example
+ * // Sets a suggested popupTemplate on the layer's clusters
+ * clusterPopupTemplateCreator.getTemplates({
+ *   layer: featureLayer,
+ *   renderer: featureLayer.renderer
+ * }).then(function(popupTemplateResponse){
+ *   const featureReduction = featureLayer.featureReduction.clone();
+ *   featureReduction.popupTemplate = popupTemplateResponse.primaryTemplate.value;
+ *   featureLayer.featureReduction = featureReduction;
+ * }).catch(function(error){
+ *   console.error(error);
+ * });
+ */
+export function getTemplates(parameters: TemplateParams): Promise<Templates | null | undefined>;
+
+export interface TemplateParams {
+  /** The point layer that is or will be clustered. */
+  layer: Exclude<SupportedLayer, SubtypeGroupLayer | SubtypeSublayer>;
+  /**
+   * Specify the renderer to be used on the layer when
+   *   `featureReduction` is enabled if it will be different than the renderer already set on the layer.
+   */
+  renderer: RendererWithVisualVariablesUnion;
+}

package/smartMapping/popup/interfaces.d.ts

@@ -0,0 +1,25 @@
+import type PopupTemplate from "../../PopupTemplate.js";
+
+/** The return object of the [getTemplates()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#getTemplates) method. */
+export interface Templates {
+  /** Includes the primary PopupTemplate suggested for the input layer. */
+  primaryTemplate: Template;
+  /** Includes secondary PopupTemplates that may be applied to the input layer. */
+  secondaryTemplates: Template[];
+}
+
+/**
+ * Defines a suggested PopupTemplate with a given name and title describing the content
+ * and purpose of the PopupTemplate.
+ */
+export interface Template {
+  /**
+   * The name of the auto-generated PopupTemplate.
+   *   This can be used in the UI of web map authoring apps.
+   */
+  name: string;
+  /** The title of the PopupTemplate. */
+  title: string;
+  /** The suggested PopupTemplate. */
+  value: PopupTemplate;
+}

package/smartMapping/popup/support/utils.d.ts

@@ -0,0 +1,13 @@
+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 SubtypeGroupLayer from "../../../layers/SubtypeGroupLayer.js";
+import type WFSLayer from "../../../layers/WFSLayer.js";
+import type KnowledgeGraphSublayer from "../../../layers/knowledgeGraph/KnowledgeGraphSublayer.js";
+import type SubtypeSublayer from "../../../layers/support/SubtypeSublayer.js";
+
+export type SupportedLayer = CSVLayer | FeatureLayer | OGCFeatureLayer | GeoJSONLayer | WFSLayer | OrientedImageryLayer | ParquetLayer | StreamLayer | SubtypeGroupLayer | SubtypeSublayer | KnowledgeGraphSublayer;

package/smartMapping/popup/templates.d.ts

@@ -1,3 +1,37 @@
-import "../../interfaces";
+import type { RendererUnion } from "../../renderers/support/typeUtils.js";
+import type { Templates } from "./interfaces.js";
+import type { SupportedLayer } from "./support/utils.js";
 
-export const getTemplates: __esri.templates["getTemplates"];
+/**
+ * Returns one or more suggested [popupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for a given layer based on
+ * its renderer. This method is useful in apps where a layer's renderer can be modified by the user (or some other process)
+ * and the popup template is expected to display values related to the renderer. Popup templates will not
+ * be generated for layers with renderers that don't refer to a data value (i.e. SimpleRenderer with no visual variables).
+ *
+ * @param params - See the table below for details of each parameter that may be passed to this function.
+ * @returns Returns an object containing suggested primary
+ *   and secondary PopupTemplates for the input layer.
+ * @example
+ * // Sets a suggested popupTemplate on the layer based on its renderer
+ * popupTemplateCreator.getTemplates({
+ *   layer: featureLayer,
+ *   renderer: featureLayer.renderer
+ * }).then(function(popupTemplateResponse){
+ *   if ( popupTemplateResponse.primaryTemplate ){
+ *     featureLayer.popupTemplate = popupTemplateResponse.primaryTemplate.value;
+ *   }
+ * }).catch(function(error){
+ *   console.error(error);
+ * });
+ */
+export function getTemplates(params: TemplateParams): Promise<Templates | null | undefined>;
+
+export interface TemplateParams {
+  /** The layer to which the suggested popup templates can be applied. */
+  layer: SupportedLayer;
+  /**
+   * Specify the renderer to be used on the layer when
+   *   if it will be different than the renderer already set on the layer.
+   */
+  renderer?: RendererUnion;
+}

package/smartMapping/raster/renderers/classBreaks.d.ts

@@ -1,3 +1,36 @@
-import "../../../interfaces";
+import type ClassBreaksRenderer from "../../../renderers/ClassBreaksRenderer.js";
+import type { ClassBreaksParameters } from "../../../renderers/support/rasterRendererHelper.js";
+import type { RasterRendererParameters } from "./interfaces.js";
+import type { ClassBreaksResult } from "../../../smartMapping/statistics/interfaces.js";
 
-export const createRenderer: __esri.classBreaks["createRenderer"];
+export interface RasterClassBreaksRendererParameters extends RasterRendererParameters, ClassBreaksParameters {}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RasterClassBreaksResult {
+  /**
+   * This object
+   * describes class breaks generated from data in a layer for a given field with a specified classification method.
+   */
+  classBreaksResult: ClassBreaksResult;
+  /**
+   * The renderer object configured to best
+   * match the given basemap and the spread of the data. Set this on a layer's `renderer` property to
+   * update its visualization.
+   */
+  renderer: ClassBreaksRenderer;
+}
+
+/**
+ * Generates a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) used to render imagery data.
+ * Depending on the `classificationMethod`, class breaks (or data ranges) are generated based on the statistics of the data.
+ * Each cell is assigned a color based on the class break in which the value of the cell or `field` falls.
+ *
+ * @param parameters - Input parameters for generating a classed color visualization for raster data
+ * returned from the cell value or a given field. See the table below for details of each parameter.
+ * @returns Resolves with
+ *   an object containing a ClassBreaksRenderer that can be set on the input layer.
+ */
+export function createRenderer(parameters: RasterClassBreaksRendererParameters): Promise<RasterClassBreaksResult>;

package/smartMapping/raster/renderers/colormap.d.ts

@@ -1,3 +1,23 @@
-import "../../../interfaces";
+import type RasterColormapRenderer from "../../../renderers/RasterColormapRenderer.js";
+import type { RasterRendererParameters } from "./interfaces.js";
 
-export const createRenderer: __esri.colormap["createRenderer"];
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RasterColormapResult {
+  /**
+   * The colormap renderer to apply
+   *   to the input layer.
+   */
+  renderer: RasterColormapRenderer;
+}
+
+/**
+ * Generates a [RasterColormapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html) used to render imagery data.
+ *
+ * @param parameters - Input parameters for generating a colormap visualization. See the table below for details of each parameter.
+ * @returns Resolves to
+ *   an object containing a RasterColormapRenderer that can be set on the input layer.
+ */
+export function createRenderer(parameters: RasterRendererParameters): Promise<RasterColormapResult>;

package/smartMapping/raster/renderers/flow.d.ts

@@ -1,3 +1,146 @@
-import "../../../interfaces";
+import type FlowRenderer from "../../../renderers/FlowRenderer.js";
+import type { VisualVariable } from "../../../renderers/interfaces.js";
+import type { RendererLegendOptionsProperties } from "../../../renderers/support/RendererLegendOptions.js";
+import type { RasterRendererParameters } from "./interfaces.js";
+import type { SummaryStatisticsResult } from "../../statistics/interfaces.js";
+import type { FlowScheme } from "../../symbology/interfaces.js";
+import type { MapViewOrSceneView } from "../../../views/MapViewOrSceneView.js";
 
-export const createRenderer: __esri.flow["createRenderer"];
+/**
+ * Generates a [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) to display raster data with streamlines.
+ * This renderer is often used for visualizing flow direction and magnitude information in meteorology
+ * and oceanography raster data.
+ *
+ * @param parameters - Input parameters for generating a flow visualization.
+ *   See the table below for details of each parameter.
+ * @returns Resolves
+ *   to an object containing a FlowRenderer that can be set on the input layer.
+ * @example
+ * const { renderer } = await flowRendererCreator.createRenderer({
+ *   layer,
+ *   view,
+ *   theme: "wave-front",
+ *   flowRepresentation: "flow-to"
+ * });
+ *
+ * // renders animated wave-like lines on the raster
+ * layer.renderer = renderer;
+ */
+export function createRenderer(parameters: FlowRendererParameters): Promise<FlowRendererResult>;
+
+export interface FlowRendererParameters extends RasterRendererParameters {
+  /**
+   * Defines the flow direction of the
+   *   data. This can be modified to display meteorological (the direction it is flowing from) or
+   *   oceanographic data (the direction it is flowing to). See
+   *   [FlowRenderer#flowRepresentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowRepresentation)
+   *   for more information.
+   */
+  flowRepresentation?: FlowRenderer["flowRepresentation"] | null;
+  /**
+   * The flow scheme
+   *   used to set colors and sizes to the flow lines.
+   */
+  flowScheme?: FlowScheme | null;
+  /**
+   * When `true`, the color of streamlines will vary
+   *   depending on the magnitude of the data. Flow lines with stronger
+   *   magnitude values will have bright colors on dark backgrounds and dark colors on light backgrounds, giving
+   *   them more prominence.
+   *
+   * @default false
+   */
+  includeColorVariable?: boolean | null;
+  /**
+   * When `true`, the opacity of streamlines will vary
+   *   depending on the magnitude of the data. Flow lines with stronger
+   *   magnitude values will be more opaque than lines with weaker magnitude values, giving
+   *   them more prominence.
+   *
+   * @default false
+   */
+  includeOpacityVariable?: boolean | null;
+  /**
+   * When `true`, the width of streamlines will vary
+   *   depending on the magnitude of the data. Flow lines with stronger
+   *   magnitude values will be wider than lines with weaker magnitude values, giving
+   *   them more prominence.
+   *
+   * @default false
+   */
+  includeSizeVariable?: boolean | null;
+  /**
+   * Provides options for setting a title to the renderer in the
+   *   [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   */
+  legendOptions?: RendererLegendOptionsProperties | null;
+  /**
+   * Determines how flow lines will render.
+   *   Possible values are listed below.
+   * | Value | Description | Example |
+   * | ----- | ----------- | ------- |
+   * | flow-line | Renders the uv and magnitude data as animated flow lines. This is ideal for representing wind and other atmospheric data. | ![flow-line](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/animated-flow/sm-flow-line-2.gif) |
+   * | wave-front | Renders UV and magnitude data in a wave-like animation. This theme works well for ocean data. | ![above](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/animated-flow/sm-wave-front-2.gif) |
+   *
+   * > [!WARNING]
+   * >
+   * > **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).
+   *
+   * @default "flow-line"
+   */
+  theme?: "flow-line" | "wave-front" | null;
+  /**
+   * The view where the input layer is rendered. This method
+   *   inspects the view's background (i.e. basemap, web map background, or view container) to determine optimal
+   *   colors for the output renderer. This parameter should always be set in practice, but if not provided
+   *   this method will assume the generated renderer will display on a light background.
+   */
+  view?: MapViewOrSceneView | null;
+}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface FlowRendererResult {
+  /**
+   * The ID of the basemap used to determine the optimal
+   *   color of the flow lines.
+   */
+  basemapId?: string | null;
+  /**
+   * Indicates whether the average color of the input view's
+   *   basemap is `light` or `dark`.
+   */
+  basemapTheme?: string | null;
+  /**
+   * The flow scheme
+   *   used to set colors and sizes to the flow lines.
+   */
+  flowScheme: FlowScheme;
+  /**
+   * A suggested layer effect to apply to the input layer. When the
+   *   `basemapTheme` is dark, a bloom is suggested to add to the layer.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > The layer effects are not supported in 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   */
+  layerEffect: string;
+  /**
+   * The FlowRenderer renderer to apply
+   *   to the input layer.
+   */
+  renderer: FlowRenderer;
+  /** Summary statistics of the raster layer. */
+  statistics: SummaryStatisticsResult;
+  /**
+   * Visual variables
+   *   included in the output renderer.
+   */
+  visualVariables: VisualVariable[];
+}

package/smartMapping/raster/renderers/interfaces.d.ts

@@ -0,0 +1,26 @@
+import type RasterFunction from "../../../layers/support/RasterFunction.js";
+import type { AbortOptions } from "../../../core/promiseUtils.js";
+import type { RasterLayer } from "../support/adapters/interfaces.js";
+
+export interface RasterRendererParameters extends AbortOptions {
+  /**
+   * The
+   *   input layer for which the renderer is generated. The
+   *   [source type](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/raster-dataset-properties.htm)
+   *   of the raster must be `Vector-UV` or `Vector-MagDir`.
+   */
+  layer: RasterLayer;
+  /**
+   * Specifies the function for how the requested image
+   *   should be processed. When `rasterFunction` is applied, the server returns updated service information that reflects custom
+   *   processing as defined by the raster function. If not provided, the output renderer is created using the layer's `rasterFunction`.
+   */
+  rasterFunction?: RasterFunction | null;
+  /** Deprecated since 4.27. Use `rasterFunction` instead. */
+  renderingRule?: RasterFunction;
+  /**
+   * Only applicable to multidimensional datasets where a raster layer can contain more than one variable
+   *   (such as temperature, humidity, wind speed) with different statistics. Indicate the variable name here.
+   */
+  variableName?: string;
+}

package/smartMapping/raster/renderers/rgb.d.ts

@@ -1,3 +1,66 @@
-import "../../../interfaces";
+import type RasterStretchRenderer from "../../../renderers/RasterStretchRenderer.js";
+import type { RasterStretchType } from "../../../renderers/interfaces.js";
+import type { RasterRendererParameters } from "./interfaces.js";
 
-export const createRenderer: __esri.rgb["createRenderer"];
+export interface RasterRGBRendererParameters extends RasterRendererParameters {
+  /**
+   * When `true`, calculates the renderer's statistics based on the current
+   *   display extent and recalculates them as you zoom and pan around the image.
+   */
+  dynamicRangeAdjustment?: boolean;
+  /**
+   * Useful in scenarios where an image service does not have statistics. When `true`, this function estimates
+   *   global statistics to keep a constant visual on pan and zoom, unlike `dynamicRangeAdjustment` which recalculates statistics on each extent change.
+   */
+  estimateStatistics?: boolean;
+  /**
+   * The gamma values to be used if `useGamma` is `true`.
+   *   Gamma refers to the degree of contrast between the mid-level gray values of a raster dataset.
+   *   It does not affect black or white values, only the middle values.
+   *   By applying a gamma correction, you can control the overall brightness of an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   *   Gamma stretching is only valid when `stretchType` is `none`, `standard-deviation`, or `min-max`. See [RasterStretchRenderer#gamma](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#gamma) for more information.
+   */
+  gamma?: [
+      number,
+      number,
+      number
+  ];
+  /** The RGB band indexes following the order of red, green, and blue channels. This array must have three numbers. */
+  rgbBandIds?: [
+      number,
+      number,
+      number
+  ];
+  /** A preferred stretch type can be provided. See [RasterStretchRenderer#stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) for more information. */
+  stretchType?: RasterStretchType;
+  /** Indicates whether the `gamma` values should be used. When `false`, the gamma is calculated from the statistics and histogram of the data. */
+  useGamma?: boolean;
+}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RasterRGBResult {
+  /**
+   * The RGB RasterStretchRenderer renderer to apply
+   *   to the input layer.
+   */
+  renderer: RasterStretchRenderer;
+  /** The RGB band indexes following the order of red, green, and blue channels. */
+  rgbBandIds?: [
+      number,
+      number,
+      number
+  ] | null;
+}
+
+/**
+ * Generates an RGB [RasterStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) to render three selected bands into
+ * red, green, and blue color channels.
+ *
+ * @param parameters - Input parameters for generating a RGB stretch visualization. See the table below for details of each parameter. The `colorRamp`, `gamma`, `useGamma`, and `dynamicRangeAdjustment` parameters are not related to RGB band ID selection or stretch type. Pass them in to preserve the existing settings if desired.
+ * @returns Resolves to
+ *   an object containing a stretch renderer that can be set on the input renderer.
+ */
+export function createRenderer(parameters: RasterRGBRendererParameters): Promise<RasterRGBResult>;

package/smartMapping/raster/renderers/shadedRelief.d.ts

@@ -1,3 +1,41 @@
-import "../../../interfaces";
+import type RasterShadedReliefRenderer from "../../../renderers/RasterShadedReliefRenderer.js";
+import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRamp.js";
+import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";
+import type { RasterRendererParameters } from "./interfaces.js";
 
-export const createRenderer: __esri.shadedRelief["createRenderer"];
+export interface RasterShadedReliefParameters extends RasterRendererParameters {
+  /**
+   * The color ramp to apply to the renderer.
+   *   By default, the color ramp is grayscale.
+   */
+  colorRamp?: AlgorithmicColorRamp | MultipartColorRamp;
+  /** The preferred hillshade type. See [RasterShadedReliefRenderer#hillshadeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#hillshadeType) for more information. */
+  hillshadeType?: RasterShadedReliefRenderer["hillshadeType"];
+  /**
+   * Applies a constant or adjusted z-factor
+   *   based on resolution changes. The shaded result is scaled dynamically by adjusting the z-factor
+   *   using one of two options. See [RasterShadedReliefRenderer#hillshadeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#hillshadeType) for more information.
+   *
+   * @default none
+   */
+  scalingType?: RasterShadedReliefRenderer["scalingType"];
+}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RasterShadedReliefResult {
+  /** The RasterShadedReliefRenderer renderer to apply to the input layer. */
+  renderer: RasterShadedReliefRenderer;
+}
+
+/**
+ * Generates a [RasterShadedReliefRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html) to render elevation data.
+ *
+ * @param parameters - Input parameters for generating a shaded relief visualization.
+ *   See the table below for details of each parameter.
+ * @returns Resolves with an object containing a RasterShadedReliefRenderer that can be set
+ *   on the input renderer.
+ */
+export function createRenderer(parameters: RasterShadedReliefParameters): Promise<RasterShadedReliefResult>;

package/smartMapping/raster/renderers/stretch.d.ts

@@ -1,3 +1,61 @@
-import "../../../interfaces";
+import type RasterStretchRenderer from "../../../renderers/RasterStretchRenderer.js";
+import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRamp.js";
+import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";
+import type { RasterStretchType } from "../../../renderers/interfaces.js";
+import type { RasterRendererParameters } from "./interfaces.js";
 
-export const createRenderer: __esri.stretch["createRenderer"];
+export interface RasterStretchColorrampRendererParameters extends RasterRendererParameters {
+  /** The 0-based index of a selected band. */
+  bandId?: number;
+  /** The color ramp to apply to the renderer. */
+  colorRamp?: AlgorithmicColorRamp | MultipartColorRamp;
+  /**
+   * When `true`, calculates the renderer's statistics based on the current
+   *   display extent and recalculates them as you zoom and pan around the image.
+   */
+  dynamicRangeAdjustment?: boolean;
+  /**
+   * Useful in scenarios where an image service does not have statistics. When `true`, this function estimates
+   *   global statistics to keep a constant visual on pan and zoom, unlike `dynamicRangeAdjustment` which recalculates statistics on each extent change.
+   */
+  estimateStatistics?: boolean;
+  /**
+   * The gamma values to be used if `useGamma` is `true`.
+   *   Gamma refers to the degree of contrast between the mid-level gray values of a raster dataset.
+   *   It does not affect the black or white values in a raster dataset, only the middle values.
+   *   By applying a gamma correction, you can control the overall brightness of an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   *   Gamma stretching is only valid when `stretchType` is `none`, `standard-deviation`, or `min-max`. See [RasterStretchRenderer#gamma](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#gamma) for more information.
+   */
+  gamma?: number;
+  /** A preferred stretch type can be provided. See [RasterStretchRenderer#stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) for more information. */
+  stretchType?: RasterStretchType;
+  /** Indicates whether the `gamma` values should be used. When `false`, the gamma is calculated from the statistics and histogram of the data. */
+  useGamma?: boolean;
+  /**
+   * Only applicable to multidimensional datasets where a raster layer can contain more than one variable
+   *   (such as temperature, humidity, wind speed) with different statistics. Indicate the variable name here.
+   */
+  variableName?: string;
+}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RasterStretchColorrampResult {
+  /** The zero-based index of the band represented by the renderer. */
+  bandId: number;
+  /**
+   * The RasterStretchRenderer renderer to apply
+   *   to the input layer.
+   */
+  renderer: RasterStretchRenderer;
+}
+
+/**
+ * Generates a [RasterStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) to render data from a single raster band.
+ *
+ * @param parameters - Input parameters for generating a single-band stretch visualization. See the table below for details of each parameter. The `colorRamp`, `gamma`, `useGamma`, `dynamicRangeAdjustment` parameters are not related to stretch type. Pass them in to preserve the existing renderer settings if desired.
+ * @returns Resolves to an object containing a stretch renderer that can be set on the input renderer.
+ */
+export function createRenderer(parameters: RasterStretchColorrampRendererParameters): Promise<RasterStretchColorrampResult>;