Package com.cercalia.sdk.model.staticmaps

Class StaticMapOptions

java.lang.Object
com.cercalia.sdk.model.staticmaps.StaticMapOptions
public final class StaticMapOptions extends Object
Options for generating a static map.

Example usage:


 StaticMapOptions options = StaticMapOptions.builder()
     .dimensions(800, 600)
     .center(new Coordinate(2.1734, 41.3851))
     .addMarker(StaticMapMarker.builder().coordinate(new Coordinate(2.1734, 41.3851)).build())
     .returnImage(true)
     .build();

  • Method Details

    • getWidth

      @Nullable public @Nullable Integer getWidth()
      Returns:
      Width of the image.

    • getHeight

      @Nullable public @Nullable Integer getHeight()
      Returns:
      Height of the image.

    • getCityName

      @Nullable public @Nullable String getCityName()
      Returns:
      Locality (city) name to center the map on.

    • getCountryCode

      @Nullable public @Nullable String getCountryCode()
      Returns:
      Country code.

    • getCoordinateSystem

      @Nullable public @Nullable String getCoordinateSystem()
      Returns:
      Coordinate system (SRS).

    • getExtent

      @Nullable public @Nullable StaticMapExtent getExtent()
      Returns:
      Map extent.

    • getCenter

      @Nullable public @Nullable Coordinate getCenter()
      Returns:
      Center coordinate.

    • getLabelOp

      @Nullable public @Nullable Integer getLabelOp()
      Returns:
      Label option.

    • getMarkers

      @NotNull public @NotNull List<StaticMapMarker> getMarkers()
      Returns:
      List of markers to show on the map.

    • getShapes

      @NotNull public @NotNull List<StaticMapShape> getShapes()
      Returns:
      List of shapes to show on the map.

    • isReturnImage

      public boolean isReturnImage()
      Returns:
      Whether to return the raw image data.

    • getMode

      public int getMode()
      Returns:
      Map mode (default is 1).

    • isPriorityfilter

      public boolean isPriorityfilter()
      Returns:
      Whether priority filter is enabled (default is true).

    • builder

      @NotNull public static @NotNull StaticMapOptions.Builder builder()
      Returns:
      a new builder for StaticMapOptions.