require(["esri/renderers/smartMapping/creators/relationship"], function(relationshipRendererCreator) { /* code goes here */ });
Object: esri/renderers/smartMapping/creators/relationship
Since: ArcGIS API for JavaScript 4.9

This object contains a helper method for creating a renderer for exploring the relationship between two numeric attributes. This is commonly known as a bivariate choropleth visualization. This renderer classifies each variable in either 2, 3, or 4 classes along separate color ramps. One of those ramps is rotated 90 degrees and overlaid on the other to create a 2x2, 3x3, or 4x4 square grid. The x-axis indicates the range of values for one variable, and the y-axis indicates the range for the second variable. The squares running diagonal from the lower left corner to the upper right corner indicate features where the two variables may be related or in agreement with one another.

Relationship renderer legend
The legend of a relationship renderer resembles a grid of two single-hue sequential color ramps overlaid on each other, forming a third hue along a diagonal line, which indicates where the two variables could potentially be related.

The lower right and upper left corners indicate features where one field has high values and the other field low values and vice versa. The image below shows what this style looks like on a map of U.S. counties where the percent of the population diagnosed with Diabetes is compared to the percent of the population that is obese.

relationship-obesity-diabetes

While this visualization style was originally designed for 2D choropleth maps, it is particularly useful in 3D scenes where bivariate visualizations of color and size would not otherwise be possible since the size of features is reserved for real-world sizes of objects, such as buildings. Therefore, the relationship renderer becomes ideal for creating thematic bivariate visualizations of 3d object SceneLayers.

Generate a relationship visualization

Keep in mind that even if you observe a positive relationship between the two variables of interest, it doesn't mean they are statistically correlated. It also doesn't imply the presence of one variable influences the other. Therefore, this renderer should be used judiciously with some prior knowledge that two variables may likely be related.

Known Limitations

  • Currently, 3D symbols cannot be generated for layers with a polyline or polygon geometry type.
  • Only FeatureLayer, SceneLayer, CSVLayer, GeoJSONLayer, and PointCloudLayer layer types are currently supported, except in the following scenarios:
    • SceneLayers without the supportsRenderer and supportsLayerQuery capabilities enabled, unless a predefined statistics object is passed to the statistics parameter of the method in conjunction with the layer. To check a SceneLayer's capabilities, use the getFieldInfoUsage() method.

Method Overview

NameReturn TypeSummaryObject
Promise<RendererResult>

Generates a relationship renderer (bivariate choropleth) based on a set of competing numeric fields.

more details
more detailsrelationship
Promise<UniqueValueRenderer>

Updates a relationship renderer (bivariate choropleth) generated from createRenderer() based on the given input parameters.

more details
more detailsrelationship

Method Details

createRenderer(params){Promise<RendererResult>}

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.

Parameters:
Specification:
params Object

Input parameters for generating a relationship visualization based on a pair of numeric field(s). See the table below for details of each parameter.

Specification:

The layer for which the visualization is generated.

view View

The view instance in which the visualization will be rendered.

field1 Object

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.

Specification:
field String

The name of a numeric field.

normalizationField String
optional

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.

maxValue Number
optional

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.

minValue Number
optional

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.

field2 Object

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.

Specification:
field String

The name of a numeric field.

normalizationField String
optional

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.

maxValue Number
optional

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.

minValue Number
optional

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.

classificationMethod String
optional
Default Value: quantile

The method for classifying each field's data values. See classBreaks for more information about each classification type.

Possible Values: quantile | equal-interval | natural-breaks

focus String
optional
Default Value: null

Determines the orientation of the 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.

ValueExampleDescription
nullrelationship-legend-nullThe legend renders as a square. The top right corner of the legend indicates that values from both field1 and field2 are considered high.
HHrelationship-legend-hhThe legend renders as a diamond with the focus on the top corner where values from both field1 and field2 are considered high.
HLrelationship-legend-hlThe legend renders as a diamond with the focus on the top corner where values from field1 are high and values from field2 are low.
LHrelationship-legend-lhThe legend renders as a diamond with the focus on the top corner where values from field1 are low and values from field2 are high.
LLrelationship-legend-llThe legend renders as a diamond with the focus on the top corner where values from both field1 and field2 are considered low.
numClasses Number
optional
Default Value: 3

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 classes3 classes4 classes
relationship-breaks-2relationship-breaks-3relationship-breaks-4

Possible Values: 2 | 3 | 4

basemap String|Basemap
optional
Default Value: gray

