com.haulmont.charts.gui.components.map

Interface MapViewer

All Superinterfaces:

com.haulmont.cuba.gui.components.Component, com.haulmont.cuba.gui.components.Component.BelongToFrame, com.haulmont.cuba.gui.components.Component.HasCaption, com.haulmont.cuba.gui.components.Component.HasIcon, com.haulmont.cuba.gui.components.Component.HasXmlDescriptor

All Known Subinterfaces:

GoogleMapViewer

public interface MapViewer
extends com.haulmont.cuba.gui.components.Component, com.haulmont.cuba.gui.components.Component.BelongToFrame, com.haulmont.cuba.gui.components.Component.HasXmlDescriptor, com.haulmont.cuba.gui.components.Component.HasIcon, com.haulmont.cuba.gui.components.Component.HasCaption

Google map component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MapViewer.Type Map types

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

com.haulmont.cuba.gui.components.Component.ActionOwner, com.haulmont.cuba.gui.components.Component.ActionsHolder, com.haulmont.cuba.gui.components.Component.Alignment, com.haulmont.cuba.gui.components.Component.BelongToFrame, com.haulmont.cuba.gui.components.Component.Buffered, com.haulmont.cuba.gui.components.Component.ChildEditableController, com.haulmont.cuba.gui.components.Component.Collapsable, com.haulmont.cuba.gui.components.Component.Container, com.haulmont.cuba.gui.components.Component.ContextHelpIconClickEvent, com.haulmont.cuba.gui.components.Component.Disposable, com.haulmont.cuba.gui.components.Component.Editable, com.haulmont.cuba.gui.components.Component.EditableChangeEvent, com.haulmont.cuba.gui.components.Component.EditableChangeListener, com.haulmont.cuba.gui.components.Component.EditableChangeNotifier, com.haulmont.cuba.gui.components.Component.ExpandedStateChangeEvent, com.haulmont.cuba.gui.components.Component.ExpandedStateChangeListener, com.haulmont.cuba.gui.components.Component.Focusable, com.haulmont.cuba.gui.components.Component.HasBorder, com.haulmont.cuba.gui.components.Component.HasButtonsPanel, com.haulmont.cuba.gui.components.Component.HasCaption, com.haulmont.cuba.gui.components.Component.HasContextHelp, com.haulmont.cuba.gui.components.Component.HasFormatter, com.haulmont.cuba.gui.components.Component.HasIcon, com.haulmont.cuba.gui.components.Component.HasInputPrompt, com.haulmont.cuba.gui.components.Component.HasNamedComponents, com.haulmont.cuba.gui.components.Component.HasOptionsStyleProvider, com.haulmont.cuba.gui.components.Component.HasPresentations, com.haulmont.cuba.gui.components.Component.HasRowsCount, com.haulmont.cuba.gui.components.Component.HasSettings, com.haulmont.cuba.gui.components.Component.HasValue, com.haulmont.cuba.gui.components.Component.HasXmlDescriptor, com.haulmont.cuba.gui.components.Component.LayoutClickEvent, com.haulmont.cuba.gui.components.Component.LayoutClickListener, com.haulmont.cuba.gui.components.Component.LayoutClickNotifier, com.haulmont.cuba.gui.components.Component.Margin, com.haulmont.cuba.gui.components.Component.MouseEventDetails, com.haulmont.cuba.gui.components.Component.OptionsStyleProvider, com.haulmont.cuba.gui.components.Component.OrderedContainer, com.haulmont.cuba.gui.components.Component.OuterMargin, com.haulmont.cuba.gui.components.Component.SecuredActionsHolder, com.haulmont.cuba.gui.components.Component.ShortcutAction, com.haulmont.cuba.gui.components.Component.ShortcutNotifier, com.haulmont.cuba.gui.components.Component.ShortcutTriggeredEvent, com.haulmont.cuba.gui.components.Component.Spacing, com.haulmont.cuba.gui.components.Component.UiPermissionAware, com.haulmont.cuba.gui.components.Component.Validatable, com.haulmont.cuba.gui.components.Component.ValueChangeEvent, com.haulmont.cuba.gui.components.Component.ValueChangeListener, com.haulmont.cuba.gui.components.Component.Wrapper

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addCircleCenterChangeListener(CircleCenterChangeListener listener)
void	addCircleClickListener(CircleClickListener listener)
void	addCircleCompleteListener(CircleCompleteListener listener)
void	addCircleDoubleClickListener(CircleDoubleClickListener listener)
void	addCircleOverlay(Circle circle) Adds circle on map
void	addCircleRadiusChangeListener(CircleRadiusChangeListener listener)
void	addCircleRightClickListener(CircleRightClickListener listener)
void	addHeatMapLayer(HeatMapLayer layer) Adds heatmap layer on map.
void	addImageMapType(ImageMapType imageMapType) Adds Map type
void	addInfoWindowClosedListener(InfoWindowClosedListener listener)
void	addLabel(Label label) Adds label on the map.
void	addMapClickListener(MapClickListener listener)
void	addMapInitListener(MapInitListener listener)
void	addMapMoveListener(MapMoveListener listener)
void	addMapRightClickListener(MapRightClickListener listener)
void	addMarker(Marker marker) Adds marker on the map
Marker	addMarker(java.lang.String caption, GeoPoint position, boolean draggable, java.lang.String iconUrl) Creates and adds marker.
void	addMarkerClickListener(MarkerClickListener listener)
void	addMarkerDoubleClickListener(MarkerDoubleClickListener listener)
void	addMarkerDragListener(MarkerDragListener listener)
void	addMarkerRightClickListener(MarkerRightClickListener listener)
void	addOverlayImageMapType(ImageMapType imageMapType) Adds image map type as overlay on top of the active map
void	addPolygonClickListener(PolygonClickListener listener)
void	addPolygonCompleteListener(PolygonCompleteListener listener)
void	addPolygonEditListener(PolygonEditListener listener)
void	addPolygonOverlay(Polygon polygon) Adds polygon on map
void	addPolygonRightClickListener(PolygonRightClickListener listener)
void	addPolyline(Polyline polyline) Adds polyline on map
boolean	areKeyboardShortcutsEnabled()
void	clearMarkers() Removes all the markers from map
void	closeInfoWindow(InfoWindow infoWindow) Closes given info window
Circle	createCircle() Creates circle.
Circle	createCircle(GeoPoint center, double radius) Creates circle with given center location and radius (in meters).
DirectionsRequest	createDirectionsRequest() Creates directions request.
DirectionsRequest	createDirectionsRequest(GeoPoint origin, GeoPoint destination, TravelMode travelMode) Creates directions request.
DirectionsWaypoint	createDirectionsWaypoint() Creates directions waypoint.
DirectionsWaypoint	createDirectionsWaypoint(GeoPoint location, boolean stopOver) Creates directions waypoint.
GeoPoint	createGeoPoint() Creates geo point with no coordinates
GeoPoint	createGeoPoint(double latitude, double longitude) Creates geo point with given coordinates
HeatMapLayer	createHeatMapLayer() Creates heatmap layer.
ImageMapType	createImageMapType(java.lang.String mapTypeId) Create Image Map Type
ImageMapType	createImageMapType(java.lang.String mapTypeId, java.lang.String tileUrlCallbackJsFunction) Create Image Map Type Example of tile callback function for retreiving OpenStreet maps tiles:
ImageMapType	createImageMapType(java.lang.String mapTypeId, java.lang.String name, java.lang.String tileUrlCallbackJsFunction) Create Image Map Type Example of tile callback function for retreiving OpenStreet maps tiles:
InfoWindow	createInfoWindow() Creates info window.
InfoWindow	createInfoWindow(java.lang.String content) Creates info window with given content.
InfoWindow	createInfoWindow(java.lang.String content, Marker anchorMarker) Creates info window with given content and anchor marker.
Label	createLabel() Creates empty Label.
Label	createLabel(java.lang.String value, GeoPoint position) Creates Label with given params.
Label	createLabel(java.lang.String value, GeoPoint position, Label.ContentType contentType) Creates Label with given params.
Marker	createMarker() Creates marker with default icon.
Marker	createMarker(java.lang.String caption, GeoPoint position, boolean draggable) Creates marker with given params.
Marker	createMarker(java.lang.String caption, GeoPoint position, boolean draggable, MarkerImage icon) Creates marker with given params.
Marker	createMarker(java.lang.String caption, GeoPoint position, boolean draggable, java.lang.String iconUrl) Creates marker with given params.
MarkerImage	createMarkerImage() Creates marker image object
MarkerImage	createMarkerImage(java.lang.String url) Creates marker image object
Point	createPoint(double x, double y) Creates point object
Polygon	createPolygon() Creates polygon.
Polygon	createPolygon(java.util.List<GeoPoint> coordinates) Creates polygon with given coordinates for vertices.
Polygon	createPolygon(java.util.List<GeoPoint> coordinates, java.lang.String fillColor, double fillOpacity, java.lang.String strokeColor, double strokeOpacity, int strokeWeight) Creates polygon with given params.
Polyline	createPolyline() Creates polyline.
Polyline	createPolyline(java.util.List<GeoPoint> coordinates) Creates polyline with given coordinates for vertices.
Polyline	createPolyline(java.util.List<GeoPoint> coordinates, java.lang.String strokeColor, double strokeOpacity, int strokeWeight) Creates polyline with given parameters.
Size	createSize(double width, double height) Creates size object
void	fitToBounds(GeoPoint boundsNE, GeoPoint boundsSW) Changes map viewpoint to contain area defined by a given bounds.
GeoPoint	getBoundNorthEast()
GeoPoint	getBoundSouthWest()
GeoPoint	getCenter()
java.lang.String	getMapType()
java.util.Collection<Marker>	getMarkers()
int	getMaxZoom()
int	getMinZoom()
java.lang.String	getRemoveMessage()
int	getZoom()
boolean	hasMarker(Marker marker)
boolean	isCenterBoundLimitsEnabled()
boolean	isDraggable()
boolean	isInfoWindowOpen(InfoWindow infoWindow)
boolean	isScrollWheelEnabled()
boolean	isVertexRemovingEnabled()
boolean	isVisibleAreaBoundLimitsEnabled()
void	openInfoWindow(InfoWindow infoWindow) Opens given info window
void	removeCircleCenterChangeListener(CircleCenterChangeListener listener)
void	removeCircleClickListener(CircleClickListener listener)
void	removeCircleCompleteListener(CircleCompleteListener listener)
void	removeCircleDoubleClickListener(CircleDoubleClickListener listener)
void	removeCircleOverlay(Circle circle) Removes circle from map
void	removeCircleRadiusChangeListener(CircleRadiusChangeListener listener)
void	removeCircleRightClickListener(CircleRightClickListener listener)
void	removeHeatMapLayer(HeatMapLayer layer) Removes heatmap layer from map.
void	removeImageMapType(ImageMapType imageMapType) Removes Map Type
void	removeInfoWindowClosedListener(InfoWindowClosedListener listener)
void	removeLabel(Label label) Removes label from the map.
void	removeMapClickListener(MapClickListener listener)
void	removeMapInitListener(MapInitListener listener)
void	removeMapMoveListener(MapMoveListener listener)
void	removeMapRightClickListener(MapRightClickListener listener)
void	removeMarker(Marker marker) Removes marker from map
void	removeMarkerClickListener(MarkerClickListener listener)
void	removeMarkerDoubleClickListener(MarkerDoubleClickListener listener)
void	removeMarkerDragListener(MarkerDragListener listener)
void	removeMarkerRightClickListener(MarkerRightClickListener listener)
void	removeOverlayImageMapType(ImageMapType imageMapType) Removes overlay map
void	removePolygonClickListener(PolygonClickListener listener)
void	removePolygonCompleteListener(PolygonCompleteListener listener)
void	removePolygonEditListener(PolygonEditListener listener)
void	removePolygonOverlay(Polygon polygon) Removes polygon from map
void	removePolygonRightClickListener(PolygonRightClickListener listener)
void	removePolygonVertex(Polygon polygon, GeoPoint vertex) Removes given vertex from given polygon.
void	removePolyline(Polyline polyline) Removes polyline from the map
void	route(DirectionsRequest request, DirectionsRequestCallback callback) Method for requesting mapping service to create a route
void	setCenter(GeoPoint center) Sets map center
void	setCenterBoundLimits(GeoPoint limitNE, GeoPoint limitSW) Sets map center possible locations bounds
void	setCenterBoundLimitsEnabled(boolean enable) Sets whether map center possible locations should be limited
void	setDraggable(boolean draggable) Sets whether user should be able to change map viewpoint by dragging the map
void	setDrawingOptions(DrawingOptions drawingOptions) Sets options for drawing mode
void	setKeyboardShortcutsEnabled(boolean enabled) Sets whether keyboard shortcuts should be enabled
void	setMapType(MapViewer.Type type) Sets map type
void	setMapType(java.lang.String typeId) Sets map type by its ID.
void	setMapTypes(java.util.List<java.lang.String> mapTypeIds) Sets map types available in map type control.
void	setMaxZoom(int maxZoom) Sets map maximum zoom
void	setMinZoom(int minZoom) Sets map minimum zoom
void	setRemoveMessage(java.lang.String message) Sets message which will be used in popup to remove polygon vertex.
void	setScrollWheelEnabled(boolean enabled) Sets whether map zoom should be editable by mouse wheel scrolling
void	setSizeUndefined() Deprecated. Use Component.setSizeAuto()
void	setVertexRemovingEnabled(boolean enabled) Sets whether vertex removing is available or not.
void	setVisibleAreaBoundLimits(GeoPoint limitNE, GeoPoint limitSW) Sets bounds for limiting map visible area
void	setVisibleAreaBoundLimitsEnabled(boolean enabled) Enables limiting of the visible area by a given bounds
void	setZoom(int zoom) Sets map zoom level.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasXmlDescriptor

