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
Aggregate
EV charging station description.
val connectorsFree
Number of available connectors (in the Available status).
val connectorsTotal
Total number of connectors, except for connectors in the Unavailable status.
val isActive
Shows whether connectors are active. true if there is at least one available (in the Available status), reserved (Reserved), or busy (Charging) connector.
val isBusy
Shows whether connectors are busy. true if half or more of the connectors are busy (in the Charging status).
val power
The maximum power of the connector at the station.
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.
var routerType
Type of a search engine for finding alternative routes.
Anchor
Image anchor point. (0, 0) - upper-left corner, (1, 1) - lower-right corner.
AndroidAutoMapSession
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
AndroidAutoMapSession(mapOptions: MapOptions)
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
mapOptions
The configuration of the map. The following parameters are not utilized:
fun onSurfaceAvailable(
surface: Surface,
width: Int,
height: Int
): Unit
Provides a surface for rendering additional content on top of the map. This surface can be created and provided before the onMapReady callback is triggered.
fun onSurfaceDestroyed(surface: Surface): Unit
Indicates that the surface has been destroyed.
fun onMapReady(map: Map): Unit
Provides a map when it is successfully initialized.
fun onMapReadyException(exception: Exception): Unit
Provides an exception in case of an error during initialization.
fun setTheme(theme: MapTheme): Unit
Applies the theme to the map.
This takes effect only after the map has been initialized (i.e., after onMapReady has been called). To set a theme before the map is initialized, use the mapOptions#mapTheme.
fun setCopyrightPosition(position: CopyrightPosition): Unit
Sets the position of the copyright icon on the screen.
Important: This method must be called only after the onCreate state of Lifecycle.
AnimationSettings
Settings of map object animations. Applied to style layers with a model source specified. For example, layers of the "3D model" and "Directional model" type.
var animationIndex
Gets the index of the current model animation. If null, the value from styles is used.
var sceneIndex
Gets the index of the current model scene. If null, the value from styles is used.
var sceneName
Gets the title of the current model scene. If null, the value from styles is used.
var animationRepeatCount
Gets the number of the model animation repetitions. If null, the value from styles is used.
var animationSpeed
Gets the speed of playing the model animation. If null, the value from styles is used.
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
AudioSettings
Class for managing the sound.
All methods can be called from any thread.
AudioStreamReader
fun read(): List<Short>
Description of the callback function type that the audio driver calls to read audio data stream.
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.
AvailableCallback
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.
val viewportRestrictionChannel
Gets the viewport restrictions.
var viewportRestriction
Gets the viewport restrictions.
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
Borders(
snapping: Double