The parameters for the fitViewportToBounds method.

Properties

bounds

bounds: [number, number, number, number]

The bounds to fit the viewport to.

FeltBoundary

The input type for setting the viewport to a particular center and zoom.

Properties

center

center: LatLng

The center of the viewport in latitude and longitude.

zoom

zoom: number

The zoom level of the viewport.

The Viewport module allows you to control the viewport of the map, such as setting the current viewport, getting the current viewport, and being notified when the viewport changes.

Index

Controller

• ViewportController

Types

• ViewportCenterZoom

• SetViewportCenterZoomParams

• ViewportFitBoundsParams

Types

The current state of the viewport, including the derived bounds.

• ViewportState

Properties

center

center: LatLng

The center of the viewport in latitude and longitude.

LatLng

zoom

zoom: number

The zoom level of the viewport.

FeltZoom

bounds

bounds: [number, number, number, number]

The bounding box of the viewport.

This is derived, and depends on the center and zoom of the viewport, as well as its size.

FeltBoundary

The viewport controller allows you to control the viewport of the map.

You can get the current viewport, move the viewport, and be notified when the viewport changes.

Extended by

• FeltController

Methods

getViewport()

getViewport(): Promise<ViewportState>

Gets the current state of the viewport.

Returns

Promise<ViewportState>

setViewport()

setViewport(viewport: SetViewportCenterZoomParams): void

Moves the map to the specified location.

Parameters

Returns

void

Example

felt.setViewport({
  center: { latitude: 0, longitude: 0 },
  zoom: 10,
});

fitViewportToBounds()

fitViewportToBounds(bounds: ViewportFitBoundsParams): void

Fits the map to the specified bounds.

Parameters

Returns

void

Example

const west = -122.4194;
const south = 37.7749;
const east = -122.4194;
const north = 37.7749;
felt.fitViewportToBounds({ bounds: [west, south, east, north] });

Events

onViewportMove()

onViewportMove(args: {handler: (viewport: ViewportState) => void; }): VoidFunction

Adds a listener for when the viewport changes.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onViewportMove({
  handler: viewport => console.log(viewport.center.latitude),
});

// later on...
unsubscribe();

onViewportMoveEnd()

onViewportMoveEnd(args: {handler: (viewport: ViewportState) => void; }): VoidFunction

Adds a listener for when the viewport move ends, which is when the user stops dragging or zooming the map, animations have finished, or inertial dragging ends.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onViewportMoveEnd({
  handler: viewport => console.log(viewport.center.latitude),
});

// later on...
unsubscribe();

The parameters for the setViewport method.

Properties

center?

optional center: {latitude: Latitude;longitude: Longitude; }

zoom?

optional zoom: number