getXmlDescriptor, setXmlDescriptor

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

TAG_NAME

@Deprecated
static final java.lang.String TAG_NAME

Deprecated.

Tag name for XML loader

See Also:

Constant Field Values

Method Detail

addMarkerClickListener

void addMarkerClickListener(MarkerClickListener listener)

removeMarkerClickListener

void removeMarkerClickListener(MarkerClickListener listener)

addMarkerDoubleClickListener

void addMarkerDoubleClickListener(MarkerDoubleClickListener listener)

removeMarkerDoubleClickListener

void removeMarkerDoubleClickListener(MarkerDoubleClickListener listener)

addMarkerDragListener

void addMarkerDragListener(MarkerDragListener listener)

removeMarkerDragListener

void removeMarkerDragListener(MarkerDragListener listener)

addMarkerRightClickListener

void addMarkerRightClickListener(MarkerRightClickListener listener)

removeMarkerRightClickListener

void removeMarkerRightClickListener(MarkerRightClickListener listener)

addMapMoveListener

void addMapMoveListener(MapMoveListener listener)

removeMapMoveListener

void removeMapMoveListener(MapMoveListener listener)

addMapClickListener

void addMapClickListener(MapClickListener listener)

removeMapClickListener

void removeMapClickListener(MapClickListener listener)

