BackgroundLayer (Trimble MAPS Maps SDK for Android 0.9.39 Reference)

java.lang.Object
- com.trimblemaps.mapsdk.style.layers.Layer
- - com.trimblemaps.mapsdk.style.layers.BackgroundLayer

@UiThread
public class BackgroundLayer
extends Layer

The background color or pattern of the map.

Constructor Summary

Constructors
Constructor Description

BackgroundLayer(java.lang.String layerId)
Creates a BackgroundLayer.

Constructors
Constructor	Description
`BackgroundLayer(java.lang.String layerId)`	Creates a BackgroundLayer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`finalize()`
`PropertyValue<java.lang.String>`	`getBackgroundColor()`	Get the BackgroundColor property
`int`	`getBackgroundColorAsInt()`	The color with which the background will be drawn.
`TransitionOptions`	`getBackgroundColorTransition()`	Get the BackgroundColor property transition options
`PropertyValue<java.lang.Float>`	`getBackgroundOpacity()`	Get the BackgroundOpacity property
`TransitionOptions`	`getBackgroundOpacityTransition()`	Get the BackgroundOpacity property transition options
`PropertyValue<java.lang.String>`	`getBackgroundPattern()`	Get the BackgroundPattern property
`TransitionOptions`	`getBackgroundPatternTransition()`	Get the BackgroundPattern property transition options
`protected void`	`initialize(java.lang.String layerId)`
`void`	`setBackgroundColorTransition(TransitionOptions options)`	Set the BackgroundColor property transition options
`void`	`setBackgroundOpacityTransition(TransitionOptions options)`	Set the BackgroundOpacity property transition options
`void`	`setBackgroundPatternTransition(TransitionOptions options)`	Set the BackgroundPattern property transition options
`BackgroundLayer`	`withProperties(PropertyValue<?>... properties)`	Set a property or properties.

Methods inherited from class com.trimblemaps.mapsdk.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
  - 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
```
@NonNull
public BackgroundLayer withProperties(@NonNull
                                      PropertyValue<?>... properties)
```
    Set a property or properties.
    
    Parameters:
    
    properties - the var-args properties
    
    Returns:
    
    This
  - getBackgroundColor
```
@NonNull
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
  - getBackgroundColorTransition
```
@NonNull
public TransitionOptions getBackgroundColorTransition()
```
    Get the BackgroundColor property transition options
    
    Returns:
    
    transition options for String
  - setBackgroundColorTransition
```
public void setBackgroundColorTransition(@NonNull
                                         TransitionOptions options)
```
    Set the BackgroundColor property transition options
    
    Parameters:
    
    options - transition options for String
  - getBackgroundPattern
```
@NonNull
public PropertyValue<java.lang.String> getBackgroundPattern()
```
    Get the BackgroundPattern property
    
    Returns:
    
    property wrapper value around String
  - getBackgroundPatternTransition
```
@NonNull
public TransitionOptions getBackgroundPatternTransition()
```
    Get the BackgroundPattern property transition options
    
    Returns:
    
    transition options for String
  - setBackgroundPatternTransition
```
public void setBackgroundPatternTransition(@NonNull
                                           TransitionOptions options)
```
    Set the BackgroundPattern property transition options
    
    Parameters:
    
    options - transition options for String
  - getBackgroundOpacity
```
@NonNull
public PropertyValue<java.lang.Float> getBackgroundOpacity()
```
    Get the BackgroundOpacity property
    
    Returns:
    
    property wrapper value around Float
  - getBackgroundOpacityTransition
```
@NonNull
public TransitionOptions getBackgroundOpacityTransition()
```
    Get the BackgroundOpacity property transition options
    
    Returns:
    
    transition options for Float
  - setBackgroundOpacityTransition
```
public void setBackgroundOpacityTransition(@NonNull
                                           TransitionOptions options)
```
    Set the BackgroundOpacity 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

Class BackgroundLayer

Constructor Summary

Method Summary

Methods inherited from class com.trimblemaps.mapsdk.style.layers.Layer

Methods inherited from class java.lang.Object

Constructor Detail

BackgroundLayer

Method Detail

initialize

withProperties

getBackgroundColor

getBackgroundColorAsInt

getBackgroundColorTransition

setBackgroundColorTransition

getBackgroundPattern

getBackgroundPatternTransition

setBackgroundPatternTransition

getBackgroundOpacity

getBackgroundOpacityTransition

setBackgroundOpacityTransition

finalize