Skip to main content

class

ActivityTracker

ActivityTracker(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: Duration = Duration.ofMilliseconds(20000)
)

A navigator extension that monitors user activity and emits a signal when the user has stopped using the navigator and can be turned off.

Parameters

platformContext

Context.

model

Model of the navigator the status of which is being monitored.

speedBound

Upper speed limit in m/s, above which in the Finished state of the navigator it is considered that the navigator is active, i.e. the movement continues.

timeThreshold

The amount of time the Navigator's Finished state monitors movement below the threshold to determine if the Navigator is inactive. If during this time the movement rate is less than the set threshold, or there is no location and speed data, the Navigator is considered inactive.

Properties

val stopChannel

An active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, i.e. the movement stops or its speed falls below the threshold, and if this state persists for some time, then the flag is set is set to true, otherwise it is set to false.

val stop

An active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, i.e. the movement stops or its speed falls below the threshold, and if this state persists for some time, then the flag is set is set to true, otherwise it is set to false.

AddEventResult

Result of adding event (event object or error).

AddEventResult(event: RoadEvent)
Parameters
AddEventResult(error: AddEventError)
Parameters
Methods
fun match(event: Function1, error: Function1): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

val isEvent

val asEvent

val isError

val asError

val value

Address

Address as a set of separate components.

Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
postCode: String?,
buildingCode: String?,
addressComment: String?
)

Address as a set of separate components.

Parameters

drillDown

components

buildingName

postCode

buildingCode

addressComment

Properties

val drillDown

The set of administrative division objects where the described object is located.

val components

A full address of an object may contain several separate address components.

val buildingName

Name of the building.

val postCode

ZIP code.

val buildingCode

The unique ZIP code of the building.

val addressComment

Comment on the address. Example: "301 office; 9th floor"

AddressAdmDiv

Object of administrative division.

AddressAdmDiv(type: String, name: String)

Object of administrative division.

Parameters

type

name

Properties

val type

The type of the administrative unit. One of the following:

  • country
  • region (province/territory/republic, etc.)
  • district_area - district of the region
  • city
  • settlement
  • division
  • district
  • living_area - residential estate, microdistrict
  • place

val name

AddressComponent

The address component: street, house number, or verbal description of location.

AddressComponent(streetAddress: AddressStreet)
Parameters

streetAddress

AddressComponent(number: AddressNumber)
Parameters
AddressComponent(location: AddressLocation)
Parameters
Methods
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

val isStreetAddress

val asStreetAddress

val isNumber

val asNumber

val isLocation

val asLocation

val value

AddressLocation

Used for components that are difficult to describe with a specific address.

AddressLocation(comment: String)

Used for components that are difficult to describe with a specific address.

Parameters

comment

Properties

val comment

Text description of the building location.

AddressNumber

In some settlements, only the house number is indicated, without the street (for example, Krasnoobsk).

AddressNumber(number: String)

In some settlements, only the house number is indicated, without the street (for example, Krasnoobsk).

Parameters

number

Properties

val number

House number, including fractions and letters. Possibly a proper name, if that's the custom.

AddressStreet

Regular address, there is a street and a building number.

AddressStreet(street: String, number: String)

Regular address, there is a street and a building number.

Parameters

street

number

Properties

val street

Street name.

val number

House number, including fractions, cases and letters.

AddRoadEventButton

Button for adding a traffic event.

AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Button for adding a traffic event.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

AddRoadEventCard

Card for adding a road event.

AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Card for adding a road event.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
Properties

const MAX_DESCRIPTION_LENGTH

AddRoadEventCardModel

Model of the card for adding a road event.

Implements: java.lang.AutoCloseable
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)

Model of the card for adding a road event.

Parameters

roadEventManager

map

Methods
fun onEventTypeClicked(type: RoadEventType): Unit

Action when the event type selection control is clicked.

Parameters
fun onLaneClicked(lane: Lane): Unit

Action when the lane selection control is clicked.

Parameters

lane

Returns
fun onDescriptionEntered(description: String): Unit