addMapRightClickListener

void addMapRightClickListener(MapRightClickListener listener)

removeMapRightClickListener

void removeMapRightClickListener(MapRightClickListener listener)

addInfoWindowClosedListener

void addInfoWindowClosedListener(InfoWindowClosedListener listener)

removeInfoWindowClosedListener

void removeInfoWindowClosedListener(InfoWindowClosedListener listener)

addPolygonCompleteListener

void addPolygonCompleteListener(PolygonCompleteListener listener)

removePolygonCompleteListener

void removePolygonCompleteListener(PolygonCompleteListener listener)

addPolygonEditListener

void addPolygonEditListener(PolygonEditListener listener)

removePolygonEditListener

void removePolygonEditListener(PolygonEditListener listener)

addPolygonClickListener

void addPolygonClickListener(PolygonClickListener listener)

removePolygonClickListener

void removePolygonClickListener(PolygonClickListener listener)

addPolygonRightClickListener

void addPolygonRightClickListener(PolygonRightClickListener listener)

removePolygonRightClickListener

void removePolygonRightClickListener(PolygonRightClickListener listener)

addMapInitListener

void addMapInitListener(MapInitListener listener)

removeMapInitListener

void removeMapInitListener(MapInitListener listener)

addCircleClickListener

void addCircleClickListener(CircleClickListener listener)

