HeatmapOptions
Package: com.eegeo.mapapi.heatmaps
Defines creation parameters for a Heatmap.
Fields
public static int RESOLUTION_PIXELS_MIN
Minimum value of the resolutionPixels option
public static int RESOLUTION_PIXELS_MAX
Maximum value of the resolutionPixels option
Constructors
HeatmapOptions()
Default constructor for heatmap creation parameters.
Methods
HeatmapOptions add(WeightedLatLngAlt data)
Adds data points to the heatmap. The WeightedLatLngAlt.intensity field is used as a weighting value. A weight of N is equivalent to placing N points all at the same coordinate, each with a weight of 1.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| WeightedLatLngAlt | data | The data points to add. |
HeatmapOptions add(WeightedLatLngAlt data)
Adds a point to the end of the current data point collection. The WeightedLatLngAlt.intensity field is used as a weighting value. A weight of N is equivalent to placing N points all at the same coordinate, each with a weight of 1.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| WeightedLatLngAlt | data | The point to add. |
HeatmapOptions heatmapRadius(double heatmapRadiusMeters)
Sets options to have a single densityStop entry with defined radius, and default gain.
Returns:
| Type | argument | Description |
|---|---|---|
| double | heatmapRadiusMeters |
HeatmapOptions addDensityStop(float stop, double heatmapRadiusMeters, double heatmapGain)
Add a density stop to the end of the current collection of density stops.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | stop | A stop function input value in the range [0..1]. |
| double | heatmapRadiusMeters | The radius of the circle drawn for each point, in meters. |
| double | heatmapGain | Intensity multiplier. |
HeatmapOptions setDensityStops(float stops, double heatmapRadiiMeters, double heatmapGains)
Set the density stops collection.
Returns:
| Type | argument | Description |
|---|---|---|
| float | stops | Array of stop function input values in the range [0..1]. |
| double | heatmapRadiiMeters | Array of radii of the circles drawn for each point, in meters. |
| double | heatmapGains | Array of intensity multipliers. |
HeatmapOptions weightMin(double weightMin)
Defines a domain mapping from heatmap intensity value [weightMin..weightMax] to colorGradient stop function input [0..1].
Returns: This object.
| Type | argument | Description |
|---|---|---|
| double | weightMin | The option value. |
HeatmapOptions weightMax(double weightMax)
Defines a domain mapping from heatmap intensity value [weightMin..weightMax] to colorGradient stop function input [0..1].
Returns: This object.
| Type | argument | Description |
|---|---|---|
| double | weightMax | The option value. |
HeatmapOptions densityBlend(float densityBlend)
Controls which of the densityStops heatmap images is displayed, by linearly interpolating between the two adjacent stops whose stop value is closest to densityBlend. The parameter is clamped to the range [0..1].
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | densityBlend | The option value. |
HeatmapOptions interpolateDensityByZoom(double zoomMin, double zoomMax)
Sets the options to blend between density stops based on current map camera zoom level. In this case, densityBlend is ignored. Options zoomMin and zoomMax control the extents over which heatmap density will change with map zoom, linearly interpolating between them.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| double | zoomMin | The camera zoom level at which the highest density stop is displayed (with stop of 1.0). Ignored if interpolateDensityByZoom is false. |
| double | zoomMax | The camera zoom level at which the lowest density stop is displayed (with stop of 0.0). Ignored if interpolateDensityByZoom is false. |
HeatmapOptions gradient(float stops, int colors)
Sets the color ramp applied to each pixel of the heatmap intensity image, from minimum intensity weightMin at stop == 0.0 to maximum intensity weightMax at stop == 1.0.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | stops | Stop function input values in the range [0..1]. |
| int | colors | The color value for each stop, as 32-bit ARGB color. |
HeatmapOptions opacity(float opacity)
Sets the overall opacity of the heatmap. The parameter is clamped to the range [0..1].
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | opacity | The option value. |
HeatmapOptions resolutionPixels(int resolutionPixels)
Defines the maximum dimension, in pixels, of the intensity image calculated for each heatmap density stop. A higher value allows more detail to be visible in the heatmap, but requires more computational resources.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| int | resolutionPixels | The option value. |
HeatmapOptions polygon(PolygonOptions polygonOptions)
Set options for defining a clipping polygon. Also contains options for elevation and indoor map.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| PolygonOptions | polygonOptions | The polygon options instance. |
HeatmapOptions intensityBias(float intensityBias)
Determines the normative value of the data represented by the heatmap, corresponding to a point on the colorGradient function. This is useful when displaying weighted point data that diverges around some center value, for example temperatures above or below freezing point. In this case, intensityBias might be set to 0.5 to correspond with the mid-point of the colorGradient function. This would correspond to a normative temperature value at the mid-point between weightMin and weightMax. The property is clamped to the range [0..1].
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | intensityBias | The option value. |
HeatmapOptions intensityScale(float intensityScale)
Sets an additional overall intensity multiplier. The scaling value is applied relative to the origin (normative value) determined by intensityBias.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | intensityScale | The option value. |
HeatmapOptions occludedMapFeatures(HeatmapOcclusionMapFeature occludedMapFeatures)
Sets the map feature types that, if occluding areas of the heatmap, will cause those areas of the heatmap to be drawn with an alternate style.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| HeatmapOcclusionMapFeature | occludedMapFeatures | The option value. |
HeatmapOptions occludedStyleAlpha(float occludedAlpha)
Sets the opacity of occluded areas of the heatmap, clamped to the range [0..1].
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | occludedAlpha | The option value. |
HeatmapOptions occludedStyleSaturation(float occludedSaturation)
Sets the color saturation of occluded areas of the heatmap, clamped to the range [0..1], where 0.0 is fully desaturated (grayscale), and 1.0 has no effect.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | occludedSaturation | The option value. |
HeatmapOptions occludedStyleBrightness(float occludedBrightness)
Sets the color brightness of occluded areas of the heatmap, clamped to the range [0..1], where 0.0 is fully darkened (black), and 1.0 has no effect.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | occludedBrightness | The option value. |
HeatmapOptions textureBorder(float textureBorderPercent)
Sets the size of a gutter at the edges of the heatmap images, around the bounds of the data points. Specified as a percentage of the image dimensions.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| float | textureBorderPercent | The option value. |
HeatmapOptions useApproximation(boolean useApproximation)
Set the useApproximation option. If false, uses a slightly more accurate but computationally costly method for calculating the heatmap.
Returns: This object.
| Type | argument | Description |
|---|---|---|
| boolean | useApproximation | The option value. |
List<WeightedLatLngAlt> getWeightedPoints()
Returns the data points for the heatmpa.
Returns: The option value.
float getHeatmapDensityStops()
Returns the stop parameter array for the density stops.
Returns: The option value.
double getHeatmapRadii()
Returns the circle radius array for the density stops.
Returns: The option value.
double getHeatmapGains()
Returns the gains array for the density stops.
Returns: The option value.
float getDensityBlend()
Returns the densityBlend option.
Returns: The option value.
boolean getInterpolateDensityByZoom()
Returns the interpolateDensityByZoom option.
Returns: The option value.
double getZoomMin()
Returns the zoomMin option.
Returns: The option value.
double getZoomMax()
Returns the zoomMax option.
Returns: The option value.
double getWeightMin()
Returns the weightMin option.
Returns: The option value.
double getWeightMax()
Returns the weightMax option.
Returns: The option value.
float getGradientStops()
Returns the gradientStops option.
Returns: The option value.
int getGradientColors()
Returns the gradientColors option.
Returns: The option value.
float getOpacity()
Returns the opacity option.
Returns: The option value.
int getResolutionPixels()
Returns the resolutionPixels option.
Returns: The option value.
float getIntensityBias()
Returns the intensityBias option.
Returns: The option value.
float getIntensityScale()
Returns the intensityScale option.
Returns: The option value.
PolygonOptions getPolygonOptions()
Returns the options defining a clipping polygon for the heatmap, and also indoor map and elevation options.
Returns: The option value.
float getOccludedStyleAlpha()
Returns the occludedAlpha option.
Returns: The option value.
float getOccludedStyleSaturation()
Returns the occludedSaturation option.
Returns: The option value.
float getOccludedStyleBrightness()
Returns the occludedBrightness option.
Returns: The option value.
HeatmapOcclusionMapFeature getOccludedMapFeatures()
Returns the occludedMapFeatures option.
Returns: The option value.
float getTextureBorderPercent()
Returns the textureBorderPercent option.
Returns: The option value.
boolean getUseApproximation()
Returns the useApproximation option.
Returns: The option value.