MPIOptions

class MPIOptions

This class holds the options

Constructors

MPIOptions

fun MPIOptions()

Types

AbstractLegacyLabel

interface AbstractLegacyLabel

AbstractLegacyLabel holds the properties of legacy labels of data classes: LegacyLabelInternal and LegacyLabel

AbstractLegacyLabelAllLocations

interface AbstractLegacyLabelAllLocations

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

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>?)

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

Label

data class Label @JvmOverloads() constructor(activeColor: String?, inactiveColor: String?, maxTextDivWidth: Double?, minTextDivWidth: Double?, markerSize: Double?, textSize: Double?, color: String?, textLines: Double?, text: String, shortText: String?, stateText: String?, rank: Double?, appearance: MPIOptions.LabelAppearance?)

Label holds the properties of smart labels to be set when setting labels to polygons

LabelAllLocations

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

LabelAllLocations holds the properties of smart labels to be set at a collection of locations

LabelAppearance

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

LabelAppearance holds the appearance properties of smart labels to be set when labeling polygons

LegacyLabel

data class LegacyLabel(text: String, height: Float?, margin: Float?, color: String?, fontSize: Float?, scaleMin: Float?, scaleStep: Float?) : MPIOptions.AbstractLegacyLabel

LegacyLabel holds the properties of legacy labels to be set when setting legacy labels to polygons

LegacyLabelAllLocations

data class LegacyLabelAllLocations(height: Float?, margin: Float?, color: String?, fontSize: Float?, scaleMin: Float?, scaleStep: Float?, locations: List<String>?) : MPIOptions.AbstractLegacyLabelAllLocations

LegacyLabelAllLocations holds the properties of legacy labels to be set when setting legacy labels to a collection of polygons

LegacyLabelAllLocationsInternal

data class LegacyLabelAllLocationsInternal(legacyLabels: Boolean, height: Float?, margin: Float?, color: String?, fontSize: Float?, scaleMin: Float?, scaleStep: Float?, locations: List<String>?) : MPIOptions.AbstractLegacyLabelAllLocations

LegacyLabelAllLocationsInternal exposes the legacy labels flag to be true internally while setting legacy labels to a collection of polygons

LegacyLabelInternal

data class LegacyLabelInternal(legacyLabels: Boolean, text: String, height: Float?, margin: Float?, color: String?, fontSize: Float?, scaleMin: Float?, scaleStep: Float?) : MPIOptions.AbstractLegacyLabel

LegacyLabelInternal exposes the legacy labels flag to be true internally while setting legacy labels to polygons

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