MarkerOptions (JxMaps API)

java.lang.Object
- com.teamdev.jxmaps.MapObject
- - com.teamdev.jxmaps.MarkerOptions

All Implemented Interfaces:

java.lang.Cloneable
```
public class MarkerOptions
extends MapObject
```
Represents marker object options.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class MarkerOptions.Property

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`MarkerOptions.Property`

Constructor Summary

Constructors
Constructor and Description

MarkerOptions()
Creates new MarkerOptions object.

MarkerOptions(Map map)
Deprecated.

Constructors
Constructor and Description
`MarkerOptions()` Creates new MarkerOptions object.
`MarkerOptions(Map map)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Point`	`getAnchorPoint()` Returns value of anchorPoint property.
`Animation`	`getAnimation()` Returns value of animation property.
`Attribution`	`getAttribution()` Returns value of attribution property.
`boolean`	`getClickable()` Returns value of clickable property.
`boolean`	`getCrossOnDrag()` Returns value of crossOnDrag property.
`java.lang.String`	`getCursor()` Returns value of cursor property.
`boolean`	`getDraggable()` Returns value of draggable property.
`Icon`	`getIcon()` Returns value of icon property.
`java.lang.String`	`getIconString()` Returns value of iconString property.
`Symbol`	`getIconSymbol()` Returns value of iconSymbol property.
`MarkerLabel`	`getLabel()` Returns value of label property.
`java.lang.String`	`getLabelString()` Returns value of labelString property.
`double`	`getOpacity()` Returns value of opacity property.
`boolean`	`getOptimized()` Returns value of optimized property.
`MarkerPlace`	`getPlace()` Returns value of place property.
`LatLng`	`getPosition()` Returns value of position property.
`MarkerShape`	`getShape()` Returns value of shape property.
`java.lang.String`	`getTitle()` Returns value of title property.
`boolean`	`getVisible()` Returns value of visible property.
`double`	`getZIndex()` Returns value of zIndex property.
`void`	`setAnchorPoint(Point value)` Sets new value for anchorPoint property.
`void`	`setAnimation(Animation value)` Sets new value for animation property.
`void`	`setAttribution(Attribution value)` Sets new value for attribution property.
`void`	`setClickable(boolean value)` Sets new value for clickable property.
`void`	`setCrossOnDrag(boolean value)` Sets new value for crossOnDrag property.
`void`	`setCursor(java.lang.String cursor)` Sets new value for cursor property.
`void`	`setDraggable(boolean value)` Sets new value for draggable property.
`void`	`setIcon(Icon value)` Sets new value for icon property.
`void`	`setIconString(java.lang.String value)` Sets new value for iconString property.
`void`	`setIconSymbol(Symbol value)` Sets new value for iconSymbol property.
`void`	`setLabel(MarkerLabel value)` Sets new value for label property.
`void`	`setLabelString(java.lang.String value)` Sets new value for labelString property.
`void`	`setOpacity(double value)` Sets new value for opacity property.
`void`	`setOptimized(boolean value)` Sets new value for optimized property.
`void`	`setPlace(MarkerPlace value)` Sets new value for place property.
`void`	`setPosition(LatLng value)` Sets new value for position property.
`void`	`setShape(MarkerShape value)` Sets new value for shape property.
`void`	`setTitle(java.lang.String value)` Sets new value for title property.
`void`	`setVisible(boolean value)` Sets new value for visible property.
`void`	`setZIndex(double value)` Sets new value for zIndex property.

Methods inherited from class com.teamdev.jxmaps.MapObject
addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MarkerOptions
```
public MarkerOptions()
```
    Creates new MarkerOptions object.
  - MarkerOptions
```
@Deprecated
public MarkerOptions(Map map)
```
    Deprecated.
    
    Creates new MarkerOptions object.
    
    Parameters:
    
    map - owner Map object
- Method Detail
  - getAnchorPoint
```
public Point getAnchorPoint()
```
    Returns value of anchorPoint property.
    Contains the offset from the marker's position to the tip of an InfoWindow that has been opened with the marker as anchor.
    
    Returns:
    
    property value
    
    See Also:
    
    setAnchorPoint(com.teamdev.jxmaps.Point)
  - setAnchorPoint
