camera
Convenience method that returns the CameraOptions object for given parameters. This method takes into account the current map padding in addition to the padding provided in parameters.
Return
The CameraOptions object representing the provided parameters. Padding is absent in the returned CameraOptions as the zoom level already accounts for the padding.
Parameters
The coordinates representing the bounds of the camera.
The amount of padding in pixels to add to the given coordinates.
The bearing of the camera.
The pitch of the camera.
Convenience method that adjusts the provided CameraOptions object for given parameters.
Returns the provided camera options with zoom adjusted to fit coordinates into the box, so that coordinates on the left, top, right, and bottom of the effective camera center at the principal point of the projection (defined by padding) fit into the box. Returns the provided camera options object unchanged upon an error.
The method fails if the principal point is positioned outside of the box or if there is no sufficient screen space, defined by principal point and the box, to fit the geometry. Additionally, in cases when the principal point is positioned exactly on one of the edges of the box, any geometry point that spans further than that edge on the same axis cannot possibly be framed and is ignored for zoom level calculation purposes.
This API isn't supported by Globe projection.
Return
The CameraOptions object with the zoom level adjusted to fit coordinates into the box.
Parameters
The coordinates representing the bounds of the camera.
The CameraOptions for which zoom should be adjusted. Note that the camera.center, and camera.zoom (as fallback) is required.
The screen box into which coordinates should fit.
Convenience method that returns the CameraOptions object for given parameters.
Return
The CameraOptions object representing the provided parameters. Padding is absent in the returned CameraOptions as the zoom level already accounts for the padding.
Parameters
The coordinates representing the bounds of the camera.
The CameraOptions which will be applied before calculating the camera for the coordinates. If any of the fields in CameraOptions are not provided then the current value from the map for that field will be used.
The amount of padding in pixels to add to the given coordinates. Note: This padding is not applied to the map but to the coordinates provided. If you want to apply padding to the map use param camera.
The maximum zoom level allowed in the returned camera options.
The center of the given bounds relative to map center in pixels.
Note: if the render thread did not yet calculate the size of the map - current cameraState will be returned.