Package io.jmix.mapsflowui.kit.component.model

Class MapView

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.MapView

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GeoMapView, NoOpMapView

public abstract class MapView
extends MapObservableObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapView.StateChangeEvent	INTERNAL.

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Extent	currentExtent
protected Extent	extent
protected Double	maxZoom
protected Double	minZoom
protected CRS	projection
protected Double	rotation
protected double	zoom

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
MapView()

Method Summary

Modifier and Type	Method	Description
Extent	getCurrentExtent()	Gets the extent (or bounding box) of the currently visible area.
Extent	getExtent()
Double	getMaxZoom()
Double	getMinZoom()
CRS	getProjection()
Double	getRotation()	Note, the rotation can be updated from the client-side and can be available after the first view change.
protected String	getType()
double	getZoom()
protected void	onStateChangeEvent(MapView.StateChangeEvent event)
void	setExtent(Extent extent)	Sets the view extent.
void	setMaxZoom(Double maxZoom)	Sets the maximum zoom level for the view.
void	setMinZoom(Double minZoom)	Sets a minimum zoom level for the view.
void	setProjection(CRS projection)	Sets the projection to view.
void	setRotation(Double rotation)	Sets the rotation for the view in radians (positive rotation clockwise, 0 means North).
void	setZoom(double zoom)	Zooms to a specific zoom level.

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSyncId, hashCode, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMapObjectChangeListener, setMetaProperty, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

extent

protected Extent extent

projection

protected CRS projection

rotation

protected Double rotation

maxZoom

protected Double maxZoom

minZoom

protected Double minZoom

zoom

protected double zoom

currentExtent

protected Extent currentExtent

Constructor Details

MapView

public MapView()

Method Details

getExtent

public Extent getExtent()

Returns:

view extent or null if not set

setExtent

public void setExtent(Extent extent)

Sets the view extent. This extent is a constraint that does not enable to move map visible area outside specified extent.

Note, extent attribute is set only at creation time and cannot be changed at runtime.

For more details see: View docs

Parameters:

extent - extent to set

getProjection

public CRS getProjection()

Returns:

projection or null if not set

setProjection

public void setProjection(CRS projection)

Sets the projection to view. The default projection is "EPSG:3857" (Pseudo-Mercator). If a source (based on TileImageSource or ImageSource) has a projection different from the current map view’s projection then the reprojection happens automatically.

There are available two options:

• CRS value - sets value as CRS constant, e.g. CRS.EPSG_4326 or as anonymous implementation, e.g. setProjection(() -> "EPSG:4326");.
• Projection value - sets custom projection.

Note, projection attribute is set only at creation time and cannot be changed at runtime.

Parameters:

projection - projection to set

getRotation

public Double getRotation()

Note, the rotation can be updated from the client-side and can be available after the first view change.

Returns:

the rotation in radians or null if not set or is not updated from the client-side

setRotation

public void setRotation(Double rotation)

Sets the rotation for the view in radians (positive rotation clockwise, 0 means North).

For more details see: setRotation docs

Parameters:

rotation - rotation to set

getMaxZoom

public Double getMaxZoom()

Returns:

maximum zoom level or null if not set

setMaxZoom

public void setMaxZoom(Double maxZoom)

Sets the maximum zoom level for the view. The default value is 28.

For more details see: setMaxZoom docs

Parameters:

maxZoom - maximum zoom to set

getMinZoom

public Double getMinZoom()

Returns:

minimum zoom level or null if not set

setMinZoom

public void setMinZoom(Double minZoom)

Sets a minimum zoom level for the view. The default value is 0.

For more details see: setMinZoom docs

Parameters:

minZoom - minimum zoom level to set

getZoom

public double getZoom()

Returns:

zoom level

setZoom

public void setZoom(double zoom)

Zooms to a specific zoom level. The zoom level starts at 0 as the most zoomed-out level, and then continually increases to zoom further in.

Parameters:

zoom - zoom level

getCurrentExtent

public Extent getCurrentExtent()

Gets the extent (or bounding box) of the currently visible area.

Note, the extent is calculated on the client-side and will only be available after the first view change.

Returns:

the coordinates of the view's extent

getType

protected String getType()

Specified by:

getType in class MapObservableObject

onStateChangeEvent

protected void onStateChangeEvent(MapView.StateChangeEvent event)