Popover

public final class Popover


A representation of a popover object in a 3D map.

Summary

Public methods

final int

The altitude mode of the anchor object that the popover is anchored to.

final @NonNull String

The id of the anchor object that the popover is anchored to.

final @NonNull Point

The offset of the anchor object that the popover is anchored to.

final boolean

Whether the popover is auto-closed when the anchor is occluded.

final boolean

Whether the popover is auto-pan when the anchor is occluded.

final @NonNull Function0<Unit>

The function to update the camera position when the popover is shown the first time auto-pan is enabled.

final @NonNull View

The content of the popover.

final @NonNull Anchorable

The anchor object that the popover is anchored to.

final @NonNull Function0<Unit>

The function to remove the popover from the map.

final void

Hides the popover.

final boolean

Whether the popover is visible on the screen.

final void

Removes the popover from the map.

final void

Shows the popover.

final void

Toggles the visibility of the popover.

Public methods

getAltitudeMode

public final int getAltitudeMode()

The altitude mode of the anchor object that the popover is anchored to.

getAnchorId

public final @NonNull String getAnchorId()

The id of the anchor object that the popover is anchored to.

getAnchorOffset

public final @NonNull Point getAnchorOffset()

The offset of the anchor object that the popover is anchored to.

getAutoCloseEnabled

public final boolean getAutoCloseEnabled()

Whether the popover is auto-closed when the anchor is occluded.

getAutoPanEnabled

public final boolean getAutoPanEnabled()

Whether the popover is auto-pan when the anchor is occluded.

getAutoPanFn

public final @NonNull Function0<UnitgetAutoPanFn()

The function to update the camera position when the popover is shown the first time auto-pan is enabled.

getContent

public final @NonNull View getContent()

The content of the popover.

getPositionAnchor

public final @NonNull Anchorable getPositionAnchor()

The anchor object that the popover is anchored to.

getRemoveFn

public final @NonNull Function0<UnitgetRemoveFn()

The function to remove the popover from the map.

hide

@UiThread
public final void hide()

Hides the popover.

isVisible

public final boolean isVisible()

Whether the popover is visible on the screen.

remove

@UiThread
public final void remove()

Removes the popover from the map.

show

@UiThread
public final void show()

Shows the popover.

toggle

@UiThread
public final void toggle()

Toggles the visibility of the popover.