size

The layer for which the renderer 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, unless a valueExpression is provided.

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.

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.

Defines the size theme. For gridded datasets, the default is reference-size. For all other datasets, the default is high-to-low.

Value	Description
high-to-low	The max data value is assigned the max size. The min data value is assigned the min size. All other values are interpolated.
above	The max data value is assigned the max size. The average data value is assigned the min size. 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. The average data value, is assigned the min size. 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.
reference-size	Since 4.30 When defined, creates a proportional size renderer with an outer ring that functions as a reference line representing the maximum data value (or other threshold). The ring is proportionally filled by an inner dot based on the feature's data value specified in field (and normalizationField if defined). This is a good style for visualizing ratios and percentages. It works best for gridded datasets where geometries don't overlap, such as styles for binning (i.e. forBinning = true), hexbin layers, or any other layer created with data aggregated to tessellated shapes. This theme only applies to layers with a polygon geometry type, or any layer that has binning enabled. This theme is ignored if valueExpression is specified in lieu of a field.
spike	Since 4.33 When defined, creates a spike symbol whose height is scaled based on the value of field and normalizationField. This theme works best for skewed datasets. This theme only applies to layers with a polygon or point geometry type. This theme is ignored if valueExpression is specified in lieu of a field.

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.

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. The view parameter is required if specifying a valueExpression. When using a valueExpression, client-side statistics are calculated based on the features in the view's extent. To generate statistics for the entire layer, set an equivalent sqlExpression.

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

A SQL expression evaluating to a number. When provided, statistics are queried from the server for the entire layer. Only use this parameter when generating a renderer based on an equivalent valueExpression. This parameter is ignored for client-side layer types.

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.

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.

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.

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 size visual variable.

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 size visual variable.

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.

Since

ArcGIS Maps SDK for JavaScript 4.30

Options for specifying the symbol used in a reference size visualization. When defined, creates a proportional size renderer with an outer ring that functions as a reference line representing a maximum data value (or threshold). The ring is proportionally filled by an inner dot based on the feature's data value specified in field (and normalizationField if defined). This is a good style for visualizing ratios and percentages. It works best for gridded datasets where geometries don't overlap, such as styles for binning (i.e. forBinning = true), hexbin layers, or any other layer created with data aggregated to tessellated shapes. This parameter only applies to layers with a polygon geometry type, or any layer that has binning enabled. This parameter is ignored if valueExpression is specified in lieu of a field.

Since

ArcGIS Maps SDK for JavaScript 4.33

Options for specifying the symbol used in a spike theme.

Since

ArcGIS Maps SDK for JavaScript 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 otherwise result in undesired size ranges and stops. 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.

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 defined in the featureReduction property of the layer.

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.

An array of size visual variables configured based on the statistics of the data and the view scale.

Indicates whether default values are 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.

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

Since

ArcGIS Maps SDK for JavaScript 4.30

Indicates if the polygon layer used to generate the renderer was determined to be gridded. This is done when referenceSizeOptions are set for creating a reference size visualization.

The size scheme used by the visual variables.

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

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

Indicates if the size units of the symbols will be in meters. This should be true when generating visualizations with 3D volumetric symbology.

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.

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

The minimum height of the spike symbol in points.

The maximum height of the spike symbol in points.

The width of the base of the spike in points.

The width of the spike outline in points.

The default height of the spike symbol in points.

Defines the symbol configuration to use in a spike visualization.

Defines the symbol shape to use in a reference size visualization. Using a circle shape works best across a variety of datasets, but other shape options are available for visualizing layers representing tessellated grids of other shapes.

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 sized uniformly, for example with spheres. A SceneView instance must be provided to the view parameter if this option is used.

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.

Only for polygon layers. Indicates whether the polygon outline width 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.

The layer for which the renderer is updated.

The renderer instance to update if not already set on the layer.

The name of a numeric field used to dynamically change the inner dot size.

The name of a numeric field use to normalize the data in the input field.

The size stops with which to update the reference size visualization. These values typically come from SizeSlider.stops.

Updates the symbol shape used in the reference size visualization.

Use this property to update the color of the symbols.

Only valid for reference size visualizations implemented in a UniqueValueRenderer. The scheme updates the colors of each category.

The view where the input layer is rendered.

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

