lonboard.view_state

lonboard.view_state

BaseViewState

Base class for view states.

MapViewState dataclass

Bases: BaseViewState

State of a MapView.

longitude class-attribute instance-attribute

longitude: float = 0

longitude at the map center

latitude class-attribute instance-attribute

latitude: float = 10

latitude at the map center.

zoom class-attribute instance-attribute

zoom: float = 0.5

zoom level.

pitch class-attribute instance-attribute

pitch: float = 0

pitch angle in degrees. 0 is top-down.

bearing class-attribute instance-attribute

bearing: float = 0

bearing angle in degrees. 0 is north.

max_zoom class-attribute instance-attribute

max_zoom: float = 20

max zoom level.

min_zoom class-attribute instance-attribute

min_zoom: float = 0

min zoom level.

max_pitch class-attribute instance-attribute

max_pitch: float = 60

max pitch angle.

min_pitch class-attribute instance-attribute

min_pitch: float = 0

min pitch angle.

GlobeViewState dataclass

Bases: BaseViewState

State of a GlobeView.

longitude instance-attribute

longitude: float

longitude at the viewport center.

latitude instance-attribute

latitude: float

latitude at the viewport center.

zoom instance-attribute

zoom: float

zoom level.

max_zoom class-attribute instance-attribute

max_zoom: float = 20

max zoom level. Default 20.

min_zoom class-attribute instance-attribute

min_zoom: float = 0

min zoom level. Default 0.

FirstPersonViewState dataclass

Bases: BaseViewState

State of a FirstPersonView.

longitude instance-attribute

longitude: float

longitude of the camera position.

latitude instance-attribute

latitude: float

latitude of the camera position.

position class-attribute instance-attribute

position: tuple[float, float, float] = (0.0, 0.0, 0.0)

Meter offsets of the camera from the lng-lat anchor point.

bearing class-attribute instance-attribute

bearing: float = 0.0

bearing angle in degrees. 0 is north.

pitch class-attribute instance-attribute

pitch: float = 0.0

pitch angle in degrees. 0 is horizontal.

max_pitch class-attribute instance-attribute

max_pitch: float = 90.0

max pitch angle. Default 90 (down).

min_pitch class-attribute instance-attribute

min_pitch: float = -90.0

min pitch angle. Default -90 (up).

OrthographicViewState dataclass

Bases: BaseViewState

State of an OrthographicView.

target class-attribute instance-attribute

target: tuple[float, float, float] = (0.0, 0.0, 0.0)

The world position at the center of the viewport.

zoom class-attribute instance-attribute

zoom: float | tuple[float, float] = 0.0

The zoom level of the viewport.

• zoom: 0 maps one unit distance to one pixel on screen, and increasing zoom by 1 scales the same object to twice as large. For example zoom: 1 is 2x the original size, zoom: 2 is 4x, zoom: 3 is 8x etc.

To apply independent zoom levels to the X and Y axes, supply a tuple [zoomX, zoomY].

Default 0.

min_zoom class-attribute instance-attribute

min_zoom: float | None = None

The min zoom level of the viewport. Default -Infinity.

max_zoom class-attribute instance-attribute

max_zoom: float | None = None

The max zoom level of the viewport. Default Infinity.

OrbitViewState dataclass

Bases: BaseViewState

State of an OrbitView.

target class-attribute instance-attribute

target: tuple[float, float, float] = (0.0, 0.0, 0.0)

The world position at the center of the viewport.

rotation_orbit class-attribute instance-attribute

rotation_orbit: float = 0.0

Rotating angle around orbit axis. Default 0.

rotation_x class-attribute instance-attribute

rotation_x: float = 0.0

Rotating angle around X axis. Default 0.

zoom class-attribute instance-attribute

zoom: float = 0.0

The zoom level of the viewport.

zoom: 0 maps one unit distance to one pixel on screen, and increasing zoom by 1 scales the same object to twice as large.

Default 0.

min_zoom class-attribute instance-attribute

min_zoom: float | None = None

The min zoom level of the viewport. Default -Infinity.

max_zoom class-attribute instance-attribute

max_zoom: float | None = None

The max zoom level of the viewport. Default Infinity.

min_rotation_x class-attribute instance-attribute

min_rotation_x: float = -90.0

The min rotating angle around X axis. Default -90.

max_rotation_x class-attribute instance-attribute

max_rotation_x: float = 90.0

The max rotating angle around X axis. Default 90.