Action when entering description.

Parameters

description

Returns
fun onSendClicked(): Unit

Action when the submit button is clicked.

Returns
fun close(): Unit
Returns
Properties

val eventTypeChannel

Selected event type.

val lanesChannel

val canSelectLanesChannel

Is it possible to set lanes.

val descriptionChannel

Entered description.

val markerPositionChannel

Marker position on the screen.

val canSendChannel

Is it possible to send an event.

val resultChannel

The result of sending the event.

AddRoadEventControl

Base class for controls for adding traffic events.

Extends: android.widget.FrameLayout
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Base class for controls for adding traffic events.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
@CallSuper
fun detachFromModel(): Unit
Returns
fun onAttachedToWindow(): Unit
Returns
fun onDetachedFromWindow(): Unit
Returns

AddRoadEventControls

A set of controls for adding road events. Consists of a card with event parameters, "Submit" button and a marker indicating the location of adding an event on the map.

AddRoadEventControls(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

A set of controls for adding road events. Consists of a card with event parameters, "Submit" button and a marker indicating the location of adding an event on the map.

Parameters

context

attrs

defStyle

Methods
fun show(): Unit
Returns
fun hide(): Unit
Returns
fun attachToMap(map: Map): Unit
Parameters

map

Returns
fun detachFromMap(map: Map): Unit
Parameters

map

Returns
Properties

val cardHeightChannel

Height in pixels to which the card is expanded.

AddRoadEventMarker

Marker for adding a road event.

AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Marker for adding a road event.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
fun detachFromModel(): Unit
Returns

AlternativeRoutesProviderSettings

Properties

var alternativeRoutesEnabled

Flag to enable/disable suggesting alternative routes. By default, this option is enabled.

var betterRouteEnabled

Flag to enable/disable suggesting a better route. By default, this option is enabled.

var routeSearchDelay

Delay before searching for alternative routes when starting a trip on a route or after switching to another route. Should be no less than 5 seconds. The default value is 20 seconds.

var betterRouteTimeCostThreshold

Minimum travel time difference between the original route and the alternative route for which the alternative route is considered a better route.

var betterRouteLengthThreshold

Minimum total length of route edges that differ between the original route and the alternative route at which the alternative route is considered a better route.

Anchor

Image anchor point. (0, 0) - upper left corner, (1, 1) - lower right.

Anchor(x: Float = 0.5f, y: Float = 0.5f)

Image anchor point. (0, 0) - upper left corner, (1, 1) - lower right.

Parameters
Properties

ApartmentRange

Range of apartments.

ApartmentRange(start: String, end: String? = null)

Range of apartments.

Parameters
Properties

val start

Beginning of the range/stored value. Currently, only numeric values are possible, while there are no flats with suffixes in the data yet.

val end

The end of the range. If absent, then the range consists of a single value start. Otherwise, it is an arithmetic progression from start to end in increments of 1.

Attribute

Additional attribute. Example: { tag: "hotel_room_internet", name: "Free internet in rooms" }

Attribute(tag: String, value: String)

Additional attribute. Example: { tag: "hotel_room_internet", name: "Free internet in rooms" }

Parameters

tag

value

Properties

val tag

Tag.

val value

Value.

Attributes

Interface for managing map object properties.

Only map objects have properties, but you can set default properties for the entire map, for the style and for the source (see ISource for details).

Methods
fun setAttributeValue(name: String, value: AttributeValue): Unit

Setting property.

Parameters

name

Property name.

value

Returns
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit

Setting a property set.

Parameters

values

Set of the "name":"value" pairs for the added property.

attributesToRemove

List of names of properties to be removed.

Returns
fun removeAttribute(name: String): Unit

Deleting a property.

Parameters

name

Name of property to delete.

Returns
fun getAttributeValue(name: String): AttributeValue

Getting a property.

Parameters

name

Name of property to get.

Returns
Properties

val attributeNames

Getting a list of properties.

val changed

Getting a channel that notifies about property changes.

AttributeValue

Properties of map objects.

AttributeValue()
AttributeValue(boolean: Boolean)
Parameters

boolean

AttributeValue(number: Double)
Parameters

number

AttributeValue(integer: Long)
Parameters

integer

AttributeValue(string: String)
Parameters

string

AttributeValue(data: ByteArray)
Parameters
AttributeValue(array: List<AttributeValue>)
Parameters
AttributeValue(item: Map)
Parameters

item

Methods
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

val isEmpty

val isBoolean

val asBoolean

val isNumber

val asNumber

val isInteger

val asInteger

val isString

val asString

val isData

val asData

val isArray

val asArray

val isObject

val asObject

val value

AuthorInfo

Information about the author of the event or photo.

AuthorInfo(type: AuthorType, name: String)

Information about the author of the event or photo.

Parameters
Properties

val type

Content author category.

val name

A string containing the name of the user who added the event or photo.

  • Username if the author is an authorized user and has agreed to have their name displayed.
  • An empty string for an anonymous user or a user who has refused to display their name.

BaseCamera

Camera.

Sets the parameters for projecting the map onto the screen.

Methods
fun clone(): BaseCamera

Create a copy of the current camera.

Returns
Properties

val projection

Projection.

Used to get a screen point from a map point and a map point from a screen point. Camera parameters are fixed at the time of the call.

val positionChannel

Getting the current camera position.

var position

Getting the current camera position.

val zoomRestrictionsChannel

Get actual zoom level limits.

var zoomRestrictions

Get actual zoom level limits.

val deviceDensityChannel

Getting the DPI ratio to the device's base DPI.

val deviceDensity

Getting the DPI ratio to the device's base DPI.

val sizeChannel

Get viewport size.

var size

Get the size of the viewing area.

val paddingChannel

Get current paddings from screen edges.

var padding

Get current paddings from screen edges.

val positionPointChannel

The point on the screen to which the camera position is attached is set taking padding into account.

var positionPoint

The point on the screen to which the camera position is attached is set taking padding into account.

val visibleArea

The area of intersection of the visibility pyramid of the camera and the surface of the map.

val visibleRectChannel

The bounding rectangle of the visible area of the map.

val visibleRect

The bounding rectangle of the visible area of the map.

val styleZoomToTiltRelationChannel

Getting the current function of the dependency of the camera tilt angle on the style zoom level.

var styleZoomToTiltRelation

Getting the current function of the dependency of the camera tilt angle on the style zoom level.

val maxTiltRestrictionChannel

Getting the current function of the maximum camera tilt angle dependency on the style zoom level.

var maxTiltRestriction

Getting the current function of the maximum camera tilt angle dependency on the style zoom level.

Bearing

The angle between the directions of two objects or between the direction of the object and north. The angle is measured clockwise. The range of values is 0°,360°.

Bearing(value: Double = 0.0)

The angle between the directions of two objects or between the direction of the object and north. The angle is measured clockwise. The range of values is 0°,360°.

Parameters

value

Properties

val value

BetterRouteInfo

Information about an available alternative route.

BetterRouteInfo(trafficRoute: TrafficRoute, startPoint: RoutePoint)

Information about an available alternative route.

Parameters

trafficRoute

startPoint

Properties

val trafficRoute

Alternative route.

val startPoint

The point on the alternative route, from which the movement starts in case of switchingt to this route.

BetterRoutePromptControl

Dialog prompting you to switch to route following with a lower expected arrival time.

BetterRoutePromptControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Dialog prompting you to switch to route following with a lower expected arrival time.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Properties

val visibilityChannel

BicycleBriefRouteInfo

Basic information about the cycling route.

BicycleBriefRouteInfo(length: RouteDistance, landmark: String)

Basic information about the cycling route.

Parameters

length

landmark

Properties

val length

Route length.

val landmark

Landmark.

BicycleInstructionCrossroad

Description of maneuvers when passing through an intersection or a pedestrian crossing.

BicycleInstructionCrossroad(landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.NONE, maneuvers: List<BicycleInstructionCrossroadManeuver>)

Description of maneuvers when passing through an intersection or a pedestrian crossing.

Parameters
Properties

val landmark

val maneuvers

A chain of consecutive maneuvers.

BicycleInstructionCrossroadManeuver

BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Parameters
Properties

val direction

val turnAngle

Angle of rotation in degrees -180,180.

BicycleInstructionFinish

End of the cycling part of the route.

BicycleInstructionFinish()

End of the cycling part of the route.

Methods
fun toString(): String
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
fun hashCode(): Int
Returns

BicycleInstructionStart

Beginning of the cycling part of the route.

BicycleInstructionStart()

Beginning of the cycling part of the route.

Methods
fun toString(): String
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
fun hashCode(): Int
Returns

BicycleRouteSearchOptions

Bike route search options.

BicycleRouteSearchOptions(
avoidCarRoads: Boolean = false,
avoidStairways: Boolean = false,
avoidUnderpassesAndOverpasses: Boolean = false,
excludedAreas: List<ExcludedArea> = listOf()
)

Bicycle route search options.

Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

val avoidCarRoads

Avoid highways.

val avoidStairways

Avoid stairways.

val avoidUnderpassesAndOverpasses

Avoid underground and elevated passages.

val excludedAreas

Excluded areas (not more than 25).

BoolRouteLongAttribute

A container that stores an extended route attribute. Each element is stored as a pair consisting of a point and an attribute element value. Attribute action starts at this point and ends at the next point, at which the next element's attribute action begins.

Methods
fun entry(point: RoutePoint): BoolRouteLongEntry?

The element that the specified point falls into.

Parameters
fun entries(begin: RoutePoint, end: RoutePoint): List<BoolRouteLongEntry>

Elements partially or completely covered by begin,end.

Parameters
Properties

val size

Amount of elements.

val isEmpty

Elements are missing.

val first

First element.

val last

Last element.

val entries

BoolRouteLongEntry

Extended route element - segment and value on it.

BoolRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Boolean
)