removeCircleClickListener

void removeCircleClickListener(CircleClickListener listener)

addCircleDoubleClickListener

void addCircleDoubleClickListener(CircleDoubleClickListener listener)

removeCircleDoubleClickListener

void removeCircleDoubleClickListener(CircleDoubleClickListener listener)

addCircleRadiusChangeListener

void addCircleRadiusChangeListener(CircleRadiusChangeListener listener)

removeCircleRadiusChangeListener

void removeCircleRadiusChangeListener(CircleRadiusChangeListener listener)

addCircleCenterChangeListener

void addCircleCenterChangeListener(CircleCenterChangeListener listener)

removeCircleCenterChangeListener

void removeCircleCenterChangeListener(CircleCenterChangeListener listener)

addCircleCompleteListener

void addCircleCompleteListener(CircleCompleteListener listener)

removeCircleCompleteListener

void removeCircleCompleteListener(CircleCompleteListener listener)

addCircleRightClickListener

void addCircleRightClickListener(CircleRightClickListener listener)

removeCircleRightClickListener

void removeCircleRightClickListener(CircleRightClickListener listener)

createGeoPoint

GeoPoint createGeoPoint()

Creates geo point with no coordinates

Returns:

geo point

createGeoPoint

GeoPoint createGeoPoint(double latitude,
                        double longitude)

Creates geo point with given coordinates

Parameters:

latitude - latitude

longitude - latitude

Returns:

geo point

createMarker

Marker createMarker()

Creates marker with default icon. Add marker on map using addMarker(com.haulmont.charts.gui.map.model.Marker)

Returns:

marker

createMarker

Marker createMarker(java.lang.String caption,
                    GeoPoint position,
                    boolean draggable)

Creates marker with given params. Add marker on map using addMarker(com.haulmont.charts.gui.map.model.Marker)

Parameters:

caption - caption

position - position

draggable - draggable

Returns:

marker

createMarker

Marker createMarker(java.lang.String caption,
                    GeoPoint position,
                    boolean draggable,
                    java.lang.String iconUrl)

Creates marker with given params. Add marker on map using addMarker(com.haulmont.charts.gui.map.model.Marker)

Parameters:

caption - caption

position - position

draggable - draggable

iconUrl - icon url

Returns:

marker

createMarker

Marker createMarker(java.lang.String caption,
                    GeoPoint position,
                    boolean draggable,
                    MarkerImage icon)

Creates marker with given params. Add marker on map using addMarker(com.haulmont.charts.gui.map.model.Marker)

Parameters:

caption - caption

position - position

draggable - draggable

icon - icon

Returns:

marker

createPolygon

Polygon createPolygon()

Creates polygon. Add polygon on map using addPolygonOverlay(com.haulmont.charts.gui.map.model.Polygon)

Returns:

polygon

createPolygon

Polygon createPolygon(java.util.List<GeoPoint> coordinates)

Creates polygon with given coordinates for vertices. Add polygon on map using addPolygonOverlay(com.haulmont.charts.gui.map.model.Polygon)

Returns:

polygon

createPolygon

Polygon createPolygon(java.util.List<GeoPoint> coordinates,
                      java.lang.String fillColor,
                      double fillOpacity,
                      java.lang.String strokeColor,
                      double strokeOpacity,
                      int strokeWeight)

Creates polygon with given params. Add polygon on map using addPolygonOverlay(com.haulmont.charts.gui.map.model.Polygon)

Returns:

polygon

createCircle

Circle createCircle()

Creates circle. Add circle on map using addCircleOverlay(com.haulmont.charts.gui.map.model.Circle)

Returns:

circle

createCircle

Circle createCircle(GeoPoint center,
                    double radius)

Creates circle with given center location and radius (in meters). Add circle on map using addCircleOverlay(com.haulmont.charts.gui.map.model.Circle)

Returns:

circle

createPolyline

Polyline createPolyline()

Creates polyline. Add polyline on map using addPolyline(com.haulmont.charts.gui.map.model.Polyline)

Returns:

polyline

createPolyline

Polyline createPolyline(java.util.List<GeoPoint> coordinates)

Creates polyline with given coordinates for vertices. Add polyline on map using addPolyline(com.haulmont.charts.gui.map.model.Polyline)

Returns:

polyline

createPolyline

Polyline createPolyline(java.util.List<GeoPoint> coordinates,
                        java.lang.String strokeColor,
                        double strokeOpacity,
                        int strokeWeight)

Creates polyline with given parameters. Add polyline on map using addPolyline(com.haulmont.charts.gui.map.model.Polyline)

Returns:

polyline

createInfoWindow

InfoWindow createInfoWindow()

Creates info window. Open info window on map using openInfoWindow(com.haulmont.charts.gui.map.model.InfoWindow)

Returns:

info window

createInfoWindow

InfoWindow createInfoWindow(java.lang.String content)

