univariateColorSize | API Reference | ArcGIS Maps SDK for JavaScript 4.30

See also

Styles and data visualization

Method Overview

Name	Return Type	Summary	Object
	Promise<ContinuousRendererResult>	Generates a Renderer that may be applied directly to a Layer.	univariateColorSize
	Promise<VisualVariablesResult>	This method generates color and size visual variables, both based on the same given field or expression.	univariateColorSize

Method Details

createContinuousRenderer Method createContinuousRenderer(params){Promise<ContinuousRendererResult>}

Generates a Renderer that may be applied directly to a Layer. The renderer contains continuous color and size visual variables that map symbols with optimal colors and sizes based on the view's background to stop values based on summary statistics from the indicated field or expression.

In most cases you will provide a layer, basemap, field, and theme to generate this renderer. This is a scenario in which the statistics of the data aren't well known and the user doesn't know what colors and sizes to use in the visualization. You can also use a valueExpression instead of a field to visualize features based on a value returned from a script executed at runtime.

Parameters

Specification

params Object

See the table below for details of each parameter that may be passed to this method.

Specification

The layer for which the visual variable is generated.

view View

optional

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. This parameter is required when creating renderers using a valueExpression or for renderers intended for display in a SceneView.

field String

optional

The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a valueExpression is used.

normalizationField String

optional

The name of the field to normalize the values of the given field. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities.

valueExpression String

optional

An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions may reference field values using the $feature profile variable and must return a number. This property overrides the field property and therefore is used instead of an input field value.

valueExpressionTitle String

optional

Text describing the value returned from the valueExpression. This is used by the Legend widget.

theme String

optional

Default Value: high-to-low

Sets the size stops and colors based on meaningful data values. Since version 4.18.

Value	Description
high-to-low	The max data value is assigned the max size and color. The min data value is assigned the min size and color. All other values are interpolated.
above	The max data value is assigned the max size and color. The average data value, or zero, is assigned the min size and color. All other values between the max data value and the average are interpolated. This is useful for mapping an increase in a variable over time, like an increase in population, or unemployment between two dates.
below	The min data value is assigned the max size and color. The average data value, or zero, is assigned the min size and color. All other values between the min data value and the average are interpolated. This is useful for mapping a decline in a variable over time, like a decrease in population, or unemployment between two dates.
above-and-below	The min and max data values are assigned the max size and color. The average data value, or zero, is assigned the min size and color. A diverging color ramp is used. All other values between the min and max data values and the average are interpolated. This is useful for mapping a value's change over time and rates.

Possible Values:"high-to-low"|"above"|"below"|"above-and-below"

sqlExpression String

optional

A SQL expression evaluating to a number.

sqlWhere String

optional

A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization.

statistics SummaryStatisticsResult

optional

A statistics object generated from the summaryStatistics function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server.

minValue Number

optional

A custom minimum value set by the user. Use this in conjunction with maxValue to generate statistics between lower and upper bounds. This will be the lowest stop in the returned visual variables.

maxValue Number

optional

A custom maximum value set by the user. Use this in conjunction with minValue to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned visual variables.

defaultSymbolEnabled Boolean

optional

Enables the defaultSymbol on the renderer and assigns it to features with no value and features that do not fall within the configured data range.

colorOptions Object

optional

Options for configuring the color portion of the visualization.

Specification

colorScheme ColorScheme

optional

In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a theme and the basemap.

isContinuous Boolean

optional

Default Value: false

Only applies to the above-and-below theme. if true, adds a ColorVariable with a diverging color ramp to the renderer. Since version 4.18.

sizeOptions Object

optional

Options for configuring the size portion of the visualization.

Specification

sizeScheme SizeScheme

optional

In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the view's background.

sizeOptimizationEnabled Boolean

optional

Default Value: false

Indicates whether symbol sizes should vary based on view scale. When set, a valid MapView instance must be provided in the view parameter. This option is not supported for 3D SceneViews.

symbolOptions Object

optional

Options for setting symbols for the above-and-below theme. Since version 4.18.

Parameters

Specification

symbolStyle String

optional

Sets above and below symbols based on pre-defined named symbol pairs.

symbols Object

optional

Allows you to specify custom symbols in the above-and-below theme.

Specification

above Symbol

The symbol to use for the above portion of the above-and-below visualization.

below Symbol

The symbol to use for the below portion of the above-and-below visualization.

legendOptions Object

optional