The named string or basemap object of the Esri basemap that will be paired with the output visualization.

legendOptions Object
optional

Provides options for modifying Legend properties describing the visualization.

Specification:
title String
optional

The title used to describe the renderer in the Legend.

showLegend Boolean
optional

Indicates whether to include the renderer in the legend.

relationshipScheme RelationshipScheme
optional

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 basemap.

symbolType String
optional
Default Value: 2d

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.

ValueDescription
2dGenerates a visualization using 2D symbols such as SimpleMarkerSymbol, SimpleLineSymbol, or SimpleFillSymbol. Use this option if generating a visualization for data in a MapView.
3d-flatGenerates a visualization using 3D symbols with flat symbol layers such as IconSymbol3DLayer, LineSymbol3DLayer, or FillSymbol3DLayer. Use this option if generating a 2D visualization for data in a SceneView.
3d-volumetricGenerates a visualization using 3D symbols with volumetric symbol layers such as ObjectSymbol3DLayer, PathSymbol3DLayer, or ExtrudeSymbol3DLayer. Use this option if generating a 3D visualization for data in a SceneView. A SceneView instance must be provided to the view parameter if this option is used.
defaultSymbolEnabled Boolean
optional
Default Value: true

Enables the defaultSymbol on the renderer and assigns it to features with no value or that fall outside of the prescribed class breaks.

colorMixMode String
optional
Default Value: replace

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 for more context. See the table below for possible values.

ValueDescription
tintApplies the symbol color to the desaturated geometry/texture color.
replaceRemoves the geometry/texture color and applies the symbol color.
multiplyMultiplies geometry/texture color value with the symbol color value. The result is a darker color. Multiplying with white keeps the geometry color the same.
Returns:
TypeDescription
Promise<RendererResult>Resolves to an instance of 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 params = {
  layer: layer,
  view: view,
  basemap: map.basemap,  // "gray"
  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(params)
  .then(function(response){
    layer.renderer = response.renderer;
  });
updateRenderer(params){Promise<UniqueValueRenderer>}

Updates a relationship renderer (bivariate choropleth) generated from createRenderer() based on the given input parameters.

Parameters:
Specification:
params Object

Input parameters for updating a relationship visualization created in createRenderer().

Specification:
field1 Object

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.

Specification:
field String

The name of a numeric field.

normalizationField String
optional

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.

classBreakInfos ClassBreak[]

The class breaks for the first field used in the relationship visualization.

field2 Object

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.

Specification:
field String

The name of a numeric field.

normalizationField String
optional

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.

classBreakInfos ClassBreak[]

The class breaks for the second field used in the relationship visualization.

focus String
optional
Default Value: null

Determines the orientation of the 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.

ValueExampleDescription
nullrelationship-legend-nullThe legend renders as a square. The top right corner of the legend indicates that values from both field1 and field2 are considered high.
HHrelationship-legend-hhThe legend renders as a diamond with the focus on the top corner where values from both field1 and field2 are considered high.
HLrelationship-legend-hlThe legend renders as a diamond with the focus on the top corner where values from field1 are high and values from field2 are low.
LHrelationship-legend-lhThe legend renders as a diamond with the focus on the top corner where values from field1 are low and values from field2 are high.
LLrelationship-legend-llThe legend renders as a diamond with the focus on the top corner where values from both field1 and field2 are considered low.
numClasses Number

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 classes3 classes4 classes
relationship-breaks-2relationship-breaks-3relationship-breaks-4

Possible Values: 2 | 3 | 4

colors Color[]

The array of colors to be used by the symbols in the uniqueValueInfos of the renderer.

The relationship renderer (generated from createRenderer()) to update with the other parameters provided in this method.

Returns:
TypeDescription
Promise<UniqueValueRenderer>Resolves to the updated relationship renderer.

Type Definitions

RendererResult

The result object of the createRenderer() method. See the table below for details of each property.

Properties:

The renderer object representing the relationship visualization. Set this on a layer's renderer property to update its visualization.

classBreaks Object

Describes each class break for both fields considered in the relationship visualization.

Specification:

The class breaks generated for values in the field1 parameter.

The class breaks generated for values in the field2 parameter.

uniqueValueInfos UniqueValueInfo[]

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.

relationshipScheme RelationshipScheme

The relationship scheme used by the renderer based on the given basemap.

basemapId String

The ID of the basemap used to determine the optimal fill colors of the features.

API Reference search results

NameTypeModule
Loading...