Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapRequestOptions

A data type that represents the configuration options for an API map request.

Hierarchy

  • MapRequestOptions

Index

Properties

Optional bounds

bounds: GeoBounds

Coordinate bounds defining the visible region.

Optional format

format: string

Output format, e.g. png or jpg.

Optional layers

layers: string[] | LayerGroups

Layer groups.

Optional metric

metric: boolean

Whether text values should be output in Metric units.

Optional offset

offset: string

Time offset for the map data.

Optional p

p: string

Location the map will be centered on.

Optional size

size: { height: number; width: number }

Output image size.

Type declaration

  • height: number
  • width: number

Optional type

Type of map request, which determines the request URL format.

Optional zoom

zoom: number

Zoom level.

Generated using TypeDoc