On this page
Interface MapOptions
interface MapOptions {
apiKey?: string;
basemap?: ReferenceMapStyle;
bearing?: number;
center?: LngLatLike;
container: string | HTMLElement;
logoControl?: ControlPosition;
maxPitch?: number;
maxZoom?: number;
minPitch?: number;
minZoom?: number;
modelResolutionControl?: boolean | ControlPosition;
navigationControl?: boolean | ControlPosition;
pitch?: number;
zoom?: number;
}
apiKey?: string;
basemap?: ReferenceMapStyle;
bearing?: number;
center?: LngLatLike;
container: string | HTMLElement;
logoControl?: ControlPosition;
maxPitch?: number;
maxZoom?: number;
minPitch?: number;
minZoom?: number;
modelResolutionControl?: boolean | ControlPosition;
navigationControl?: boolean | ControlPosition;
pitch?: number;
zoom?: number;
}
Properties
OptionalapiKey
apiKey?: string
Your MapTiler Cloud API key. Get one for free at https://maptiler.com/cloud/
Optionalbasemap
The base map style to use.
Optionalbearing
bearing?: number
The initial bearing (rotation) in degrees.
Optionalcenter
The initial center position of the map.
container
container: string | HTMLElement
The HTML element or ID of the container where the map will be rendered.
OptionallogoControl
Where to show MapTiler logo
OptionalmaxPitch
maxPitch?: number
The maximum pitch (tilt) allowed.
OptionalmaxZoom
maxZoom?: number
The maximum zoom level allowed.
OptionalminPitch
minPitch?: number
The minimum pitch (tilt) allowed.
OptionalminZoom
minZoom?: number
The minimum zoom level allowed.
OptionalmodelResolutionControl
Whether to show the detail control.
OptionalnavigationControl
Whether to show navigation controls (zoom, compass).
Optionalpitch
pitch?: number
The initial pitch (tilt) in degrees.
Optionalzoom
zoom?: number
The initial zoom level.
Options for initializing a Map instance.