Class: Aws::GeoMaps::Types::GetStaticMapRequest

Inherits:

Struct

• Object
• Struct
• Aws::GeoMaps::Types::GetStaticMapRequest

Includes:

Structure

Defined in:

lib/aws-sdk-geomaps/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:key]

Instance Attribute Summary

• #bounded_positions ⇒ String

  Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma.

• #bounding_box ⇒ String

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

• #center ⇒ String

  Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image.

• #compact_overlay ⇒ String

  Takes in a string to draw geometries on the image.

• #file_name ⇒ String

  The map scaling parameter to size the image, icons, and labels.

• #geo_json_overlay ⇒ String

  Takes in a string to draw geometries on the image.

• #height ⇒ Integer

  Specifies the height of the map image.

• #key ⇒ String

  Optional: The API key to be used for authorization.

• #padding ⇒ Integer

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

• #radius ⇒ Integer

  Used with center parameter, it specifies the zoom of the image where you can control it on a granular level.

• #scale_bar_unit ⇒ String

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

• #style ⇒ String

  Style specifies the desired map style for the ‘Style` APIs.

• #width ⇒ Integer

  Specifies the width of the map image.

• #zoom ⇒ Float

  Specifies the zoom level of the map image.

Instance Attribute Details

#bounded_positions ⇒ String

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.

<note markdown=“1”> Cannot be used with ‘Zoom` and or `Radius`

</note>

Example: 97.170451,78.039098,99.045536,27.176178

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#bounding_box ⇒ 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.

Example: -123.17075,49.26959,-123.08125,49.31429

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#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.

<note markdown=“1”> Cannot be used with ‘Zoom` and or `Radius`

</note>

Example: 49.295,-123.108

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#compact_overlay ⇒ String

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

Example: ‘line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B`

<note markdown=“1”> Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#file_name ⇒ String

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

Example: ‘map, map@2x`

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#geo_json_overlay ⇒ String

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

Example: ‘[{“type”:“Feature”,“geometry”:{“type”:“MultiPoint”,“coordinates”: [[-90.076345,51.504107],],“properties”: Aws::GeoMaps::Types::GetStaticMapRequest.“color”:““color”:“#00DD00”}]}`

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#height ⇒ Integer

Specifies the height of the map image.

Returns:

• (Integer)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#padding ⇒ Integer

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

<note markdown=“1”> Value for max and min is determined by:

Min: `1`

Max: `min(height, width)/4`

</note>

Example: ‘100`

Returns:

• (Integer)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#radius ⇒ Integer

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`.

Example: ‘1500`

<note markdown=“1”> Cannot be used with ‘Zoom`.

</note>

Unit: ‘Meters`

Returns:

• (Integer)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#scale_bar_unit ⇒ String

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

Example: ‘KilometersMiles, Miles, Kilometers, MilesKilometers`

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#style ⇒ String

Style specifies the desired map style for the ‘Style` APIs.

Returns:

• (String)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#width ⇒ Integer

Specifies the width of the map image.

Returns:

• (Integer)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end

#zoom ⇒ Float

Specifies the zoom level of the map image.

<note markdown=“1”> Cannot be used with ‘Radius`.

</note>

Returns:

• (Float)

# File 'lib/aws-sdk-geomaps/types.rb', line 442

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :compact_overlay,
  :geo_json_overlay,
  :height,
  :key,
  :padding,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:key]
  include Aws::Structure
end