com.mapbox.mapboxsdk.style.layers

Class HeatmapLayer

java.lang.Object

com.mapbox.mapboxsdk.style.layers.Layer

com.mapbox.mapboxsdk.style.layers.HeatmapLayer

@UiThread
public class HeatmapLayer
extends Layer

A heatmap.

See Also:

The online documentation

Constructor Summary

Constructors

Constructor and Description
HeatmapLayer(java.lang.String layerId, java.lang.String sourceId) Creates a HeatmapLayer.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
Expression	getFilter() Get a single expression filter.
PropertyValue<java.lang.String>	getHeatmapColor() Get the HeatmapColor property
int	getHeatmapColorAsInt() Defines the color of each pixel based on its density value in a heatmap.
PropertyValue<java.lang.Float>	getHeatmapIntensity() Get the HeatmapIntensity property
TransitionOptions	getHeatmapIntensityTransition() Get the HeatmapIntensity property transition options
PropertyValue<java.lang.Float>	getHeatmapOpacity() Get the HeatmapOpacity property
TransitionOptions	getHeatmapOpacityTransition() Get the HeatmapOpacity property transition options
PropertyValue<java.lang.Float>	getHeatmapRadius() Get the HeatmapRadius property
TransitionOptions	getHeatmapRadiusTransition() Get the HeatmapRadius property transition options
PropertyValue<java.lang.Float>	getHeatmapWeight() Get the HeatmapWeight property
java.lang.String	getSourceId() Get the source id.
java.lang.String	getSourceLayer() Get the source layer.
protected void	initialize(java.lang.String layerId, java.lang.String sourceId)
void	setFilter(Expression filter) Set a single expression filter.
void	setHeatmapIntensityTransition(TransitionOptions options) Set the HeatmapIntensity property transition options
void	setHeatmapOpacityTransition(TransitionOptions options) Set the HeatmapOpacity property transition options
void	setHeatmapRadiusTransition(TransitionOptions options) Set the HeatmapRadius property transition options
void	setSourceLayer(java.lang.String sourceLayer) Set the source layer.
HeatmapLayer	withFilter(Expression filter) Set a single expression filter.
HeatmapLayer	withProperties(PropertyValue<?>... properties) Set a property or properties.
HeatmapLayer	withSourceLayer(java.lang.String sourceLayer) Set the source Layer.

Methods inherited from class com.mapbox.mapboxsdk.style.layers.Layer

checkThread, getId, getMaxZoom, getMinZoom, getNativePtr, getVisibility, isDetached, nativeGetFilter, nativeGetId, nativeGetMaxZoom, nativeGetMinZoom, nativeGetSourceId, nativeGetSourceLayer, nativeGetVisibility, nativeSetFilter, nativeSetLayoutProperty, nativeSetMaxZoom, nativeSetMinZoom, nativeSetPaintProperty, nativeSetSourceLayer, setDetached, setMaxZoom, setMinZoom, setProperties

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeatmapLayer

public HeatmapLayer(java.lang.String layerId,
                    java.lang.String sourceId)

Creates a HeatmapLayer.

Parameters:

layerId - the id of the layer

sourceId - the id of the source

Method Detail

initialize

protected void initialize(java.lang.String layerId,
                          java.lang.String sourceId)

setSourceLayer

public void setSourceLayer(java.lang.String sourceLayer)

Set the source layer.

Parameters:

sourceLayer - the source layer to set

withSourceLayer

@NonNull
public HeatmapLayer withSourceLayer(java.lang.String sourceLayer)

Set the source Layer.

Parameters:

sourceLayer - the source layer to set

Returns:

This

getSourceId

@NonNull
public java.lang.String getSourceId()

Get the source id.

Returns:

id of the source

getSourceLayer

@NonNull
public java.lang.String getSourceLayer()

Get the source layer.

Returns:

sourceLayer the source layer to get

setFilter

public void setFilter(@NonNull
                      Expression filter)

Set a single expression filter.

Parameters:

filter - the expression filter to set

withFilter

@NonNull
public HeatmapLayer withFilter(@NonNull
                                        Expression filter)

Set a single expression filter.

Parameters:

filter - the expression filter to set

Returns:

This

getFilter

@Nullable
public Expression getFilter()

Get a single expression filter.

Returns:

the expression filter to get

withProperties

@NonNull
public HeatmapLayer withProperties(@NonNull
                                            PropertyValue<?>... properties)

Set a property or properties.

Parameters:

properties - the var-args properties

Returns:

This

getHeatmapRadius

@NonNull
public PropertyValue<java.lang.Float> getHeatmapRadius()

Get the HeatmapRadius property

Returns:

property wrapper value around Float

getHeatmapRadiusTransition

@NonNull
public TransitionOptions getHeatmapRadiusTransition()

Get the HeatmapRadius property transition options

Returns:

transition options for Float

setHeatmapRadiusTransition

public void setHeatmapRadiusTransition(@NonNull
                                       TransitionOptions options)

Set the HeatmapRadius property transition options

Parameters:

options - transition options for Float

getHeatmapWeight

@NonNull
public PropertyValue<java.lang.Float> getHeatmapWeight()

Get the HeatmapWeight property

Returns:

property wrapper value around Float

getHeatmapIntensity

@NonNull
public PropertyValue<java.lang.Float> getHeatmapIntensity()

Get the HeatmapIntensity property

Returns:

property wrapper value around Float

getHeatmapIntensityTransition

@NonNull
public TransitionOptions getHeatmapIntensityTransition()

Get the HeatmapIntensity property transition options

Returns:

transition options for Float

setHeatmapIntensityTransition

public void setHeatmapIntensityTransition(@NonNull
                                          TransitionOptions options)

Set the HeatmapIntensity property transition options

Parameters:

options - transition options for Float

getHeatmapColor

@NonNull
public PropertyValue<java.lang.String> getHeatmapColor()

Get the HeatmapColor property

Returns:

property wrapper value around String

getHeatmapColorAsInt

@ColorInt
public int getHeatmapColorAsInt()

Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.

Returns:

int representation of a rgba string color

Throws:

java.lang.RuntimeException - thrown if property isn't a value

getHeatmapOpacity

@NonNull
public PropertyValue<java.lang.Float> getHeatmapOpacity()

Get the HeatmapOpacity property

Returns:

property wrapper value around Float

getHeatmapOpacityTransition

@NonNull
public TransitionOptions getHeatmapOpacityTransition()

Get the HeatmapOpacity property transition options

Returns:

transition options for Float

setHeatmapOpacityTransition

public void setHeatmapOpacityTransition(@NonNull
                                        TransitionOptions options)

Set the HeatmapOpacity property transition options

Parameters:

options - transition options for Float

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class Layer

Throws:

java.lang.Throwable