com.haulmont.charts.gui.map.model

Interface Marker

public interface Marker

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCaption()
MarkerImage	getIcon()
java.lang.String	getIconUrl()
GeoPoint	getPosition()
boolean	isAnimationEnabled()
boolean	isClickable()
boolean	isDraggable()
boolean	isOptimized()
boolean	isVisible()
void	setAnimationEnabled(boolean animationEnabled) Sets whether marker adding animation must be turned on.
void	setCaption(java.lang.String caption) Sets caption to be displayed when user hovers the marker
void	setClickable(boolean clickable)
void	setDraggable(boolean draggable) Sets whether marker should be draggable.
void	setIcon(MarkerImage icon) Sets icon
void	setIconUrl(java.lang.String iconUrl) Sets marker's icon URL.
void	setOptimized(boolean optimized) Sets if marker rendering should be optimized, which will lead to markers being rendered as a single DOM element.
void	setPosition(GeoPoint position) Sets position of the marker
void	setVisible(boolean visible) Sets marker visibility

Method Detail

setPosition

void setPosition(GeoPoint position)

Sets position of the marker

Parameters:

position - position

getPosition

GeoPoint getPosition()

Returns:

position of the marker

setCaption

void setCaption(java.lang.String caption)

Sets caption to be displayed when user hovers the marker

Parameters:

caption - caption

getCaption

java.lang.String getCaption()

Returns:

caption

setDraggable

void setDraggable(boolean draggable)

Sets whether marker should be draggable. Defaults to false

Parameters:

draggable - draggable

isDraggable

boolean isDraggable()

Returns:

true if marker is draggable

setIconUrl

void setIconUrl(java.lang.String iconUrl)

Sets marker's icon URL. IF not specified marker will use standard icon.

Parameters:

iconUrl - icon url

getIconUrl

java.lang.String getIconUrl()

Returns:

marker icon's url

setAnimationEnabled

void setAnimationEnabled(boolean animationEnabled)

Sets whether marker adding animation must be turned on. Disable of a lot of markers should be added at once. Defaults to true

Parameters:

animationEnabled - true if animation should be enabled

isAnimationEnabled

boolean isAnimationEnabled()

Returns:

true if animation is enabled

setOptimized

void setOptimized(boolean optimized)

Sets if marker rendering should be optimized, which will lead to markers being rendered as a single DOM element. This can drastically increase performance when a lot of markers should be displayed. Should be set to false if user wants to use animated marker icon. Defaults to true

Parameters:

optimized - true if marker rendering should be optimized

isOptimized

boolean isOptimized()

Returns:

true if marker rendering optimization is on

isVisible

boolean isVisible()

Returns:

true if marker is visible

setVisible

void setVisible(boolean visible)

Sets marker visibility

Parameters:

visible - true if marker should be visible

isClickable

boolean isClickable()

Returns:

true if clicks on marker will cause click events

setClickable

void setClickable(boolean clickable)

Parameters:

clickable - true if marker is clickable

setIcon

void setIcon(MarkerImage icon)

Sets icon

Parameters:

icon - icon

getIcon

MarkerImage getIcon()

Returns:

icon