com.mapbox.mapboxsdk.style.sources

Class ImageSource

java.lang.Object

com.mapbox.mapboxsdk.style.sources.Source

com.mapbox.mapboxsdk.style.sources.ImageSource

@UiThread
public class ImageSource
extends Source

Image source, allows a georeferenced raster image to be shown on the map.

The georeferenced image scales and rotates as the user zooms and rotates the map. The geographic location of the raster image content, supplied with `LatLngQuad`, can be non-axis aligned.

* @see the style specification

Field Summary

Fields inherited from class com.mapbox.mapboxsdk.style.sources.Source

detached

Constructor Summary

Constructors

Constructor and Description
ImageSource(java.lang.String id, LatLngQuad coordinates, android.graphics.Bitmap bitmap) Create an ImageSource from coordinates and a bitmap image
ImageSource(java.lang.String id, LatLngQuad coordinates, int resourceId) Create an ImageSource from coordinates and a bitmap image resource
ImageSource(java.lang.String id, LatLngQuad coordinates, java.net.URI uri) Create an ImageSource from coordinates and an image URI
ImageSource(java.lang.String id, LatLngQuad coordinates, java.net.URL url) Deprecated. use ImageSource(String, LatLngQuad, URI) instead

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
java.lang.String	getUri() Get the source URI.
java.lang.String	getUrl() Deprecated. use getUri() instead
protected void	initialize(java.lang.String layerId, LatLngQuad payload)
protected java.lang.String	nativeGetUrl()
protected void	nativeSetCoordinates(LatLngQuad latLngQuad)
protected void	nativeSetImage(android.graphics.Bitmap bitmap)
protected void	nativeSetUrl(java.lang.String url)
void	setCoordinates(LatLngQuad latLngQuad) Updates the latitude and longitude of the four corners of the image
void	setImage(android.graphics.Bitmap bitmap) Updates the source image to a bitmap
void	setImage(int resourceId) Updates the source image to a bitmap image resource
void	setUri(java.lang.String uri) Updates the source image URI.
void	setUri(java.net.URI uri) Updates the source image URI.
void	setUrl(java.lang.String url) Deprecated. use setUri(String) instead
void	setUrl(java.net.URL url) Deprecated. use setUri(URI) instead

Methods inherited from class com.mapbox.mapboxsdk.style.sources.Source

checkThread, getAttribution, getId, getMaxOverscaleFactorForParentTiles, getMinimumTileUpdateInterval, getNativePtr, getPrefetchZoomDelta, isVolatile, nativeGetAttribution, nativeGetId, nativeGetMaxOverscaleFactorForParentTiles, nativeGetMinimumTileUpdateInterval, nativeGetPrefetchZoomDelta, nativeIsVolatile, nativeSetMaxOverscaleFactorForParentTiles, nativeSetMinimumTileUpdateInterval, nativeSetPrefetchZoomDelta, nativeSetVolatile, setDetached, setMaxOverscaleFactorForParentTiles, setMinimumTileUpdateInterval, setPrefetchZoomDelta, setVolatile

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageSource

@Deprecated
public ImageSource(java.lang.String id,
                               LatLngQuad coordinates,
                               @NonNull
                               java.net.URL url)

Deprecated. use ImageSource(String, LatLngQuad, URI) instead

Create an ImageSource from coordinates and an image URL

Parameters:

id - The source id

coordinates - The Latitude and Longitude of the four corners of the image

url - remote json file

ImageSource

public ImageSource(java.lang.String id,
                   LatLngQuad coordinates,
                   @NonNull
                   java.net.URI uri)

Create an ImageSource from coordinates and an image URI

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

id - The source id

coordinates - The Latitude and Longitude of the four corners of the image

uri - json file uri

ImageSource

public ImageSource(java.lang.String id,
                   LatLngQuad coordinates,
                   @NonNull
                   android.graphics.Bitmap bitmap)

Create an ImageSource from coordinates and a bitmap image

Parameters:

id - The source id

coordinates - The Latitude and Longitude of the four corners of the image

bitmap - A Bitmap image

ImageSource

public ImageSource(java.lang.String id,
                   LatLngQuad coordinates,
                   @DrawableRes
                   int resourceId)

Create an ImageSource from coordinates and a bitmap image resource

Parameters:

id - The source id

coordinates - The Latitude and Longitude of the four corners of the image

resourceId - The resource ID of a Bitmap image

Method Detail

setUrl

@Deprecated
public void setUrl(@NonNull
                               java.net.URL url)

Deprecated. use setUri(URI) instead

Updates the source image url

Parameters:

url - An Image url

setUrl

@Deprecated
public void setUrl(java.lang.String url)

Deprecated. use setUri(String) instead

Updates the source image url

Parameters:

url - An image url

setUri

public void setUri(@NonNull
                   java.net.URI uri)

Updates the source image URI.

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

uri - An Image uri

setUri

public void setUri(java.lang.String uri)

Updates the source image URI.

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

uri - An image uri

setImage

public void setImage(@NonNull
                     android.graphics.Bitmap bitmap)

Updates the source image to a bitmap

Parameters:

bitmap - A Bitmap image

setImage

public void setImage(@DrawableRes
                     int resourceId)
              throws java.lang.IllegalArgumentException

Updates the source image to a bitmap image resource

Parameters:

resourceId - The resource ID of a Bitmap image

Throws:

java.lang.IllegalArgumentException

getUrl

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

Deprecated. use getUri() instead

Returns:

The url or null

getUri

@Nullable
public java.lang.String getUri()

Get the source URI.

Returns:

The uri or null

setCoordinates

public void setCoordinates(LatLngQuad latLngQuad)

Updates the latitude and longitude of the four corners of the image

Parameters:

latLngQuad - latitude and longitude of the four corners of the image

initialize

protected void initialize(java.lang.String layerId,
                          LatLngQuad payload)

nativeSetUrl

protected void nativeSetUrl(java.lang.String url)

nativeGetUrl

@NonNull
protected java.lang.String nativeGetUrl()

nativeSetImage

protected void nativeSetImage(android.graphics.Bitmap bitmap)

nativeSetCoordinates

protected void nativeSetCoordinates(LatLngQuad latLngQuad)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable