Class PictureMarkerSymbol
- java.lang.Object
-
- com.esri.arcgisruntime.symbology.Symbol
-
- com.esri.arcgisruntime.symbology.MarkerSymbol
-
- com.esri.arcgisruntime.symbology.PictureMarkerSymbol
-
- All Implemented Interfaces:
JsonSerializable
,RemoteResource
,Loadable
public final class PictureMarkerSymbol extends MarkerSymbol implements Loadable, RemoteResource
Uses an image to symbolize geoelements that have point or multipoint geometry.Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.
Picture marker symbols can be created from files, URLs or on Android from Drawables.
Picture marker symbols are loadable, since retrieving the image data may require a network request or take time to complete. They are auto-loaded when they are drawn in a MapView.
- Since:
- 100.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.esri.arcgisruntime.symbology.MarkerSymbol
MarkerSymbol.AngleAlignment
-
-
Constructor Summary
Constructors Constructor Description PictureMarkerSymbol(android.graphics.drawable.BitmapDrawable drawable)
Deprecated.As of 100.1.0, replaced bycreateAsync(BitmapDrawable)
.PictureMarkerSymbol(java.lang.String url)
Constructs a PictureMarkerSymbol with a URL to a Drawable image.PictureMarkerSymbol(java.lang.String url, RequestConfiguration requestConfiguration)
Constructs a PictureMarkerSymbol with a URL to a Drawable image and a request configuration.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDoneLoadingListener(java.lang.Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.static ListenableFuture<PictureMarkerSymbol>
createAsync(android.graphics.drawable.BitmapDrawable drawable)
Asynchronously creates a PictureMarkerSymbol from a BitmapDrawable.Credential
getCredential()
Gets the credential used to authenticate access to the picture marker symbol URL.float
getHeight()
Gets the height, in density-independent pixels (dp).android.graphics.drawable.BitmapDrawable
getImage()
Deprecated.As of 100.1.0, replaced bygetImage(Resources)
.android.graphics.drawable.BitmapDrawable
getImage(android.content.res.Resources resources)
Gets the image used to visualize this PictureMarkerSymbol as a BitmapDrawable.ArcGISRuntimeException
getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
of the loadable resource.float
getOpacity()
Gets the opacity.RequestConfiguration
getRequestConfiguration()
Gets the RequestConfiguration object in use by this PictureMarkerSymbol.java.lang.String
getUri()
Returns the URL from which the Drawable can be fetched.float
getWidth()
Gets the width, in density-independent pixels (dp).void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
removeDoneLoadingListener(java.lang.Runnable listener)
Removes a done loading listener from the loadable resource.boolean
removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.void
setCredential(Credential credential)
Sets the credential used to authenticate access to the picture marker symbol URL.void
setHeight(float height)
Sets the height, in density-independent pixels (dp).void
setOpacity(float opacity)
Sets the opacity as a value between 0.0 and 1.0.void
setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets configuration parameters used for network requests sent using this PictureMarkerSymbol object.void
setWidth(float width)
Sets the width, in density-independent pixels (dp).MultilayerPointSymbol
toMultilayerSymbol()
Get Multilayer point symbol generated from picture marker symbol.-
Methods inherited from class com.esri.arcgisruntime.symbology.MarkerSymbol
getAngle, getAngleAlignment, getLeaderOffsetX, getLeaderOffsetY, getOffsetX, getOffsetY, getRotationType, setAngle, setAngleAlignment, setLeaderOffsetX, setLeaderOffsetY, setOffsetX, setOffsetY, setRotationType
-
Methods inherited from class com.esri.arcgisruntime.symbology.Symbol
createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, fromJson, getUnknownJson, getUnsupportedJson, toJson
-
-
-
-
Constructor Detail
-
PictureMarkerSymbol
@Deprecated public PictureMarkerSymbol(android.graphics.drawable.BitmapDrawable drawable)
Deprecated.As of 100.1.0, replaced bycreateAsync(BitmapDrawable)
.Instantiates a PictureMarkerSymbol with a BitmapDrawable image. The PictureMarkerSymbol will inherit the alpha property from the BitmapDrawable in cases where it is set prior to instantiation.- Parameters:
drawable
- drawable to be used for the symbol.- Throws:
java.lang.IllegalArgumentException
- if the drawable is null- Since:
- 100.0.0
-
PictureMarkerSymbol
public PictureMarkerSymbol(java.lang.String url)
Constructs a PictureMarkerSymbol with a URL to a Drawable image.Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.
- Parameters:
url
- url to be used for the symbol.- Throws:
java.lang.IllegalArgumentException
- if the url is null or empty- Since:
- 100.0.0
-
PictureMarkerSymbol
public PictureMarkerSymbol(java.lang.String url, RequestConfiguration requestConfiguration)
Constructs a PictureMarkerSymbol with a URL to a Drawable image and a request configuration.Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.
- Parameters:
url
- Url of the image to be used for the symbolrequestConfiguration
- configuration to be used for HTTP/HTTPS requests. If null, the global configuration is used- Throws:
java.lang.IllegalArgumentException
- if the url is null or empty- Since:
- 100.0.0
-
-
Method Detail
-
createAsync
public static ListenableFuture<PictureMarkerSymbol> createAsync(android.graphics.drawable.BitmapDrawable drawable)
Asynchronously creates a PictureMarkerSymbol from a BitmapDrawable. The PictureMarkerSymbol will inherit the alpha property from the BitmapDrawable in cases where it is set prior to instantiation.- Parameters:
drawable
- drawable to be used for the symbol- Returns:
- a ListenableFuture that provides a PictureMarkerSymbol upon successful completion of the async operation
- Throws:
java.lang.IllegalArgumentException
- if drawable is null- Since:
- 100.1.0
-
setCredential
public void setCredential(Credential credential)
Sets the credential used to authenticate access to the picture marker symbol URL.- Specified by:
setCredential
in interfaceRemoteResource
- Parameters:
credential
- the credential used to authenticate access to the picture marker symbol URL- Since:
- 100.0.0
-
getCredential
public Credential getCredential()
Gets the credential used to authenticate access to the picture marker symbol URL.- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the credential used to authenticate access to the picture marker symbol URL
- Since:
- 100.0.0
-
setRequestConfiguration
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets configuration parameters used for network requests sent using this PictureMarkerSymbol object. The global RequestConfiguration is used if no RequestConfiguration is set.- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- object containing the parameters to use- Since:
- 100.0.0
-
getRequestConfiguration
public RequestConfiguration getRequestConfiguration()
Gets the RequestConfiguration object in use by this PictureMarkerSymbol.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the RequestConfiguration object or null if none has been set
- Since:
- 100.0.0
- See Also:
RequestConfiguration
-
setHeight
public void setHeight(float height)
Sets the height, in density-independent pixels (dp).- Parameters:
height
- The height in dp- Throws:
java.lang.IllegalArgumentException
- if input is less than 0- Since:
- 100.0.0
-
getHeight
public float getHeight()
Gets the height, in density-independent pixels (dp).- Returns:
- the height in dp
- Since:
- 100.0.0
-
setWidth
public void setWidth(float width)
Sets the width, in density-independent pixels (dp).- Parameters:
width
- the width in dp- Throws:
java.lang.IllegalArgumentException
- if input is less than 0- Since:
- 100.0.0
-
getWidth
public float getWidth()
Gets the width, in density-independent pixels (dp).- Returns:
- the width in dp
- Since:
- 100.0.0
-
getUri
public java.lang.String getUri()
Returns the URL from which the Drawable can be fetched. This URL is only set when it is constructed with a URL.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of this RemoteResource
- Since:
- 100.0.0
-
getOpacity
public float getOpacity()
Gets the opacity.- Returns:
- the opacity
- Since:
- 100.0.0
-
setOpacity
public void setOpacity(float opacity)
Sets the opacity as a value between 0.0 and 1.0. 1.0 is fully opaque and 0.0 is fully transparent. The default is 1.0.- Parameters:
opacity
- the new opacity- Throws:
java.lang.IllegalArgumentException
- if the opacity is out of range- Since:
- 100.0.0
-
getImage
public android.graphics.drawable.BitmapDrawable getImage()
Deprecated.As of 100.1.0, replaced bygetImage(Resources)
.Gets the image used to visualize this PictureMarkerSymbol as a BitmapDrawable.- Returns:
- the image as a BitmapDrawable
- Since:
- 100.0.0
-
getImage
public android.graphics.drawable.BitmapDrawable getImage(android.content.res.Resources resources)
Gets the image used to visualize this PictureMarkerSymbol as a BitmapDrawable.- Parameters:
resources
- the application Resources object- Returns:
- the image as a BitmapDrawable
- Since:
- 100.1.0
-
toMultilayerSymbol
public MultilayerPointSymbol toMultilayerSymbol()
Get Multilayer point symbol generated from picture marker symbol.Given a picture marker symbol, this method will return a MultilayerPointSymbol with a PictureMarkerSymbolLayer.
- Returns:
- a
MultilayerPointSymbol
object - Since:
- 100.13.0
-
getLoadStatus
public LoadStatus getLoadStatus()
Description copied from interface:Loadable
Returns theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- Returns:
- the LoadStatus of the loadable resource
-
getLoadError
public ArcGISRuntimeException getLoadError()
Description copied from interface:Loadable
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- Returns:
- the most recent error that was encountered when the loadable resource transitioned to the
LoadStatus.FAILED_TO_LOAD
state.
-
cancelLoad
public void cancelLoad()
Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.getLoadError()
.Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.
This method does nothing if the resource is not in
LoadStatus.LOADING
state.- Specified by:
cancelLoad
in interfaceLoadable
-
loadAsync
public void loadAsync()
Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.Runnable)
that is invoked upon completion of the asynchronous load operation.If the load operation completes successfully, the load status will be
LoadStatus.LOADED
, which means the resource has loaded its metadata.If the load operation failed, the load status will be
LoadStatus.FAILED_TO_LOAD
and the error can be retrieved by callingLoadable.getLoadError()
.This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (
LoadStatus.LOADING
state) whenloadAsync
is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
is called, the done loading listener is immediately invoked when added to the loadable resource.If a loadable resource has failed to load, calling
loadAsync
on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
.
-
retryLoadAsync
public void retryLoadAsync()
Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
addDoneLoadingListener
public void addDoneLoadingListener(java.lang.Runnable listener)
Description copied from interface:Loadable
Adds a listener to the loadable resource that is invoked when loading has completed.The listener may be added at any point, whether the loadable resource has already completed loading or not.
- For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.
Alternatively, to be notified when there is any change in the load status, use the
Loadable.addLoadStatusChangedListener(LoadStatusChangedListener)
method instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
public boolean removeDoneLoadingListener(java.lang.Runnable listener)
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
-