Extended route element - segment and value on it.

Parameters
Properties

val point

val length

val value

BriefExtraRouteInfo

Additional information about the route for a specific type of transport.

BriefExtraRouteInfo(bicycle: BicycleBriefRouteInfo)
Parameters
BriefExtraRouteInfo(car: CarBriefRouteInfo)
Parameters
BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)
Parameters
BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)
Parameters

publicTransport

BriefExtraRouteInfo(scooter: ScooterBriefRouteInfo)
Parameters
Methods
fun match(
bicycle: Function1,
car: Function1,
pedestrian: Function1,
publicTransport: Function1,
scooter: Function1
): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

val isBicycle

val asBicycle

val isCar

val asCar

val isPedestrian

val asPedestrian

val isPublicTransport

val asPublicTransport

val isScooter

val asScooter

val value

BriefPublicTransportCard

A short card that displays information about a public transport route. Unlike a PublicTransportCard, it does not contain information about transfers.

Extends: android.widget.FrameLayout
BriefPublicTransportCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

A short card that displays information about a public transport route. Unlike a PublicTransportCard, it does not contain information about transfers.

Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns

BriefPublicTransportCardModel

Model for BriefPublicTransportCard.

BriefPublicTransportCardModel(route: TrafficRoute, context: Context)

Model for BriefPublicTransportCard.

Parameters
Properties

val title

Title. Estimated travel time, for example, "1 hour 42 minutes".

val transports

Transport information.

val description

Description. Number of transfers and walking time, e.g. 1transfer,15min walk.

BriefRoadEvent

BriefRoadEvent(
id: Long = 0,
eventType: RoadEventType = RoadEventType.OTHER,
lanes: EnumSet<Lane>
)
Parameters
Properties

val id

val eventType

val lanes

BriefRouteInfo

Basic route information.

BriefRouteInfo(duration: Duration, extraInfo: BriefExtraRouteInfo)

Basic route information.

Parameters
Properties

val duration

Driving time along the route.

val extraInfo

Additional information about the route for a specific type of transport.

BriefRouteInfoSearchPoints

Points to