Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapConfigOptions

A data type that represents the configuration options a map configuration instance.

Hierarchy

  • MapConfigOptions

Index

Properties

Optional autoFuture

autoFuture: boolean

Whether corresponding future layers should automatically be added to the map when adding a data layer when available. Default is true.

Optional bounds

bounds: GeoBounds

Coordinate bounds of the visible region.

Optional center

center: string | Coordinate

Center of the map, either as a place string or coordinate object.

Optional combined

combined: boolean

Whether all layers should be combined together into a single image. This results in fewer requests but increased map units since base and overlay layers will be requested each time data and/or text layers change.

Default value is false.

Optional date

date: Date | number

Date and time either as a Date object or UNIX timestamp as a number (e.g. 20180601174100).

Optional layers

Defines the layers to display on the map grouped by category.

Optional metric

metric: boolean

Whether text layers should display values in Metric units. Default is false.

Optional offset

offset: string

Time offset either as a UNIX timestamp as a string (e.g. 20180601174100) or a relative offset as a string (e.g. -6hours).

Optional size

size: { factor?: number; height?: number | "auto"; width?: number }

Map size.

Type declaration

  • Optional factor?: number

    Aspect ratio of width-to-height. This value is used when calculating an auto height based on the configured width.

  • Optional height?: number | "auto"

    Image height, which can either be a number or auto. If auto is used, then the image height will be determined by the configured width and the value for factor.

  • Optional width?: number

    Image width

Optional zoom

zoom: number

Zoom level.

Generated using TypeDoc