io.jmix.mapsui.component

Interface GeoMap

All Superinterfaces:

io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.HasSubParts

All Known Implementing Classes:

GeoMapImpl

@StudioComponent(caption="GeoMap",
                 xmlElement="geoMap",
                 xmlns="http://jmix.io/schema/maps/ui",
                 xmlnsAlias="maps",
                 category="Maps",
                 icon="io/jmix/mapsui/icon/geoMap.svg",
                 canvasIcon="io/jmix/mapsui/icon/geoMap_canvas.svg",
                 canvasIconSize=LARGE,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/maps/maps-ui.html")
public interface GeoMap
extends io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.HasSubParts

UI component that displays a geographical data provided by Layers.

The map is built by superposing layers. Initially, GeoMap has the only one layer - CanvasLayer, which is always placed above the other layers. Canvas can be obtained by calling getCanvas() method.

Selected layer of the map is a layer which the map is focused on. Selected layer fires events, reacts on user clicks and can be modified by UI interaction (if the layer is editable). Initially, selected layer is not specified.

Attempting to pass a null value in all places where layer is expected cause NullPointerException to be thrown (except the cases when argument annotated as Nullable).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GeoMap.Bounds Represents the viewing area of the map.
static class	GeoMap.ClickEvent An event that is fired after click on a map.
static class	GeoMap.DragEndEvent An event that is fired after dragging the map.
static class	GeoMap.LayerAddedEvent An event that is fired after adding a layer on a map.
static class	GeoMap.LayerRemovedEvent An event that is fired after removing a layer from a map.
static class	GeoMap.MoveEndEvent An event that is fired after changing the map's viewing area, i.e.
static class	GeoMap.RightClickEvent An event that is fired after right click on a map.
static class	GeoMap.SelectedLayerChangedEvent An event that is fired after changing the map's selected layer.
static class	GeoMap.ZoomEndEvent An event that is fired after zooming the map.

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addClickListener(java.util.function.Consumer<GeoMap.ClickEvent> listener) Registers a new click listener.
io.jmix.core.common.event.Subscription	addDragEndListener(java.util.function.Consumer<GeoMap.DragEndEvent> listener) Registers a new drag end listener.
void	addLayer(Layer layer) Adds the given layer to the map.
io.jmix.core.common.event.Subscription	addLayerAddedListener(java.util.function.Consumer<GeoMap.LayerAddedEvent> listener) Registers a new layer added listener.
io.jmix.core.common.event.Subscription	addLayerRemovedListener(java.util.function.Consumer<GeoMap.LayerRemovedEvent> listener) Registers a new layer removed listener.
io.jmix.core.common.event.Subscription	addMoveEndListener(java.util.function.Consumer<GeoMap.MoveEndEvent> listener) Registers a new move end listener.
io.jmix.core.common.event.Subscription	addRightClickListener(java.util.function.Consumer<GeoMap.RightClickEvent> listener) Registers a new right click listener.
io.jmix.core.common.event.Subscription	addSelectedLayerChangedListener(java.util.function.Consumer<GeoMap.SelectedLayerChangedEvent> listener) Registers a new selected layer changed listener.
io.jmix.core.common.event.Subscription	addZoomEndListener(java.util.function.Consumer<GeoMap.ZoomEndEvent> listener) Registers a new zoom end listener.
GeoMap.Bounds	getBounds() Returns the bounds of the map which define the viewport of the map.
CanvasLayer	getCanvas() Returns the canvas layer of the map.
org.locationtech.jts.geom.Point	getCenter() Returns current geographic center of the map.
<T extends Layer> T	getLayer(java.lang.String layerId) Returns a layer by its ID.
<T extends Layer> T	getLayerOrNull(java.lang.String layerId) Returns a layer by its ID, or null if the map does not contain a layer with the given ID.
java.util.List<Layer>	getLayers() Returns the list of layers currently added to the map.
Layer	getSelectedLayer() Returns the selected layer of the map.
double	getZoomLevel() Returns current map zoom level.
void	openPopup(PopupWindow popupWindow) Opens the given popup window.
void	removeLayer(Layer layer) Removes the given layer from the map.
void	selectLayer(Layer layer) Sets the selected (i.e.
default void	selectLayerById(java.lang.String layerId) Sets the selected (i.e.
void	setCenter(double x, double y) Sets the initial geographic center of the map.
void	setMaxZoom(int maxZoom) Sets maximum map zoom level.
void	setMinZoom(int minZoom) Sets minimum map zoom level.
void	setReadOnly(boolean readOnly) Switches map to a read-only mode.
void	setZoomLevel(double zoomLevel) Sets map zoom level.
void	zoomToBounds(org.locationtech.jts.geom.Point topLeft, org.locationtech.jts.geom.Point bottomRight) Sets a map view that contains the given geographical bounds with the maximum zoom level possible.
void	zoomToGeometry(org.locationtech.jts.geom.Geometry geometry) Sets a map view that contains envelope of the given geometry with the maximum zoom level possible.

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasSubParts

getSubPart

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

addLayer

@StudioElementsGroup(caption="Layers",
                     xmlElement="layers",
                     icon="io/jmix/mapsui/icon/layers.svg",
                     documentationURL="https://docs.jmix.io/jmix/%VERSION%/maps/layers.html")
void addLayer(Layer layer)

Adds the given layer to the map.

Preserves an order of the layers, but tile layers (such as TileLayer or WMSTileLayer) should be added first, otherwise IllegalStateException is to be thrown.

If a layer with the same ID is already on the map, the given layer will not be added to the map and IllegalArgumentException is to be thrown.

Parameters:

layer - to be added on the map

Throws:

java.lang.IllegalStateException - when attempting to add a tile layer above a vector layer

java.lang.IllegalArgumentException - when a layer with the same ID is already on the map

removeLayer

void removeLayer(Layer layer)

Removes the given layer from the map.

Parameters:

layer - to be removed from the map

Throws:

java.lang.IllegalArgumentException - when map does not contain the specified layer

getLayer

@Nonnull
<T extends Layer> T getLayer(java.lang.String layerId)

Returns a layer by its ID.

Parameters:

layerId - ID of a layer

Returns:

layer

Throws:

java.lang.IllegalArgumentException - when map does not contain a layer with the specified id

getLayerOrNull

@Nullable
<T extends Layer> T getLayerOrNull(java.lang.String layerId)

Returns a layer by its ID, or null if the map does not contain a layer with the given ID.

Parameters:

layerId - ID of a layer

Returns:

layer

getLayers

java.util.List<Layer> getLayers()

Returns the list of layers currently added to the map. The resulting list preserves the order of layers (from the first added layer to the last). The Canvas layer is not included in this list.

setCenter

void setCenter(double x,
               double y)

Sets the initial geographic center of the map.

Parameters:

x - longitude

y - latitude

getCenter

org.locationtech.jts.geom.Point getCenter()

Returns current geographic center of the map.

setZoomLevel

@StudioProperty(name="zoom")
void setZoomLevel(double zoomLevel)

Sets map zoom level.
The default value is 15.

Parameters:

zoomLevel - of the map

getZoomLevel

double getZoomLevel()

Returns current map zoom level.

setMaxZoom

void setMaxZoom(int maxZoom)

Sets maximum map zoom level.

If not specified and at least one tile layer is on the map, the highest of their maxZoom will be used.

Parameters:

maxZoom - maximum map zoom level

setMinZoom

void setMinZoom(int minZoom)

Sets minimum map zoom level.

If not specified and at least one tile layer is on the map, the lowest of their minZoom will be used.

Parameters:

minZoom - minimum map zoom level

setReadOnly

void setReadOnly(boolean readOnly)

Switches map to a read-only mode. Virtually, it means an impossibility of changing zoom, position, etc., via mouse.

Parameters:

readOnly - true/false

getCanvas

CanvasLayer getCanvas()

Returns the canvas layer of the map.

Returns:

Canvas layer

selectLayer

void selectLayer(@Nullable
                 Layer layer)

Sets the selected (i.e. the active) layer of the map.

A null parameter deselects currently selected layer.

Parameters:

layer - selected layer

Throws:

java.lang.IllegalArgumentException - when map does not contain the specified layer

selectLayerById

default void selectLayerById(java.lang.String layerId)

Sets the selected (i.e. the active) layer of the map by the given layer's ID.

Parameters:

layerId - ID of the layer

Throws:

java.lang.IllegalArgumentException - when map does not contain the specified layer

getSelectedLayer

@Nullable
Layer getSelectedLayer()

Returns the selected layer of the map.

Returns:

the selected layer or null when none of the layers is selected

getBounds

GeoMap.Bounds getBounds()

Returns the bounds of the map which define the viewport of the map.

zoomToBounds

void zoomToBounds(org.locationtech.jts.geom.Point topLeft,
                  org.locationtech.jts.geom.Point bottomRight)

Sets a map view that contains the given geographical bounds with the maximum zoom level possible.

Parameters:

topLeft - NorthWest point

bottomRight - SouthEast point

zoomToGeometry

void zoomToGeometry(org.locationtech.jts.geom.Geometry geometry)

Sets a map view that contains envelope of the given geometry with the maximum zoom level possible.

Note: if the given geometry is point, map will be centered to this point with the current zoom level.

openPopup

void openPopup(PopupWindow popupWindow)

Opens the given popup window.

addClickListener

io.jmix.core.common.event.Subscription addClickListener(java.util.function.Consumer<GeoMap.ClickEvent> listener)

Registers a new click listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addRightClickListener

io.jmix.core.common.event.Subscription addRightClickListener(java.util.function.Consumer<GeoMap.RightClickEvent> listener)

Registers a new right click listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addMoveEndListener

io.jmix.core.common.event.Subscription addMoveEndListener(java.util.function.Consumer<GeoMap.MoveEndEvent> listener)

Registers a new move end listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addZoomEndListener

io.jmix.core.common.event.Subscription addZoomEndListener(java.util.function.Consumer<GeoMap.ZoomEndEvent> listener)

Registers a new zoom end listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addDragEndListener

io.jmix.core.common.event.Subscription addDragEndListener(java.util.function.Consumer<GeoMap.DragEndEvent> listener)

Registers a new drag end listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addLayerAddedListener

io.jmix.core.common.event.Subscription addLayerAddedListener(java.util.function.Consumer<GeoMap.LayerAddedEvent> listener)

Registers a new layer added listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addLayerRemovedListener

io.jmix.core.common.event.Subscription addLayerRemovedListener(java.util.function.Consumer<GeoMap.LayerRemovedEvent> listener)

Registers a new layer removed listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addSelectedLayerChangedListener

io.jmix.core.common.event.Subscription addSelectedLayerChangedListener(java.util.function.Consumer<GeoMap.SelectedLayerChangedEvent> listener)

Registers a new selected layer changed listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source