Provides options for configuring the Legend representing the renderer generated from this method. Since version 4.18.

Specification

title String

optional

The title used to represent the renderer generated from this method in the Legend.

showLegend Boolean

optional

Indicates if the Legend widget should display content describing the generated renderer.

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. Possible values are described below.

Value	Description
2d	Generates a visualization using 2D symbols such as SimpleMarkerSymbol, SimpleLineSymbol, or SimpleFillSymbol. Use this option if generating a visualization for data in a MapView.
3d-flat	Generates 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-volumetric	Generates 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 and only the symbol's height should be variable, for example with cylinders. 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 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.

Possible Values:"2d"|"3d-flat"|"3d-volumetric"|"3d-volumetric-uniform"

forBinning Boolean

optional

Indicates whether the generated renderer is for a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of the layer.

signal AbortSignal

optional

Allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns

Type	Description
Promise<ContinuousRendererResult>	Resolves to an instance of ContinuousRendererResult.

Examples

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// color/size univariate visualization based on field and normalization field
const params = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY"
};

// when the promise resolves, apply the renderer to the layer
colorAndSizeRendererCreator.createContinuousRenderer(params)
  .then(function(response){
    layer.renderer = response.renderer;
  });

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// above-and-below visualization based off Arcade expression
const params = {
  layer: layer,
  valueExpression: "(($feature.votes_2016 - $feature.votes_2012) / $feature.votes_2016) * 100",
  valueExpressionTitle: "Change in votes from 2012-2016",
  view: view,
  theme: "above-and-below",
  colorOptions: {
    isContinuous: false
  },
  symbolOptions: {
    symbolStyle: "arrow"
  }
};

// when the promise resolves, apply the renderer to the layer
colorAndSizeRendererCreator.createContinuousRenderer(params)
  .then(function(response){
    layer.renderer = response.renderer;
  });

createVisualVariables Method createVisualVariables(params){Promise<VisualVariablesResult>}

This method generates color and size visual variables, both based on the same given field or expression. These visual variables are generated with default stops that are optimally chosen based on the statistics queried for the indicated field or expression and colors based on the view's background.

There are two different ways this method may be called. The most common case is by providing a layer, view, and field. This is the scenario where the statistics of the data aren't well known and the user doesn't know what colors to use. You can optionally use a valueExpression instead of a field to visualize features based on a numeric value returned from a script executed at runtime.

The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the object in the statistics parameter to avoid making an extra call to the server. You can also provide a colorScheme and/or a sizeScheme if you don't want one picked for you. In this case the theme option would be ignored.

The resulting array of visual variables will contain one color visual variable, and one or two size visual variables depending on the value of the sizeOptions.axis parameter.

Parameters

Specification

params Object

Input parameters for generating color and size visual variables based on data returned from a given field or expression. See the table below for details of each parameter.

Specification

The layer for which the visual variable is generated.

view View

optional

field String

optional

The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a valueExpression is used.

normalizationField String

optional

valueExpression String

optional

valueExpressionTitle String

optional

Text describing the value returned from the valueExpression. This is used by the Legend widget.

theme String

optional

Default Value: high-to-low

Sets the size stops and colors based on meaningful data values.

Value	Description
high-to-low	The max data value is assigned the max size and color. The min data value is assigned the min size and color. All other values are interpolated.
above	The max data value is assigned the max size and color. The average data value, or zero, is assigned the min size and color. All other values between the max data value and the average are interpolated. This is useful for mapping an increase in a variable over time, like an increase in population, or unemployment between two dates.
below	The min data value is assigned the max size and color. The average data value, or zero, is assigned the min size and color. All other values between the min data value and the average are interpolated. This is useful for mapping a decline in a variable over time, like a decrease in population, or unemployment between two dates.
above-and-below	The min and max data values are assigned the max size and color. The average data value, or zero, is assigned the min size and color. A diverging color ramp is used. All other values between the min and max data values and the average are interpolated. This is useful for mapping a value's change over time and rates.

Possible Values:"high-to-low"|"above"|"below"|"above-and-below"

sqlExpression String

optional

A SQL expression evaluating to a number.

sqlWhere String

optional

statistics SummaryStatisticsResult

optional

minValue Number

optional

A custom minimum value set by the user. Use this in conjunction with maxValue to generate statistics between lower and upper bounds. This will be the lowest stop in the returned visual variables.

maxValue Number

optional

colorOptions Object

optional

