MPIOptions

class MPIOptions

This class holds the options

Constructors

MPIOptions

fun MPIOptions()

Types

AbstractFlatLabel

interface AbstractFlatLabel

AbstractFlatLabel holds the properties of flat labels of data classes: FlatLabelInternal and FlatLabel

AbstractFlatLabelAllLocations

interface AbstractFlatLabelAllLocations

AbstractFlatLabelAllLocations holds the properties of flat label all locations of data classes: FlatLabelAllLocationsInternal and FlatLabelAllLocations

BlueDot

data class BlueDot(allowImplicitFloorLevel: Boolean?, smoothing: Boolean?, showBearing: Boolean?, baseColor: String?)

BlueDot holds the properties of values to be set when enabling blue dot

ConnectionPath

data class ConnectionPath @JvmOverloads() constructor(drawDuration: Double?, nearRadius: Double?, farRadius: Double?, color: String?)

Connection path object

FlatLabel

data class FlatLabel(text: String?, appearance: MPIOptions.FlatLabelAppearance?) : MPIOptions.AbstractFlatLabel

FlatLabel holds the properties of flat labels to be set when setting flat label to polygons

FlatLabelAllLocations

data class FlatLabelAllLocations(appearance: MPIOptions.FlatLabelAppearance?, locations: List<String>?) : MPIOptions.AbstractFlatLabelAllLocations

FlatLabelAllLocations holds the properties of flat labels to be set when setting flat labels to a collection of polygons

FlatLabelAllLocationsInternal

data class FlatLabelAllLocationsInternal(legacyLabels: Boolean, appearance: MPIOptions.FlatLabelAppearance?, locations: List<String>?) : MPIOptions.AbstractFlatLabelAllLocations

FlatLabelAllLocationsInternal exposes the flat labels flag to be true internally while setting flat labels to a collection of polygons

FlatLabelAppearance

data class FlatLabelAppearance @JvmOverloads() constructor(height: Float?, margin: Float?, color: String?, fontSize: Float?, scaleMin: Float?, scaleStep: Float?)

FlatLabelAppearance holds the appearance properties of flat labels to be set when labeling polygons

FlatLabelInternal

data class FlatLabelInternal(flatLabels: Boolean, text: String?, appearance: MPIOptions.FlatLabelAppearance?) : MPIOptions.AbstractFlatLabel

FlatLabelInternal exposes the flat labels flag to be true internally while setting flat labels to polygons

FloatingLabel

data class FloatingLabel @JvmOverloads() constructor(text: String, shortText: String?, stateText: String?, rank: Double?, appearance: MPIOptions.FloatingLabelAppearance?)

FloatingLabel holds the properties of floating labels to be set when setting labels to polygons

FloatingLabelAllLocations

data class FloatingLabelAllLocations @JvmOverloads() constructor(appearance: MPIOptions.FloatingLabelAppearance?, locations: List<String>?)

FloatingLabelAllLocations holds the properties of floating labels to be set at a collection of locations

FloatingLabelAppearance

data class FloatingLabelAppearance @JvmOverloads() constructor(margin: Double?, text: MPIOptions.FloatingLabelAppearance.Text?, marker: MPIOptions.FloatingLabelAppearance.Marker?)

FloatingLabelAppearance holds the appearance properties of floating labels to be set when labeling polygons

Focus

data class Focus @JvmOverloads() constructor(nodes: List<MPINavigatable.MPINode>?, polygons: List<MPINavigatable.MPIPolygon>?, duration: Double?, changeZoom: Boolean?, minZoom: Double?, tilt: Double?, padding: MPIOptions.FocusPadding?, focusZoomFactor: Double?)

Focus holds the properties of values to be set when focus on is called

FocusPadding

data class FocusPadding(top: Double, bottom: Double, left: Double, right: Double)

Focus padding for focus

Init

data class Init @JvmOverloads() constructor(clientId: String, clientSecret: String, venue: String, perspective: String?, baseUrl: String, noAuth: Boolean, firstMapId: String?, headers: List<MPIHeader>?, useBundle: Boolean?)

This class hold the properties of values to be used when initialzing a map

Journey

data class Journey @JvmOverloads() constructor(connectionTemplateString: String?, destinationMarkerTemplateString: String?, departureMarkerTemplateString: String?, pathOptions: MPIOptions.Path?, polygonHighlightColor: String?)

Journey holds the properties of journey when drawing jouney

Marker

data class Marker(rank: Double?, anchor: MPIOptions.MARKER_ANCHOR?)

TODO: Fill ME!

MARKER_ANCHOR

enum MARKER_ANCHOR : Enum<MPIOptions.MARKER_ANCHOR>

MARKER_ANCHOR holds the properties of anchor when adding markers

MARKER_ANCHOR_SERIALIZER

object MARKER_ANCHOR_SERIALIZER

serializer for marker anchor

Path

data class Path @JvmOverloads() constructor(color: String?, pulseColor: String?, nearRadius: Double?, farRadius: Double?, drawDuration: Double?, drawConnectionSegments: Boolean?, pulseIterations: Double?, connectionPathOptions: MPIOptions.ConnectionPath?, displayArrowsOnPath: Boolean?)

Path holds the properties of values to be set when path is drawn

ShowVenue

data class ShowVenue(firstMapId: String?, labelAllLocationsOnInit: Boolean, backgroundColor: String?, backgroundAlpha: Double?)

ShowVenue holds the properties of values to be set when showing a venue.

Functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open override fun toString(): String

convert Marker to string