Maps SDK for Android/com.magiclane.sdk.d3scene/OverlayItem

OverlayItem

class OverlayItem : GemNativeObj

Marker object.

Constructors

constructor()

constructor(address: Long)

constructor(address: Long, isRef: Boolean)

Properties

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

val categoryId: Int

OverlayItem category id

val coordinates: Coordinates?

The marker coordinates

val image: Image?

The image of the item.

val name: String?

The name of the item.

val overlayInfo: OverlayInfo?

The parent overlay info.

val overlayUid: Int

The parent overlay UID.

The unique ID of the item within the overlay.

Functions

external fun assign(value: OverlayItem)

Copies value into this instance

cancelGetPreviewExtendedData

external fun cancelGetPreviewExtendedData(listener: ProgressListener)

Cancel an asynchronous get OverlayItem preview EXTENDED data.

Overrides finalize that garbage collector will call when needed.

external fun getPreviewData(): ParameterList?

Get OverlayItem preview data as parameters list

fun getPreviewData(type: EPreviewDataType): String?

Get OverlayItem data

getPreviewExtendedData

external fun getPreviewExtendedData(list: GemList<Parameter>, listener: ProgressListener): Int

Asynchronous get OverlayItem preview EXTENDED data (dynamic data that needs to be downloaded) as parameters list.

external fun getPreviewUrl(webViewSize: Size?): String?

Get the preview URL for the item (if any). The preview URL may be opened by the UI into a web browser window to present more details to the user about this item.

hasPreviewExtendedData

external fun hasPreviewExtendedData(): Boolean

Check if this type of OverlayItem has preview EXTENDED data (dynamic data that needs to be downloaded)

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

operator fun not(): Boolean

Checks if this object is valid.

Releases the native referenced value of this object if: