Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.symbology

Class PictureFillSymbol

java.lang.Object
com.esri.arcgisruntime.symbology.Symbol
com.esri.arcgisruntime.symbology.FillSymbol
com.esri.arcgisruntime.symbology.PictureFillSymbol
All Implemented Interfaces:
JsonSerializable, RemoteResource, Loadable
public final class PictureFillSymbol extends FillSymbol implements Loadable, RemoteResource
Uses an image to fill the shape of graphic and feature polygons with a repeating pattern.

Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

A PictureFillSymbol which is a FillSymbol based on an image with given properties:

  • Height - how tall the Symbol is.
  • Width - how wide the Symbol is.
  • Opacity - level of transparency of the Symbol.
  • Angle - rotation of the Symbol. In degrees.
  • Scale - scale of the Symbol in x, y direction.
  • Offset - offset of the Symbol in x, y direction relative to its origin.

PictureFillSymbols symbolize Graphics and Features that have a polygon geometry that uses an image to fill the shape in a repeating pattern. An image or a URI of an image can be used to create a PictureFillSymbol.

Example of how to create a PictureFillSymbol from a URI: 

 GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
 mapView.getGraphicsOverlays().add(graphicsOverlay);

 // creates a picture fill symbol from a URI
 PictureFillSymbol fillSymbol = new PictureFillSymbol(
   "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/FeatureServer/0/images/e82f744ebb069bb35b234b3fea46deae");

 PointCollection pointCollections = new PointCollection(SpatialReferences.getWebMercator());
 pointCollections.add(new Point(-226773, 6450477, SpatialReferences.getWebMercator()));
 pointCollections.add(new Point(-286773, 6550477, SpatialReferences.getWebMercator()));
 pointCollections.add(new Point(-206773, 6650477, SpatialReferences.getWebMercator()));
 Polygon polygon = new Polygon(pointCollections, SpatialReferences.getWebMercator());

 Graphic symbolGraphic = new Graphic(polygon, fillSymbol);
 graphicsOverlay.getGraphics().add(symbolGraphic);