Creates info window with given content. Open info window on map using openInfoWindow(com.haulmont.charts.gui.map.model.InfoWindow)

Returns:

info window

createInfoWindow

InfoWindow createInfoWindow(java.lang.String content,
                            Marker anchorMarker)

Creates info window with given content and anchor marker. Open info window on map using openInfoWindow(com.haulmont.charts.gui.map.model.InfoWindow)

Returns:

info window

createHeatMapLayer

HeatMapLayer createHeatMapLayer()

Creates heatmap layer. Add layer on map using Open info window on map using addHeatMapLayer(com.haulmont.charts.gui.map.model.layer.HeatMapLayer)

Returns:

heatmap layer

createDirectionsRequest

DirectionsRequest createDirectionsRequest()

Creates directions request. Request directions api using route(com.haulmont.charts.gui.map.model.directions.DirectionsRequest, com.haulmont.charts.gui.map.model.directions.DirectionsRequestCallback)

Returns:

request

createDirectionsRequest

DirectionsRequest createDirectionsRequest(GeoPoint origin,
                                          GeoPoint destination,
                                          TravelMode travelMode)

Creates directions request. Request directions api using route(com.haulmont.charts.gui.map.model.directions.DirectionsRequest, com.haulmont.charts.gui.map.model.directions.DirectionsRequestCallback)

Parameters:

origin - location of origin

destination - location of destination

travelMode - type of routing requested

Returns:

directions request

createDirectionsWaypoint

DirectionsWaypoint createDirectionsWaypoint()

Creates directions waypoint.

Returns:

waypoint

createDirectionsWaypoint

DirectionsWaypoint createDirectionsWaypoint(GeoPoint location,
                                            boolean stopOver)

Creates directions waypoint.

Parameters:

location - location

stopOver - if true, indicates that this waypoint is a stop between the origin and destination. This has the effect of splitting the route into two. This value is true by default.

Returns:

waypoint

createMarkerImage

MarkerImage createMarkerImage()

Creates marker image object

Returns:

marker image

createMarkerImage

MarkerImage createMarkerImage(java.lang.String url)

Creates marker image object

Parameters:

url - icon or sprites file url

Returns:

marker image

createSize

Size createSize(double width,
                double height)

Creates size object

Parameters:

width - width

height - height

Returns:

size

createPoint

Point createPoint(double x,
                  double y)

Creates point object

Parameters:

x - X coordinate

y - Y coordinate

Returns:

point

addHeatMapLayer

void addHeatMapLayer(HeatMapLayer layer)

Adds heatmap layer on map.

Parameters:

layer - layer

removeHeatMapLayer

void removeHeatMapLayer(HeatMapLayer layer)

Removes heatmap layer from map.

Parameters:

layer - layer

createImageMapType

ImageMapType createImageMapType(java.lang.String mapTypeId)

Create Image Map Type

Parameters:

mapTypeId - id, used when you add this map in map type controls

Returns:

image map type

createImageMapType

ImageMapType createImageMapType(java.lang.String mapTypeId,
                                java.lang.String tileUrlCallbackJsFunction)

Create Image Map Type Example of tile callback function for retreiving OpenStreet maps tiles:

  f = function f(x, y, zoom) {
          return 'http://tile.openstreetmap.org/' + zoom + '/' + x + '/' + y + '.png';
        }
 
 

Parameters:

mapTypeId - id, used when you add this map in map type controls

tileUrlCallbackJsFunction - javascript function providing url of the tile by its coordinates and zoom

Returns:

image map type

createImageMapType

ImageMapType createImageMapType(java.lang.String mapTypeId,
                                java.lang.String name,
                                java.lang.String tileUrlCallbackJsFunction)

Create Image Map Type Example of tile callback function for retreiving OpenStreet maps tiles:

  f = function f(x, y, zoom) {
          return 'http://tile.openstreetmap.org/' + zoom + '/' + x + '/' + y + '.png';
        }
 
 

Parameters:

mapTypeId - id, used when you add this map in map type controls

name - name, for map type control

tileUrlCallbackJsFunction - javascript function providing url of the tile by its coordinates and zoom

Returns:

image map type

addImageMapType

void addImageMapType(ImageMapType imageMapType)

Adds Map type

Parameters:

imageMapType -

removeImageMapType

void removeImageMapType(ImageMapType imageMapType)

Removes Map Type

Parameters:

