com.mapbox.mapboxsdk.style.layers

Class BackgroundLayer

java.lang.Object

com.mapbox.mapboxsdk.style.layers.Layer

com.mapbox.mapboxsdk.style.layers.BackgroundLayer

public class BackgroundLayer
extends Layer

The background color or pattern of the map.

See Also:

The online documentation

Constructor Summary

Constructors

Constructor and Description
BackgroundLayer(long nativePtr) Creates a BackgroundLayer.
BackgroundLayer(java.lang.String layerId) Creates a BackgroundLayer.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
PropertyValue<java.lang.String>	getBackgroundColor() Get the BackgroundColor property
int	getBackgroundColorAsInt() The color with which the background will be drawn.
PropertyValue<java.lang.Float>	getBackgroundOpacity() Get the BackgroundOpacity property
PropertyValue<java.lang.String>	getBackgroundPattern() Get the BackgroundPattern property
protected void	initialize(java.lang.String layerId)
BackgroundLayer	withProperties(PropertyValue<?>... properties) Set a property or properties.

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

getId, getMaxZoom, getMinZoom, getNativePtr, getVisibility, nativeGetId, nativeGetMaxZoom, nativeGetMinZoom, nativeGetVisibility, nativeSetFilter, nativeSetLayoutProperty, nativeSetMaxZoom, nativeSetMinZoom, nativeSetPaintProperty, nativeSetSourceLayer, setMaxZoom, setMinZoom, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundLayer

public BackgroundLayer(long nativePtr)

Creates a BackgroundLayer.

Parameters:

nativePtr - pointer used by core

BackgroundLayer

public BackgroundLayer(java.lang.String layerId)

Creates a BackgroundLayer.

Parameters:

layerId - the id of the layer

Method Detail

initialize

protected void initialize(java.lang.String layerId)

withProperties

public BackgroundLayer withProperties(PropertyValue<?>... properties)

Set a property or properties.

Parameters:

properties - the var-args properties

Returns:

This

getBackgroundColor

public PropertyValue<java.lang.String> getBackgroundColor()

Get the BackgroundColor property

Returns:

property wrapper value around String

getBackgroundColorAsInt

public int getBackgroundColorAsInt()

The color with which the background will be drawn.

Returns:

int representation of a rgba string color

Throws:

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

getBackgroundPattern

public PropertyValue<java.lang.String> getBackgroundPattern()

Get the BackgroundPattern property

Returns:

property wrapper value around String

getBackgroundOpacity

public PropertyValue<java.lang.Float> getBackgroundOpacity()

Get the BackgroundOpacity property

Returns:

property wrapper value around Float

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class Layer

Throws:

java.lang.Throwable