Package io.jmix.mapsui.component

Class TooltipOptions

java.lang.Object

io.jmix.mapsui.component.TooltipOptions

public class TooltipOptions
extends Object

Options for a tooltip.

Constructor Summary

Constructors

Constructor	Description
TooltipOptions()

Method Summary

Modifier and Type	Method	Description
String	getDirection()
Boolean	getInteractive()
Double	getOpacity()
Boolean	getPermanent()
Boolean	getSticky()
TooltipOptions	setDirection(String direction)	Direction where to open the tooltip.
TooltipOptions	setInteractive(Boolean interactive)	If true, the tooltip will accept mouse clicks.
TooltipOptions	setOpacity(Double opacity)	Sets tooltip container opacity.
TooltipOptions	setPermanent(Boolean permanent)	Whether to open the tooltip permanently or only on mouseover.
TooltipOptions	setSticky(Boolean sticky)	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

Constructor Details

TooltipOptions

public TooltipOptions()

Method Details

getDirection

public String getDirection()

setDirection

public TooltipOptions setDirection(String direction)

Direction where to open the tooltip. Possible values are: right, left, top, bottom, center, auto.

auto will dynamically switch between right and left according to the tooltip position on the map.

Default value is auto.

getPermanent

public Boolean getPermanent()

setPermanent

public TooltipOptions setPermanent(Boolean permanent)

Whether to open the tooltip permanently or only on mouseover.

Default value is false.

getSticky

public Boolean getSticky()

setSticky

public TooltipOptions setSticky(Boolean sticky)

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

Default value is false.

getInteractive

public Boolean getInteractive()

setInteractive

public TooltipOptions setInteractive(Boolean interactive)

If true, the tooltip will accept mouse clicks. This mouse click will be propagated to the corresponding geometry. Makes sense only when permanent option is set to true.

Default value is false.

getOpacity

public Double getOpacity()

setOpacity

public TooltipOptions setOpacity(Double opacity)

Sets tooltip container opacity.

Default value is 0.9.