Interface Icon

Package world.mappable.mapkit.map

All Superinterfaces:

PlacemarkPresentation

interface Icon extends PlacemarkPresentation

Provides an interface to set icon and its style for a placemark.

Summary

Methods

Type and modifiers

Method and Description

void

setImage(@NonNull ImageProvider image)
Sets the image with the default style for the icon.

void

setImage(@NonNull ImageProvider image,
         @NonNull IconStyle style)

Sets the image with the given style for the icon.

void

setImage(@NonNull ImageProvider image,
         @NonNull IconStyle style,
         @NonNull Callback onFinished)

Sets the image with the given style for the icon.

void

setView(@NonNull ViewProvider view)
Sets the view with the given style for the icon.

void

setView(@NonNull ViewProvider view,
        @NonNull IconStyle style)

Sets the view with the default style for the icon.

void

setView(@NonNull ViewProvider view,
        @NonNull IconStyle style,
        @NonNull Callback onFinished)

Sets the view with the given style for the icon.

IconStyle

getStyle()
The style properties (scale, zIndex, etc.) of the icon placemark.

void

setStyle(@NonNull IconStyle style)

Methods

setImage

void setImage(@NonNull ImageProvider image)

Sets the image with the default style for the icon.


setImage

void setImage(@NonNull ImageProvider image,
              @NonNull IconStyle style)

Sets the image with the given style for the icon.


setImage

void setImage(@NonNull ImageProvider image,
              @NonNull IconStyle style,
              @NonNull Callback onFinished)

Sets the image with the given style for the icon.

The callback will be called immediately after the icon finished loading.

Parameters

onFinished

Called when the icon is loaded.


setView

void setView(@NonNull ViewProvider view)

Sets the view with the given style for the icon.


setView

void setView(@NonNull ViewProvider view,
             @NonNull IconStyle style)

Sets the view with the default style for the icon.


setView

void setView(@NonNull ViewProvider view,
             @NonNull IconStyle style,
             @NonNull Callback onFinished)

Sets the view with the given style for the icon.

The callback will be called immediately after the icon finished loading.

Parameters

onFinished

Called when the icon is loaded.


getStyle

@NonNull
IconStyle getStyle()

The style properties (scale, zIndex, etc.) of the icon placemark.

Note: The current style cannot be modified directly - you must reset it to apply changes.


setStyle

void setStyle(@NonNull IconStyle style)