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

package/smartMapping/renderers/predominance.d.ts

@@ -1,3 +1,264 @@
-import "../../interfaces";
+import type FeatureFilter from "../../layers/support/FeatureFilter.js";
+import type UniqueValueRenderer from "../../renderers/UniqueValueRenderer.js";
+import type * as opacityCreator from "./opacity.js";
+import type * as sizeCreator from "./size.js";
+import type * as typeCreator from "./type.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+import type { AbortOptions } from "../../core/promiseUtils.js";
+import type { RendererLegendTitleOption } from "../../renderers/support/RendererLegendOptions.js";
+import type { UniqueValueInfo } from "./type.js";
+import type { SupportedLayer } from "../support/adapters/interfaces.js";
+import type { PredominanceScheme, BasemapTheme } from "../symbology/interfaces.js";
 
-export const createRenderer: __esri.predominance["createRenderer"];
+/**
+ * Generates a predominance renderer based on a set of competing numeric fields.
+ *
+ * Visualizing predominance involves coloring a [layer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) features based
+ * on which attribute among a set of competing numeric attributes wins or beats the others in total count.
+ * Common applications of this include visualizing election results, survey results, and demographic majorities.
+ *
+ * For example, suppose you have a layer of U.S. counties with fields containing the total sales of
+ * various crops: wheat, soybeans, corn, cotton, and vegetables. If a feature has the following values for each field:
+ *
+ * Field Name | Count | Color
+ * -----------|-------|------
+ * Wheat | 130 | purple
+ * Soybeans | 2000 | blue
+ * Corn | 0 | yellow
+ * Cotton | 300 | green
+ * Vegetables | 120 | red
+ *
+ * Then the renderer symbolizes the feature with a blue color since Soybeans is the predominant crop.
+ *
+ * The predominant field of a feature is determined based on the result of an Arcade expression generated
+ * by this method. You are required to provide a `layer`, `view`, and list of `fields` to generate this renderer. Optionally, you can
+ * set `includeSizeVariable` to `true` to change the size of each feature to indicate how influential the feature is compared to the entire layer
+ * as a whole. You can also set `includeOpacityVariable` to `true` to add opacity to each feature depending on how
+ * strong the predominant field is compared to all the other fields. For the example above, the feature would likely be
+ * opaque since Soybeans beats all other features combined by a wide margin. If the Soybean total were still the highest, but only 301,
+ * then the feature would be very transparent, indicating the Soybean total wins, but not by a wide margin.
+ *
+ * Other options are provided for convenience for more involved custom visualization authoring
+ * applications.
+ *
+ * @param parameters - Input parameters for generating a predominance visualization based on a set of competing field(s).
+ *   See the table below for details of each parameter.
+ * @returns Resolves to an instance of [RendererResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult).
+ * @example
+ * const layer = new FeatureLayer({
+ *   url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/USA_County_Crops_2007/FeatureServer/0"
+ * });
+ *
+ * // will create a visualization of predominant crop by U.S. county
+ *
+ * const parameter = {
+ *   layer: layer,
+ *   view: view,
+ *   fields: [{
+ *     name: "M217_07",
+ *     label: "Vegetables"
+ *   }, {
+ *     name: "M188_07",
+ *     label: "Cotton"
+ *   }, {
+ *     name: "M172_07",
+ *     label: "Wheat"
+ *   }, {
+ *     name: "M193_07",
+ *     label: "Soybeans"
+ *   }, {
+ *     name: "M163_07",
+ *     label: "Corn"
+ *   }],
+ *   includeOpacityInfo: true
+ * };
+ *
+ * // when the promise resolves, apply the renderer to the layer
+ * predominanceRendererCreator.createRenderer(parameters)
+ *   .then(function(response){
+ *     layer.renderer = response.renderer;
+ *   });
+ */
+export function createRenderer(parameters: RendererParams): Promise<RendererResult>;
+
+export type SymbolType = "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform";
+
+export type ColorMixModeType = "tint" | "replace" | "multiply";
+
+export interface FieldInfo {
+  /**
+   * The label describing the field name (or category) in the legend. This is should be used
+   *   if the given field doesn't have an intuitive field name. For example, for a field named `dem` representing the total vote count
+   *   for the Democratic party, you can set the label to `Democrat` to clarify the name of the category in the final visualization.
+   */
+  label?: string | null;
+  /** The name of a numeric field. */
+  name: string;
+}
+
+export interface RendererParams extends AbortOptions {
+  /**
+   * **This option only applies to generating renderers for mesh SceneLayers**.
+   *   Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in
+   *   [FillSymbol3DLayer#material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context.
+   *   See the table below for possible values.
+   *
+   *   Value | Description
+   *   ------|------------
+   *   tint | Applies the symbol `color` to the desaturated geometry/texture color.
+   *   replace | Removes the geometry/texture color and applies the symbol `color`.
+   *   multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same.
+   *
+   * @default replace
+   */
+  colorMixMode?: ColorMixModeType | null;
+  /**
+   * Enables the `defaultSymbol` on the renderer and assigns it to features
+   *   with no value.
+   *
+   * @default true
+   */
+  defaultSymbolEnabled?: boolean | null;
+  /**
+   * A set of competing numeric fields used as the basis of the predominance visualization. For example,
+   *   if creating an election map, you would indicate the names of each field representing the candidate or political party where
+   *   total votes are stored.
+   */
+  fields?: FieldInfo[] | null;
+  /**
+   * _Since 4.31_ When defined, only features included in the filter
+   *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
+   *   This is useful when a lot of variation exists in the data
+   *   that could result in undesired data ranges. A common use case would be to set a filter that only
+   *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
+   *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   */
+  filter?: FeatureFilter | null;
+  /**
+   * Indicates whether the generated renderer is for a binning or clustering visualization.
+   *   If `true`, then the input field(s) in this method should refer to [aggregate fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html) defined in the `featureReduction` property of the layer.
+   */
+  forBinning?: boolean | null;
+  /**
+   * Indicates whether to include data-driven opacity in the final renderer. If `true`, features
+   *   where the predominant value beats all others by a large margin are given a high opacity. Features where the predominant value beats
+   *   others by a small margin will be assigned a low opacity, indicating that while the feature has a winning value, it doesn't win by much.
+   *
+   *   ![predominance-opacity](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/predominance-opacity.png)
+   */
+  includeOpacityVariable?: boolean | null;
+  /**
+   * Indicates whether to include data-driven size in the final renderer. If `true`, features will be assigned
+   *   a sized based on the sum of all competing values in the `fields` param. Features with small total counts will be sized with small icons or lines depending on
+   *   the geometry type of the layer, and features with large total counts will be sized with large icons or lines. Enabling this option
+   *   is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by
+   *   features with large geographic areas, but relatively small data values.
+   *
+   *   ![predominance-size](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/predominance-size.png)
+   */
+  includeSizeVariable?: boolean | null;
+  /**
+   * The layer
+   *   for which the visualization is generated. When a client-side layer type is provided, attribute and spatial statistics are calculated
+   * only from features in the view's extent. When a server-side layer type is provided, the statistics
+   * are calculated from the entire layer.
+   */
+  layer?: SupportedLayer | null;
+  /**
+   * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/) properties describing
+   *   the visualization.
+   */
+  legendOptions?: RendererLegendTitleOption | null;
+  /**
+   * Only for polygon layers. Indicates whether the
+   *   polygon outline width should vary based on view scale. When set, a valid [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
+   *   instance must be provided in the `view` parameter. This option is not supported for 3D
+   *   [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @default false
+   */
+  outlineOptimizationEnabled?: boolean | null;
+  /**
+   * In authoring apps,
+   *   the user may select a pre-defined predominance scheme. Pass the scheme object to this property to avoid getting one based on the background of the `view`.
+   */
+  predominanceScheme?: PredominanceScheme | null;
+  /**
+   * Indicates whether
+   *   symbol sizes should vary based on view scale. When set, a valid [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
+   *   instance must be provided in the `view` parameter. This option is not supported for 3D
+   *   [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @default false
+   */
+  sizeOptimizationEnabled?: boolean | null;
+  /**
+   * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   *   See the table below for information about values that may be passed to this parameter.
+   *   Possible Value | Description
+   *   ---------------|------------
+   *   count | Unique values/types will be sorted from highest to lowest based on the count of features that fall in each category.
+   *   value | Unique values/types will be sorted in the order they were specified in the `fields` parameter.
+   *
+   * @default count
+   */
+  sortBy?: typeCreator.SortBy | null;
+  /**
+   * The type of symbol to generate. This depends on the view
+   *   in which you are working and the desired visualization. This parameter does not need to be specified for layers
+   *   with a `mesh` geometry type. Possible values are described below.
+   *
+   *   | Value | Description |
+   *   | ----- | ----------- |
+   *   | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). |
+   *   | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). |
+   *   | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. |
+   *   | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sizes uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. |
+   *
+   * @default 2d
+   */
+  symbolType?: SymbolType | null;
+  /** The view instance in which the visualization will be rendered. */
+  view?: MapViewOrSceneView | null;
+}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RendererResult {
+  /** The ID of the basemap used to determine the optimal fill color of the features. */
+  basemapId?: string | null;
+  /** Indicates whether the average color of the input view's basemap is `light` or `dark`. */
+  basemapTheme?: BasemapTheme | null;
+  /**
+   * An array of objects describing the values or categories
+   *   excluded from consideration in visualizing data from the given fields. The specification of each object matches
+   *   that of the objects specified in the `predominantCategoryInfos` property.
+   */
+  excludedCategoryInfos: UniqueValueInfo[];
+  /**
+   * An opacity visual
+   *   variable representing the percentage of the total count comprised by the predominant value of all fields. This
+   *   variable indicates the strength of a particular value's predominance compared to the other values.
+   */
+  opacity?: opacityCreator.VisualVariableResult | null;
+  /** The predominance scheme used by the renderer. */
+  predominanceScheme: PredominanceScheme;
+  /**
+   * An array of objects describing the value, symbol, and count of
+   *   each unique type or category represented in the renderer.
+   */
+  predominantCategoryInfos: UniqueValueInfo[];
+  /**
+   * The unique value renderer object representing
+   *   the predominance visualization. Set this on a layer's `renderer` property to update its visualization.
+   */
+  renderer: UniqueValueRenderer;
+  /**
+   * A size visual
+   *   variable representing the total count of all fields included in the predominance visualization. This is included
+   *   if the `includeSizeVariable` parameter is true.
+   */
+  size?: sizeCreator.VisualVariableResult | null;
+}

package/smartMapping/renderers/relationship.d.ts

@@ -1,4 +1,329 @@
-import "../../interfaces";
+import type Color from "../../Color.js";
+import type FeatureFilter from "../../layers/support/FeatureFilter.js";
+import type UniqueValueRenderer from "../../renderers/UniqueValueRenderer.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+import type { AbortOptions } from "../../core/promiseUtils.js";
+import type { RelationshipNumClasses } from "../../renderers/support/interfaces.js";
+import type { RendererLegendOptionsProperties } from "../../renderers/support/RendererLegendOptions.js";
+import type { UniqueValueInfo } from "./type.js";
+import type { ClassBreak, ClassBreaksResult } from "../statistics/interfaces.js";
+import type { SupportedLayer } from "../support/adapters/interfaces.js";
+import type { RelationshipScheme, BasemapTheme } from "../symbology/interfaces.js";
 
-export const createRenderer: __esri.relationship["createRenderer"];
-export const updateRenderer: __esri.relationship["updateRenderer"];
+/**
+ * Updates a relationship renderer (bivariate choropleth) generated from [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer)
+ * based on the given input parameters.
+ *
+ * @param parameters - Input parameters for updating a relationship visualization created in [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer).
+ * @returns Resolves to the updated relationship renderer.
+ */
+export function updateRenderer(parameters: UpdateRendererParams): Promise<UniqueValueRenderer>;
+
+/**
+ * Generates a relationship renderer (bivariate choropleth) based on a set of competing numeric fields.
+ *
+ * Each feature's category is determined based on the result of an Arcade expression generated internally
+ * by this method. You are required provide a `layer`, `view`, `field1` name, and `field2` name to generate this renderer. Optionally, you can
+ * set the `focus` to change the rotation of the legend and the `numClasses` parameter to change the grid size of the legend.
+ *
+ * Other options are provided for convenience for more involved custom visualization authoring
+ * applications.
+ *
+ * @param parameters - Input parameters for generating a relationship visualization based on a pair of numeric field(s).
+ *   See the table below for details of each parameter.
+ * @returns Resolves to an instance of [RendererResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult).
+ * @example
+ * const layer = new FeatureLayer({
+ *   url: "https://services.arcgis.com/..."
+ * });
+ *
+ * // will create a bivariate choropleth visualization exploring the relationship
+ * // between the % of the population classified as obese, and the %
+ * // of the population diagnosed with diabetes
+ *
+ * const parameters = {
+ *   layer: layer,
+ *   view: view,
+ *   field1: {
+ *     field: "POP_Diabetes",
+ *     normalizationField: "TOTAL_POP"
+ *   },
+ *   field2: {
+ *     field: "POP_Obesity",
+ *     normalizationField: "TOTAL_POP"
+ *   },
+ *   focus: "HH",
+ *   defaultSymbolEnabled: false
+ * };
+ *
+ * // when the promise resolves, apply the renderer to the layer
+ * relationshipRendererCreator.createRenderer(parameters)
+ *   .then(function(response){
+ *     layer.renderer = response.renderer;
+ *   });
+ */
+export function createRenderer(parameters: RendererParams): Promise<RendererResult>;
+
+export type SymbolType = "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform";
+
+export type ColorMixModeType = "tint" | "replace" | "multiply";
+
+export type FocusType = "HH" | "HL" | "LH" | "LL";
+
+export interface FieldInfo {
+  /** The name of a numeric field. */
+  field: string;
+  /** The label used to describe the field or variable in the legend. */
+  label?: string;
+  /**
+   * The maximum bound of values to visualize in the given field. If a feature's value is greater than
+   *   this value, then it will be assigned the default symbol of the renderer.
+   */
+  maxValue?: number;
+  /**
+   * The minimum bound of values to visualize in the given field. If a feature's value is less than
+   *   this value, then it will be assigned the default symbol of the renderer.
+   */
+  minValue?: number;
+  /**
+   * The name of a numeric field used to normalize the given `field`. In choropleth visualizations
+   *   it is best practice to normalize your data values if they haven't already been normalized.
+   */
+  normalizationField?: string;
+}
+
+export interface RendererParams extends AbortOptions {
+  /**
+   * The method for classifying each field's data values. See
+   *   [classBreaks()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) for more information
+   *   about each classification type.
+   *
+   * @default quantile
+   */
+  classificationMethod?: "equal-interval" | "natural-breaks" | "quantile";
+  /**
+   * **This option only applies to generating renderers for mesh SceneLayers**.
+   *   Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in
+   *   [FillSymbol3DLayer#material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context.
+   *   See the table below for possible values.
+   *
+   *   Value | Description
+   *   ------|------------
+   *   tint | Applies the symbol `color` to the desaturated geometry/texture color.
+   *   replace | Removes the geometry/texture color and applies the symbol `color`.
+   *   multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same.
+   *
+   * @default replace
+   */
+  colorMixMode?: ColorMixModeType | null;
+  /**
+   * Enables the `defaultSymbol` on the renderer and assigns it to features
+   *   with no value or that fall outside of the prescribed class breaks.
+   *
+   * @default true
+   */
+  defaultSymbolEnabled?: boolean | null;
+  /**
+   * A numeric field that will be used to explore its relationship with `field2`. In the default visualization,
+   *   the values of this field are rendered along the vertical axis of the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   */
+  field1?: FieldInfo | null;
+  /**
+   * A numeric field that will be used to explore its relationship with `field1`. In the default visualization,
+   *   the values of this field are rendered along the horizontal axis of the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   */
+  field2?: FieldInfo | null;
+  /**
+   * _Since 4.31_ When defined, only features included in the filter
+   *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
+   *   This is useful when a lot of variation exists in the data
+   *   that could result in undesired data ranges. A common use case would be to set a filter that only
+   *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
+   *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   */
+  filter?: FeatureFilter | null;
+  /**
+   * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/). This value does not change the renderer or symbology
+   *   of any features in the layer. This affects the legend only. See the table below for a description of the possible values. See the class description
+   *   at the top of this page for a more thorough explanation of how to read the legend.
+   *
+   *   Value | Example | Description
+   *   ------|-------------|--------
+   *   null | ![relationship-legend-null](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-null.png) | The legend renders as a square. The top right corner of the legend indicates that values from both `field1` and `field2` are considered high. |
+   *   HH | ![relationship-legend-hh](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-hh.png) | The legend renders as a diamond with the focus on the top corner where values from both `field1` and `field2` are considered high. |
+   *   HL | ![relationship-legend-hl](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-hl.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are high and values from `field2` are low. |
+   *   LH | ![relationship-legend-lh](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-lh.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are low and values from `field2` are high. |
+   *   LL | ![relationship-legend-ll](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-ll.png) | The legend renders as a diamond with the focus on the top corner where values from both `field1` and `field2` are considered low. |
+   *
+   * @default null
+   */
+  focus?: FocusType | null;
+  /**
+   * Indicates whether the generated renderer is for a binning or clustering visualization.
+   *   If `true`, then the input field(s) in this method should refer to [aggregate fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html) defined in the `featureReduction` property of the layer.
+   */
+  forBinning?: boolean | null;
+  /**
+   * The layer
+   *   for which the visualization is generated. When a client-side layer type is provided, attribute and spatial statistics are calculated
+   * only from features in the view's extent. When a server-side layer type is provided, the statistics
+   * are calculated from the entire layer.
+   */
+  layer?: SupportedLayer | null;
+  /**
+   * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/) properties describing
+   *   the visualization.
+   */
+  legendOptions?: RendererLegendOptionsProperties | null;
+  /**
+   * Indicates the number of classes by which to break up the values of each field. More classes give you more detail, but more colors, making the visualization
+   *   more difficult to understand. There are only three possible values.
+   *
+   * 2 classes | 3 classes | 4 classes
+   * --|--|---
+   * ![relationship-breaks-2](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-breaks-2.png) | ![relationship-breaks-3](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-breaks-3.png) | ![relationship-breaks-4](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-breaks-4.png)
+   *
+   * **Possible Values:** 2 | 3 | 4
+   *
+   * @default 3
+   */
+  numClasses?: RelationshipNumClasses | null;
+  /**
+   * For polygon layers only. Indicates whether the
+   *   polygon outline width should vary based on view scale. When set, a valid [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
+   *   instance must be provided in the `view` parameter. This option is not supported for 3D
+   *   [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @default false
+   */
+  outlineOptimizationEnabled?: boolean | null;
+  /**
+   * In authoring apps,
+   *   the user may select a pre-defined relationship scheme. Pass the scheme object to this property to avoid getting one based on the background of the `view`.
+   */
+  relationshipScheme?: RelationshipScheme | null;
+  /**
+   * For point and polyline layers only. Indicates whether
+   *   symbol sizes should vary based on view scale. When set, a valid [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
+   *   instance must be provided in the `view` parameter. This option is not supported for 3D
+   *   [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @default false
+   */
+  sizeOptimizationEnabled?: boolean | null;
+  /**
+   * The type of symbol to generate. This depends on the view
+   *   in which you are working and the desired visualization. This parameter does not need to be specified for layers
+   *   with a `mesh` geometry type. Possible values are described below.
+   *
+   *   | Value | Description |
+   *   | ----- | ----------- |
+   *   | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). |
+   *   | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). |
+   *   | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. |
+   *   | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sizes uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. |
+   *
+   * @default 2d
+   */
+  symbolType?: SymbolType | null;
+  /** The view instance in which the visualization will be rendered. */
+  view: MapViewOrSceneView | null;
+}
+
+export interface ClassBreaksInfo {
+  /** The class breaks generated for values in the `field1` parameter. */
+  field1: ClassBreaksResult;
+  /** The class breaks generated for values in the `field2` parameter. */
+  field2: ClassBreaksResult;
+}
+
+/**
+ * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) method. See the table
+ * below for details of each property.
+ */
+export interface RendererResult {
+  /** The ID of the basemap used to determine the optimal fill colors of the features. */
+  basemapId?: string | null;
+  /** Indicates whether the average color of the input view's basemap is `light` or `dark`. */
+  basemapTheme?: BasemapTheme | null;
+  /** Describes each class break for both fields considered in the relationship visualization. */
+  classBreaks: ClassBreaksInfo;
+  /** The relationship scheme used by the renderer. */
+  relationshipScheme: RelationshipScheme;
+  /**
+   * The renderer object representing
+   *   the relationship visualization. Set this on a layer's `renderer` property to update its visualization.
+   */
+  renderer: UniqueValueRenderer;
+  /**
+   * Describes each
+   *   container or bin used in the visualization. Each unique value info object describes a class break for `field1`
+   *   and `field2`. Therefore, features with the same color fall share will have values that fall in the same class break
+   *   for `field1` and the same class break for `field2`.
+   */
+  uniqueValueInfos: UniqueValueInfo[];
+}
+
+export interface UpdateParamsFieldInfo {
+  /**
+   * The class breaks
+   *   for the field used in the relationship visualization.
+   */
+  classBreakInfos: ClassBreak[];
+  /** The name of a numeric field. */
+  field: string;
+  /** The label used to describe the field or variable in the legend. */
+  label?: string;
+  /**
+   * The name of a numeric field used to normalize the given `field`. In choropleth visualizations
+   *   it is best practice to normalize your data values if they haven't already been normalized.
+   */
+  normalizationField?: string;
+}
+
+export interface UpdateRendererParams {
+  /** The array of colors to be used by the symbols in the uniqueValueInfos of the renderer. */
+  colors?: Color[] | null;
+  /**
+   * A numeric field used to explore its relationship with `field2`. In the default visualization,
+   *   the values of this field are rendered along the vertical axis of the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   */
+  field1?: UpdateParamsFieldInfo | null;
+  /**
+   * A numeric field used to explore its relationship with `field1`. In the default visualization,
+   *   the values of this field are rendered along the horizontal axis of the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   */
+  field2?: UpdateParamsFieldInfo | null;
+  /**
+   * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/). This value does not change the renderer or symbology
+   *   of any features in the layer. This affects the legend only. See the table below for a description of the possible values. See the class description
+   *   at the top of this page for a more thorough explanation of how to read the legend.
+   *
+   *   Value | Example | Description
+   *   ------|-------------|--------
+   *   null | ![relationship-legend-null](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-null.png) | The legend renders as a square. The top right corner of the legend indicates that values from both `field1` and `field2` are considered high. |
+   *   HH | ![relationship-legend-hh](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-hh.png) | The legend renders as a diamond with the focus on the top corner where values from both `field1` and `field2` are considered high. |
+   *   HL | ![relationship-legend-hl](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-hl.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are high and values from `field2` are low. |
+   *   LH | ![relationship-legend-lh](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-lh.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are low and values from `field2` are high. |
+   *   LL | ![relationship-legend-ll](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend-ll.png) | The legend renders as a diamond with the focus on the top corner where values from both `field1` and `field2` are considered low. |
+   *
+   * @default null
+   */
+  focus?: FocusType | null;
+  /**
+   * Indicates the number of classes by which to break up the values of each field. More classes give you more detail, but more colors, making the visualization
+   *   more difficult to understand. There are only three possible values.
+   *
+   * 2 classes | 3 classes | 4 classes
+   * --|--|---
+   * ![relationship-breaks-2](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-breaks-2.png) | ![relationship-breaks-3](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-breaks-3.png) | ![relationship-breaks-4](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-breaks-4.png)
+   *
+   * **Possible Values:** 2 | 3 | 4
+   */
+  numClasses?: RelationshipNumClasses | null;
+  /**
+   * The relationship renderer (generated from [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer))
+   *   to update with the other parameters provided in this method.
+   */
+  renderer?: UniqueValueRenderer | null;
+}