Options for configuring the color portion of the visualization.

Specification

theme String

optional

Default Value: high-to-low

Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below.

Value	Description	Example
high-to-low	High values are emphasized with strong colors.
above-and-below	Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors.
centered-on	Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors.
extremes	High and low values are emphasized with strong colors. All others are visualized with weak colors.

Possible Values:"high-to-low"|"above-and-below"|"centered-on"|"extremes"

colorScheme ColorScheme

optional

In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a theme and the view.

legendOptions Object

optional

Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the Legend.

Specification

title String

The title used to represent the given field or expression in the Legend.

isContinuous Boolean

optional

Default Value: true

Only applies to the above-and-below theme. if true, adds a ColorVariable with a diverging color ramp to the renderer.

sizeOptions Object

optional

Options for configuring the size portion of the visualization.

Specification

axis String

optional

Default Value: all

When set to all, a single size variable that scales uniformly in all dimensions is generated. When set to height, the result contains two size visual variables: the first one sizes the height according to the field statistics, while the second defines a constant size for width and depth.

Possible Values:"all"|"height"

sizeScheme SizeScheme

optional

In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the view's background.

legendOptions Object

optional

Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the Legend.

Specification

title String

The title used to represent the given field or expression in the Legend.

worldScale Boolean

optional

Indicates if the size units of the symbols will be in meters. This should be true when generating visualizations with 3D volumetric symbology. A view must be provided if this property is set to true.

forBinning Boolean

optional

signal AbortSignal

optional

Allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns

Type	Description
Promise<VisualVariablesResult>	Resolves to an instance of VisualVariablesResult.

Examples

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// color/size univariate visualization based on field and normalization field
const params = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  theme: "above"
};

// when the promise resolves, apply the visual variables to the renderer
colorAndSizeRendererCreator.createVisualVariables(params)
  .then(function(response){
    const renderer = layer.renderer.clone();
    renderer.visualVariables = [ response.color.visualVariable, ...response.size.visualVariables ];
    layer.renderer = renderer;
  });

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based off an Arcade expression
const params = {
  layer: layer,
  view: view,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  sqlExpression: "( POP_POVERTY / TOTPOP_CY ) * 100"
};

// when the promise resolves, apply the visual variables to the renderer
colorAndSizeRendererCreator.createVisualVariables(params)
  .then(function(response){
    const renderer = layer.renderer.clone();
    renderer.visualVariables = [ response.color.visualVariable, ...response.size.visualVariables ];
    layer.renderer = renderer;
  });

Type Definitions

ContinuousRendererResult Type Definition ContinuousRendererResult

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

Properties

renderer ClassBreaksRenderer

The renderer object configured to best match the view's background and the spread of the data. Set this on a layer's renderer property to update its visualization.

color Object

Object containing visual variable and scheme information for the color portion of the visualization.

Specification: visualVariable ColorVariable

A color visual variable configured based on the statistics of the data and the color scheme.

colorScheme ColorScheme

The color scheme used by the visual variable.

size Object

Object containing visual variable and scheme information for the size portion of the visualization.

Specification: visualVariables SizeVariable []

The size visual variable(s) configured based on the statistics of the data and the view scale.

sizeScheme SizeScheme

The size scheme used by the visual variable.

defaultValuesUsed Boolean

Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all.

statistics SummaryStatisticsResult

Basic statistics returned from a query to the service for the given field or expression.

basemapId String

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

basemapTheme String

Indicates whether the average color of the input view's basemap is light or dark.

VisualVariablesResult Type Definition VisualVariablesResult

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

Properties

color Object

Object containing visual variable and scheme information for the color portion of the visualization.

Specification: visualVariable ColorVariable

A color visual variable configured based on the statistics of the data and the color scheme.

colorScheme ColorScheme

The color scheme used by the visual variable.

size Object

Object containing visual variable and scheme information for the size portion of the visualization.

Specification: visualVariables SizeVariable []

The size visual variable(s) configured based on the statistics of the data and the view scale.

sizeScheme SizeScheme

The size scheme used by the visual variable.

defaultValuesUsed Boolean

statistics SummaryStatisticsResult

Basic statistics returned from a query to the service for the given field or expression.

basemapId String

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

basemapTheme String

Indicates whether the average color of the input view's basemap is light or dark.

authoringInfo AuthoringInfo

Authoring information related to the creation of the visual variables. This includes inforamation related to UI inputs from sliders and selected themes.