```
public void setAnchorPoint(Point value)
```
    Sets new value for anchorPoint property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getAnchorPoint()
  - getClickable
```
public boolean getClickable()
```
    Returns value of clickable property.
    If true, the marker receives mouse and touch events. Default value is true.
    
    Returns:
    
    property value
    
    See Also:
    
    setClickable(boolean)
  - setClickable
```
public void setClickable(boolean value)
```
    Sets new value for clickable property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getClickable()
  - getDraggable
```
public boolean getDraggable()
```
    Returns value of draggable property.
    If true, the marker can be dragged. Default value is false.
    
    Returns:
    
    property value
    
    See Also:
    
    setDraggable(boolean)
  - setDraggable
```
public void setDraggable(boolean value)
```
    Sets new value for draggable property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getDraggable()
  - getCrossOnDrag
```
public boolean getCrossOnDrag()
```
    Returns value of crossOnDrag property.
    If false, disables cross that appears beneath the marker when dragging. This option is true by default.
    
    Returns:
    
    property value
    
    See Also:
    
    setCrossOnDrag(boolean)
  - setCrossOnDrag
```
public void setCrossOnDrag(boolean value)
```
    Sets new value for crossOnDrag property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getCrossOnDrag()
  - getOptimized
```
public boolean getOptimized()
```
    Returns value of optimized property.
    Optimization renders many markers as a single static element. Optimized rendering is enabled by default. \Disable optimized rendering for animated GIFs or PNGs, or when each marker must be rendered as a separate DOM element (advanced usage only).
    
    Returns:
    
    property value
    
    See Also:
    
    setOptimized(boolean)
  - setOptimized
```
public void setOptimized(boolean value)
```
    Sets new value for optimized property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getOptimized()
  - getVisible
```
public boolean getVisible()
```
    Returns value of visible property.
    If true, the marker is visible
    
    Returns:
    
    property value
    
    See Also:
    
    setVisible(boolean)
  - setVisible
```
public void setVisible(boolean value)
```
    Sets new value for visible property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getVisible()
  - getCursor
```
public java.lang.String getCursor()
```
    Returns value of cursor property.
    Represents mouse cursor to show on hover
    
    Returns:
    
    property value
    
    See Also:
    
    setCursor(java.lang.String)
  - setCursor
```
public void setCursor(java.lang.String cursor)
```
    Sets new value for cursor property.
    
    Parameters:
    
    cursor - new property value
    
    See Also:
    
    getCursor()
  - getTitle
```
public java.lang.String getTitle()
```
    Returns value of title property.
    Contains rollover text
    
    Returns:
    
    property value
    
    See Also:
    
    setTitle(java.lang.String)
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Sets new value for title property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getTitle()
  - getOpacity
```
public double getOpacity()
```
    Returns value of opacity property.
    Contains the marker's opacity between 0.0 and 1.0.
    
    Returns:
    
    property value
    
    See Also:
    
    setOpacity(double)
  - setOpacity
```
public void setOpacity(double value)
```
    Sets new value for opacity property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getOpacity()
  - getZIndex
```
public double getZIndex()
```
    Returns value of zIndex property.
    All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values. By default, markers are displayed according to their vertical position on screen, with lower markers appearing in front of markers further up the screen.
    
    Returns:
    
    property value
    
    See Also:
    
    setZIndex(double)
  - setZIndex
```
public void setZIndex(double value)
```
    Sets new value for zIndex property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getZIndex()
  - getPosition
```
public LatLng getPosition()
```
    Returns value of position property.
    Contains marker position. Required.
    
    Returns:
    
    property value
    
    See Also:
    
    setPosition(com.teamdev.jxmaps.LatLng)
  - setPosition
```
public void setPosition(LatLng value)
```
    Sets new value for position property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getPosition()
  - getAnimation
```
public Animation getAnimation()
```
    Returns value of animation property.
    Indicates which animation to play when marker is added to a map.
    
    Returns:
    
    property value
    
    See Also:
    
    setAnimation(com.teamdev.jxmaps.Animation)
  - setAnimation
