class
ActivityTracker
val stopChannel
Active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, (the movement stops or its speed falls below the threshold) and this state persists for some time, the flag is set to true, otherwise it is set to false.
val stop
Active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, (the movement stops or its speed falls below the threshold) and this state persists for some time, the flag is set to true, otherwise it is set to false.
AddEventResult
Result of adding an event (event object or error).
fun match(event: Function1, error: Function1): T
fun toString(): String
fun hashCode(): Int
Address
Address as a set of separate components.
Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)
Address as a set of separate components.
drillDown
components
buildingName
postCode
buildingCode
fiasCode
addressComment
val drillDown
Set of administrative division objects where the described object is located.
val components
Full address of an object may contain several separate address components.
val buildingName
Name of the building.
val postCode
ZIP code.
val buildingCode
Unique ZIP code of the building.
val fiasCode
FIAS code of the building.
val addressComment
Comment on the address. Example: "office 301; 9th floor"
AddressAdmDiv
Object of administrative division.
AddressComponent
Address component: street, house number, or verbal description of location.
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
fun toString(): String
fun hashCode(): Int
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.
comment
AddressNumber
House number used as a full address. In some settlements, only the house number is indicated, without the street (for example, Krasnoobsk).
AddressStreet
Regular address with a street name and a building number.
AddRoadEventButton
Button for adding a road event.
AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Button for adding a road event.
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCard
Card for adding a road event.
AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Card for adding a road event.
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCardModel
Model of the card for adding a road event.
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)
Model of the card for adding a road event.
fun onEventTypeClicked(type: RoadEventType): Unit
Action that occurs when the event type selection control is clicked.
fun onLaneClicked(lane: Lane): Unit
Action that occurs when the lane selection control is clicked.
fun onDescriptionEntered(description: String): Unit
Action that occurs when entering description.
fun close(): Unit
val eventTypeChannel
Selected event type.
val lanesChannel
Selected lanes.
val canSelectLanesChannel
Whether it is possible to set lanes.
val descriptionChannel
Entered description.
val markerPositionChannel
Marker position on the screen.
val canSendChannel
Whether it is possible to send an event.
val resultChannel
Result of sending the event.
AddRoadEventControl
Base class for controls for adding road events.
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Base class for controls for adding road events.
fun attachToModel(model: AddRoadEventCardModel): Unit
@CallSuper
fun detachFromModel(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
AddRoadEventControls
Set of controls for adding road events. Consists of a card with event parameters, a "Submit" button, and a marker indicating the location of adding an event on the map.
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.
fun attachToModel(model: AddRoadEventCardModel): Unit
fun detachFromModel(): Unit
AlternativeRouteSelector
AlternativeRoutesProviderSettings
Settings of searching for alternative routes and a better route.
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. Must be not 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 corner.
ApartmentRange
Range of apartments.
val start
Beginning of the range/stored value. Currently, only numeric values are possible, while there are no apartments with suffixes in the data yet.
val end
End of the range. If absent, the range consists of a single start value. 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" }
Attributes
Interface for managing map object properties.
Only map objects have properties, but you can set default properties for the entire map, the style, and the source (see ISource for details).
fun setAttributeValue(name: String, value: AttributeValue): Unit
Sets a property.
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit
Sets a property set.
values
Set of the "name":"value" pairs for the added property.
attributesToRemove
List of names of properties to be removed.
fun removeAttribute(name: String): Unit
Deletes a property.
fun getAttributeValue(name: String): AttributeValue
Gets a property.
AttributeValue
Properties of map objects.
AttributeValue()
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
empty
boolean
number
integer
string
data
array
item
fun toString(): String
fun hashCode(): Int
AuthorInfo
Information about the author of the event or the photo.
AuthorInfo(type: AuthorType, name: String)
Information about the author of the event or the photo.
BaseCamera
Camera.
Sets the parameters for projecting the map onto the screen.
fun changePosition(positionChange: CameraPositionChange): Unit
Changes only a part of the camera position parameters.
The call interrupts flyover and gesture processing, and also resets following of changed parameters, and when changing coordinates, also resets following the style zoom level and direction.
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
Gets the current camera position.
var position
Gets the current camera position.
val zoomRestrictionsChannel
Gets current zoom level limits.
var zoomRestrictions
Gets current zoom level limits.
val deviceDensityChannel
Gets the DPI ratio to the device's base DPI.
val deviceDensity
Gets the DPI ratio to the device's base DPI.
val sizeChannel
Gets the size of the viewing area.
var size
Gets the size of the viewing area.
val paddingChannel
Gets current paddings from the screen edges.
var padding
Gets current paddings from the screen edges.
val positionPointChannel
Point on the screen to which the camera position is attached. The point is set based on paddings.
var positionPoint
Point on the screen to which the camera position is attached. The point is set based on paddings.
val visibleArea
Area of intersection of the camera visibility pyramid and the surface of the map.
val visibleRectChannel
Rectangle indicating the visible area of the map.
val visibleRect
Rectangle indicating the visible area of the map.
val maxTiltRestrictionChannel
Gets the current function of the maximum camera tilt angle dependency on the style zoom level.
var maxTiltRestriction
Gets 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 the north. The angle is measured clockwise. The range of values is 0°,360°.
BearingFollowController
Controller following the map bearing.
BearingFollowController(
bearingSource: BearingSource,
animationDuration: Duration = Duration.ofMilliseconds(1000),
valueThreshold: Bearing = Bearing(value = 1.0)
)
Creates a controller for following the map direction.
bearingSource
Source of information about direction.
animationDuration
Non-negative duration of change in real direction.
valueThreshold
Non-negative threshold value of considered change in real direction.
BetterRouteInfo
Information about an available alternative route.
BetterRoutePromptControl
Dialog prompting you to switch to a route with a lower expected arrival time.
val visibilityChannel
BicycleBriefRouteInfo
Basic information about the cycling route.
BicycleBriefRouteInfo(length: RouteDistance, landmark: String)
Basic information about the cycling route.
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.
BicycleInstructionCrossroadManeuver
BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
BicycleInstructionFinish
End of the cycling part of the route.
BicycleInstructionFinish()
End of the cycling part of the route.
BicycleInstructionStart
Beginning of the cycling part of the route.
BicycleInstructionStart()
Beginning of the cycling part of the route.
BicycleRouteSearchOptions
Bicycle route search options.
BicycleRouteSearchOptions(
avoidCarRoads: Boolean = false,
avoidStairways: Boolean = false,
avoidUnderpassesAndOverpasses: Boolean = false,
excludedAreas: List<ExcludedArea> = listOf()
)
Bicycle route search options.
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
excludedAreas
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.
fun entry(point: RoutePoint): BoolRouteLongEntry?
Element that the specified point falls into.
fun entries(begin: RoutePoint, end: RoutePoint): List<BoolRouteLongEntry>
Elements partially or completely covered by the begin,end segment.
BoolRouteLongEntry
Extended route element - segment and value on it.
BoolRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Boolean
)
Extended route element - segment and value on it.
Borders
val snapping
Sets the pull to a value that is a multiple of this number.
val isLg
Indication of using a logarithmic scale.
val value
Value by which the filtering occurs.
val min
Lower bound of the set of values.
val max
Upper bound of the set of values.
val currentMin
Currently set minimum value.
val currentMax
Currently set maximum value.
BriefExtraRouteInfo
Additional information about the route for a specific type of transport.
BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)
pedestrian
BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)
publicTransport
fun match(
bicycle: Function1,
car: Function1,
pedestrian: Function1,
publicTransport: Function1,
scooter: Function1
): T
bicycle
car
pedestrian
publicTransport
scooter
fun toString(): String
fun hashCode(): Int
BriefPublicTransportCard
Card that displays brief information about a public transport route. Unlike a PublicTransportCard, it does not contain information about transfers.
BriefPublicTransportCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Card that displays brief information about a public transport route. Unlike a PublicTransportCard, it does not contain information about transfers.
fun onAttachedToWindow(): Unit
var model
BriefPublicTransportCardModel
Model for BriefPublicTransportCard.
BriefPublicTransportCardModel(route: TrafficRoute, context: Context)
Model for BriefPublicTransportCard.
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
BriefRouteInfo
Basic route information.
BriefRouteInfo(duration: Duration, extraInfo: BriefExtraRouteInfo)
Basic route information.
BriefRouteInfoSearchPoints
Points used to request searching for the basic route information.
BriefRouteInfoSearchPoints(startPoint: RouteSearchPoint, finishPoint: RouteSearchPoint)
Points used to request searching for the basic route information.
BuildingId
BuildingInfo
Information about building.
BuildingInfo(
buildingName: String? = null,
purposeName: String? = null,
purposeCode: PurposeCode? = null,
buildingLevels: BuildingLevels? = null
)
Information about building.
BuildingLevels
Information about the floor plans of the building.
BuildingLevels(defaultLevelId: LevelId, levels: List<LevelInfo>)
Information about the floor plans of the building.
CalloutMapPosition
Route callout position.
CalloutMapPosition(
mapId: MapId,
calloutPosition: GeoPoint?,
routePoint: RoutePoint?
)
Route callout position.
Camera
Camera to start moving the map and adjust tracking.
fun move(moveController: CameraMoveController): Future<CameraAnimatedMoveResult>
moveController
Animated camera movement controller.
fun move(
position: CameraPosition,
time: Duration = Duration.ofMilliseconds(300),
animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>
position
Final camera position.
time
Time allotted for moving the map
animationType
Camera animation type.
fun move(
point: GeoPoint,
zoom: Zoom,
tilt: Tilt?,
bearing: Bearing,
time: Duration = Duration.ofMilliseconds(300),
animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>
Starts the animated map movement using the built-in map movement controller.
Resets the current map tracking mode and interrupts gesture processing.
point
Point of the final camera position.
zoom
Zoom level in the final camera position.
tilt
Tilt in the final camera poition or an empty value if it is necessary to use the value from the follow controller or the current one depending on the active following mode.
bearing
Bearing in the final camera position.
time
Time allotted for moving the map
animationType
Camera animation type.
fun processMovementAndStop(): Unit
Sets the camera position according to the current time and stops animated movement.
Calling the method interrupts the flyover and gesture processing, and also resets the tracking mode.
fun addFollowController(followController: FollowController): Unit
Adds a tracking controller.
There can be several different ones, for example, a controller for tracking the scale, map tilt, geolocation, etc.
fun removeFollowController(followController: FollowController): Unit
Removes the tracking controller.
fun setCustomFollowController(followController: CustomFollowController): Unit
Adds a tracking controller implemented on the platform.
Only one such controller can be installed. If you install multiple controllers, only the last one installed is used.
fun removeCustomFollowController(): Unit
Removes the tracking controller implemented on the platform.
CameraBehaviour
Camera tracking mode.
Camera modes are degraded according to the following rules:
- Map shift sets to None the following events: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent with the specified event center, DirectMapScalingEvent with the specified event center, ScaleMapEvent with the specified event center
- Rotation of the map relative to the position point blocks the publication of Bearing events: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent without event center
- Changing the scale relative to the position point blocks the publication of StyleZoom events: MapScalingBeginEvent, DirectMapScalingEvent without event center, ScaleMapEvent without event center
- Tilt locks the publication of Tilt events: DirectMapTiltEvent
CameraBehaviour(position: FollowPosition?, tilt: FollowTilt = FollowTilt.OFF)
Camera tracking mode.
Camera modes are degraded according to the following rules:
- Map shift sets to None the following events: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent with the specified event center, DirectMapScalingEvent with the specified event center, ScaleMapEvent with the specified event center
- Rotation of the map relative to the position point blocks the publication of Bearing events: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent without event center
- Changing the scale relative to the position point blocks the publication of StyleZoom events: MapScalingBeginEvent, DirectMapScalingEvent without event center, ScaleMapEvent without event center
- Tilt locks the publication of Tilt events: DirectMapTiltEvent
CameraBehaviourChange
Change tracking mode.
CameraBehaviourChange(newBehaviour: CameraBehaviour, changeReason: CameraBehaviourChangeReason)
Change tracking mode.
CameraNotifier
Warns you when you enter the traffic camera coverage area.
CameraPosition
Camera position.
val point
Map point corresponding to the camera position (see ICamera::position_point()).
val zoom
Zoom level. 0 is the entire world inscribed in a square of 256x256 logical pixels (see LogicalPixel).
val tilt
Tilt angle of the direction of vertical view.
0 - nadir (look vertically down), the maximum value is 60 degrees.
val bearing
Rotation angle of the direction of horizontal view relative to the north direction. Counted clockwise, in degrees.
CameraPositionChange
Description of changing some of the camera position parameters.
CameraPositionPoint
Relative screen position of the point to which the camera is attached.
Screen area is set by paddings. x - offset from the left edge of the screen area, y - offset from the top edge. Allowed range of padding values: (0.0f, 1.0f) 0,0 - the upper-left corner of the screen area, 1,1 - the lower-right corner.
CameraPositionPoint(x: Float = 0.5f, y: Float = 0.5f)
Relative screen position of the point to which the camera is attached.
Screen area is set by paddings. x - offset from the left edge of the screen area, y - offset from the top edge. Allowed range of padding values: (0.0f, 1.0f) 0,0 - the upper-left corner of the screen area, 1,1 - the lower-right corner.
CameraProgressInfo
Information about the progress of passing the camera zone.
CameraRouteAttribute
Container that describes a point attribute of a route. Each element is stored as a point on the route (at which the element is located) and the value of the element itself.
fun entries(begin: RoutePoint, end: RoutePoint): List<CameraRouteEntry>
Elements falling within the [begin, end) range.
fun findNearBackward(point: RoutePoint): CameraRouteEntry?
Finds the nearest element, the position of which is < = point.
The complexity of the operation is log2(N), where N = size.