imageMapType -

addOverlayImageMapType

void addOverlayImageMapType(ImageMapType imageMapType)

Adds image map type as overlay on top of the active map

Parameters:

imageMapType -

removeOverlayImageMapType

void removeOverlayImageMapType(ImageMapType imageMapType)

Removes overlay map

Parameters:

imageMapType -

setZoom

void setZoom(int zoom)

Sets map zoom level. Supported values depend on used map service provider. For Google Maps it is from 0 to 20 where 0 corresponds to a map of the Earth fully zoomed out.

Parameters:

zoom - zoom

getZoom

int getZoom()

Returns:

zoom

addMarker

Marker addMarker(java.lang.String caption,
                 GeoPoint position,
                 boolean draggable,
                 java.lang.String iconUrl)

Creates and adds marker.

Parameters:

caption - caption

position - position

draggable - draggable

iconUrl - icon URL

Returns:

created marker

addMarker

void addMarker(Marker marker)

Adds marker on the map

Parameters:

marker - marker

removeMarker

void removeMarker(Marker marker)

Removes marker from map

Parameters:

marker - marker

clearMarkers

void clearMarkers()

Removes all the markers from map

hasMarker

boolean hasMarker(Marker marker)

Parameters:

marker - marker

Returns:

true if given marker is on the map

getMarkers

java.util.Collection<Marker> getMarkers()

Returns:

collection of the added on the map markers

setSizeUndefined

@Deprecated
void setSizeUndefined()

Deprecated. Use Component.setSizeAuto()

Clears any size settings.

getCenter

GeoPoint getCenter()

Returns:

center coordinate

setCenter

void setCenter(GeoPoint center)

Sets map center

Parameters:

center - center

getBoundNorthEast

GeoPoint getBoundNorthEast()

Returns:

coordinate of a north-east map corner. Note that border coordinates are not known before map fully initialized. If you need to know border during screen initialization, use addMapInitListener(com.haulmont.charts.gui.map.model.listeners.MapInitListener)

getBoundSouthWest

GeoPoint getBoundSouthWest()

Returns:

coordinate of a south-west map corner. Note that border coordinates are not known before map fully initialized. If you need to know border during screen initialization, use addMapInitListener(com.haulmont.charts.gui.map.model.listeners.MapInitListener)

addPolyline

void addPolyline(Polyline polyline)

Adds polyline on map

Parameters:

polyline - polyline

removePolyline

void removePolyline(Polyline polyline)

Removes polyline from the map

Parameters:

polyline - polyline

addCircleOverlay

void addCircleOverlay(Circle circle)

Adds circle on map

Parameters:

circle - circle

removeCircleOverlay

void removeCircleOverlay(Circle circle)

Removes circle from map

Parameters:

circle - circle

setVisibleAreaBoundLimitsEnabled

void setVisibleAreaBoundLimitsEnabled(boolean enabled)

Enables limiting of the visible area by a given bounds

Parameters:

enabled - enabled

fitToBounds

void fitToBounds(GeoPoint boundsNE,
                 GeoPoint boundsSW)

Changes map viewpoint to contain area defined by a given bounds. If the boundsNE has longitude less than boundsSW longitude, so viewpoint will be changed to the bounds from boundsSW of the first part of MapViewer to the boundsNE of next part of MapViewer.

Parameters:

boundsNE - north-east coordinate

boundsSW - south-west coordinate

isVisibleAreaBoundLimitsEnabled

boolean isVisibleAreaBoundLimitsEnabled()

Returns:

true if visible area limitation is enabled

setVisibleAreaBoundLimits

void setVisibleAreaBoundLimits(GeoPoint limitNE,
                               GeoPoint limitSW)

Sets bounds for limiting map visible area

Parameters:

limitNE - north-east coordinate

limitSW - south-west coordinate

setMaxZoom

void setMaxZoom(int maxZoom)

Sets map maximum zoom

Parameters:

maxZoom - zoom

getMaxZoom

int getMaxZoom()

Returns:

map maximum zoom

setMinZoom

void setMinZoom(int minZoom)

Sets map minimum zoom

Parameters:

minZoom - zoom

getMinZoom

int getMinZoom()

Returns:

map minimum zoom

isDraggable

boolean isDraggable()

Returns:

true if map viewpoint can be changed by user dragging the map

setDraggable

void setDraggable(boolean draggable)

