@studiometa/ui

Appearance

Twig API ​

Parameters ​

Required parameter

The access_token parameter is required.

All parameters from the Figure component are inherited.

access_token ​

  • Type: string
  • Default: '<MISSING_ACCESS_TOKEN>'
  • Required

Your Mapbox access token.

username ​

  • Type: string
  • Default: 'mapbox'

The username of the account to which the style belongs.

style_id ​

  • Type: string
  • Default: 'streets-v12'

The ID of the style from which to create a static map.

lon ​

  • Type: number
  • Default: 0

Longitude, a number between -180 and 180.

lat ​

  • Type: number
  • Default: 0

Latitude, a number between -85.0511 and 85.0511.

zoom ​

  • Type: number
  • Default: 0

Zoom level, a number between 0 and 22.

marker ​

  • Type: string

Adds a custom marker. Format: 'url-<URL_TO_IMAGE>(<LON>,<LAT>)'. See https://docs.mapbox.com/api/maps/static-images/#example-request-retrieve-a-static-map-with-a-custom-marker-overlay for more information.

overlay ​

  • Type: object

Adds overlays/markers. Must be a valid geojson object. See https://docs.mapbox.com/api/maps/static-images/#overlay-options for more information.

bearing ​

  • Type: number
  • Default: 0

Rotates the map, a number between 0 and 360.

pitch ​

  • Type: number
  • Default: 0

Pitch tilts the map, between 0 and 60

is_hd ​

  • Type: boolean
  • Default: true

Renders the map at @2x scale.

attribution ​

  • Type: boolean
  • Default: true

Whether there is attribution on the image. When set to false, see https://docs.mapbox.com/help/getting-started/attribution/#static--print.

  • Type: boolean
  • Default: true

Whether there is a Mapbox logo.