CameraOptions interface
The options for setting the map control's camera.
- Extends
Properties
| bearing | The bearing of the map (rotation) in degrees.
When the bearing is 0, 90, 180, or 270 the top of the map container will be north, east, south or west respectively.
|
| center | The position to align the center of the map view with.
|
| center |
A pixel offset to apply to the center of the map.
This is useful if you want to programmatically pan the map to another location or if you want to center the map over a shape, then offset the maps view to make room for a popup.
Default |
| max |
A bounding box in which to constrain the viewable map area to.
Users won't be able to pan the center of the map outside of this bounding box.
Set maxBounds to null or undefined to remove maxBounds
Default |
| max |
The maximum pitch that the map can be pitched to during the animation. Must be between 0 and 85, and greater than or equal to |
| max |
The maximum zoom level that the map can be zoomed into during the animation. Must be between 0 and 24, and greater than or equal to |
| min |
The minimum pitch that the map can be pitched to during the animation. Must be between 0 and 85, and less than or equal to |
| min |
The minimum zoom level that the map can be zoomed out to during the animation. Must be between 0 and 24, and less than or equal to |
| pitch | The pitch (tilt) of the map in degrees between 0 and 60, where 0 is looking straight down on the map.
|
| zoom | The zoom level of the map view.
|
Property Details
bearing
The bearing of the map (rotation) in degrees.
When the bearing is 0, 90, 180, or 270 the top of the map container will be north, east, south or west respectively.
default 0
bearing?: numberProperty Value
number
center
The position to align the center of the map view with.
default [0, 0]
center?: PositionProperty Value
centerOffset
A pixel offset to apply to the center of the map.
This is useful if you want to programmatically pan the map to another location or if you want to center the map over a shape, then offset the maps view to make room for a popup.
Default [0, 0].
centerOffset?: PixelProperty Value
maxBounds
A bounding box in which to constrain the viewable map area to.
Users won't be able to pan the center of the map outside of this bounding box.
Set maxBounds to null or undefined to remove maxBounds
Default undefined.
maxBounds?: BoundingBoxProperty Value
maxPitch
The maximum pitch that the map can be pitched to during the animation. Must be between 0 and 85, and greater than or equal to minPitch
Default 60.
maxPitch?: numberProperty Value
number
maxZoom
The maximum zoom level that the map can be zoomed into during the animation. Must be between 0 and 24, and greater than or equal to minZoom.
default 20
maxZoom?: numberProperty Value
number
minPitch
The minimum pitch that the map can be pitched to during the animation. Must be between 0 and 85, and less than or equal to maxPitch.
Default 0.
minPitch?: numberProperty Value
number
minZoom
The minimum zoom level that the map can be zoomed out to during the animation. Must be between 0 and 24, and less than or equal to maxZoom.
Setting minZoom below 1 may result in an empty map when the zoom level is less than 1.
default 1
minZoom?: numberProperty Value
number
pitch
The pitch (tilt) of the map in degrees between 0 and 60, where 0 is looking straight down on the map.
default 0
pitch?: numberProperty Value
number
zoom
The zoom level of the map view.
default 1
zoom?: numberProperty Value
number