Skip to main content

interface

BufferedChannel

Properties

val value

T?

CameraMoveController

Class that allows you to control the position of the camera for the needs of animation.

The class must be thread-safe.

Methods
fun position(time: Duration): CameraPosition

Position of the viewing area at a particular point in time. The controller must be prepared for the animation times to be passed in any order, not necessarily non-decreasing.

Parameters

time

Time from the start of the animation in milliseconds.

Returns
CameraPosition

Position of the viewing area at the specified point in time.

fun animationTime(): Duration

Animation duration in milliseconds.

Returns
Duration

Animation duration in milliseconds.

Channel

Methods
@CheckResult
fun connect(executor: Executor, callback: ChannelCallback<T>): AutoCloseable
Parameters
@CheckResult
fun connect(callback: ChannelCallback<T>): AutoCloseable
Parameters

CustomFollowController

Interface that can be implemented on the platform to create custom controller for parameter tracking. To add a controller to a camera, you need to implement this interface and create a FollowController object passing an object that implements this interface as an argument.

Methods
fun availableValues(): EnumSet<FollowValue>

Set of value types that this controller can manage.

fun requestValues(values: EnumSet<FollowValue>): Unit

Tells the controller which values it provides are in use. This frees up the resources associated with calculating unused values. The method can be called multiple times with different values, in which case the last one is considered relevant.

Parameters
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit

Installs a notifier that notifies about new values. The notifier must be stored in the implemented controller

Parameters

notifier

Returns
fun coordinates(): GeoPoint?

Geographical coordinates.

Returns
fun satelliteBearing(): Bearing?

Direction of movement.

Returns
fun magneticBearing(): Bearing?

Direction to magnetic north.

Returns
fun tilt(): Tilt?

Map tilt.

Returns
fun styleZoom(): StyleZoom?

Map style zoom level.

Returns
fun accuracy(): Double?

Precision circle radius (meters).

Returns

Future

Extends: java.lang.AutoCloseable
Methods
fun onComplete(
executor: Executor,
resultCallback: FutureResultCallback<T>,
errorCallback: FutureErrorCallback
): Unit
Parameters

executor

resultCallback

errorCallback

Returns
fun onComplete(resultCallback: FutureResultCallback<T>, errorCallback: FutureErrorCallback): Unit
Parameters

resultCallback

errorCallback

Returns
fun onResult(executor: Executor, callback: FutureResultCallback<T>): Unit
Parameters
fun onResult(callback: FutureResultCallback<T>): Unit
Parameters
fun onError(executor: Executor, callback: FutureErrorCallback): Unit
Parameters

executor

callback

Returns
fun onError(callback: FutureErrorCallback): Unit
Parameters
suspend fun await(): T
Returns
T

HttpClient

Methods
fun sendRequest(request: HttpRequest, callback: HttpResponseCallback): Unit
Parameters

LocationChangeListener

Interface for reporting changes in geolocation and its availability.

Methods
fun onLocationChanged(locations: Array<Location>): Unit
Parameters

locations

Returns
fun onAvailabilityChanged(availability: Boolean): Unit
Parameters

availability

Returns

LocationSource

Methods
fun activate(listener: LocationChangeListener): Unit
Parameters
fun deactivate(): Unit
Returns
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit
Parameters

accuracy

Returns

LogSink

Logging receiver.

Methods
fun write(message: LogMessage): Unit

Logging. The method can be called on an arbitrary thread.

Parameters

message

Returns

MagneticHeadingSource

Methods
fun activate(listener: MagneticChangeListener): Unit
Parameters
fun deactivate(): Unit
Returns

MapEventSender

Interface that allows you to send an input event to the map.

Methods
fun sendEvent(event: Event): Unit
Parameters

event

Returns

MapGestureRecognitionEngine

Interface for gesture recognition.

Extends: java.lang.AutoCloseable
Methods
fun processMotionEvent(event: MotionEvent): Boolean
Parameters

event

Returns
fun resetRecognitionState(): Unit
Returns
fun onDevicePpiChanged(devicePpi: DevicePpi): Unit
Parameters

devicePpi

Returns
fun setMapEventSender(mapEventSender: MapEventSender): Unit
Parameters

mapEventSender

Returns

MutableChannel

Methods
fun send(value: T): Unit
Parameters

value

T
Returns

MutableStatefulChannel

Properties

var value

T

RoadEventActionButtonModel

Action button model for a traffic event.

Methods
fun onClicked(): Unit

Action on click.

Returns
Properties

val icon

Icon?

Icon.

val name

Name, for example, "Confirm".

val countChannel

Number of actions applied to the event by all users.

val highlightChannel

SafeLocationListener

Extends: android.location.LocationListener
Methods
fun onProviderDisabled(provider: String): Unit
Parameters

provider

Returns
fun onProviderEnabled(provider: String): Unit
Parameters

provider

Returns
fun onStatusChanged(
provider: String,
status: Int,
extras: Bundle
): Unit
Parameters

provider

status

extras

Returns

SimpleClusterRenderer

Class for customizing cluster appearance in IMapObjectManager.

Methods
fun renderCluster(cluster: SimpleClusterObject): SimpleClusterOptions

Gets a marker for the cluster.

Parameters

cluster

Cluster object.

Returns
SimpleClusterOptions

Cluster marker object.

StatefulChannel

Properties

val value

T

StyleZoomToTiltRelation

Object for describing the dependence of the camera tilt angle on the style zoom level.

Methods
fun styleZoomToTilt(styleZoom: StyleZoom): Tilt

Gets camera tilt based on style zoom level.

Parameters

styleZoom

Style zoom.

Returns
Tilt

Camera tilt angle

The function should be continuous and monotonic.

The function should be thread-safe.

TouchEventsObserver

Methods
fun onTap(point: ScreenPoint): Unit
Parameters

point

Returns
fun onLongTouch(point: ScreenPoint): Unit
Parameters

point

Returns
fun onDragBegin(data: DragBeginData): Unit
Parameters
fun onDragMove(point: ScreenPoint): Unit
Parameters

point

Returns
fun onDragEnd(): Unit
Returns