com.mapbox.mapboxsdk.maps

Class Style

java.lang.Object

com.mapbox.mapboxsdk.maps.Style

public class Style
extends java.lang.Object

The proxy object for current map style.

To create new instances of this object, create a new instance using a Style.Builder and load the style with MapboxMap. This object is returned from MapboxMap.getStyle() once the style has been loaded by underlying map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Style.Builder Builder for composing a style object.
static interface	Style.OnStyleLoaded Callback to be invoked when a style has finished loading.
static interface	Style.StyleUrl Indicates the parameter accepts one of the values from Style.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DARK Dark: Subtle dark backdrop for data visualizations.
static java.lang.String	LIGHT Light: Subtle light backdrop for data visualizations.
static java.lang.String	MAPBOX_STREETS Mapbox Streets: A complete basemap, perfect for incorporating your own data.
static java.lang.String	OUTDOORS Outdoors: A general-purpose style tailored to outdoor activities.
static java.lang.String	SATELLITE Satellite: A beautiful global satellite and aerial imagery layer.
static java.lang.String	SATELLITE_STREETS Satellite Streets: Global satellite and aerial imagery with unobtrusive labels.
static java.lang.String	TRAFFIC_DAY Traffic Day: Color-coded roads based on live traffic congestion data.
static java.lang.String	TRAFFIC_NIGHT Traffic Night: Color-coded roads based on live traffic congestion data, designed to maximize legibility in low-light situations.

Method Summary