Sets whether user should be able to change map viewpoint by dragging the map

Parameters:

draggable - true for draggable

areKeyboardShortcutsEnabled

boolean areKeyboardShortcutsEnabled()

Returns:

true if keyboard shortcuts are enabled

setKeyboardShortcutsEnabled

void setKeyboardShortcutsEnabled(boolean enabled)

Sets whether keyboard shortcuts should be enabled

Parameters:

enabled - enabled

isScrollWheelEnabled

boolean isScrollWheelEnabled()

Returns:

true of zoom changing by mouse wheel scrolling is enabled

setScrollWheelEnabled

void setScrollWheelEnabled(boolean enabled)

Sets whether map zoom should be editable by mouse wheel scrolling

Parameters:

enabled - enabled

isCenterBoundLimitsEnabled

boolean isCenterBoundLimitsEnabled()

Returns:

true if map center possible locations are limited

setCenterBoundLimitsEnabled

void setCenterBoundLimitsEnabled(boolean enable)

Sets whether map center possible locations should be limited

Parameters:

enable - enable

setCenterBoundLimits

void setCenterBoundLimits(GeoPoint limitNE,
                          GeoPoint limitSW)

Sets map center possible locations bounds

Parameters:

limitNE - north-east coordinate

limitSW - south-west coordinate

addPolygonOverlay

void addPolygonOverlay(Polygon polygon)

Adds polygon on map

Parameters:

polygon - polygon

removePolygonOverlay

void removePolygonOverlay(Polygon polygon)

Removes polygon from map

Parameters:

polygon - polygon

setMapType

void setMapType(MapViewer.Type type)

Sets map type

Parameters:

type - type

setMapType

void setMapType(java.lang.String typeId)

Sets map type by its ID. Useful for setting custom map type

Parameters:

typeId - map type id

setMapTypes

void setMapTypes(java.util.List<java.lang.String> mapTypeIds)

Sets map types available in map type control. For passing standard map id use MapViewer.Type.getMapTypeId()

Parameters:

mapTypeIds - map type ids

getMapType

java.lang.String getMapType()

Returns:

map type

openInfoWindow

void openInfoWindow(InfoWindow infoWindow)

Opens given info window

Parameters:

infoWindow - info window

closeInfoWindow

void closeInfoWindow(InfoWindow infoWindow)

Closes given info window

Parameters:

infoWindow - info window

isInfoWindowOpen

boolean isInfoWindowOpen(InfoWindow infoWindow)

Parameters:

infoWindow - info window

Returns:

true if given info window is opened

setDrawingOptions

void setDrawingOptions(DrawingOptions drawingOptions)

Sets options for drawing mode

Parameters:

drawingOptions - drawing options

route

void route(DirectionsRequest request,
           DirectionsRequestCallback callback)

Method for requesting mapping service to create a route

Parameters:

request - request

callback - callback object

createLabel

Label createLabel()

Creates empty Label. Add Label on map using addLabel(Label).

Returns:

Label instance

createLabel

Label createLabel(java.lang.String value,
                  GeoPoint position)

Creates Label with given params. Add Label on map using addLabel(Label).

Parameters:

value - value

position - position

Returns:

Label instance

createLabel

Label createLabel(java.lang.String value,
                  GeoPoint position,
                  Label.ContentType contentType)

Creates Label with given params. Add Label on map using addLabel(Label).

Parameters:

value - value

position - position

contentType - contentType

Returns:

Label instance

addLabel

void addLabel(Label label)

Adds label on the map.

Parameters:

label - label

removeLabel

void removeLabel(Label label)

Removes label from the map.

Parameters:

label - label

removePolygonVertex

void removePolygonVertex(Polygon polygon,
                         GeoPoint vertex)

Removes given vertex from given polygon.

Parameters:

polygon - polygon

vertex - vertex

setRemoveMessage

void setRemoveMessage(java.lang.String message)

Sets message which will be used in popup to remove polygon vertex.

Parameters:

message - localized message

getRemoveMessage

java.lang.String getRemoveMessage()

Returns:

remove message

setVertexRemovingEnabled

void setVertexRemovingEnabled(boolean enabled)

Sets whether vertex removing is available or not.

Parameters:

enabled - enabled

isVertexRemovingEnabled

boolean isVertexRemovingEnabled()

Returns:

whether vertex removing is available or not