com.gwidgets.api.leaflet.options

Class TooltipOptions

java.lang.Object

com.gwidgets.api.leaflet.options.TooltipOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class TooltipOptions
extends Object

The Class TooltipOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TooltipOptions.Builder

Method Summary

Modifier and Type	Method and Description
String	getAttribution()
String	getClassName()
String	getDirection() Direction where to open the tooltip.
boolean	getInteractive() If true, the tooltip will listen to the feature events.
Point	getOffset() Optional offset of the tooltip position.
double	getOpacity() Tooltip container opacity.
String	getPane() Returns the popup bound to this layer.
boolean	getPermanent() Whether to open the tooltip permanently or only on mouseover.
boolean	getSticky() If true, the tooltip will follow the mouse instead of being fixed at the feature center.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPane

@JsOverlay
public final String getPane()

Returns the popup bound to this layer.

getOffset

@JsOverlay
public final Point getOffset()

Optional offset of the tooltip position.

getPermanent

@JsOverlay
public final boolean getPermanent()

Whether to open the tooltip permanently or only on mouseover.

getDirection

@JsOverlay
public final String getDirection()

Direction where to open the tooltip. Possible values are: right, left, top, bottom, center, auto. auto will dynamicaly switch between right and left according to the tooltip position on the map.

getSticky

@JsOverlay
public final boolean getSticky()

If true, the tooltip will follow the mouse instead of being fixed at the feature center.

getInteractive

@JsOverlay
public final boolean getInteractive()

If true, the tooltip will listen to the feature events.

getOpacity

@JsOverlay
public final double getOpacity()

Tooltip container opacity.

getClassName

@JsOverlay
public final String getClassName()

getAttribution

@JsOverlay
public final String getAttribution()