com.tomtom.online.sdk.map.style

Interface Style

All Known Subinterfaces:

StyleSettings

@Beta(year=2019,
      month=12)
public interface Style

An interface that represents map style.

Method Summary

Modifier and Type	Method and Description
void	addImage(com.tomtom.online.sdk.map.style.images.Image image) Adds an image to the style.
void	addLayer(Layer layer) Adds a layer to the style.
void	addSource(Source source) Adds a source to the style.
Optional<com.tomtom.online.sdk.map.style.images.Image>	findImageById(java.lang.String id) Provides access to the image with the provided id if such an image is present in the style.
Optional<Layer>	findLayerById(java.lang.String id) Provides access to the layer with a provided id if such a layer is present in the style.
java.util.List<Layer>	findLayersById(java.lang.String regex) Provides access to all layers whose id matches the provided Regex.
java.util.List<Layer>	findLayersBySourceLayerId(java.lang.String regex) Provides access to all layers whose source layers have an id matching the provided Regex.
Optional<Source>	findSourceById(java.lang.String id) Provides access to the source with the provided id if such a source is present in the style.
java.util.List<Layer>	getLayers() Provides access to all layers in the style.
void	moveLayerBehind(java.lang.String id, java.lang.String referenceLayerId) Moves the layer behind the reference layer.
void	removeImage(java.lang.String id) Removes an image with a provided id from the style.
void	removeLayer(java.lang.String id) Removes the layer with a provided id from the style.
void	removeSource(java.lang.String id) Removes the source with the provided id from the style.

Method Detail

addLayer

@Beta(year=2019,
      month=12)
void addLayer(@NonNull
                                               Layer layer)

Adds a layer to the style. The layer is added above all existing layers.

removeLayer

@Beta(year=2019,
      month=12)
void removeLayer(@NonNull
                                                  java.lang.String id)

Removes the layer with a provided id from the style.

findLayerById

@Beta(year=2019,
      month=12)
 @NonNull
Optional<Layer> findLayerById(@NonNull
                                                                         java.lang.String id)

Provides access to the layer with a provided id if such a layer is present in the style.

findLayersById

@Beta(year=2019,
      month=12)
 @NonNull
java.util.List<Layer> findLayersById(@NonNull
                                                                                java.lang.String regex)

Provides access to all layers whose id matches the provided Regex.

findLayersBySourceLayerId

@Beta(year=2019,
      month=12)
 @NonNull
java.util.List<Layer> findLayersBySourceLayerId(@NonNull
                                                                                           java.lang.String regex)

Provides access to all layers whose source layers have an id matching the provided Regex.

getLayers

@Beta(year=2019,
      month=12)
 @NonNull
java.util.List<Layer> getLayers()

Provides access to all layers in the style.

moveLayerBehind

@Beta(year=2019,
      month=12)
void moveLayerBehind(@NonNull
                                                      java.lang.String id,
                                                      @NonNull
                                                      java.lang.String referenceLayerId)

Moves the layer behind the reference layer.

addSource

@Beta(year=2019,
      month=12)
void addSource(@NonNull
                                                Source source)

Adds a source to the style.

removeSource

@Beta(year=2019,
      month=12)
void removeSource(@NonNull
                                                   java.lang.String id)

Removes the source with the provided id from the style.

findSourceById

@Beta(year=2019,
      month=12)
 @NonNull
Optional<Source> findSourceById(@NonNull
                                                                           java.lang.String id)

Provides access to the source with the provided id if such a source is present in the style.

findImageById

@Beta(year=2019,
      month=12)
 @NonNull
Optional<com.tomtom.online.sdk.map.style.images.Image> findImageById(java.lang.String id)

Provides access to the image with the provided id if such an image is present in the style.

removeImage

@Beta(year=2019,
      month=12)
 @NonNull
void removeImage(@NonNull
                                                            java.lang.String id)

Removes an image with a provided id from the style.

addImage

@Beta(year=2019,
      month=12)
 @NonNull
void addImage(@NonNull
                                                         com.tomtom.online.sdk.map.style.images.Image image)

Adds an image to the style.