```
public void setAnimation(Animation value)
```
    Sets new value for animation property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getAnimation()
  - getAttribution
```
public Attribution getAttribution()
```
    Returns value of attribution property.
    Contains all the information needed to identify your application as the source of a save. In this context, 'place' means a business, point of interest or geographic location. attribution must be specified with a place in order to enable a save.
    
    Returns:
    
    property value
    
    See Also:
    
    setAttribution(com.teamdev.jxmaps.Attribution)
  - setAttribution
```
public void setAttribution(Attribution value)
```
    Sets new value for attribution property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getAttribution()
  - getPlace
```
public MarkerPlace getPlace()
```
    Returns value of place property.
    Contains place information, used to identify and describe the place associated with this Marker. In this context, 'place' means a business, point of interest or geographic location. To allow a user to save this place, open an info window anchored on this marker. The info window will contain information about the place and an option for the user to save it. Only one of position or place can be specified.
    
    Returns:
    
    property value
    
    See Also:
    
    setPlace(com.teamdev.jxmaps.MarkerPlace)
  - setPlace
```
public void setPlace(MarkerPlace value)
```
    Sets new value for place property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getPlace()
  - getShape
```
public MarkerShape getShape()
```
    Returns value of shape property.
    Contains image map region definition used for drag/click.
    
    Returns:
    
    property value
    
    See Also:
    
    setShape(com.teamdev.jxmaps.MarkerShape)
  - setShape
```
public void setShape(MarkerShape value)
```
    Sets new value for shape property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getShape()
  - getIcon
```
public Icon getIcon()
```
    Returns value of icon property.
    Contains icon for the foreground.
    
    Returns:
    
    property value
    
    See Also:
    
    setIcon(com.teamdev.jxmaps.Icon)
  - setIcon
```
public void setIcon(Icon value)
```
    Sets new value for icon property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getIcon()
  - getIconString
```
public java.lang.String getIconString()
```
    Returns value of iconString property.
    Icon for the foreground. String representation.
    
    Returns:
    
    property value
    
    See Also:
    
    setIconString(java.lang.String)
  - setIconString
```
public void setIconString(java.lang.String value)
```
    Sets new value for iconString property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getIconString()
  - getIconSymbol
```
@Nullable
public Symbol getIconSymbol()
```
    Returns value of iconSymbol property.
    Icon for the foreground. Symbol object.
    
    Returns:
    
    property value
    
    See Also:
    
    setIconSymbol(com.teamdev.jxmaps.Symbol)
  - setIconSymbol
```
public void setIconSymbol(Symbol value)
```
    Sets new value for iconSymbol property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getIconSymbol()
  - getLabel
```
public MarkerLabel getLabel()
```
    Returns value of label property.
    Adds a label to the marker.
    
    Returns:
    
    property value
    
    See Also:
    
    setLabel(com.teamdev.jxmaps.MarkerLabel)
  - setLabel
```
public void setLabel(MarkerLabel value)
```
    Sets new value for label property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getLabel()
  - getLabelString
```
public java.lang.String getLabelString()
```
    Returns value of labelString property.
    Adds a string label to the marker.
    
    Returns:
    
    property value
    
    See Also:
    
    setLabelString(java.lang.String)
  - setLabelString
```
public void setLabelString(java.lang.String value)
```
    Sets new value for labelString property.
    
    Parameters:
    
    value - new property value
    
    See Also:
    
    getLabelString()

Class MarkerOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.teamdev.jxmaps.MapObject

Methods inherited from class java.lang.Object

Constructor Detail

MarkerOptions

MarkerOptions

Method Detail

getAnchorPoint

setAnchorPoint

getClickable

setClickable

getDraggable

setDraggable

getCrossOnDrag

setCrossOnDrag

getOptimized

setOptimized

getVisible

setVisible

getCursor

setCursor

getTitle

setTitle

getOpacity

setOpacity

getZIndex

setZIndex

getPosition

setPosition

getAnimation

setAnimation

getAttribution

setAttribution

getPlace

setPlace

getShape

setShape

getIcon

setIcon

getIconString

setIconString

getIconSymbol

setIconSymbol

getLabel

setLabel

getLabelString

setLabelString