geomaps/aws.sdk.kotlin.services.geomaps.model/GetStaticMapRequest/Builder

Builder

Properties

Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

boundingBox

var boundingBox: String?

Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

center

var center: String?

Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

colorScheme

var colorScheme: ColorScheme?

Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

compactOverlay

var compactOverlay: String?

Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

cropLabels

var cropLabels: Boolean?

It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

fileName

var fileName: String?

The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

geoJsonOverlay

var geoJsonOverlay: String?

Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

height

var height: Int?

Specifies the height of the map image.

key

var key: String?

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

labelSize

var labelSize: LabelSize?

Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

language

var language: String?

Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language.

padding

var padding: Int?

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

pointsOfInterests

var pointsOfInterests: MapFeatureMode?

Determines if the result image will display icons representing points of interest on the map.

politicalView

var politicalView: String?

Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

radius

var radius: Long?

Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

scaleBarUnit

var scaleBarUnit: ScaleBarUnit?

Displays a scale on the bottom right of the map image with the unit specified in the input.

style

var style: StaticMapStyle?

Style specifies the desired map style.

width

var width: Int?

Specifies the width of the map image.

zoom

var zoom: Float?

Specifies the zoom level of the map image.