Package com.esri.arcgisruntime.symbology

Class 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

    • Constructor Detail

      • PictureMarkerSymbol

        @Deprecated
public PictureMarkerSymbol​(android.graphics.drawable.BitmapDrawable drawable)
        Deprecated.
        As of 100.1.0, replaced by createAsync(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 symbol
        requestConfiguration - 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 interface RemoteResource
        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 interface RemoteResource
        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 interface RemoteResource
        Parameters:
        requestConfiguration - object containing the parameters to use
        Since:
        100.0.0

      • 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 interface RemoteResource
        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 by getImage(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 the LoadStatus of the loadable resource.
        Specified by:
        getLoadStatus in interface Loadable
        Returns:
        the LoadStatus of the loadable resource

      • 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 from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.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 interface Loadable

      • 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 to LoadStatus.LOADING. A listener can be added via Loadable.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 calling Loadable.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) when loadAsync 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 or LoadStatus.FAILED_TO_LOAD state) when loadAsync 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 calling Loadable.cancelLoad().

        Specified by:
        loadAsync in interface Loadable

      • 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 interface Loadable

      • 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 interface Loadable
        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 interface Loadable
        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 a LoadStatusChangedListener 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 interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be added

      • removeLoadStatusChangedListener

        public boolean removeLoadStatusChangedListener​(LoadStatusChangedListener listener)
        Description copied from interface: Loadable
        Removes a LoadStatusChangedListener from the loadable resource.
        Specified by:
        removeLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be removed
        Returns:
        true if the listener was removed, otherwise false