aws_sdk_geomaps::operation::get_static_map

Struct GetStaticMapInput

#[non_exhaustive]
pub struct GetStaticMapInput {Show 20 fields
    pub bounding_box: Option<String>,
    pub bounded_positions: Option<String>,
    pub center: Option<String>,
    pub color_scheme: Option<ColorScheme>,
    pub compact_overlay: Option<String>,
    pub crop_labels: Option<bool>,
    pub geo_json_overlay: Option<String>,
    pub height: Option<i32>,
    pub key: Option<String>,
    pub label_size: Option<LabelSize>,
    pub language: Option<String>,
    pub padding: Option<i32>,
    pub political_view: Option<String>,
    pub points_of_interests: Option<MapFeatureMode>,
    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)§

This struct is marked as 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

§color_scheme: Option<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.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

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

§crop_labels: Option<bool>

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.

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

§label_size: Option<LabelSize>

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

§language: Option<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.

Supported codes:

ar
as
az
be
bg
bn
bs
ca
cs
cy
da
de
el
en
es
et
eu
fi
fo
fr
ga
gl
gn
gu
he
hi
hr
hu
hy
id
is
it
ja
ka
kk
km
kn
ko
ky
lt
lv
mk
ml
mr
ms
mt
my
nl
no
or
pa
pl
pt
ro
ru
sk
sl
sq
sr
sv
ta
te
th
tr
uk
uz
vi
zh

§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

§political_view: Option<String>

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

The following political views are currently supported:

ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands
EGY: Egypt's view on Bir Tawil
IND: India's view on Gilgit-Baltistan
KEN: Kenya's view on the Ilemi Triangle
MAR: Morocco's view on Western Sahara
RUS: Russia's view on Crimea
SDN: Sudan's view on the Halaib Triangle
SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters
SYR: Syria's view on the Golan Heights
TUR: Turkey's view on Cyprus and Northern Cyprus
TZA: Tanzania's view on Lake Malawi
URY: Uruguay's view on Rincon de Artigas
VNM: Vietnam's view on the Paracel Islands and Spratly Islands

§points_of_interests: Option<MapFeatureMode>

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

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

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

Struct GetStaticMapInput Copy item path

Fields (Non-exhaustive)§

Implementations§

impl GetStaticMapInput

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

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

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

pub fn color_scheme(&self) -> Option<&ColorScheme>

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

pub fn crop_labels(&self) -> Option<bool>

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

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

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

pub fn label_size(&self) -> Option<&LabelSize>

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

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

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

pub fn points_of_interests(&self) -> Option<&MapFeatureMode>

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

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

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

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

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

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

impl GetStaticMapInput

pub fn builder() -> GetStaticMapInputBuilder

Trait Implementations§

impl Clone for GetStaticMapInput

fn clone(&self) -> GetStaticMapInput

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

impl Debug for GetStaticMapInput

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

impl PartialEq for GetStaticMapInput

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

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

impl StructuralPartialEq for GetStaticMapInput

Auto Trait Implementations§

impl Freeze for GetStaticMapInput

impl RefUnwindSafe for GetStaticMapInput

impl Send for GetStaticMapInput

impl Sync for GetStaticMapInput

impl Unpin for GetStaticMapInput

impl UnwindSafe for GetStaticMapInput

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

impl<T> Paint for Twhere T: ?Sized,

fn fg(&self, value: Color) -> Painted<&T>

§Example

fn primary(&self) -> Painted<&T>

§Example

fn fixed(&self, color: u8) -> Painted<&T>

§Example

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

§Example

fn black(&self) -> Painted<&T>

§Example

fn red(&self) -> Painted<&T>

§Example

fn green(&self) -> Painted<&T>

§Example

fn yellow(&self) -> Painted<&T>

Struct GetStaticMapInput

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,