Supported image formats are:
Since:
100.1.0
See Also:

  • Property Details

  • Constructor Details

    • PictureFillSymbol

      public PictureFillSymbol(String uri)
      Creates a picture fill symbol object from an image URL.

      The URI location can be a path to an online resource (http or https) or 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 the uri is null or empty
      Since:
      100.1.0

    • PictureFillSymbol

      public PictureFillSymbol(Image image)
      Creates a picture fill symbol object with the given 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.1.0

  • Method Details

    • setCredential

      public void setCredential(Credential credential)
      Sets the credential used to authenticate access to the PictureFillSymbol's URI.
      Specified by:
      setCredential in interface RemoteResource
      Parameters:
      credential - the credential used to authenticate access to this Symbol's URI
      Since:
      100.1.0

    • getCredential

      public Credential getCredential()
      Gets the credential used to authenticate access to the PictureFillSymbol's URI.

      The default value is null.

      Specified by:
      getCredential in interface RemoteResource
      Returns:
      the credential used to authenticate access to the Symbol's URI
      Since:
      100.1.0

    • setRequestConfiguration

      public void setRequestConfiguration(RequestConfiguration requestConfiguration)
      Sets the configuration parameters used for the network requests sent when using this PictureFillSymbol 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 interface RemoteResource
      Parameters:
      requestConfiguration - object containing the parameters to use
      Since:
      100.1.0

    • getRequestConfiguration

      public RequestConfiguration getRequestConfiguration()
      Gets the RequestConfiguration object in use by this Symbol.

      The default value is null.

      Specified by:
      getRequestConfiguration in interface RemoteResource
      Returns:
      the RequestConfiguration object or null if none has been set
      Since:
      100.1.0

    • getImage

      public Image getImage()
      Gets the image used for the picture fill symbol to fill the polygon geometries.
      Returns:
      the Image object
      Since:
      100.1.0

    • getOffsetX

      public double getOffsetX()
      Gets the horizontal offset of the picture fill symbol.
      Returns:
      the horizontal offset of the picture fill symbol.
      Since:
      200.2.0

    • setOffsetX

      public void setOffsetX(double offsetX)
      Sets the horizontal offset of the picture fill symbol.
      Parameters:
      offsetX - the horizontal offset of the picture fill symbol.
      Since:
      200.2.0

    • getOffsetY

      public double getOffsetY()
      Gets the vertical offset of the picture fill symbol.
      Returns:
      the vertical offset of the picture fill symbol.
      Since:
      200.2.0

    • setOffsetY

      public void setOffsetY(double offsetY)
      Sets the vertical offset of the picture fill symbol.
      Parameters:
      offsetY - the vertical offset of the picture fill symbol.
      Since:
      200.2.0

    • setHeight

      public void setHeight(float height)
      Sets the height of the picture fill symbol in device-independent pixels (DIPs).

      The height of the symbol spanning from the bottom to the top of the image. The default value is 0.0. You can use this property to override the height of the symbol. Note that if you set the setHeight(float) or setWidth(float) to 0.0, then the picture fill symbol will adopt the height and width of the loaded getImage().

      Parameters:
      height - height of the Symbol, must be greater or equal to 0
      Throws:
      IllegalArgumentException - if input is less than 0
      Since:
      100.1.0

    • getHeight

      public float getHeight()
      Gets the height of the picture fill symbol in device-independent pixels (DIPs).

      The height of the symbol spanning from the bottom to the top of the image. The default value is 0.0. You can use this property to override the height of the symbol. Note that if you set the setHeight(float) or setWidth(float) to 0.0, then the picture fill symbol will adopt the height and width of the loaded getImage().

      Returns:
      the height of the symbol
      Since:
      100.1.0
      See Also:

    • setWidth

      public void setWidth(float width)
      Sets the width of the picture fill symbol in device-independent pixels (DIPs).

      The width of the symbol spanning from the left to the right side of the image. The default value is 0.0. You can use this property to override the width of the symbol. Note that if you set the setHeight(float) or setWidth(float) to 0.0, then the picture fill symbol will adopt the height and width of the loaded getImage().

      Parameters:
      width - width of the Symbol, must greater or equal to 0
      Throws:
      IllegalArgumentException - if input is less than 0
      Since:
      100.1.0

    • getWidth

      public float getWidth()
      Gets the width of the picture fill symbol in device-independent pixels (DIPs).

      The width of the symbol spanning from the left to the right side of the image. The default value is 0.0. You can use this property to override the width of the symbol. Note that if you set the setHeight(float) or setWidth(float) to 0.0, then the picture fill symbol will adopt the height and width of the loaded getImage().

      Returns:
      the width of the symbol
      Since:
      100.1.0
      See Also:

    • getUri

      public String getUri()
      The URI of the picture fill symbol.

      The 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. In order to use a PictureFillSymbol from a URL, the symbol must be loaded asynchronously. Any properties that are changed while this symbol is loading will persist once the image has loaded.

      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URI from where this picture is stored if one was used
      Since:
      100.1.0

    • getOpacity

      public float getOpacity()
      Gets the opacity for the picture fill symbol.

      The value ranges from 0.0 (fully transparent) to 1.0 (opaque). The default value is 1.0.

      Returns:
      the opacity of this Symbol
      Since:
      100.1.0

    • setOpacity

      public void setOpacity(float opacity)
      Sets the opacity for the picture fill symbol.

      The value ranges from 0.0 (fully transparent) to 1.0 (opaque). The default value is 1.0.

      Parameters:
      opacity - the new opacity level of this Symbol, must be between 0 and 1.0
      Throws:
      IllegalArgumentException - if the opacity is out of range
      Since:
      100.1.0

    • setAngle

      public void setAngle(double angle)
      Sets the rotation angle of the picture fill symbol in degrees.

      The angle will rotate the symbol about its center relative to north. A positive value rotates the symbol clockwise, a negative value rotates the symbol anti-clockwise. The default value is 0.0.

      Parameters:
      angle - the rotation angle of picture fill symbol in degrees
      Since:
      100.1.0

    • getAngle

      public double getAngle()
      Gets the rotation angle of the picture fill symbol in degrees.

      The angle will rotate the symbol about its center relative to north. A positive value rotates the symbol clockwise, a negative value rotates the symbol anti-clockwise. The default value is 0.0.

      Returns:
      the rotation angle of picture fill symbol in degrees
      Since:
      100.1.0

    • setScaleX

      public void setScaleX(double scaleX)
      Sets the horizontal scaling of the picture fill symbol.

      The default value is 1.0.

      Parameters:
      scaleX - the x scale of the picture fill symbol
      Throws:
      IllegalArgumentException - if the scale is negative
      Since:
      100.1.0

    • getScaleX

      public double getScaleX()
      Gets the horizontal scaling of the picture fill symbol.

      The default value is 1.0.

      Returns:
      the x scale of the picture fill symbol
      Since:
      100.1.0

    • setScaleY

      public void setScaleY(double scaleY)
      Sets the vertical scaling of the picture fill symbol.

      The default value is 1.0.

      Parameters:
      scaleY - the y scale of the picture fill symbol
      Throws:
      IllegalArgumentException - if the scale is negative
      Since:
      100.1.0

    • getScaleY

      public double getScaleY()
      Gets the vertical scaling of the picture fill symbol.

      The default value is 1.0.

      Returns:
      the y scale of the picture fill symbol
      Since:
      100.1.0

    • toMultilayerSymbol

      public MultilayerPolygonSymbol toMultilayerSymbol()
      Converts a PictureFillSymbol to a MultilayerPolygonSymbol with a PictureFillSymbolLayer.

      The resulting MultilayerPolygonSymbol contains a single PictureFillSymbolLayer.

      Returns:
      a MultilayerPolygonSymbol object
      Since:
      100.13.0

    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the loadStatus property.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the value of the loadStatus property
      See Also:

    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the loadError property.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      Returns:
      the value of the loadError property
      See Also:

    • 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(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, add a listener to the Loadable.loadStatusProperty() instead.

      Specified by:
      addDoneLoadingListener in interface Loadable
      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 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

    • loadStatusProperty

      public ReadOnlyObjectProperty<LoadStatus> loadStatusProperty()
      Description copied from interface: Loadable
      The load status.
      Specified by:
      loadStatusProperty in interface Loadable
      Returns:
      the loadStatus property
      See Also:

    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      Returns:
      the loadError property
      See Also: