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.
Defines a PictureMarkerSymbol which is a MarkerSymbol based on an image with given properties:
- Height, how tall the Symbol.
- Width, how wide the Symbol is.
- Opacity, level of transparency of the Symbol.
PictureMarkerSymbols symbolize Graphics and Features that have a Point or Multipoint geometry that uses an image for the shape of the Symbol. An image or a URI of an image can be used to create a PictureMarkerSymbol.
A URI is the address location of where the image is being stored. This address can come from an online source or from a locally stored location.
Example of how to create a PictureMarkerSymbol from a URL:
ArcGISMap map = new ArcGISMap(Basemap.createTopographic()); MapView mapView = new MapView(); mapView.setMap(map); GraphicsOverlay graphicsOverlay = new GraphicsOverlay(); mapView.getGraphicsOverlays().add(graphicsOverlay); // creates a picture marker symbol from a URL PictureMarkerSymbol markerSymbol = new PictureMarkerSymbol( "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/FeatureServer/0/images/e82f744ebb069bb35b234b3fea46deae"); markerSymbol.loadAsync(); Point point = new Point(-226773, 6550477, SpatialReferences.getWebMercator()); Graphic symbolGraphic = new Graphic(point, markerSymbol); // need to wait for the symbol to be done loading before applying to graphics overlay markerSymbol.addDoneLoadingListener(() -> graphicsOverlay.getGraphics().add(symbolGraphic));
In order to use a PictureMarkerSymbol from a URL the Symbol must be loaded asynchronously and the Symbol must be loaded before adding it to a GraphicsOverlay. Any properties that are changed while this symbol is loading will persist once the image has loaded.
Supported image formats are:
- Since:
- 100.0.0
- See Also:
Graphic
,Feature
,GraphicsOverlay
,Image
,MarkerSymbol
,Symbol
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.esri.arcgisruntime.symbology.MarkerSymbol
MarkerSymbol.AngleAlignment
-
-
Constructor Summary
Constructors Constructor Description PictureMarkerSymbol(String uri)
Creates a PictureMarkerSymbol using a URI path to an image.PictureMarkerSymbol(String uri, RequestConfiguration requestConfiguration)
Creates a PictureMarkerSymbol using a URI to an image using a request configuration.PictureMarkerSymbol(Image image)
Creates a PictureMarkerSymbol using an image.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(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.Credential
getCredential()
Gets the credential used to authenticate access to the PictureMarkerSymbol's URL.float
getHeight()
Gets the length of the Symbol spanning from the bottom to the top side of the image.Image
getImage()
Gets the Image used to visualize this PictureMarkerSymbol.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 level of transparency for this Symbol.RequestConfiguration
getRequestConfiguration()
Gets the RequestConfiguration object in use by this Symbol.String
getUri()
Fetches the URL location of the image used for this Symbol.float
getWidth()
Gets the length of the Symbol spanning from the left to the right side of the image.void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
removeDoneLoadingListener(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 PictureMarkerSymbol's URL.void
setHeight(float height)
Sets the length of the Symbol spanning from the bottom to the top side of the image.void
setOpacity(float opacity)
Sets the level of transparency for this symbol.void
setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets the configuration parameters used for the network requests sent when using this PictureMarkerSymbol object.void
setWidth(float width)
Sets the length of the Symbol spanning from the left to the right side of the image.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, createSwatchAsync, fromJson, getUnknownJson, getUnsupportedJson, toJson
-
-
-
-
Constructor Detail
-
PictureMarkerSymbol
public PictureMarkerSymbol(String uri)
Creates a PictureMarkerSymbol using a URI path to an image.The URI location can be a path to an online resource (http or https) or a location to a local file.
Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.
- Parameters:
uri
- URI location of the image, not null- Throws:
IllegalArgumentException
- if input is null or empty- Since:
- 100.0.0
-
PictureMarkerSymbol
public PictureMarkerSymbol(String uri, RequestConfiguration requestConfiguration)
Creates a PictureMarkerSymbol using a URI to an image using a request configuration.The URI location can be a path to an online resource (http or https), or a location to a local file.
The request configuration is to be used for http/https requests and a default configuration will be used if the one passed is null.
- Parameters:
uri
- URI location of the picture, not nullrequestConfiguration
- configuration to be used- Throws:
IllegalArgumentException
- if any of the input is null- Since:
- 100.0.0
-
PictureMarkerSymbol
public PictureMarkerSymbol(Image image)
Creates a PictureMarkerSymbol using an image.Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.
- Parameters:
image
- an image to used for this Symbol, not null- Throws:
IllegalArgumentException
- if image is null- Since:
- 100.0.0
-
-
Method Detail
-
setCredential
public void setCredential(Credential credential)
Sets the credential used to authenticate access to the PictureMarkerSymbol's URL.A credential makes sure that the person trying to access the Symbol's URL has permission to do so.
- Specified by:
setCredential
in interfaceRemoteResource
- Parameters:
credential
- the credential used to authenticate access to this Symbol's URL- Since:
- 100.0.0
-
getCredential
public Credential getCredential()
Gets the credential used to authenticate access to the PictureMarkerSymbol's URL.The default value is null.
- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the credential used to authenticate access to the Symbol's URL
- Since:
- 100.0.0
- See Also:
setCredential(com.esri.arcgisruntime.security.Credential)
-
setRequestConfiguration
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets the configuration parameters used for the network requests sent when using this PictureMarkerSymbol object. The global RequestConfiguration is used if no RequestConfiguration is set which contains the default values from the getter/setter methods.- 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 Symbol.The default value is null.
- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the RequestConfiguration object or null if none has been set
- Since:
- 100.0.0
- See Also:
setRequestConfiguration(com.esri.arcgisruntime.io.RequestConfiguration)
-
getImage
public Image getImage()
Gets the Image used to visualize this PictureMarkerSymbol.- Returns:
- the Image
- Since:
- 100.0.0
-
setHeight
public void setHeight(float height)
Sets the length of the Symbol spanning from the bottom to the top side of the image.When setting the height, if width is set to 0.0 then no effect will take place. This will cause the image to be displayed at it's default size.
- Parameters:
height
- height of the Symbol, must be greater or equal to 0.0- Throws:
IllegalArgumentException
- if input is less than 0.0- Since:
- 100.0.0
-
getHeight
public float getHeight()
Gets the length of the Symbol spanning from the bottom to the top side of the image.The default value is 0.0.
- Returns:
- the height of the symbol
- Since:
- 100.0.0
- See Also:
setHeight(float)
-
setWidth
public void setWidth(float width)
Sets the length of the Symbol spanning from the left to the right side of the image.When setting the width, if height is set to 0.0 then no effect will take place. This will cause the image to be displayed at it's default size.
- Parameters:
width
- width of the Symbol, must greater or equal to 0.0- Throws:
IllegalArgumentException
- if input is less than 0.0- Since:
- 100.0.0
-
getWidth
public float getWidth()
Gets the length of the Symbol spanning from the left to the right side of the image.The default value is 0.0.
- Returns:
- the width of the symbol
- Since:
- 100.0.0
- See Also:
setWidth(float)
-
getUri
public String getUri()
Fetches the URL location of the image used for this Symbol. Will only fetch a URL if one was used to create this symbol.Default value is null.
- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URL from where this picture is stored if one was used
- Since:
- 100.0.0
-
getOpacity
public float getOpacity()
Gets the level of transparency for this Symbol.Default value is 1.0.
- Returns:
- the opacity of this Symbol
- Since:
- 100.0.0
- See Also:
setOpacity(float)
-
setOpacity
public void setOpacity(float opacity)
Sets the level of transparency for this symbol.The value ranges from 0.0 (fully transparent) to 1.0 (opaque) with the default value being 1.0.
- Parameters:
opacity
- the new opacity level of this Symbol, must be between 0.0 and 1.0- Throws:
IllegalArgumentException
- if the opacity is out of range- Since:
- 100.0.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(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(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
-
-