Indicates whether symbol sizes should vary based on view scale. When set, a valid MapView instance must be provided in the view parameter. For gridded layers (i.e. isGrid is `true), size optimization is always enabled and therefore this parameter is ignored.

The layer for which the renderer is updated.

The renderer instance to update if not already set on the layer.

The name of a numeric field used to dynamically change the spike height.

The name of a numeric field use to normalize the data in the input field.

The size stops with which to update the spike visualization. These values typically come from SizeSlider.stops.

Use this property to update the color of the symbols.

Only valid for spike visualizations implemented in a UniqueValueRenderer. The scheme updates the colors of each category.

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

Options for specifying the symbol used in a spike theme.

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, unless a valueExpression is provided.

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

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. The view parameter is required if specifying a valueExpression. When using a valueExpression, client-side statistics are calculated based on the features in the view's extent.

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

Indicates how the data is normalized. The data value obtained from the field is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values.

Possible Value	Description
field	Divides the field value by the value of normalizationField. This value is set by default if the normalizationField is provided.
log	Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values.
percent-of-total	Divides the data value by the sum of all data values then multiplies by 100. Use normalizationTotal to define the total value by which to normalize. This value is set by default if the normalizationTotal is provided.

With the exception of log normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size.

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.

When normalizationType is percent-of-total, this property contains the total of all data values.

The classification method used for generating breaks. See the table below for a list of possible values.

Possible Value	Description
equal-interval	Divides the range of attribute values into equal-sized subranges. For example, if you specify three classes for a field whose values range from 0 to 300, this method will create three classes with ranges of 0–100, 101–200, and 201–300. Equal interval is best applied to familiar data ranges, such as percentages and temperature. This method emphasizes the amount of an attribute value relative to other values. For example, it could show if a store is part of the group of stores that make up the top one-third of all sales.
natural-breaks	Groups similar values that maximize the differences between classes. Features are divided into classes whose boundaries are set where there are relatively big differences in the data values. Natural breaks are data-specific classifications and not useful for comparing multiple maps built from different underlying information.
quantile	Assigns the same number of data values to each class. This is well suited to linearly distributed data. Because features are grouped in equal numbers in each class, the resulting map can often be misleading. Similar features can potentially be placed in adjacent classes, or features with widely different values can be put in the same class. You can minimize this distortion by increasing the number of classes.
standard-deviation	Creates class breaks with equal value ranges that are a proportion of the standard deviation. This is usually done at intervals of one, one-half, one-third, or one-fourth standard deviations from the mean.

If a standard-deviation classification method is used, then this indicates the interval by which to generate class breaks.

Possible Values: 1 | 0.5 | 0.33 | 0.25

The number of class breaks to generate. This is ignored if a standard-deviation classification method is specified.

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.

Provides options for setting a title to describe a field instead of using the field name. This title will represent the field in the Legend.

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 sized uniformly, for example with spheres. A SceneView instance must be provided to the view parameter if this option is used.

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.

Only for polygon layers. Indicates whether the polygon outline width 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.

A minimum value set by the user. Use this in conjunction with maxValue to generate class breaks between lower and upper bounds. This will be the lower bound of the lowest class break.

A maximum value set by the user. Use this in conjunction with minValue to generate class breaks between lower and upper bounds. This will be the upper bound of the highest class break.

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 defined in the featureReduction property of the layer.

Since

ArcGIS Maps SDK for JavaScript 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.

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.

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.

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.

The size scheme used by the visual variables.

Indicates whether default values are 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.

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

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

This object describes class breaks generated from data in a layer for a given field with a specified classification method.

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.

The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the endTime parameter must reference a Date field in the layer.

The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the startTime parameter must reference a Date field in the layer.

The time unit used to calculate the difference between endTime and startTime. If a unit is not specified, then a suggested unit is determined based on the spread and distribution of the data.

Sets the size stops based on meaningful data values.

Value	Description
high-to-low	The max data value is assigned the max size. The min data value is assigned the min size. All other values are interpolated.
above	The max data value is assigned the max size. The average data value is assigned the min size. 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. The average data value, is assigned the min size. 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.

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.

Provides options for modifying Legend properties describing the visualization.

A statistics object generated from the summaryStatistics function. The createAgeRenderer() method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query.

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.

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

Enables the defaultSymbol on the renderer and assigns it to features with no value.

Only for polygon layers. Indicates whether the polygon outline width 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.

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.

Sets a minimum age for the visualization. Even if data exists below this value, only statistics will be calculated for values between the minValue and maxValue. Added at version 4.15.

Since

ArcGIS Maps SDK for JavaScript 4.15

Sets a maximum age for the visualization. Even if data exists above this value, only statistics will be calculated for values between the minValue and maxValue.

Since

ArcGIS Maps SDK for JavaScript 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.

The time unit used to represent age in the output renderer.