Struct GetStaticMapInput

#[non_exhaustive]
pub struct GetStaticMapInput {

    pub bounding_box: Option<String>,
    pub bounded_positions: Option<String>,
    pub center: Option<String>,
    pub compact_overlay: Option<String>,
    pub geo_json_overlay: Option<String>,
    pub height: Option<i32>,
    pub key: Option<String>,
    pub padding: Option<i32>,
    pub radius: Option<i64>,
    pub file_name: Option<String>,
    pub scale_bar_unit: Option<ScaleBarUnit>,
    pub style: Option<StaticMapStyle>,
    pub width: Option<i32>,
    pub zoom: Option<f32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bounding_box: Option<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

bounded_positions: Option<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.

Cannot be used with Zoom and or Radius

Example: 97.170451,78.039098,99.045536,27.176178

center: Option<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.

Cannot be used with Zoom and or Radius

Example: 49.295,-123.108

compact_overlay: Option<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

Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

geo_json_overlay: Option<String>

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

Example: {"type":"FeatureCollection","features": \[{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": \[\[-90.076345,51.504107\],\[-0.074451,51.506892\]\]},"properties": {"color":"#00DD00"}}\]}

height: Option<i32>

Specifies the height of the map image.

key: Option<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.

padding: Option<i32>

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

Value for max and min is determined by:

Min: 1

Max: min(height, width)/4

Example: 100

radius: Option<i64>

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

Cannot be used with Zoom.

Unit: Meters

file_name: Option<String>

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

Example: map, map@2x

scale_bar_unit: Option<ScaleBarUnit>

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

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

style: Option<StaticMapStyle>

Style specifies the desired map style for the Style APIs.

width: Option<i32>

Specifies the width of the map image.

zoom: Option<f32>

Specifies the zoom level of the map image.

Cannot be used with Radius.

Implementations

impl GetStaticMapInput

pub fn bounding_box(&self) -> Option<&str>

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

pub fn bounded_positions(&self) -> Option<&str>

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.

Cannot be used with Zoom and or Radius

Example: 97.170451,78.039098,99.045536,27.176178

pub fn center(&self) -> Option<&str>

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.

Cannot be used with Zoom and or Radius

Example: 49.295,-123.108

pub fn compact_overlay(&self) -> Option<&str>

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

Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

pub fn geo_json_overlay(&self) -> Option<&str>

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

Example: {"type":"FeatureCollection","features": \[{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": \[\[-90.076345,51.504107\],\[-0.074451,51.506892\]\]},"properties": {"color":"#00DD00"}}\]}

pub fn height(&self) -> Option<i32>

Specifies the height of the map image.

pub fn key(&self) -> Option<&str>

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

pub fn padding(&self) -> Option<i32>

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

Value for max and min is determined by:

Min: 1

Max: min(height, width)/4

Example: 100

pub fn radius(&self) -> Option<i64>

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

Cannot be used with Zoom.

Unit: Meters

pub fn file_name(&self) -> Option<&str>

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

Example: map, map@2x

pub fn scale_bar_unit(&self) -> Option<&ScaleBarUnit>

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

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

pub fn style(&self) -> Option<&StaticMapStyle>

Style specifies the desired map style for the Style APIs.

pub fn width(&self) -> Option<i32>

Specifies the width of the map image.

pub fn zoom(&self) -> Option<f32>

Specifies the zoom level of the map image.

Cannot be used with Radius.

impl GetStaticMapInput

pub fn builder() -> GetStaticMapInputBuilder

Creates a new builder-style object to manufacture GetStaticMapInput.

Trait Implementations

impl Clone for GetStaticMapInput

fn clone(&self) -> GetStaticMapInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetStaticMapInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetStaticMapInput

fn eq(&self, other: &GetStaticMapInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetStaticMapInput