The HeatmapRenderer renders point data into a raster visualization that emphasizes areas of higher density or weighted values.

See https://developers.arcgis.com/web-map-specification/objects/heatmapRenderer/.

interface HeatmapRendererJson {
    authoringInfo?: AuthoringInfoJson;
    blurRadius?: number;
    colorStops?: ColorStopJson[];
    field?: string;
    maxPixelIntensity?: number;
    minPixelIntensity?: number;
    rotationExpression?: string;
    rotationType?: RotationJsonType;
    type: "heatmap";
    visualVariables?: VisualVariableJson[];
}

Hierarchy (view full)

Properties

authoringInfo?: AuthoringInfoJson

An object containing metadata about the authoring process for creating a renderer object. This allows the authoring clients to save specific overridable settings so that next time it is accessed via the UI, their selections are remembered. Non-authoring clients should ignore it.

blurRadius?: number

The radius (in pixels) of the circle over which the majority of each points value is spread over.

colorStops?: ColorStopJson[]

An array of colorStop objects describing the renderer's color ramp with more specificity than just colors.

field?: string

Value specifying the field used in generating the heat map.

maxPixelIntensity?: number

The pixel intensity value which is assigned the final color in the color ramp.

minPixelIntensity?: number

The pixel intensity value which is assigned the initial color in the color ramp.

rotationExpression?: string

A constant value or an expression that derives the angle of rotation based on a feature attribute value. When an attribute name is specified, it's enclosed in square brackets.

rotationType?: RotationJsonType

String value (either geographic or arithmetic) which controls the origin and direction of rotation on point features. If the rotationType is defined as 'arithmetic', the symbol is rotated from East in a counter-clockwise direction where East is the 0� axis. If the rotationType is defined as 'geographic', the symbol is rotated from North in a clockwise direction where North is the 0� axis.

type

The type of renderer. See RendererJsonType.

visualVariables?: VisualVariableJson[]

An array of visualVariable objects used for continuous color or size, simple, and unique values with feature opacity.