Interface IMarker
- All Superinterfaces:
IAnchor
,ICefObjRef
,IComponentMouseDragEventObject
,IComponentMouseEventObject
,IOptionedMapObject<provided.mixedData.MixedDataDictionary>
,IVisibleMapObject
- All Known Subinterfaces:
IMarkerWrapped
public interface IMarker extends ICefObjRef, IVisibleMapObject, IComponentMouseEventObject, IComponentMouseDragEventObject, IAnchor, IOptionedMapObject<provided.mixedData.MixedDataDictionary>
Represents a marker placed on the map. Markers can be used as anchor points for info windows
- Author:
- swong
-
Method Summary
Modifier and Type Method Description boolean
getClickable()
Returns whether or not the marker is clickablejava.lang.String
getCursor()
Get the CSS cursor type shown when hovering over the markerboolean
getDraggable()
Returns whether or not the marker is draggablejava.lang.String
getIcon()
Get the URL of the icon for the markerIMarkerLabel
getLabel()
Get the label of the markerdouble
getOpacity()
Get the opacity of the markerILatLng
getPosition()
The LatLng position of this anchor point.java.lang.String
getTitle()
Get the title of the markerdouble
getZIndex()
Gets the z-index of the marker on the mapvoid
setClickable(boolean isClickable)
Sets whether or not the marker is clickablevoid
setCursor(java.lang.String cursor)
Set the CSS cursor type shown when hovering over the markervoid
setDraggable(boolean isDraggable)
Sets whether or not the marker is draggablevoid
setIcon(java.lang.String url)
Set the URL string of the marker's iconvoid
setLabel(IMarkerLabel label)
Set the label of the markervoid
setMarkerEvent(MarkerEventType eventType, java.lang.Runnable eventFn)
Set an MarkerEventType event on the markervoid
setOpacity(double opacity)
Set the opacity of the markervoid
setPosition(ILatLng latLng)
Set the position of this markervoid
setTitle(java.lang.String title)
Set the title of the marker.void
setZIndex(double zIndex)
Sets the z-index of the marker on the mapMethods inherited from interface provided.owlMaps.general.IAnchor
getPixelOffset
Methods inherited from interface provided.owlMaps.cefUtils.ICefObjRef
getCefId
Methods inherited from interface provided.owlMaps.mouse.IComponentMouseDragEventObject
setComponentMouseDragEvent
Methods inherited from interface provided.owlMaps.mouse.IComponentMouseEventObject
setComponentMouseEvent
Methods inherited from interface provided.owlMaps.general.IOptionedMapObject
setOptions
Methods inherited from interface provided.owlMaps.general.IVisibleMapObject
getVisible, setVisible
-
Method Details
-
getPosition
ILatLng getPosition()Description copied from interface:IAnchor
The LatLng position of this anchor point.- Specified by:
getPosition
in interfaceIAnchor
- Returns:
- The ILatLng of the anchor's location
-
setPosition
Set the position of this marker- Parameters:
latLng
- The new position
-
getLabel
IMarkerLabel getLabel()Get the label of the marker- Returns:
- The label value
-
setLabel
Set the label of the marker- Parameters:
label
- The new label for the marker
-
getTitle
java.lang.String getTitle()Get the title of the marker- Returns:
- The title of the marker
-
setTitle
void setTitle(java.lang.String title)Set the title of the marker. Note that this may appear to override the marker's label.- Parameters:
title
- The new title of the marker
-
getClickable
boolean getClickable()Returns whether or not the marker is clickable- Returns:
- true if clickable, false otherwise
-
setClickable
void setClickable(boolean isClickable)Sets whether or not the marker is clickable- Parameters:
isClickable
- true if clickable, false otherwise.
-
getDraggable
boolean getDraggable()Returns whether or not the marker is draggable- Returns:
- true if draggable, false otherwise
-
setDraggable
void setDraggable(boolean isDraggable)Sets whether or not the marker is draggable- Parameters:
isDraggable
- true if draggable, false otherwise
-
getOpacity
double getOpacity()Get the opacity of the marker- Returns:
- The opacity value [0.0, 1.0]
-
setOpacity
void setOpacity(double opacity)Set the opacity of the marker- Parameters:
opacity
- The new opacity value [0.0, 1.0]
-
getIcon
java.lang.String getIcon()Get the URL of the icon for the marker- Returns:
- The URL string of the icon
-
setIcon
void setIcon(java.lang.String url)Set the URL string of the marker's icon- Parameters:
url
- A URL string
-
getCursor
java.lang.String getCursor()Get the CSS cursor type shown when hovering over the marker- Returns:
- The CSS cursor type for the marker
-
setCursor
void setCursor(java.lang.String cursor)Set the CSS cursor type shown when hovering over the marker- Parameters:
cursor
- The CSS cursor type for the marker
-
getZIndex
double getZIndex()Gets the z-index of the marker on the map- Returns:
- the z-index
-
setZIndex
void setZIndex(double zIndex)Sets the z-index of the marker on the map- Parameters:
zIndex
- The new z-index
-
setMarkerEvent
Set an MarkerEventType event on the marker- Parameters:
eventType
- The event typeeventFn
- The callback to use when the event occurs
-