For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Interface ICameraHelper
interface ICameraHelper {
get useGlobeControls(): boolean;
cameraForBoxAndBearing(
options: CameraForBoundsOptions,
padding: PaddingOptions,
bounds: LngLatBounds,
bearing: number,
tr: IReadonlyTransform,
): CameraForBoxAndBearingHandlerResult;
handleEaseTo(
tr: ITransform,
options: EaseToHandlerOptions,
): EaseToHandlerResult;
handleFlyTo(
tr: ITransform,
options: FlyToHandlerOptions,
): FlyToHandlerResult;
handleJumpToCenterZoom(
tr: ITransform,
options: { center?: LngLatLike; zoom?: number },
): void;
handleMapControlsPan(
deltas: MapControlsDeltas,
tr: ITransform,
preZoomAroundLoc: LngLat,
): void;
handleMapControlsRollPitchBearingZoom(
deltas: MapControlsDeltas,
tr: ITransform,
): void;
handlePanInertia(
pan: Point,
transform: IReadonlyTransform,
): { easingCenter: LngLat; easingOffset: Point };
}
get useGlobeControls(): boolean;
cameraForBoxAndBearing(
options: CameraForBoundsOptions,
padding: PaddingOptions,
bounds: LngLatBounds,
bearing: number,
tr: IReadonlyTransform,
): CameraForBoxAndBearingHandlerResult;
handleEaseTo(
tr: ITransform,
options: EaseToHandlerOptions,
): EaseToHandlerResult;
handleFlyTo(
tr: ITransform,
options: FlyToHandlerOptions,
): FlyToHandlerResult;
handleJumpToCenterZoom(
tr: ITransform,
options: { center?: LngLatLike; zoom?: number },
): void;
handleMapControlsPan(
deltas: MapControlsDeltas,
tr: ITransform,
preZoomAroundLoc: LngLat,
): void;
handleMapControlsRollPitchBearingZoom(
deltas: MapControlsDeltas,
tr: ITransform,
): void;
handlePanInertia(
pan: Point,
transform: IReadonlyTransform,
): { easingCenter: LngLat; easingOffset: Point };
}
Methods
cameraForBoxAndBearing
-
cameraForBoxAndBearing(
options: CameraForBoundsOptions,
padding: PaddingOptions,
bounds: LngLatBounds,
bearing: number,
tr: IReadonlyTransform,
): CameraForBoxAndBearingHandlerResultParameters
- options: CameraForBoundsOptions
- padding: PaddingOptions
- bounds: LngLatBounds
- bearing: number
- tr: IReadonlyTransform
Returns CameraForBoxAndBearingHandlerResult
handleEaseTo
-
Parameters
- tr: ITransform
- options: EaseToHandlerOptions
Returns EaseToHandlerResult
handleFlyTo
-
Parameters
- tr: ITransform
- options: FlyToHandlerOptions
Returns FlyToHandlerResult
handleJumpToCenterZoom
-
Parameters
- tr: ITransform
- options: { center?: LngLatLike; zoom?: number }
Returns void
handleMapControlsPan
-
Parameters
- deltas: MapControlsDeltas
- tr: ITransform
- preZoomAroundLoc: LngLat
Returns void
handleMapControlsRollPitchBearingZoom
-
Parameters
- deltas: MapControlsDeltas
- tr: ITransform
Returns void
handlePanInertia
-
handlePanInertia(
pan: Point,
transform: IReadonlyTransform,
): { easingCenter: LngLat; easingOffset: Point }Parameters
- pan: Point
- transform: IReadonlyTransform
Returns { easingCenter: LngLat; easingOffset: Point }