ClassBreaksRenderer

A class breaks renderer is a renderer that classifies numeric data into two or more ranges of values to create a visualization. A class breaks renderer contains a collection of ranges (or class breaks). Each ClassBreak has a ClassBreak.minValue, ClassBreak.maxValue, and a unique ClassBreak.symbol. The ranges reflect a specific RendererClassificationMethod, such as equal interval, natural breaks, quantile, standard deviation and manual classification.

ClassBreaksRenderer contains properties for setting the field that the class breaks refer to and also for controlling normalization. It also defines a default label and symbol to display for values that don't fall within any of the class breaks. You can add or remove a ClassBreak from this renderer via the ClassBreaksRenderer.classBreaks collection.

Class breaks can be defined as continuous, where the minimum value of a break is defined by the maximum value of the previous class break. For continuous class breaks only the max value needs to be set on each ClassBreak.

For discontinuous class breaks, set both a min and a max value in each ClassBreak.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(fieldName: String = "", classBreaks: Iterable<ClassBreak> = emptyList())

Creates a new class breaks renderer with the given class breaks applied to the given field.

Properties

Link copied to clipboard

The renderer's background fill symbol.

Link copied to clipboard

The collection of class breaks which define each range in this renderer.

Link copied to clipboard

The renderer's classification method. RendererClassificationMethod.Manual if an error occurs.

Link copied to clipboard

The label used for the default symbol.

Link copied to clipboard

The default symbol for values that don't fall within any of the class breaks.

Link copied to clipboard

The name of the field that the class breaks apply to.

Link copied to clipboard

The minimum value of the first class break if the renderer uses continuous class breaks. This will set the minimum value of the first class break in a renderer containing continuous class breaks where each ClassBreak does not define a minimum value. In this case the minimum value of each break will be the maximum value of the preceding one. As the first class break has no class break before it, this value will define its minimum.

Link copied to clipboard

The renderer's normalization field. This field will be used to normalize the data when the ClassBreaksRenderer.normalizationType is set to RendererNormalizationType.ByField

Link copied to clipboard

The renderer's normalization total. This field is the normalization total when ClassBreaksRenderer.normalizationType is set to RendererNormalizationType.ByPercentOfTotal. This means that the minimum and maximum values in each class break are defined as percentages of this total.

Link copied to clipboard

The renderer's normalization type. If this property is not RendererNormalizationType.None, then the class breaks contain a normalized min/max value instead of the actual value. In this case, the type will indicate the way in which the value in the field should be normalized before comparing with the class breaks.

Inherited properties

Link copied to clipboard

The expression describing how attributes values are translated into a rotation to be applied to the GeoElement. When an attribute name is specified in the rotation expression, it is enclosed in square brackets, for example: Rotation.

Link copied to clipboard

Indicates whether the rotation calculated from the Renderer.rotationExpression is interpreted as arithmetic or geographic. The options are:

Link copied to clipboard

The scene view properties for the renderer. This can be used to make changes to how a GeoElement is displayed in a SceneView.

Functions

Link copied to clipboard
open override fun clone(): ClassBreaksRenderer

Inherited functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
fun getSymbol(feature: Feature, applyAttributeOverrides: Boolean = false): Symbol?

Returns the symbol that is used to visualize the given feature with override attributes from the renderer. If applyAttributeOverrides is set to true, this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. These include visual variable size, color, opacity and rotation. If the override expression or attributes contain any information not known to either the renderer or observation (such as "scale"), that override will not be applied. If the override attributes are applied successfully, a symbol with overridden properties will be returned otherwise the original symbol will be returned.

fun getSymbol(graphic: Graphic, applyAttributeOverrides: Boolean = false): Symbol?

Returns the symbol that is used to visualize the given graphic with override attributes from the renderer. If applyAttributeOverrides is set to true, this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. These include visual variable size, color, opacity and rotation. If the override expression or attributes contain any information not known to either the renderer or observation (such as "scale"), that override will not be applied. If the override attributes are applied successfully, a symbol with overridden properties will be returned otherwise the original symbol will be returned.

fun getSymbol(dynamicEntity: DynamicEntity, applyAttributeOverrides: Boolean = false): Symbol?

Returns the symbol that is used to visualize the given dynamic entity with override attributes from the renderer. If applyAttributeOverrides is set to true, this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. These include visual variable size, color, opacity and rotation. If the override expression or attributes contain any information not known to either the renderer or dynamic entity (such as "scale"), that override will not be applied. If the override attributes are applied successfully, a symbol with overridden properties will be returned else the original symbol will be returned.

fun getSymbol(dynamicEntityObservation: DynamicEntityObservation, applyAttributeOverrides: Boolean = false): Symbol?

Returns the symbol that is used to visualize the given dynamic entity observation with override attributes from the renderer. If applyAttributeOverrides is set to true, this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. These include visual variable size, color, opacity and rotation. If the override expression or attributes contain any information not known to either the renderer or observation (such as "scale"), that override will not be applied. If the override attributes are applied successfully, a symbol with overridden properties will be returned else the original symbol will be returned.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.