com.google.gwt.maps.client.visualizationlib
Class HeatMapLayerOptions

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.google.gwt.maps.client.visualizationlib.HeatMapLayerOptions

public class HeatMapLayerOptions
extends JavaScriptObject

This object defines the properties that can be set on a HeatmapLayer object.

See HeapMapLayerOptions API Doc

Constructor Summary

protected

HeatMapLayerOptions() See newInstance()

Method Summary

MVCArray<LatLng>	getData() Get the data points to display.
boolean	getDissipating() Get the dissipating property
JsArrayString	getGradient() Get color gradient of the heatmap.
MapWidget	getMap() Gets map layer is rendered to, or NULL if not associated with map.
double	getMaxIntensity() Get maximum intensity
double	getOpacity() Get layer opacity
double	getRadius() Get data point influence in pixels.
static HeatMapLayerOptions	newInstance() creates - This object defines the properties that can be set on a HeatmapLayer object.
void	setData(MVCArray<LatLng> dataPoints) The data points to display.
void	setDissipating(boolean dissipating) Specifies whether heatmaps dissipate on zoom.
void	setGradient(JsArrayString gradient) The color gradient of the heatmap, specified as an array of CSS color strings.
void	setMap(MapWidget mapWidget) Renders the heatmap on the specified map.
void	setMaxIntensity(double maxIntensity) The maximum intensity of the heatmap.
void	setOpacity(double opacity) The opacity of the heatmap, expressed as a number between 0 and 1.
void	setRadius(double radius) The radius of influence for each data point, in pixels.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HeatMapLayerOptions

protected HeatMapLayerOptions()

See newInstance()

Method Detail

newInstance

public static final HeatMapLayerOptions newInstance()

creates - This object defines the properties that can be set on a HeatmapLayer object.

setData

public final void setData(MVCArray<LatLng> dataPoints)

The data points to display. Required.
NOTE: To clear the map points, set equal to an empty array.

Parameters:

dataPoints -

getData

public final MVCArray<LatLng> getData()

Get the data points to display. Required.

Returns:

dataPoints

setDissipating

public final void setDissipating(boolean dissipating)

Specifies whether heatmaps dissipate on zoom. By default, the radius of influence of a data point is specified by the radius option only. When dissipating is disabled, the radius option is intepreted as a radius at zoom level 0.

Parameters:

dissipating - enables/disables dissipating

getDissipating

public final boolean getDissipating()

Get the dissipating property

Returns:

dissipating state

setGradient

public final void setGradient(JsArrayString gradient)

The color gradient of the heatmap, specified as an array of CSS color strings. All CSS3 colors are supported except for extended named colors.

Parameters:

gradient -

getGradient

public final JsArrayString getGradient()

Get color gradient of the heatmap.

Returns:

gradient

setMap

public final void setMap(MapWidget mapWidget)

Renders the heatmap on the specified map. If map is set to null, the heatmap will be removed.

Parameters:

mapWidget -

getMap

public final MapWidget getMap()

Gets map layer is rendered to, or NULL if not associated with map.

Returns:

NULL if not associated with map

setMaxIntensity

public final void setMaxIntensity(double maxIntensity)

The maximum intensity of the heatmap. By default, heatmap colors are dynamically scaled according to the greatest concentration of points at any particular pixel on the map. This property allows you to specify a fixed maximum. Setting the maximum intensity can be helpful when your dataset contains a few outliers with an unusually high intensity.

Parameters:

maxIntensity -

getMaxIntensity

public final double getMaxIntensity()

Get maximum intensity

Returns:

maxIntensity

setOpacity

public final void setOpacity(double opacity)

The opacity of the heatmap, expressed as a number between 0 and 1. Defaults to 0.6.

Parameters:

opacity - [0-1]

getOpacity

public final double getOpacity()

Get layer opacity

Returns:

opacity

setRadius

public final void setRadius(double radius)

The radius of influence for each data point, in pixels.

Parameters:

radius - (pixels)

getRadius

public final double getRadius()

Get data point influence in pixels.

Returns:

radius (pixels)