Modifier and Type	Method and Description
void	addImage(java.lang.String name, android.graphics.Bitmap image) Adds an image to be used in the map's style
void	addImage(java.lang.String name, android.graphics.Bitmap bitmap, boolean sdf) Adds an image to be used in the map's style
void	addImage(java.lang.String name, android.graphics.Bitmap bitmap, boolean sdf, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds an image to be used in the map's style
void	addImage(java.lang.String name, android.graphics.Bitmap image, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds an image to be used in the map's style
void	addImage(java.lang.String name, android.graphics.drawable.Drawable drawable) Adds an drawable to be converted into a bitmap to be used in the map's style
void	addImage(java.lang.String name, android.graphics.drawable.Drawable drawable, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds an drawable to be converted into a bitmap to be used in the map's style
void	addImageAsync(java.lang.String name, android.graphics.Bitmap image) Adds an image asynchronously, to be used in the map's style.
void	addImageAsync(java.lang.String name, android.graphics.Bitmap bitmap, boolean sdf) Adds an image asynchronously, to be used in the map's style.
void	addImageAsync(java.lang.String name, android.graphics.Bitmap bitmap, boolean sdf, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds an image asynchronously, to be used in the map's style.
void	addImageAsync(java.lang.String name, android.graphics.Bitmap image, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds an image asynchronously, to be used in the map's style.
void	addImageAsync(java.lang.String name, android.graphics.drawable.Drawable drawable) Adds an drawable asynchronously, to be converted into a bitmap to be used in the map's style.
void	addImageAsync(java.lang.String name, android.graphics.drawable.Drawable drawable, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds an drawable asynchronously, to be converted into a bitmap to be used in the map's style.
void	addImages(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images) Adds images to be used in the map's style.
void	addImages(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images, boolean sdf) Adds images to be used in the map's style.
void	addImages(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images, boolean sdf, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds images to be used in the map's style.
void	addImages(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds images to be used in the map's style.
void	addImages(Image[] images) Add images synchronously, to be used in the map's style.
void	addImagesAsync(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images) Adds images asynchronously, to be used in the map's style.
void	addImagesAsync(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images, boolean sdf) Adds images asynchronously, to be used in the map's style.
void	addImagesAsync(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images, boolean sdf, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds images asynchronously, to be used in the map's style.
void	addImagesAsync(java.util.HashMap<java.lang.String,android.graphics.Bitmap> images, java.util.List<ImageStretches> stretchX, java.util.List<ImageStretches> stretchY, ImageContent content) Adds images asynchronously, to be used in the map's style.
void	addLayer(Layer layer) Adds the layer to the map.
void	addLayerAbove(Layer layer, java.lang.String above) Adds the layer to the map.
void	addLayerAt(Layer layer, int index) Adds the layer to the map at the specified index.
void	addLayerBelow(Layer layer, java.lang.String below) Adds the layer to the map.
void	addSource(Source source) Adds the source to the map.
android.graphics.Bitmap	getImage(java.lang.String id) Get an image from the map's style using an id.
java.lang.String	getJson() Returns the current style json.
Layer	getLayer(java.lang.String id) Get the layer by id
<T extends Layer> T	getLayerAs(java.lang.String layerId) Tries to cast the Layer to T, throws ClassCastException if it's another type.
java.util.List<Layer>	getLayers() Retrieve all the layers in the style
Light	getLight() Get the light source used to change lighting conditions on extruded fill layers.
Source	getSource(java.lang.String id) Retrieve a source by id
<T extends Source> T	getSourceAs(java.lang.String sourceId) Tries to cast the Source to T, throws ClassCastException if it's another type.
java.util.List<Source>	getSources() Retrieve all the sources in the style
TransitionOptions	getTransition() Get the transition options for style changes.
java.lang.String	getUri() Returns the current style uri.
java.lang.String	getUrl() Deprecated. use getUri() instead
boolean	isFullyLoaded() Returns true if the style is fully loaded.
void	removeImage(java.lang.String name) Removes an image from the map's style.
boolean	removeLayer(Layer layer) Removes the layer.
boolean	removeLayer(java.lang.String layerId) Removes the layer.
boolean	removeLayerAt(int index) Removes the layer.
boolean	removeSource(Source source) Removes the source, preserving the reference for re-use
boolean	removeSource(java.lang.String sourceId) Removes the source from the style.
void	setTransition(TransitionOptions transitionOptions) Set the transition options for style changes.
static Image	toImage(Style.Builder.ImageWrapper imageWrapper)

Methods inherited from class java.lang.Object

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

Field Detail

MAPBOX_STREETS

public static final java.lang.String MAPBOX_STREETS

Mapbox Streets: A complete basemap, perfect for incorporating your own data. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

OUTDOORS

public static final java.lang.String OUTDOORS

Outdoors: A general-purpose style tailored to outdoor activities. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

LIGHT

public static final java.lang.String LIGHT

Light: Subtle light backdrop for data visualizations. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

DARK

public static final java.lang.String DARK

Dark: Subtle dark backdrop for data visualizations. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

SATELLITE

public static final java.lang.String SATELLITE

Satellite: A beautiful global satellite and aerial imagery layer. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

SATELLITE_STREETS

public static final java.lang.String SATELLITE_STREETS

Satellite Streets: Global satellite and aerial imagery with unobtrusive labels. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

TRAFFIC_DAY

public static final java.lang.String TRAFFIC_DAY

Traffic Day: Color-coded roads based on live traffic congestion data. Traffic data is currently available in these select countries. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

TRAFFIC_NIGHT

public static final java.lang.String TRAFFIC_NIGHT

Traffic Night: Color-coded roads based on live traffic congestion data, designed to maximize legibility in low-light situations. Traffic data is currently available in these select countries. Using this constant means your map style will always use the latest version and may change as we improve the style.

See Also:

Constant Field Values

Method Detail

getUrl

@NonNull
 @Deprecated
public java.lang.String getUrl()

Deprecated. use getUri() instead

Returns the current style url.

Returns:

the style url

getUri

@NonNull
public java.lang.String getUri()

Returns the current style uri.

Returns:

the style uri

getJson

@NonNull
public java.lang.String getJson()

Returns the current style json.

Returns:

the style json

getSources

@NonNull
public java.util.List<Source> getSources()

Retrieve all the sources in the style

Returns:

all the sources in the current style

addSource

public void addSource(@NonNull
                      Source source)

Adds the source to the map. The source must be newly created and not added to the map before

Parameters:

source - the source to add

getSource

@Nullable
public Source getSource(java.lang.String id)

Retrieve a source by id

Parameters:

id - the source's id

Returns:

the source if present in the current style

getSourceAs

@Nullable
public <T extends Source> T getSourceAs(@NonNull
                                                  java.lang.String sourceId)

Tries to cast the Source to T, throws ClassCastException if it's another type.

Type Parameters:

T - the generic type of a Source

Parameters:

sourceId - the id used to look up a layer

Returns:

the casted Source, null if another type

removeSource

public boolean removeSource(@NonNull
                            java.lang.String sourceId)

Removes the source from the style.

Parameters:

sourceId - the source to remove

Returns:

true if the source was removed, false otherwise

removeSource

public boolean removeSource(@NonNull
                            Source source)

Removes the source, preserving the reference for re-use

Parameters:

source - the source to remove

Returns:

true if the source was removed, false otherwise

addLayer

public void addLayer(@NonNull
                     Layer layer)

Adds the layer to the map. The layer must be newly created and not added to the map before

Parameters:

layer - the layer to add

addLayerBelow

public void addLayerBelow(@NonNull
                          Layer layer,
                          @NonNull
                          java.lang.String below)

Adds the layer to the map. The layer must be newly created and not added to the map before

Parameters:

layer - the layer to add

below - the layer id to add this layer before

addLayerAbove

public void addLayerAbove(@NonNull
                          Layer layer,
                          @NonNull
                          java.lang.String above)

Adds the layer to the map. The layer must be newly created and not added to the map before

Parameters:

layer - the layer to add

above - the layer id to add this layer above

addLayerAt

public void addLayerAt(@NonNull
                       Layer layer,
                       int index)

Adds the layer to the map at the specified index. The layer must be newly created and not added to the map before

Parameters:

layer - the layer to add

index - the index to insert the layer at

getLayer

@Nullable
public Layer getLayer(@NonNull
                                java.lang.String id)

Get the layer by id

Parameters:

id - the layer's id

Returns:

the layer, if present in the style

getLayerAs

@Nullable
public <T extends Layer> T getLayerAs(@NonNull
                                                java.lang.String layerId)

Tries to cast the Layer to T, throws ClassCastException if it's another type.

Type Parameters:

T - the generic attribute of a Layer

Parameters:

layerId - the layer id used to look up a layer

Returns:

the casted Layer, null if another type

getLayers

@NonNull
public java.util.List<Layer> getLayers()

Retrieve all the layers in the style

Returns:

all the layers in the current style

removeLayer

public boolean removeLayer(@NonNull
                           java.lang.String layerId)

Removes the layer. Any references to the layer become invalid and should not be used anymore

Parameters:

layerId - the layer to remove

Returns:

true if the layer was removed, false otherwise

removeLayer

public boolean removeLayer(@NonNull
                           Layer layer)

Removes the layer. The reference is re-usable after this and can be re-added

Parameters:

layer - the layer to remove

Returns:

true if the layer was removed, false otherwise

removeLayerAt

public boolean removeLayerAt(int index)

Removes the layer. Any other references to the layer become invalid and should not be used anymore

Parameters:

index - the layer index

Returns:

true if the layer was removed, false otherwise

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.Bitmap image)

Adds an image to be used in the map's style

Parameters:

name - the name of the image

image - the pre-multiplied Bitmap

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.Bitmap image,
                     @NonNull
                     java.util.List<ImageStretches> stretchX,
                     @NonNull
                     java.util.List<ImageStretches> stretchY,
                     @Nullable
                     ImageContent content)

Adds an image to be used in the map's style

Parameters:

name - the name of the image

image - the pre-multiplied Bitmap

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.drawable.Drawable drawable)

Adds an drawable to be converted into a bitmap to be used in the map's style

Parameters:

name - the name of the image

drawable - the drawable instance to convert

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.drawable.Drawable drawable,
                     @NonNull
                     java.util.List<ImageStretches> stretchX,
                     @NonNull
                     java.util.List<ImageStretches> stretchY,
                     @Nullable
                     ImageContent content)

Adds an drawable to be converted into a bitmap to be used in the map's style

Parameters:

name - the name of the image

drawable - the drawable instance to convert

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.Bitmap bitmap,
                     boolean sdf)

Adds an image to be used in the map's style

Parameters:

name - the name of the image

bitmap - the pre-multiplied Bitmap

sdf - the flag indicating image is an SDF or template image

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.Bitmap bitmap,
                     boolean sdf,
                     @NonNull
                     java.util.List<ImageStretches> stretchX,
                     @NonNull
                     java.util.List<ImageStretches> stretchY,
                     @Nullable
                     ImageContent content)

Adds an image to be used in the map's style

Parameters:

name - the name of the image

bitmap - the pre-multiplied Bitmap

sdf - the flag indicating image is an SDF or template image

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImageAsync

public void addImageAsync(@NonNull
                          java.lang.String name,
                          @NonNull
                          android.graphics.Bitmap image)

Adds an image asynchronously, to be used in the map's style.

Parameters:

name - the name of the image

image - the pre-multiplied Bitmap

addImageAsync

public void addImageAsync(@NonNull
                          java.lang.String name,
                          @NonNull
                          android.graphics.Bitmap image,
                          @NonNull
                          java.util.List<ImageStretches> stretchX,
                          @NonNull
                          java.util.List<ImageStretches> stretchY,
                          @Nullable
                          ImageContent content)

Adds an image asynchronously, to be used in the map's style.

Parameters:

name - the name of the image

image - the pre-multiplied Bitmap

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImageAsync

public void addImageAsync(@NonNull
                          java.lang.String name,
                          @NonNull
                          android.graphics.drawable.Drawable drawable)

Adds an drawable asynchronously, to be converted into a bitmap to be used in the map's style.

Parameters:

name - the name of the image

drawable - the drawable instance to convert

addImageAsync

public void addImageAsync(@NonNull
                          java.lang.String name,
                          @NonNull
                          android.graphics.drawable.Drawable drawable,
                          @NonNull
                          java.util.List<ImageStretches> stretchX,
                          @NonNull
                          java.util.List<ImageStretches> stretchY,
                          @Nullable
                          ImageContent content)

Adds an drawable asynchronously, to be converted into a bitmap to be used in the map's style.

Parameters:

name - the name of the image

drawable - the drawable instance to convert

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImageAsync

public void addImageAsync(@NonNull
                          java.lang.String name,
                          @NonNull
                          android.graphics.Bitmap bitmap,
                          boolean sdf)

Adds an image asynchronously, to be used in the map's style.

Parameters:

name - the name of the image

bitmap - the pre-multiplied Bitmap

sdf - the flag indicating image is an SDF or template image

addImageAsync

public void addImageAsync(@NonNull
                          java.lang.String name,
                          @NonNull
                          android.graphics.Bitmap bitmap,
                          boolean sdf,
                          @NonNull
                          java.util.List<ImageStretches> stretchX,
                          @NonNull
                          java.util.List<ImageStretches> stretchY,
                          @Nullable
                          ImageContent content)

Adds an image asynchronously, to be used in the map's style.

Parameters:

name - the name of the image

bitmap - the pre-multiplied Bitmap

sdf - the flag indicating image is an SDF or template image

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImages

public void addImages(@NonNull
                      java.util.HashMap<java.lang.String,android.graphics.Bitmap> images)

Adds images to be used in the map's style.

Parameters:

images - the map of images to add

addImages

public void addImages(@NonNull
                      java.util.HashMap<java.lang.String,android.graphics.Bitmap> images,
                      @NonNull
                      java.util.List<ImageStretches> stretchX,
                      @NonNull
                      java.util.List<ImageStretches> stretchY,
                      @Nullable
                      ImageContent content)

Adds images to be used in the map's style.

Parameters:

images - the map of images to add

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImages

public void addImages(@NonNull
                      java.util.HashMap<java.lang.String,android.graphics.Bitmap> images,
                      boolean sdf)

Adds images to be used in the map's style.

Parameters:

images - the map of images to add

sdf - the flag indicating image is an SDF or template image

addImages

public void addImages(@NonNull
                      java.util.HashMap<java.lang.String,android.graphics.Bitmap> images,
                      boolean sdf,
                      @NonNull
                      java.util.List<ImageStretches> stretchX,
                      @NonNull
                      java.util.List<ImageStretches> stretchY,
                      @Nullable
                      ImageContent content)

Adds images to be used in the map's style.

Parameters:

images - the map of images to add

sdf - the flag indicating image is an SDF or template image

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImagesAsync

public void addImagesAsync(@NonNull
                           java.util.HashMap<java.lang.String,android.graphics.Bitmap> images)

Adds images asynchronously, to be used in the map's style.

Parameters:

images - the map of images to add

addImagesAsync

public void addImagesAsync(@NonNull
                           java.util.HashMap<java.lang.String,android.graphics.Bitmap> images,
                           @NonNull
                           java.util.List<ImageStretches> stretchX,
                           @NonNull
                           java.util.List<ImageStretches> stretchY,
                           @Nullable
                           ImageContent content)

Adds images asynchronously, to be used in the map's style.

Parameters:

images - the map of images to add

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImagesAsync

public void addImagesAsync(@NonNull
                           java.util.HashMap<java.lang.String,android.graphics.Bitmap> images,
                           boolean sdf)

Adds images asynchronously, to be used in the map's style.

Parameters:

images - the map of images to add

sdf - the flag indicating image is an SDF or template image

addImagesAsync

public void addImagesAsync(@NonNull
                           java.util.HashMap<java.lang.String,android.graphics.Bitmap> images,
                           boolean sdf,
                           @NonNull
                           java.util.List<ImageStretches> stretchX,
                           @NonNull
                           java.util.List<ImageStretches> stretchY,
                           @Nullable
                           ImageContent content)

Adds images asynchronously, to be used in the map's style.

Parameters:

images - the map of images to add

sdf - the flag indicating image is an SDF or template image

stretchX - image stretch areas for x axix

stretchY - image stretch areas for y axix

content - image content for text to fit

addImages

public void addImages(Image[] images)

Add images synchronously, to be used in the map's style.

Parameters:

images - the array of images to add

removeImage

public void removeImage(@NonNull
                        java.lang.String name)

Removes an image from the map's style.

Parameters:

name - the name of the image to remove

getImage

@Nullable
public android.graphics.Bitmap getImage(@NonNull
                                                  java.lang.String id)

Get an image from the map's style using an id.

Parameters:

id - the id of the image

Returns:

the image bitmap

setTransition

public void setTransition(@NonNull
                          TransitionOptions transitionOptions)

Set the transition options for style changes.

If not set, any changes take effect without animation, besides symbols, which will fade in/out with a default duration after symbol collision detection.

To disable symbols fade in/out animation, pass transition options with TransitionOptions.enablePlacementTransitions equal to false.

Both TransitionOptions.duration and TransitionOptions.delay will also change the behavior of the symbols fade in/out animation if the placement transition is enabled.

Parameters:

transitionOptions - the transition options

getTransition

@NonNull
public TransitionOptions getTransition()

Get the transition options for style changes.

By default, any changes take effect without animation, besides symbols, which will fade in/out with a default duration after symbol collision detection.

To disable symbols fade in/out animation, pass transition options with TransitionOptions.enablePlacementTransitions equal to false into setTransition(TransitionOptions).

Both TransitionOptions.duration and TransitionOptions.delay will also change the behavior of the symbols fade in/out animation if the placement transition is enabled.

Returns:

TransitionOptions the transition options

getLight

@Nullable
public Light getLight()

Get the light source used to change lighting conditions on extruded fill layers.

Returns:

the global light source

isFullyLoaded

public boolean isFullyLoaded()

Returns true if the style is fully loaded. Returns false if style hasn't been fully loaded or a new style is underway of being loaded.

Returns:

True if fully loaded, false otherwise

toImage

public static Image toImage(Style.Builder.ImageWrapper imageWrapper)