class
ActiveLevelMode
Display mode of a floor plan.
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).
Address
Address as a set of separate components.
Address as a set of separate components.
drillDown
components
buildingName
buildingId
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 buildingId
Unique identifier 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.
AddressLocation
Used for components that are difficult to describe with a specific address.
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.
Button for adding a road event.
AddRoadEventCard
Card for adding a road event.
Card for adding a road event.
AddRoadEventCardModel
Model of the card for adding a road event.
Model of the card for adding a road event.
Action that occurs when the event type selection control is clicked.
Action that occurs when the lane selection control is clicked.
Action that occurs when entering description.
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.
Base class for controls for adding road events.
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.
Marker for adding a road event.
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
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:
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.
Indicates that the surface has been destroyed.
Forwards the SurfaceCallback.onStableAreaChanged event.
Forwards the SurfaceCallback.onVisibleAreaChanged event.
Provides a map when it is successfully initialized.
Provides an exception in case of an error during initialization.
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.
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 animationName
Name of the current model animation. If null, the value from styles is used. If the value is not specified in styles, the animation is not played.
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).
Sets a property.
Sets a property set.
values
Set of the "name":"value" pairs for the added property.
attributesToRemove
List of names of properties to be removed.
Deletes a property.
Gets a property.
AttributeValue
Properties of map objects.
empty
boolean
number
integer
string
data
array
item
AudioSettings
Class for managing the sound.
All methods can be called from any thread.
Obtains an object for managing application sound. Returns Null value if the audio driver is unavailable.
AudioStreamReader
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.
Information about the author of the event or the photo.
AvailableCallback
BaseCamera
Camera.
Sets the parameters for projecting the map onto the screen.
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.
var position
Gets the current camera position.
var zoomRestrictions
Gets current zoom level limits.
val deviceDensity
Gets the DPI ratio to the device's base DPI.
var size
Gets the size of the viewing area.
var padding
Gets current paddings from the screen edges.
var positionPoint
Point on the screen to which the camera position is attached. The point is set based on paddings.
var viewPoint
Viewpoint relative to the full size of the map viewport.
val visibleArea
Area of intersection of the camera visibility pyramid and the surface of the map.
val visibleRect
Rectangle indicating the visible area of the map.
var maxTiltRestriction
Gets the current function of the maximum camera tilt angle dependency on the style zoom level.
var viewportRestriction
Gets the viewport restrictions.
val changed
Reasons for camera state changes.
Changed properties are available in the corresponding channels.
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.
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.
Basic information about the cycling route.
BicycleInstructionCrossroad
Description of maneuvers when passing through an intersection or a pedestrian crossing.
Description of maneuvers when passing through an intersection or a pedestrian crossing.
BicycleInstructionCrossroadManeuver
BicycleInstructionFinish
End of the cycling part of the route.
End of the cycling part of the route.
BicycleInstructionStart
Beginning of the cycling part of the route.
Beginning of the cycling part of the route.
BicycleRouteSearchOptions
Bicycle route search options.
Bicycle route search options.
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
avoidUnpavedRoads
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end segment.
BoolRouteLongEntry
Extended route element - segment and value on it.
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.
BranchesInfo
Information about linked organizations.
BriefExtraRouteInfo
Additional information about the route for a specific type of transport.
motorcycle
pedestrian
publicTransport
bicycle
car
motorcycle
pedestrian
publicTransport
scooter
BriefPublicTransportCard
Card that displays brief information about a public transport route. Unlike a PublicTransportCard, it does not contain information about transfers.
Card that displays brief information about a public transport route. Unlike a PublicTransportCard, it does not contain information about transfers.
var model
BriefPublicTransportCardModel
Model for BriefPublicTransportCard.
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.
Basic route information.
BriefRouteInfoSearchPoints
Points used to request searching for the basic route information.
Points used to request searching for the basic route information.
BuildingId
BuildingInfo
Information about building.
Information about building.
buildingName
purposeName
purposeCode
buildingLevels
floorsInfo
buildingId
val buildingName
Name of the building.
val purposeName
Description of the purpose of the building.
val purposeCode
Code of the purpose of the building.
val buildingLevels
Information about floor plans of the building.
val floorsInfo
Information about the number of floors in a building.
To get this information, please request additional key setup.
val buildingId
Unique identifier of the building.
BuildingLevels
Information about the floor plans of the building.
Information about the floor plans of the building.
CalloutMapPosition
Route callout position.
Route callout position.
Camera
Camera to start moving the map and adjust tracking.
moveController
Animated camera movement controller.
position
Final camera position.
time
Time allotted for moving the map
animationType
Camera animation type.
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.
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.
Adds a tracking controller.
There can be several different ones, for example, a controller for tracking the scale, map tilt, geolocation, etc.
Removes the tracking controller.
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.
Removes the tracking controller implemented on the platform.
Filters camera change reasons by the specified byReason value through valueGetter. Obtains the initial value upon subscription.
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
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.
Change tracking mode.
CameraChange
Camera state change.
Camera state change.
changeReasons
val changeReasons
Reasons for camera state change (set of flags).
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.
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.
Elements falling within the [begin, end) range.
Finds the nearest element, the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element, the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
CameraRouteEntry
Route element - point and value in it.
Route element - point and value in it.
CameraTransactionGuard
CameraViewPoint
The relative position of the screen point with the camera viewpoint.
Available range of padding values is (0.0f, 1.0f), where 0.0 is the upper left corner of the viewport, 1.1 is the lower right.
CameraZoomRestrictions
Acceptable zoom range.
CancelEvent
Event of canceling the current action.
For example, can be called when a gesture is canceled, the window focus is lost, or when the mouse capture is lost. It can also be called from within the map when changing the zoom level restrictions, applying changes to the tracking mode, and setting the interactive mode of the map.
CarBriefRouteInfo
Basic car route information.
Basic car route information.
CarInstructionCrossroad
Description of maneuvers at the crossroads.
Description of maneuvers at the crossroads.
direction
turnAngle
landmark
exitName
CarInstructionFinish
End of the car section of the route.
End of the car section of the route.
CarInstructionRoundabout
Description of maneuvers at a roundabout.
Description of maneuvers at a roundabout.
CarInstructionStart
Beginning of the car section of the route.
Beginning of the car section of the route.
CarInstructionUTurn
U-turn on the road (not at the intersection).
U-turn at the intersection is described by the Crossroad instruction.
U-turn on the road (not at the intersection).
U-turn at the intersection is described by the Crossroad instruction.
exitName
CarRouteSearchOptions
Parameters for finding a car route.
Parameters for finding a car route.
avoidTollRoads
avoidUnpavedRoads
avoidFerries
avoidLockedRoads
routeSearchType
excludedAreas
val avoidTollRoads
Avoid toll roads.
val avoidUnpavedRoads
Avoid dirt roads.
val avoidFerries
Avoid ferries.
val avoidLockedRoads
Avoid closed roads. When set to true, the route search does not take into account road sections that are closed to traffic. If set to false, the route can be built through blocked sections of roads if it is impossible to build a route without passing through blocked sections.
val routeSearchType
Route search type.
val excludedAreas
Excluded areas (not more than 25).
Certificate
SSL certificate.
system
fromFile
fromAsset
CertificateFromAsset
SSL certificate from asset.
CertificateFromFile
SSL certificate from a file.
ChargingStation
Attributes of EV charging stations.
Attributes of EV charging stations.
CheckableGroupedItem
Single element from GroupCheckableItem.
CheckableItem
Base representation of a checkable item from a CheckableItemsGroup.
CheckableItemsGroup
Widget for representing a group of checked items.
val items
Gets a group of widget elements.
Checkbox
Checkbox widget.
val filterType
Gets the filter type that the widget represents.
val checkedText
Gets the signature text for a “checked” checkbox.
val uncheckedText
Gets the signature text for a “non-checked” checkbox.
val values
Gets a list of values by which filtering occurs. Usually one value.
var isChecked
Gets the state of the widget.
Circle
CircleOptions
Parameters for creating a geometric map object of the "Circle" type.
Parameters for creating a geometric map object of the "Circle" type.
position
radius
color
strokeWidth
strokeColor
dashedStrokeOptions
visible
userData
zIndex
levelId
val position
Geographical position.
val radius
Radius in meters.
val color
Fill color.
val strokeWidth
Width of the circle outline.
val strokeColor
Line color of the circle outline.
val dashedStrokeOptions
val visible
Visibility flag.
val userData
User data (not used inside the SDK, only needed for API users).
val zIndex
Object rendering level.
val levelId
Link to the floor plan of the building.
Closed
Closed.
Closed.
ClosingHours
Interval when the organization is closed.
Interval when the organization is closed.
ClosingSoon
Closing soon.
Closing soon.
ClusterObject
Cluster of objects.
ClusterOptions
Cluster marker settings.
Color
Color.
CommonGestureSettings
var recognizeSettings
General settings of gesture recognition.
CommonRecognizeSettings
General settings of gesture recognition.
General settings of gesture recognition.
interGestureTimeout
CompassControl
CompassControl
Compass control.
Compass control.
CompassControlModel
Compass control model. The control consists of a compass button. When the button is pressed, the map camera changes the angle in the north direction. If the map camera faces the north, the control must be hidden. Thread-safe.
ComplexGeometry
Compound geometry consisting of a set of simple or compound geometries.
An arbitrary level of nesting of compound geometries in a set is supported.
val elements
Connector
ContactInfo
Way to contact the organization.
val type
Type of the contact. One of the following:
- website
- phone
- fax
- pobox - P.O. box
- icq
- jabber
- skype
- vkontakte
- odnoklassniki
- youtube
- googleplus
- viber
- telegram
val displayText
Contact value to display.
val value
Technical value of the contact. Depending on the contact type, it has the following semantics:
- email - email address
- website - full URL
- phone - phone number in international format, for example: "+73831234567"
- fax - phone number in international format, for example: "+73831234567"
- pobox - mailing address
- icq - user ID
- jabber - user ID
- skype - user ID
- vkontakte - full URL
- twitter - full URL
- odnoklassniki - full URL
- youtube - full URL
- linkedin - full URL
- googleplus - full URL
- pinterest - full URL
- whatsapp - full URL
- viber - full URL
- telegram - full URL
val comment
Clarifying information about the contact.
Context
Context - the environment required for the SDK to work.
CoordinatesFollowController
Controller for following the coordinates of the map position.
Creates a controller for following the coordinates of the map position.
CopyrightMargins
Margins between the screen and a copyright icon, specifying the distance from each edge of the screen.
CopyrightPosition
Position of the copyright icon on the screen.
Position of the copyright icon on the screen.
gravity
The gravity value (e.g., Gravity.START, Gravity.BOTTOM) that determines the alignment of the copyright icon within the screen.
margins
The margins between the screen and a copyright icon.
CrossingTypeRouteLongAttribute
Container storing an extended route attribute. Each element is stored as a pair consisting of a point and an attribute value. The attribute value is effective from the current point to the point, where the action of the next element attribute starts.
Element that contains the specified point.
Elements falling within the [begin, end) interval.
CrossingTypeRouteLongEntry
Extended route element: interval and attribute value.
Extended route element: interval and attribute value.
CustomDashboardButton
Class for replacing the standatd button for adding road events in the navigator dashboard.
CustomizableDashboardButton
DashboardButtonAbsent
Used in DefaultNavigationControls.setCustomDashboardButton to indicate that the action button must be hidden.
DashboardControl
DashedPolygonOptions
Parameters of a dashed ploygon outline.
Parameters of a dashed ploygon outline.
DashedPolylineOptions
Dashed polyline options.
Dashed polyline options.
DashedStrokeCircleOptions
DataPrefetcher
Controller for prefetching map data for a route. Loads data from sources that support caching. Data is loaded for route segments with segment_size length ahead up to max_prefetch_distance distance. As segments are traversed, their data is removed from cache and replaced with data for subsequent segments.
var enabled
Whether map data prefetching for a route is enabled. The default value is true.
Can be used when the navigator is in Disabled status.
var minZoom
Minimum zoom level for map data prefetching. The default value is 8.
var maxZoom
Maximum zoom level for map data prefetching. The default value is 16.
var radius
Coverage radius on the map for map data prefetching. The default value is 128.
var segmentSize
Size of the minimum route segment for map data prefetching, in km. The default value is 2.
var maxPrefetchDistance
Distance ahead of the current position on the route for map data prefetching, in km. The default value is 4.
DayTime
Time moment within a day.
DefaultHttpClient
Standard implementation of the HTTP client (transport layer) for requests to the Radar API service. It does not log the bodies and headers of requests and server responses at any logging level for privacy reasons. If you need to log requests, prepare your own implementation and pass it during the initialization of DefaultLocationSource as a parameter for the RadarSettings configuration.
Standard implementation of the HTTP client (transport layer) for requests to the Radar API service. It does not log the bodies and headers of requests and server responses at any logging level for privacy reasons. If you need to log requests, prepare your own implementation and pass it during the initialization of DefaultLocationSource as a parameter for the RadarSettings configuration.
Sends a POST request to the specified URL.
url
Request URL.
body
Request body in JSON format.
headers
Server response in the form of RadarHttpResponse.
DefaultInstallFallback
Factory for creating predefined strategies for package installation or update errors (InstallFallback).
Creates a fallback that performs no operations (no-op).
Creates a fallback that repeatedly calls the install() method in case of a package download error.
retryCount
Limit of repeated calls of the install() method before stopping execution.
DefaultLocationSource
Implementation of the default location source (recommended for use). If available, GMS is used, otherwise - LocationManager.
Implementation of the default location source (recommended for use). If available, GMS is used, otherwise - LocationManager.
The method must be called after receiving permissions to use the location.
The method handles changes in sources availability.
DefaultNavigationControls
Navigator UI controls suggested for default use: lane information, speed limit, indication of the next maneuver, etc. SDK users can also create their own UI controls and use the navigator UI model to get event notifications while navigating a route.
DefaultRasterUrlTemplate
DefaultRoadEventFilter
Factory for creating standard time-based filters for road events.
Creates a filter of road events displayed on the map.
context
Context.
displayCategories
Categories of events to display on the map. If the parameter is not specified, category filtering is not applied.
startTimeCutoff
Maximum allowed event start time relative to the current time. Events with start_time later than this value are hidden. For example, +1d hides events that start later than one day from now. Events without start_time are not filtered.
If the parameter is not specified, no filtering by start time is applied.
DefaultSpeechRecognizer
Standard implementation of SpeechRecognizer that uses the Android system engine for speech recognition via <a href=""https://developer.android.com/reference/android/speech/RecognizerIntent.html"">RecognizerIntent.
Standard implementation of SpeechRecognizer that uses the Android system engine for speech recognition via <a href=""https://developer.android.com/reference/android/speech/RecognizerIntent.html"">RecognizerIntent.
Implementation of the SpeechRecognizer.recognize method. Runs the system interface for speech recognition and handles the results.
onResult
Callback function to get the recognized text.
onError
Callback function to handle possible errors.
DeviceDensity
Multiplier calculated as the ratio of DPI to the base DPI of the device.
For Android, it corresponds to resources.displayMetrics.density. For iOS, it corresponds to nativeScale.
Must be positive.
Multiplier calculated as the ratio of DPI to the base DPI of the device.
For Android, it corresponds to resources.displayMetrics.density. For iOS, it corresponds to nativeScale.
Must be positive.
value
DevicePpi
Device display resolution, in pixels per inch.
Must be positive.
Device display resolution, in pixels per inch.
Must be positive.
value
DGis
Entry point to the 2GIS SDK. At the start of work, you must call initialize.
You must call this method before working with the SDK.
appContext
Android application context.
httpOptions
Network client settings.
logOptions
Logging parameters.
vendorConfig
Overrides the SDK configuration.
keySource
Key source.
dataCollectConsent
Consent to data collection and data processing.
platformHttpClient
Network client to be used instead of the standard one.
platformAudioDriver
Platform audio driver.
mapOptions
Settings applied to all maps.
storageOptions
File storage settings.
sdkContext required for SDK services to work.
Deinitializes the SDK and frees context resources.
Before calling the method, ensure all SDK objects are freed: maps, markers, data sources, and others. If an error occurs during deinitialization, the context continues to operate.
After a successful call, the existing context is invalidated. To create a new one, call the initialize() method.
DgisMapObject
2GIS map object.
Information about the object can be obtained via directory.
val id
Stable numeric object identifier.
DgisObjectId
DgisSource
Main interface of 2GIS data sources.
Sets or removes the highlight of objects.
Adds a "selected" attribute to an object, which can be used in styles.
directoryObjectIds
Identifiers of modifiable objects.
highlighted
Sets or removes the highlight.
Creats a source that retrieves data from 2GIS servers or uses pre-loaded data in operation.
DirectMapControlBeginEvent
Event of starting the direct map control. Tells the map to handle direct map control events. Direct control events only work from DirectMapControlBeginEvent to DirectMapControlEndEvent. After the direct control event sequence has ended, kinematics may start. Kinematics uses the time the event occurred, so using the time received from the system is better than filling in the value during processing. Kinematics works only for moving the map, not for rotation and scaling.
DirectMapControlEndEvent
Event of ending the direct map control. Ends the direct map control started after getting the DirectMapControlBeginEvent. Direct map control events are described in DirectMapControlBeginEvent.
DirectMapRotationEvent
Event of the direct map rotation. Direct map control events are described in DirectMapControlBeginEvent.
bearingDelta
Changes the angle of the map rotation, in degrees. Positive values correspond to the direction of counter-clockwise rotation.
timestamp
Time of the system event generation.
rotationCenter
Point on the screen around which the map rotates. If no point is specified, the rotation is done relatively to the map position point.
DirectMapScalingEvent
Event of direct map scaling. Direct map control events are described in DirectMapControlBeginEvent.
zoomDelta
Amount by which the current zoom value changes.
timestamp
Time of the system event generation.
scalingCenter
Point on the screen around which the map is scaled. If no point is given, scaling is done relatively to the map position point.
DirectMapShiftEvent
Direct map shift event. Direct map control events are described in DirectMapControlBeginEvent.
screenShift
Change of the screen position of the map relative to the previous one, in pixels.
shiftedPoint
Center point from which the map is shifted.
timestamp
Time of the system event generation.
DirectMapTiltEvent
Direct camera tilt event. Direct map control events are described in DirectMapControlBeginEvent.
DirectoryFilter
Filters for the directory.
Filters for the directory.
DirectoryObject
Directory object.
String representation of the address formatted according to the specified length requirement.
Returns information about the transport schedule on stop platforms and route directions.
departureTimeUtc
Unix time in UTC to get the schedule.
val types
Object type. There can be several ones, for example, Sun City shopping center is a branch of the organization and a building at the same time. The first type in this list is the main one.
val title
Object title.
val titleAddition
Additional information for the title. Example: "(apt. 1-12)". To get this information, please request additional key setup.
val subtitle
Object subtitle.
Can be an empty string if the value is missing.
val description
Object description.
val id
Stable numeric object identifier.
val markerPosition
Feature point where the marker should be placed.
val address
Object address as a set of components.
val attributes
Additional object attributes.
val contextAttributes
Contextual additional object attributes.
val timeZoneOffset
Shift of the object's local time relative to UTC in seconds at the current moment.
val openingHours
Object opening hours.
val contactInfos
Object contacts.
val reviews
Reviews.
val parkingInfo
Additional information about parking.
val workStatus
Work status.
val levelId
ID of the floor where the object is located. To get this information, please request additional key setup.
val entrances
Information about the entrances. To get this information, please request additional key setup.
val tradeLicense
Information about the organization license. To get this information, please request additional key setup.
val buildingInfo
Information about building.
val branchesInfo
Information about linked organizations.
val chargingStation
EV charging station attributes.
val rubricIds
Rubric identifiers.
val orgInfo
Information about the organization.
val group
Objects grouped into a combined card. To get this information, please request additional key setup.
val routeInfos
Information about public transport routes. The field is filled only when searching by object ID.
For a route (type ObjectType.Route), it contains information about only one route.
For a stop platform (type ObjectType.StationPlatform), it contains information about all routes that pass through the platform.
val platformIds
Information about identifiers of public transport platforms. The field is filled only when searching by object identifier.
For the station entrance (type ObjectType.StationEntrance) and the metro station (type ObjectType.StationMetro), it contains information about all platform identifiers.
val nearestParkingIds
Nearest parking lots.
val nearestStations
Nearest public transport stops or stations.
val nearestPlatforms
Nearest stop platforms.
DoubleRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route at which the element is located and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
DoubleRouteEntry
Route element - point and value in it.
Route element - point and value in it.
DoubleRouteLongAttribute
Container storing an extended route attribute. Each element is stored as a pair consisting of a point and an attribute value. The attribute value is effective from the current point to the point, where the action of the next element attribute starts.
Element that contains the specified point.
Elements falling within the [begin, end) interval.
DoubleRouteLongEntry
Extended route element: interval and attribute value.
Extended route element: interval and attribute value.
DragBeginData
Data on the beginning of dragging: drag start point and an object being dragged.
Data on the beginning of dragging: drag start point and an object being dragged.
Duration
Class representing a period of time.
Converts Duration to FormattedMeasure for displaying in UI elements in the navigator.
Converts Duration to a string for displaying in UI elements in the navigator.
Converts Duration to FormattedMeasure for displaying in UI elements in the navigator.
Converts Duration to a string for displaying in UI elements in the navigator.
DynamicFilter
Dynamic filters for search results.
DynamicRouteInfo
DynamicRouteInfoSettings
Settings for receiving dynamic route data.
Elevation
Non-negative elevation of the point above the surface in meters.
Non-negative elevation of the point above the surface in meters.
value
EmptyFollowController
Base class for custom controllers. Can be used as the basis for implementing a controller on a platform.
Base class for custom controllers. Can be used as the basis for implementing a controller on a platform.
St of value types that this controller can manage.
Tells the controller which values it provides are in use. This frees up 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.
Installs a notifier that notifies about new values. The notifier must be stored in the implemented controller
Bearing. Method is called only after calling request_values with appropriate parameters.
EntranceGeometry
Geometry for displaying the entrance on the map.
Geometry for displaying the entrance on the map.
EntranceInfo
Information about the entrance to the building.
Information about the entrance to the building.
id
buildingNumber
porchName
porchNumber
apartmentRanges
geometry
entranceNumber
val id
Identifier of the entrance object.
val buildingNumber
Number of the house to which the entrance belongs.
val porchName
Non-empty entrance name. Filled only for porches (entrances in residential buildings). Can take the values of the entrance name (eg "Entrance 1") or the building number if the entrance has its own address.
val porchNumber
Non-empty entrance number. Filled only for porches (entrances in residential buildings). Can take values of the entrance number (eg "1") or the building number if the entrance has its own address.
val apartmentRanges
Numbers of apartments related to the entrance.
val geometry
Geometry for displaying the entrance on the map.
val entranceNumber
Event
Base class for all handled events.
ExceedSpeedLimitSettings
Settings for detection of exceeding the maximum allowed speed limit.
ExcludedArea
Excluded area to be avoided when building a route.
Excluded area to be avoided when building a route.
ExtraInstructionInfo
bicycleStart
bicycleFinish
bicycleCrossroad
carCrossroad
carRoundabout
pedestrianStart
pedestrianFinish
pedestrianCrossroad
pedestrianIndoorFloorChange
pedestrianIndoorEnter
pedestrianIndoorExit
scooterStart
scooterFinish
scooterCrossroad
bicycleStart
bicycleFinish
bicycleCrossroad
carStart
carFinish
carCrossroad
carRoundabout
carUturn
pedestrianStart
pedestrianFinish
pedestrianCrossroad
pedestrianIndoorFloorChange
pedestrianIndoorEnter
pedestrianIndoorExit
scooterStart
scooterFinish
scooterCrossroad
val isBicycleStart
val asBicycleStart
val isBicycleFinish
val asBicycleFinish
val isBicycleCrossroad
val asBicycleCrossroad
val isCarStart
val asCarStart
val isCarFinish
val asCarFinish
val isCarCrossroad
val asCarCrossroad
val isCarRoundabout
val asCarRoundabout
val isCarUturn
val asCarUturn
val isPedestrianStart
val asPedestrianStart
val isPedestrianFinish
val asPedestrianFinish
val isPedestrianCrossroad
val asPedestrianCrossroad
val isPedestrianIndoorFloorChange
val asPedestrianIndoorFloorChange
val isPedestrianIndoorEnter
val asPedestrianIndoorEnter
val isPedestrianIndoorExit
val asPedestrianIndoorExit
val isScooterStart
val asScooterStart
val isScooterFinish
val asScooterFinish
val isScooterCrossroad
val asScooterCrossroad
val value
File
File identifier.
Can be not only a file in the file system, but also an arbitrary data source.
File with contents from the given string.
FinishDetector
FinishRouteControl
FlagFilter
Filter of the flag type.
FloatRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end segment.
FloatRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
FloorInfo
Information about the floor plan for the marker - an element of search results.
Information about the floor plan for the marker - an element of search results.
FloorsInfo
Information about the number of floors in a building.
To get this information, please request additional key setup.
FollowControl
FollowController
Class that allows you to manage the camera position and the geolocation marker. All of its methods' implementations must be thread-safe. Most methods have trivial default implementations available (thus the FollowController responsible for scaling is not required to override coordinates() and similar methods).
FollowPosition
Settings for following the direction, tilt, and zoom level.
Settings for following the direction, tilt, and zoom level.
FormattedAddress
Human-readable representation of the address.
val drilldownAddress
Address from the drilldown. Example: "Novosibirsk, Kirovsky district".
val streetAddress
Address within the settlement. Example: "Nikolaeva, 11".
val addressComment
Comment on the address. Example: "301 office; 9th floor".
val postCode
Postal code of the object with the building code, if any. Example: "630088", "630007/XBVJF8".
FormattedMeasure
Value with units of measurement. For example, "1.5", "km".
Fps
Frames per second, frame rate.
FreeRoamSelector
Controller for switching the navigator to FreeRoam mode if the route rebuilds too long.
FreeRoamSettings
var onRoutePrefetchLength
Road graph tiles are loaded into the HTTP cache during navigation if they correspond to a section of the route from the current position to the specified distance. The default value is 5 km.
Tiles are not loaded into the HTTP cache if the parameter matches zero or negative distance.
var onRoutePrefetchRadiusMeters
When caching road graph tiles during navigation, tiles are loaded into the HTTP cache if they are closer than the specified distance in meters from the route line. The default value is 1 km.
Tiles are not loaded into the HTTP cache, if the parameter corresponds to zero or negative distance.
var prefetchRadiusMeters
Road graph tiles are loaded into the HTTP cache if they are closer than the specified distance in meters from the current position. The default value is 2 km.
Tiles are not loaded into the HTTP cache if the parameter corresponds to a zero or negative distance.< /p>
Geometry
GeometryMapObject
Geometric object of the map.
Methods are thread-safe.
The object is displayed on the map under the following conditions:
- the object is visible;
- the object is added to the data source;
- the data source containing the object is added to the map;
- the display parameters in the map styles are applicable to this object. For more information about displaying objects on the map, see ISource.
val geometryChannel
Object geometry.
var geometry
Object geometry.
val objectAttributes
Gets the properties of the map object for reading and modifying.
val isVisibleChannel
Current object visibility flag.
var isVisible
Current object visibility flag.
val isDraggableChannel
Current object relocation flag.
var isDraggable
Current object relocation flag.
val animationSettings
Getting animation settings.
Applied to objects of the 3D model or Directional model type.
val bounds
Minimum size of rectangle containing geometry.
GeometryMapObjectBuilder
Class for setting properties and then creating geometric objects.
Sets the properties of the map object.
values
Set of "name":"value" pairs for the added properties of a map object.
The method does not replace the entire set of object properties, i.e. if a property is absent in values, but has already been added to the object previously, it will not be changed.
Sets the geometry of the map object.
Sets the visibility of the map object.
Sets the possibility of dragging a map object.
Installing user data.
User data is not used in any way in the SDK and is only returned it to the user.
Constructs a map object.
The object must have geometry
After calling this function, GeometryMapObjectBuilder becomes unsuitable for setting the parameters of a map object or for creating an object.
GeometryMapObjectSource
Source of geometric map objects.
Gets a list of objects participating in clustering given a camera position. The list contains both clusters and geometric objects.
Adds an object to the source.
Adding objects by group is more efficient than adding one by one, especially when the source has already been added to one or more maps.
Adding is asynchronous, thread-safe, the method can be used from any thread.
For a source with clustering, addition is not yet implemented, an exception will be thrown.
Adds multiple objects to the source.
Adding objects by group is more efficient than adding one by one, especially when the source has already been added to one or more maps.
Adding is asynchronous, thread-safe, the method can be use from any thread.
For a source with clustering, addition is not yet implemented, an exception will be thrown.
Deletes an object from the source.
The deletion is asynchronous, thread-safe, the method can be used from any thread.
Removes objects from the source.
Removes and adds objects to the source.
GeometryMapObjectSourceBuilder
Sets the property of map objects common to the entire source (see ISource).
Sets properties of map objects common to the entire source.
Adds a map geometry object to the source.
Adds several geometric map objects to the source.
Creates a source of geometric objects.
After calling this function, you cannot use the GeometryMapObjectSourceBuilder to create a data source or set data source parameters.
GeoPoint
Point in a spherical coordinate system that, together with a geodetic coordinate system (e.g. WGS84), indicates a point on the Earth's surface. This structure is not tied to a specific geodetic coordinate system. However, this module contains free functions that operate on this structure in a specific coordinate system (to determine the coordinate system used, see the documentation for the functions).
Point in a spherical coordinate system that, together with a geodetic coordinate system (e.g. WGS84), indicates a point on the Earth's surface. This structure is not tied to a specific geodetic coordinate system. However, this module contains free functions that operate on this structure in a specific coordinate system (to determine the coordinate system used, see the documentation for the functions).
Calculates the point obtained by moving the original point in the specified direction by the specified distance.
Calculates the direction (bearing, i.e. the angle between true north and the direction of travel, counted clockwise) between two points.
GeoPointRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Calculates a GeoPoint from a known RoutePoint.
routePoint
Calculated geographical coordinates and the direction of the segment pointed to by the route_point parameter. If the route is empty or the route_point goes beyond the route, null is returned.
The complexity of the operation is O(log2(N)), where N = route_geometry .size()
Calculates the nearest point on the route to the given geographic coordinates of a point.
point
Point projected on the route.
Nearest point on the route. If the route is empty of both range.first and range.second points are located before of after the route, null is returned.
Operation complexity is O(N), where N = route_geometry.size()
GeoPointRouteEntry
Route element - point and value in it.
Route element - point and value in it.
GeoPointWithElevation
Pint in a geographic coordinates system (latitude, longitude, elevation).
Elevation is calculated in meters above the surface, not above the sea level.
Pint in a geographic coordinates system (latitude, longitude, elevation).
Elevation is calculated in meters above the surface, not above the sea level.
Calculates the direction (bearing, i.e. the angle between the north direction and the direction of travel, counted clockwise ) for projecting a point onto the map and a given point.
Calculates the minimum (by great circle) distance between the projection of a point on the map and a given point.
Calculates the point obtained by moving the projection of the origin point in the specified direction by the specified distance.
GeoRect
Rectangular area in a spherical coordinate system (for example, WGS84). This structure is not tied to a specific geodesic coordinate system.
Whether the rectangle contains a point. Points located on the boundary are also considered to belong to the rectangle.
Expands the rectangle. Returns the minimum rectangle containing the original rectangle and point.
val isValid
Checks the rectangle for validity.
val isDegenerate
Checks the rectangle for degeneracy. If the points in the rectangle are equal, then it degenerates to a point. A degenerate rectangle is a valid rectangle. An invalid rectangle is not degenerate.
val southWestPoint
Southwest point, lower-left border of the rectangle.
val northEastPoint
Northeast point, upper-right border of the rectangle.
GestureActionEventCenter
Performs the gesture relative to the geometric center of the set of touch points.
Performs the gesture relative to the geometric center of the set of touch points.
GestureActionMapPosition
Performs the gesture relative to the map position.
Performs the gesture relative to the map position.
GestureActionPoint
Sets the rule for handling map events.
eventCenter
mapPosition
targetGeoPoint
eventCenter
mapPosition
targetGeoPoint
GestureActionTargetGeoPoint
Performs the gesture relative to the targetGeoPoint geoposition.
Performs the gesture relative to the targetGeoPoint geoposition.
targetGeoPoint
GestureManager
Class for managing gesture processing.
Sets a list of rules for excluding simultaneous triggering of multiple gestures.
The passed list is extended with default rules, which do not allow the tilt management gesture to be triggered simultaneously with other gestures. Each rule contains a list of gestures that cannot be triggered simultaneously. For example, if the Scaling and Rotation gestures are specified in the rule, these gestures will not work simultaneously. If multiple gestures from the rule are called simultaneously, the gesture with higher priority will be triggered. The order of gesture priorities (in descending order): (Shift ->) Tilt -> Scaling -> Rotation -> MultiTouchShift
GLESRenderer
Creates input surfaces and renders their content to the provided output surface. The input surfaces are created with the same size as the output surface. When the input surfaces are ready, the provided callback is triggered with the corresponding event.
Creates input surfaces and renders their content to the provided output surface. The input surfaces are created with the same size as the output surface. When the input surfaces are ready, the provided callback is triggered with the corresponding event.
numberOfInputSurfaces
The number of input surfaces to create for rendering.
outputSurface
The Surface object representing the output surface where the final rendered content will be displayed.
outputSurfaceSize
The size of the output surface, which also determines the size of all input surfaces.
rendererCallback
rendererCallbackHandler
The Handler on which the renderer callback will be invoked.
Sets the copyright icon's bitmap and its position on the screen in a Cartesian coordinate system where (0, 0) is the bottom-left corner.
Important: not thread safe.
Stops the rendering thread, releases all OpenGL resources, and ensures no further callbacks will be executed.
GlobalMapOptions
Global map settings. They are specified during the SDK initialization and used for all maps.
Global map settings. They are specified during the SDK initialization and used for all maps.
GradientPolylineOptions
Gradient polyline options.
Gradient polyline options.
borderWidth
secondBorderWidth
gradientLength
borderColor
secondBorderColor
colors
colorIndices
val borderWidth
Line border width.
val secondBorderWidth
Width of the second line border.
val gradientLength
Gradient line length.
val borderColor
Border color.
val secondBorderColor
Second border color.
val colors
Gradient polyline color picker.
val colorIndices
Color indices of the gradient polyline. The number of indices must be 1 less than the number of polyline points.
GroupCheckableItem
Set of elements that works as a radio group.
val items
Gets a set of group elements.
GroupItem
Element of a combined card that contains information about an object.
Element of a combined card that contains information about an object.
HttpCacheManager
HTTP cache management interface.
Obtains an object for managing the HTTP cache.
HttpHeader
HttpOptions
HTTP client options.
HTTP client options.
timeout
useCache
cacheStoragePath
cacheMaxSize
certificates
proxy
val timeout
Timeout for HTTP requests.
val useCache
Use the HTTP cache.
val cacheStoragePath
Path to the root-level directory for the primary HTTP cache file storage. File storage will be located in the http_cache subdirectory of this directory. If the path is not specified, the default directory is used.
val cacheMaxSize
Maximum size of the HTTP cache in bytes. If not specified, the default maximum HTTP cache size is 300 Mb.
val certificates
Certificates in the PEM format. If not set, the system certificates and the ones shipped with the SDK are used.
val proxy
Proxy settings.
HttpProxyOptions
System SSL certificate.
HttpRequest
Structure for presenting an HTTP request.
Structure for presenting an HTTP request.
HttpResponse
Structure for presenting a response for an HTTP request.
The reponse body is stored and handled separately.
Structure for presenting a response for an HTTP request.
The reponse body is stored and handled separately.
HttpResponseCallback
Object with callbacks for handling the sending and receiving of data.
Method that handles receiving a response from the server.
response
Server response.
Returns false if the SDK has cancelled sending/handling a request.
Method that handles receiving a response body. Handling can be done in parts.
HttpStatusCode
Image
Image.
ImageData
Image data: size, format, and binary data.
Image data: size, format, and binary data.
IncompleteTextHandler
Autocomplete is suggested for the text entered by the user.
IndoorBuilding
Building with floor plans.
Indicates that the current building and other buildings with floor plans (other parameter) are linked together.
A group of linked buildings operates as a single object:
- the
levels()method returns a combined list of floors from all buildings in the group - the active display mode changes simultaneously for all buildings in the group
val id
Building ID with floor plans.
val defaultLevelIndex
Index of the default floor.
val levels
Information about all floors.
val activeLevelIndexChannel
Serial infex of the active floor in levels.
var activeLevelIndex
Serial infex of the active floor in levels.
val modeChannel
Active building display mode. If ActiveLevelMode value is specified, then index points to the active floor index in the levels vector. If OverviewMode value is specified, the display mode of a building overview view is active.
var mode
Active building display mode. If ActiveLevelMode value is specified, then index points to the active floor index in the levels vector. If OverviewMode value is specified, the display mode of a building overview view is active.
IndoorBuildingMode
Display mode of a building.
IndoorControl
Floor control.
It is a column with the names of floors with the active one highlighted. When you click a name, the floor plan switches. No more than 5 names are displayed at the same time, those that do not fit can be scrolled to.
Floor control.
It is a column with the names of floors with the active one highlighted. When you click a name, the floor plan switches. No more than 5 names are displayed at the same time, those that do not fit can be scrolled to.
var markedLevels
Floors on which marks are displayed.
IndoorControlModel
Floor control model.
val activeLevelIndexChannel
Active floor index.
var activeLevelIndex
Active floor index.
var markedLevels
Floors on which marks are displayed.
val levelNamesChannel
Names of floors. Empty if the map does not display a building with floor plans or if the building has only one floor.
val levelNames
Names of floors. Empty if the map does not display a building with floor plans or if the building has only one floor.
IndoorDetector
Detector that determines if a user is infoors.
IndoorManager
Class for getting the current building with floor plans.
Switching the floor plan manager on/off.
IndoorRouteLevelsGetter
Allows you to get the set of floors through which the routes displayed on the map pass.
InputEvent
User input event.
InstructionRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
InstructionRouteEntry
Route element - point and value in it.
Route element - point and value in it.
IntRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
IntRouteEntry
Route element - point and value in it.
Route element - point and value in it.
IsOpenNow
Open now.
Open now.
ItemMarkerInfo
Object identifier and its coordinates.
KeyFromAsset
Key from an asset. For Android - assets directory. For iOS - Bundle.main directory.
Key from an asset. For Android - assets directory. For iOS - Bundle.main directory.
path
KeyFromFile
Key from the file.
KeyFromString
Key from a string.
KeySource
Key source.
LabelingPriority
Object priority if objects on the map overlay.
LaneSignRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
LaneSignRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
Latitude
Geographical latitude.
LevelId
Floor plan identifier.
LevelInfo
Information about the floor of the building.
Information about the floor of the building.
Locale
Locale.
LocaleManager
Manager of application regional settings.
Setting the list of application locales.
Obtains an object for managing application locales.
val localesChannel
Application locales, if specified, otherwise - locales specified by the user in the OS.
val locales
Application locales, if specified, otherwise - locales specified by the user in the OS.
val systemLocalesChannel
Gets locales provided by the OS.
OS locales are ordered in the way specified by the user (in order of highest priority to a lower priority).
val systemLocales
Gets locales provided by the OS.
OS locales are ordered in the way specified by the user (in order of highest priority to a lower priority).
Location
coordinates
altitude
course
groundSpeed
source
timestamp
LocationCoordinates
LocationCourse
LocationFuzzyDouble
LogicalPixel
Pixel which size does not depend on screen density.
1 logical pixel equals 1/(base ppi) of an inch. The base PPI is device-specific and is calculated from the DevicePpi/DeviceDensity ratio. DevicePpi and DeviceDensity are set with the OS via the map interface. For Android, LogicalPixel corresponds to dp, for iOS - to point.
Pixel which size does not depend on screen density.
1 logical pixel equals 1/(base ppi) of an inch. The base PPI is device-specific and is calculated from the DevicePpi/DeviceDensity ratio. DevicePpi and DeviceDensity are set with the OS via the map interface. For Android, LogicalPixel corresponds to dp, for iOS - to point.
value
LogMessage
Message to be logged.
LogOptions
Log settings.
Longitude
Geographical longitude.
MagneticChangeListener
Class that keeps track of compass direction changes and compass availability.
ManeuverControl
Map
Map.
Adds a data source to the map.
Occurs asynchronously. The method can be called from any thread, it is thread-safe.
Removes a data source from the map.
Occurs asynchronously. The method can be called from any thread, it is thread safe.
Gets displayable map objects projected onto a circle on the screen.
centerPoint
Circle center.
radius
Radius of the circle.
The list of objects is formed in the order of rendering from the latest to the earliest.
Gets sublayer attributes that were previously passed explicitly.
val id
Map instance ID, unique within the process.
val camera
Gets a camera.
val indoorManager
Gets a floor plan manager.
val dataLoadingStateChannel
Notification about the state of data loading to the map.
When tracking the camera position, the map state is always MapDataLoadingState::Loading.
val dataLoadingState
Notification about the state of data loading to the map.
When tracking the camera position, the map state is always MapDataLoadingState::Loading.
val styleChannel
Gets current map styles.
var style
Gets current map styles.
val fontIconSizeMultiplierChannel
Icon and font size multiplier received from the application.
The size of icons and fonts is specified in logical pixels (see LogicalPixel) and multiplied by the font and icon size multiplier.
var fontIconSizeMultiplier
Icon and font size multiplier received from the application.
The size of icons and fonts is specified in logical pixels (see LogicalPixel) and multiplied by the font and icon size multiplier.
val sources
Gets map data sources.
Occurs asynchronously. The method can be called from any thread, it is thread safe.
val mapVisibilityStateChannel
var mapVisibilityState
val attributes
Gets attributes.
The following properties must be specified: "theme"="day|night" "navigatorOn"="true|false"
val interactiveChannel
Map interactivity. Interactivity means that the user has the ability to interact with the map. If interactivity is disabled, the map stops responding to input events obtained from the user. Controls for working with the map (zooming in and moving to the current position) also stop working. It remains possible to work with the map via set_position/move. Unfinished gestures are reset upon transition to the non-interactive state. By default, the map is interactive (interactive == true).
The function can be called from any thread.
var interactive
Map interactivity. Interactivity means that the user has the ability to interact with the map. If interactivity is disabled, the map stops responding to input events obtained from the user. Controls for working with the map (zooming in and moving to the current position) also stop working. It remains possible to work with the map via set_position/move. Unfinished gestures are reset upon transition to the non-interactive state. By default, the map is interactive (interactive == true).
The function can be called from any thread.
val graphicsPresetHintChannel
Gets the recommended graphic mode for the given device.
val graphicsPresetHint
Gets the recommended graphic mode for the given device.
val graphicsPresetChannel
Gets the graphic mode. In case of null, the recommended mode is used. If the recommended mode cannot be defined, the Normal one is used.
var graphicsPreset
Gets the graphic mode. In case of null, the recommended mode is used. If the recommended mode cannot be defined, the Normal one is used.
MapControl
Base class for map UI controls.
Base class for map UI controls.
MapController
Map ready to display with a renderer and a gesture recognizer.
Creates a map with settings specified in the options parameter.
context
SDK context. Must be valid at map creation time.
options
Parameters of an initial map state.
Future with a ready MapController or with a creation error.
MapControllerOptions
position
sources
attributes
fontIconSizeMultiplier
graphicsPreset
maxFps
powerSavingMaxFps
val position
Initial camera position. If not specified, the default position is used.
val sources
Data sources added to the map during creation.
val attributes
Map attributes applied during creation.
val fontIconSizeMultiplier
Multiplier for icon and font sizes. If not specified, the multiplier is not applied.
val graphicsPreset
Graphics quality preset. If not specified, the default preset is used.
val maxFps
Frame rate limit. If not specified, there is no limit.
val powerSavingMaxFps
Frame rate limit in power saving mode. If not specified, there is no limit.
MapControls
MapDirection
Angle of the object rotation relative to the north direction, in degrees, counted clockwise.
Angle of the object rotation relative to the north direction, in degrees, counted clockwise.
value
MapGestureRecognizer
Map gesture recognizer. Accepts touch input and converts it into map gestures. Touch points are first added (add_touch_point()) and then processed (process_touch_event()).
MapId
Map instance ID, unique within the process.
MapLocationController
Controller for map positioning in navigator.
MapManager
Interface that allows you to add maps to the navigator and remove them.
MapObject
Object on the map.
MapObjectManager
Creates an IMapObjectManager.
Deletes an object.
Adds objects.
Deletes objects.
Removes and adds objects.
Gets a list of objects participating in clustering given the camera position. The list contains both clusters and markers.
Creates an IMapObjectManager with data clustering. Only IMarker objects are clustered.
map
logicalPixel
Minimum possible distance on the screen between anchor points of markers on levels where clustering works.
maxZoom
Level starting from which all markers are visible.
clusterRenderer
Interface for setting cluster display parameters.
minZoom
Level starting from which clusters are formed.
layerId
Layer ID in the "Dynamic Object" type style. Created objects are placed on this layer, this allows you to set their order relative to other layers. If not specified, objects are placed on top of other layers.
Creates an IMapObjectManager with data generalization. Only IMarker objects are generalized.
map
logicalPixel
Minimum distance on the screen between marker anchor points on levels where generalization works.
maxZoom
Level starting from which all markers are visible.
minZoom
Level starting from which generalization works.
layerId
Layer ID in the "Dynamic Object" type style. Created objects are placed on this layer, this allows you to set their order relative to other layers. If not specified, objects are placed on top of other layers.
MapOptions
Map options.
Map options.
MapPaddingControl
Control that sets the padding of the map.
Control that sets the padding of the map.
MapRenderer
Map renderer. Creating this object starts map rendering.
MapRotationBeginEvent
Event of starting map rotation around a point.
val direction
MapRotationEndEvent
Event of ending the map rotation around the point.
MapScalingBeginEvent
MapScalingEndEvent
MapShiftBeginEvent
MapShiftEndEvent
MapTheme
Theme to use in the map.
val name
Code of the style from the Style Editor.
val loadingBackground
The background color used before styles are loaded and the map background is displayed. In default themes, this matches the default map background color.
val defaultTheme
Standard light theme for base styles.
val defaultDarkTheme
Standard dark theme for base styles.
MapView
Container of the map and additional controls.
Sets the theme to be used in the map.
Use custom gesture recognizer.
lateinit var mapOptions
var showApiVersionInCopyrightView
var maxFps
Maximum allowed map refresh rate. If not set, it is equal to the screen refresh rate.
var powerSavingMaxFps
Maximum allowed map refresh rate in power saving mode. If not set, it is equal to maxFps.
val fpsChannel
Map update frequency. To get the correct value, you must keep a subscription to the channel. Before calling the method, the map must be initialized (getMapAsync is completed).
val renderView
Returns the View used for rendering OpenGL.
val gestureManager
val mapTheme
Theme that is used by the map. To change during the lifecycle MapView, use setTheme.
MarkedByRouteIndoorControl
Floor control, which marks the floors through which routes pass on the map.
Floor control, which marks the floors through which routes pass on the map.
MarkedUpText
Marked text.
Marked text.
MarkedUpTextSpan
Describes a subset of bytes of the text string.
Marker
Point on the map that is of interest to the user.
var position
Gets a marker location.
var icon
Gets a marker icon.
var anchor
Gets an anchor point of a marker icon.
var iconOpacity
Gets the transparency of the marker icon.
var text
Gets the marker caption.
var textStyle
Gets the marker caption style.
var isDraggable
Gets the marker dragability flag.
var iconWidth
Gets the target marker width used for scaling.
var iconMapDirection
Rotation angle of the marker on the map relative to the north direction, clockwise.
var animatedAppearance
Whether to animate the appearance.
var iconAnimationMode
Gets the animation mode for an animated marker.
var labelingPriority
Priority of the marker if objects on the map overlay.
var suppressOnOverlap
Whether to hide the icon when objects on the map (markers and labels of other objects) overlay.
MarkerOptions
Marker options.
Marker options.
position
icon
iconMapDirection
anchor
text
textStyle
iconOpacity
visible
draggable
iconWidth
userData
zIndex
labelingPriority
animatedAppearance
levelId
iconAnimationMode
suppressOnOverlap
val position
val icon
val iconMapDirection
val anchor
val text
val textStyle
val iconOpacity
val visible
val draggable
val iconWidth
Target width used for scaling.
val userData
val zIndex
Object rendering level.
val labelingPriority
Priority of the marker icon if objects on the map overlay.
val animatedAppearance
Whether to animate the appearance.
val levelId
Link to the floor plan of the building.
val iconAnimationMode
Animation mode.
val suppressOnOverlap
Whether to hide the icon when objects on the map (markers and labels of other objects) overlay.
MessageControl
Meter
Length/distance in meters.
MillisecondsRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
MillisecondsRouteEntry
Route element - point and value in it.
Route element - point and value in it.
MiniMapControlModel
Model interface of the minimap UI element. Configures the marker position, zoom level, and camera angle to make the route more visible on the minimap.
Model
Navigator model intended to be displayed in the UI.
val stateChannel
Navigator state.
val state
Navigator state.
val locationChannel
Current location that the navigator is working with.
See location_available_channel.
val location
Current location that the navigator is working with.
See location_available_channel.
val locationAvailableChannel
Flag that indicates whether the current location is used for navigation. After receiving the location, the navigator decides whether it can be used for navigation (for example, if the location has too large error margins, the navigator may decide that it is not suitable for navigation). If the location is navigable, the navigator sets the value to true in this channel. If not, it sets the value to false.
Even if the value in this channel is false, the location_channel can be updated in the location_channel.
See location_channel.
val locationAvailable
Flag that indicates whether the current location is used for navigation. After receiving the location, the navigator decides whether it can be used for navigation (for example, if the location has too large error margins, the navigator may decide that it is not suitable for navigation). If the location is navigable, the navigator sets the value to true in this channel. If not, it sets the value to false.
Even if the value in this channel is false, the location_channel can be updated in the location_channel.
See location_channel.
val routeChannel
Route with maneuvers.
In the free roam mode (StateChannel::FreeRoam), there is no route on which a user is traveling. Therefore, the section of the road on which the user is currently moving is represented by the navigator as a route and returned as the current route. This type of road definition is not a complete route as it lacks a finish point and maneuvers.
val route
Route with maneuvers.
In the free roam mode (StateChannel::FreeRoam), there is no route on which a user is traveling. Therefore, the section of the road on which the user is currently moving is represented by the navigator as a route and returned as the current route. This type of road definition is not a complete route as it lacks a finish point and maneuvers.
val dynamicRouteInfoChannel
Traffic events and traffic jam data on the route or on the predicted part of the route for FreeRoam mode.
val dynamicRouteInfo
Traffic events and traffic jam data on the route or on the predicted part of the route for FreeRoam mode.
val routePositionChannel
Current user position on the route.
val routePosition
Current user position on the route.
val exceedingMaxSpeedLimitChannel
Flag of exceeding the maximum allowed speed limit.
val exceedingMaxSpeedLimit
Flag of exceeding the maximum allowed speed limit.
val betterRouteChannel
Signal indicating an alternative route with shorter expected travel time. The null value means that an alternative route cannot be found or has become outdated.
val betterRoute
Signal indicating an alternative route with shorter expected travel time. The null value means that an alternative route cannot be found or has become outdated.
val duration
val isFreeRoam
ModelData
Model data.
ModelMapObject
Model on the map.
ModelMapObjectOptions
Model parameters.
Model parameters.
position
data
size
mapDirection
opacity
visible
userData
levelId
val position
Location.
val data
Data.
val size
Target width for scaling.
val mapDirection
Angle of the model rotation on the map relative to the north direction in degrees, counted clockwise.
val opacity
Opacity.
val visible
Visibility.
val userData
User data.
val levelId
Binding to the floor plan of the building.
ModelScale
Model scaling factor selected manually. Available values are from 0.0 to 64.0.
Model scaling factor selected manually. Available values are from 0.0 to 64.0.
value
ModelSize
Model size.
If the LogicalPixel parameter is specified, the model size is not bound to the map scale and remains unchanged relative to the screen.
If the ModelScale parameter is specified, the model size is multiplied by the coefficient and bound to the map scale.
MotorcycleBriefRouteInfo
Basic information about a motorcycle route.
Basic information about a motorcycle route.
MotorcycleRouteSearchOptions
Parameters of motorcycle route search.
Parameters of motorcycle route search.
avoidTollRoads
avoidUnpavedRoads
avoidFerries
avoidLockedRoads
routeSearchType
excludedAreas
val avoidTollRoads
Avoiding toll roads.
val avoidUnpavedRoads
Avoiding unpaved roads.
val avoidFerries
Avoiding ferry crossings.
val avoidLockedRoads
Avoiding road sections closed to traffic. If set to false, closed road sections may be included in the route if it is impossible to build an alternative route.
val routeSearchType
Route search type.
val excludedAreas
Excluded areas (no more than 25).
MultiTouchGestureSettings
Settings of the multi-touch gesture.
var recognizeSettings
Settings for recognizing the multi-touch gesture.
MultiTouchRecognizeSettings
Settings for recognizing the multi-touch gesture.
Settings for recognizing the multi-touch gesture.
multitouchShiftThresholdMm
MyLocationControl
Control of the flyover to the user's current location.
Control of the flyover to the user's current location.
MyLocationControllerSettings
Settings of the controller of a geolocation marker moving.
Settings of the controller of a geolocation marker moving.
bearingSource
animationDuration
coordinatesThreshold
bearingThreshold
val bearingSource
Bearing source. If missing, a marker without bearing is displayed.
val animationDuration
Non-negative duration of the real bearing change.
val coordinatesThreshold
Non-negative threshold value of the considered change of the real position and its precision.
val bearingThreshold
Non-negative threshold value of the considered change of the real bearing.
MyLocationControlModel
Model for the control to manage the flyover to the user's location. The control consists of a button that, when clicked, triggers the camera flyover to the user location. If the location is not specified, nothing happens. Object methods must be called on the same thread.
MyLocationMapObject
Geolocation marker.
MyLocationMapObjectSource
Source containing a geolocation marker.
Creates a location marker source.
val item
Gets the geolocation marker.
MyLocationMapObjectSourceProvider
Provider of the geolocation marker source.
val myLocationMapObjectSource
Source that contains the geolocation marker.
NativeException
Exception converted from an exception thrown in native code.
NativeObject
Base class for objects that wrap objects in native code.
NativeProxy
Technical class that encapsulates a weak pointer to an object in native code.
NavigationControl
Base class for navigator UI controls.
NavigationControl
Container with controls for the zoom level and flyover to the user's current location.
NavigationFollowController
Interface for managing the map following a geolocation marker in the navigator.
NavigationManager
Root public interface of the navigator.
val uiModel
Navigator model intended to be displayed in the UI.
val indoorDetector
Indoor navigation.
val mapFollowController
Management of automatic return of the map to following a geolocation marker.
val mapLocationController
Controller for map positioning in navigator.
val mapManager
Navigator map manager.
val zoomFollowSettings
Map scaling settings during the follow mode.
val routeMapSettings
Settings for displaying the route on the map.
val routeSourceSettings
Settings for the source used to display the route on the map.
val routeMapObjectsProvider
Provider of route objects on the map.
val simulationSettings
Settings for simulation of navigating the route.
val voiceSelector
Managing voice packages in the current navigator session.
val exceedSpeedLimitSettings
Settings for detection of exceeding the speed limit.
val dynamicRouteInfoSettings
Settings for receiving and updating dynamic route data.
val soundNotificationSettings
Settings for sound alerts in the current navigator session.
val freeRoamSettings
Settings for navigating without a route in free roam mode.
val alternativeRoutesProviderSettings
Alternative route search settings in the navigation mode.
val alternativeRouteSelector
Selects an alternative route.
val trafficJamDetector
Information about traffic jams on the route.
val myLocationMapObjectSourceProvider
Provider of the geolocation marker source.
val routeRebuilder
Controller for searching for a new route when leaving the current route.
val freeRoamSelector
Controller for switching the navigator to FreeRoam mode if the route rebuilds too long.
val dataPrefetcher
Controller for prefetching map data for a route.
val finishDetector
Route completion controller.
NavigationView
UI element that displays the state of navigation on the map.
Adding it to a MapView results in the display of a route, a geolocation marker, transport events, and camera tracking. Navigation controls can be placed inside NavigationView - inheritors of NavigationControl, in particular, the ready-to-use set of controls DefaultNavigationControls.
var navigationManager
NavigationVoice
Voice to use in the navigator.
NearestPlatform
Information about the nearest stop platform.
Information about the nearest stop platform.
NearestStation
Information about the nearest public transport stop or station.
Information about the nearest public transport stop or station.
id
name
distance
routeTypes
internalTransition
color
val id
Unique stop identifier.
val name
Stop name.
val distance
Distance from the described object to the nearest stop platform of this stop in meters.
val routeTypes
Types of transport passing through the stop.
val internalTransition
Whether there is an internal crossing from the described object to the station.
val color
Color coding of the route.
NewValuesNotifier
Interface of an object that reports that there are changes in any of the parameters.
ObstacleInfo
Information about the obstacle on the route.
Information about the obstacle on the route.
ObstacleInfoRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
ObstacleInfoRouteEntry
Route element - point and value in it.
Route element - point and value in it.
ObstacleInfoRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
ObstacleInfoRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
Opacity
Opacity - from 0.0 (fully transparent) to 1.0 (fully opaque).
Opacity - from 0.0 (fully transparent) to 1.0 (fully opaque).
value
Opened
Open.
OpeningHours
Opening hours of the organization.
Opening hours of the organization.
weekOpeningHours
weekClosingHours
isOpen24x7
OpeningSoon
Opening soon.
OpenStatus
opened
openingSoon
closingSoon
closed
OrderedValue
Describes one value from a set.
OrderedValues
Describes a set of discrete ordered values.
Describes a set of discrete ordered values.
OrgId
Identifier of the organization.
OrgInfo
Information about the organization.
OverviewMode
Display mode of a building overview (model or master plan).
Display mode of a building overview (model or master plan).
Package
Package. For the convenience of working with data (installation, updating, deletion), data in the 2GIS SDK are grouped into sets according to functional-logical purpose. A set of grouped data is called a package. The functional purpose of data is unique within one package. However, sets data of packages with the same functionality may overlap, that is, it is possible that the data of several packages have common files. In operations with a group of such packages, the common data will be processed (downloaded, unpacked, deleted) only once.
Initiates a package installation or update operation.
val id
Stable technical package identifier.
val infoChannel
Package information.
val info
Package information.
val progressChannel
Package installation or update operation progress as a percentage. If the package is not installed locally, the channel contains the value 0. If the package is installed locally, regardless of the date and compatibility with the current SDK version, the channel contains the value 100. If the package is located during the install or update phase, the channel contains the update value in the range 0.100.
val progress
Package installation or update operation progress as a percentage. If the package is not installed locally, the channel contains the value 0. If the package is installed locally, regardless of the date and compatibility with the current SDK version, the channel contains the value 100. If the package is located during the install or update phase, the channel contains the update value in the range 0.100.
PackageInfo
Package information. See IPackage.
Package information. See IPackage.
name
installed
incomplete
preinstalled
compatible
hasUpdate
error
updateStatus
finalSizeOnDisk
currentSizeOnDisk
val name
Localized package name.
val installed
Installation flag - true, if the package was selected for installation.
val incomplete
Installation pending flag - true, if there is no fully loaded version of the package (possibly incompatible with the current SDK version).
val preinstalled
Flag for pre-installed packages. Pre-installed packages are always installed and fully loaded, and cannot be removed.
val compatible
Compatibility flag - true, if the downloaded package is compatible with the current SDK version.
val hasUpdate
Indicator of an update availability - true, if there is an update for the downloaded package. It is possible, that during the process of updating to a new version, an even newer version of the package became available on the server. In this case, the value is true both during the update and upon completion.
val error
Error occurred while trying to load and/or install a package, or null if there is no error.
val updateStatus
Package update status.
val finalSizeOnDisk
Size of the disk space that the territory takes after installation, in bytes. Uninitialized value indicates that the territory does not contain files (this information is obtained from a preinstalled status file that does not contain a list of territory files).
val currentSizeOnDisk
Size of the disk space that currently installed territory files take, in bytes
PackageManager
Interface for centralized package management:
- Managing auto-update and obtaining its status;
- Forced updates checking;
- Starting and stopping the installation/update of all available packages.
- Subscription to changes in information about packages;
- Subscription to changes in information about the overall installation progress of packages.
Obtains an object for managing packages from the context.
var autoupdateEnabled
Auto-update status (enabled/disabled).
val packagesChannel
Channel with a list of all known packages. Updated if information about at least one of the packages or the list composition changes.
val packages
Channel with a list of all known packages. Updated if information about at least one of the packages or the list composition changes.
PackedMapState
Serialized map state.
Gets the map state.
position
Camera position.
showTraffic
Status of displaying traffic score on the map.
behaviour
Camera tracking mode.
Serialized map state.
Gets the map state.
Gets the map state.
PackedNavigationState
Auxiliary object for serializing and deserializing the navigation state.
PackedSearchQuery
Auxiliary object for serializing and deserializing a search query.
Deserialization of a search query.
val queryText
Query text. For some queries (for example, expanding a category from a suggest), there is no text, because identifiers are stored in the query, and the behavior is different from searching the text of the suggest element.
val orgId
Organization identifier.
val rubricIds
Rubrics identifiers.
val objectIds
Objects identifiers.
val buildingId
Building identifier.
val spatialRestriction
Geometry limiting the search area.
val geometryRestriction
Geometry limiting the search area.
val areaOfInterest
Rectangular area of interest.
val territoryOfInterest
Non-strict search area restriction for objects: if an object is not within the area, it is not discarded, but its rank in search results is lowered.
val allowedResultTypes
Restriction on object types returned by search.
val pageSize
Issue page size.
val directoryFilter
Information about active filters.
val sortingType
Type of sorting of results.
val geoPoint
Center of the search area.
val radius
Search radius in meters.
val locale
Search query locale.
val searchNearby
Search for objects near the user. Increases the importance of distance from the user in search results.
Padding
Camera padding.
Specified as an inward offset from the edges, in physical pixels. The paddings affect:
- the position point;
- animated map movement;
- the placement of dynamic map objects (such as route callouts).
Camera padding.
Specified as an inward offset from the edges, in physical pixels. The paddings affect:
- the position point;
- animated map movement;
- the placement of dynamic map objects (such as route callouts).
Page
Search results page.
Gets the previous page of results.
Future that resolves into a non-null pointer to the previous page if the page is retrieved successfully. Future that resolves to a null pointer if there is no previous page. Exceptional future if an error occurred while fetching the page.
Gets the next page of results.
Future that resolves to a non-null pointer to the next page if the page is retrieved successfully. Future that resolves to a null pointer if there is no next page. Exceptional future if an error occurred while fetching the page.
val items
Non-empty set of reference objects for this page.
ParkingCapacity
Parking capacity.
Parking capacity.
ParkingControl
UI element that switches parking lots visibility on the map.
ParkingControlModel
Model of the parking lots control.
This interface is thread-safe.
Function to create a model for the parking lots control.
map
Map.
Action upon tapping the UI control. Switches the parking lots visibility on the map.
ParkingInfo
General parking information.
General parking information.
type
purpose
access
pavingType
isPaid
isIncentive
forTrucks
levelCount
capacity
PedestrianBriefRouteInfo
Basic information about the pedestrian route.
Basic information about the pedestrian route.
PedestrianInstructionCrossroad
Description of maneuvers when passing through an intersection or a pedestrian crossing.
Description of maneuvers when passing through an intersection or a pedestrian crossing.
PedestrianInstructionCrossroadManeuver
PedestrianInstructionFinish
End of the pedestrian part of the route.
End of the pedestrian part of the route.
PedestrianInstructionIndoorEnter
Entrance to the building.
Entrance to the building.
levelId
PedestrianInstructionIndoorExit
Exit of the building.
Exit of the building.
PedestrianInstructionIndoorFloorChange
Change of floors in the building.
Change of floors in the building.
PedestrianInstructionStart
Beginning of the pedestrian part of the route.
Beginning of the pedestrian part of the route.
PedestrianRouteSearchOptions
Pedestrian route search options.
Pedestrian route search options.
avoidStairways
avoidUnderpassesAndOverpasses
useIndoor
avoidUnpavedRoads
excludedAreas
PerformSearchHandler
Suggested to search for a specific set of objects.
val searchQuery
Query to run through the search engine.
PointGeometry
PointGeometryData
Geometry data of the point object.
geoPointWithElevation
Polygon
Polygon on the map.
Creates a polygon based on the parameters.
options
PolygonGeometry
PolygonOptions
Polygon settings.
Polygon settings.
contours
color
strokeWidth
strokeColor
dashedPolygonOptions
visible
userData
zIndex
levelId
elevation
Polyline
Polyline on the map.
PolylineGeometry
PolylineOptions
Polyline options.
Polyline options.
points
width
color
erasedPart
dashedPolylineOptions
gradientPolylineOptions
visible
userData
zIndex
levelId
elevation
val points
Points of a polyline.
val width
Polyline width.
val color
Primary color of the polyline.
val erasedPart
val dashedPolylineOptions
Dashed polyline options.
Dashed gradient line options are not currently supported, so if both dashed_polyline_options and gradient_polyline_options are present in PolylineOptions, then dashed_polyline_options is ignored when creating the polyline.
val gradientPolylineOptions
Gradient polyline options.
Dashed gradient line is currently not supported, so if both dashed_polyline_options and gradient_polyline_options are present in PolylineOptions, dashed_polyline_options is ignored when creating the polyline.
val visible
Polyline visibility.
val userData
User data.
val zIndex
Object rendering level.
val levelId
Link to the floor plan of the building.
val elevation
Polyline elevation above the surface in meters.
Projection
Projection.
Uses the Mercator spherical projection (EPSG:3857), looped in longitude. Displayed data is limited in latitude from -85.06° to 85.06°.
Calculates a map point at the specified screen point.
The function returns an empty value if the specified screen point is outside the map projection.
Calculates the screen point corresponding to the specified map point.
The function returns an empty value:
Calculates the nearest map point to the projection of the specified screen point.
Calculates the distance in meters between points on the map that correspond to the specified points on the screen.
Returns an empty value if one or both points on the screen are outside the map projection.
Calculates the distance in pixels between points on the screen that correspond to the specified points on the map.
Returns an empty value if one or both points on the map are:
- invalid values (
latitudeis outside the range-90; 90orlongitudeis outside the range-180; 180) - above the projection plane of the map on the screen
- far beyond the screen, and the type overflow occurs
PublicBriefRouteInfo
Basic information about rotes by public transport.
Basic information about rotes by public transport.
publicTransportInfos
val publicTransportInfos
Description of ways to travel by public transport.
PublicBriefRouteTransportInfo
Description of the public transport vehicle.
Description of the public transport vehicle.
val type
Public transport type.
val names
Names of public transport routes on which travel takes place.
val color
ARGB representation of the color associated with this type of public transport, for example, the color of a subway line. If there is no color information, the field is null.
val routeLogo
Identifier of the icon for route stops. Empty string if information is not available. Technical field.
PublicRoutePart
Description of the section of the route by public transport.
Description of the section of the route by public transport.
val transports
Types of public transport that can be used to travel this section of the route.
If the list is empty, this section of the route is suggested to be overcome by personal or rented transport or on foot.
val intermediateStops
Intermediate stops that the transport will pass before reaching the transfer point.
Stops are sorted in the order they appear on the route.
You do not need to get off at these stops.
Start and end stops are not included in this list.
PublicTransportCard
Card that displays information about a public transport route.
Card that displays information about a public transport route.
var model
PublicTransportCardModel
Model for PublicTransportCard.
Model for PublicTransportCard.
PublicTransportCostInfo
Information about the cost of travel on public transport.
val value
Cost of travel on public transport in the main currency units (e.g., in dirhams for the UAE).
val fraction
Additional cost of travel on public transport in the minimal currency units (e.g., in fils for the UAE).
val exponent
Power of 10 exponent showing how many minimal currency units are contained in one main currency unit (e.g., 2 for the UAE, since 1 dirham contains 100 fils).
val currencyCode
Three-letter currency code according to ISO 4217 standard.
PublicTransportDirectoryPlatformDepartureInfo
Information about the departure from the stop platform.
Information about the departure from the stop platform.
PublicTransportDirectoryRouteDirectionNamesInfo
Names of the start and the end stops of the route.
PublicTransportDirectoryRouteInfo
Information about public transport route.
Information about public transport route.
id
name
routeType
color
fromToStationNames
directions
PublicTransportDirectoryRouteScheduleInfo
Information about schedules on stop platforms and directions on the route.
PublicTransportDirectoryScheduleInfo
Information about schedules at stop platforms and directions.
val routeSchedules
Schedules at stop platforms and route directions.
val fullDayPlatforms
Routes schedules at the stop platform until the end of the day. The field is filled for an object with the type ObjectType.StationPlatform.
An array of PublicTransportPlatformSchedule objects represents a sequence of schedules following one another.
For example:- Transport departs with a period of 2 minutes (
period), starting at1747353600(start_time) and ending at1747360800(finish_time). - Then transport departs according to the schedule at 12:15 (
precise_time), 12:30 and 13:00.
val nearTrips
The nearest trips for the route directions to the end stop platform. The field is filled for an object with the type ObjectType.StationPlatform.
PublicTransportInfo
Description of the public transport vehicle.
Description of the public transport vehicle.
type
suggestedCarNumbers
boardingSuggest
color
routeLogo
routeInfos
val type
Public transport type.
val suggestedCarNumbers
Numbers of wagons where boarding is recommended.
If the vehicle consists of one wagon or you can board any wagon, this list is empty.
val boardingSuggest
Text description of wagons recommended for boarding.
val color
ARGB representation of the color associated with this type of public transport, for example, the color of a subway line. If there is no color information, the field is null.
val routeLogo
Identifier of the icon for route stops. Empty string if information is not available. Technical field.
val routeInfos
Information about public transport routes.
PublicTransportIntervalSchedule
Interval transport schedule (at a certain time of day, transport transits with the same interval).
Interval transport schedule (at a certain time of day, transport transits with the same interval).
PublicTransportIntervalWorkingHours
Work period of the interval schedule.
val startTime
Unix time of the interval schedule start (in the local timezone of the object).
val startTimeUtc
Unix time of the interval schedule start in UTC.
val finishTime
Unix time of the interval schedule end (in the local timezone of the object).
val finishTimeUtc
Unix time of the interval schedule end in UTC.
PublicTransportNearTripSchedule
Interval transport schedule (at a certain time of day, transport transits with the same interval).
Interval transport schedule (at a certain time of day, transport transits with the same interval).
PublicTransportPlatform
Information about the stop platform - a place where you can board the public transport, which is displayed on the map. A public transport stop (PublicTransportStop) consists of one or more stop platforms.
Information about the stop platform - a place where you can board the public transport, which is displayed on the map. A public transport stop (PublicTransportStop) consists of one or more stop platforms.
id
stationId
name
description
transitions
position
val id
Identifier of the stop platform.
val stationId
Identifier of the stop to which the platform belongs. For example, the bus stop or subway station where the platform is located.
val name
Stop name.
val description
Short description of the location of the stop platform.
val transitions
Information about other public transport routes that you can transfer to at the stop platform.
val position
Geoposition.
PublicTransportPlatformSchedule
Schedule at the stop platform.
Schedule at the stop platform.
PublicTransportPlatformTransition
Information about the public transport route that you can transfer to at the stop platform.
Information about the public transport route that you can transfer to at the stop platform.
routeId
routeName
routeType
color
stationId
stationName
PublicTransportPreciseSchedule
Exact arrival schedule of public transport to the stop platform.
Exact arrival schedule of public transport to the stop platform.
PublicTransportRouteDirection
Route direction of the public transport.
Route direction of the public transport.
PublicTransportRouteDirectionId
Identifier of the route direction of the public transport.
Identifier of the route direction of the public transport.
value
PublicTransportRouteGeometry
Geometry of the route direction of the public transport.
Geometry of the route direction of the public transport.
PublicTransportRouteInfo
Information about a public transport route.
Information about a public transport route.
name
directionName
lastPlatformName
costInfo
traversalType
PublicTransportRouteSearchOptions
Search options for a public transport route.
Search options for a public transport route.
val startTime
Time in UTC for which the route should be built. If not set, the current time is used.
val useSchedule
Whether to refer to the public transport schedule when building a route.
val transportTypes
Types of public transport. If not filled, routes are built for all supported types of public transport.
PublicTransportSchedule
Transport schedule.
intervalSchedule
preciseSchedule
intervalSchedule
preciseSchedule
PublicTransportStop
Description of the public transport stop.
PublicTransportTransfer
Description of how to get to the next transfer point by public transport.
Description of how to get to the next transfer point by public transport.
val startPointName
Name of the point from which the movement for this section of the route begins.
val finishPointName
Destination point name for this route segment.
val routeParts
Description of the route segment on public transport, which can be used to get to the next transfer point.
All route segments from this list follow the same geometry line.
If the list is empty, then this route segment it is suggested to be passed by personal or rented transport or on foot.
PublicTransportTransferRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
PublicTransportTransferRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
PurposeCode
Code of the purpose of the building.
RadarApiSettings
Settings for working with the Radar API.
A sealed class representing two possible states:
ON - Radar API is enabled with the specified settings.OFF - Radar API is disabled.RadarHttpResponse
Model of the response to an HTTP request to the Radar API.
Range
Describes a set of discrete ordered values.
RangeFilter
Filter for the value ranges.
RangeWidget
Widget for representing a continuous or a discrete set of ordered values.
RasterTileSource
Source that gets raster tiles.
Creates a source that gets raster tiles.
context
Context.
sublayerName
sourceTemplate
Template for requesting tiles.
RasterUrlTemplate
defaultSource
RemainingRouteInfoControl
Navigator UI control that displays information about the remaining distance to the route finish and the remaining travel time.
Remover
Object to remove user content.
Deletes content.
Action is available for content authored by the user.
RenderedObject
Displayable map object.
RenderedObjectInfo
Detailed information about the displayable map object.
Detailed information about the displayable map object.
Reviews
Reviews.
RoadCameraInfo
Camera information.
Camera information.
RoadEvent
Traffic event.
val type
Event type.
val id
Event identifier.
val name
Localized event name.
val author
Information about the user who added the event.
val timestamp
Timestamp of event creation.
val location
Event coordinates.
val elevation
Elevation of a road event.
val description
Custom description of the traffic event.
val cameraInfo
Information about the camera.
Available for events of the "Camera" type only.
val schedule
Schedule.
Currently available for road blockings only, and may not even exist.
val lanes
Affected lanes.
Currently, can be set for custom events only.
val availableActions
List of available actions with the event.
val remover
Gets the object to delete the event.
RoadEventAction
Event action.
Applies an action (for example, adds a "like", confirms an event).
There are opposite actions, such as "like" and "dislike". If both actions are available for an event, the method call resets the application of the opposite - it is impossible to put "like" and "dislike" at the same time.
Cancels an action (for example, restores the "like", resets confirmation of an event).
There are actions that are opposite of each other, for example "like" and "dislike". If both are available for an event action, calling the method does not cause the opposite action to be applied.
RoadEventActionButton
Action button for the traffic event (confirm, like, etc.).
Action button for the traffic event (confirm, like, etc.).
val model
RoadEventActionInfo
Information about the action.
Information about the action.
RoadEventCard
Card that displays information about a traffic event.
Card that displays information about a traffic event.
RoadEventCardModel
Traffic event card model.
Traffic event card model.
val name
Name, e.g. "Closure".
val description
Description, e.g. "Road works".
val lanes
Affected lanes, e.g. "Left lane, middle lane".
val schedule
Schedule, for example, "October 10th 08:00 - October 15th 23:30".
val creationTime
Creation time, e.g. "5 hours ago", "August 5", "December 10, 2020".
val author
Author, for example, "2GIS".
val photoChannel
Photo.
val actionCompletedChannel
Notification about action completion.
val removeCompletedChannel
Notification about event deletion completion.
val actions
Actions.
RoadEventFilterData
Road event data used for filtering.
Road event data used for filtering.
RoadEventManager
Object for creating traffic events.
Creates an "Accident" event.
location
Event location.
lanes
Lanes of the road affected by the event.
description
Custom event description.
Creates a "Camera" event.
location
Event location.
description
Custom event description.
Creates a "Road closure" event.
location
Event location.
description
Custom event description.
Creates a "Comment" event.
location
Event location.
description
Custom event description.
Creates an "Other" event.
location
Event location.
lanes
Lanes of the road affected by the event.
description
Custom event description.
Creates a "Road works" event.
location
Event location.
lanes
Lanes of the road affected by the event.
description
Custom event description.
Obtains an object for working with road events.
RoadEventMapObject
Map object "Traffic event".
RoadEventMapObjectRouteAttribute
Container that describes a point route attribute. Each element is stored as a route point, in which this element is located, and the value of the element.
Elements that fit into the [begin, end) interval.
Find the closest element with the position <= point.
Operation complexity: log2(N), where N = size.
Find the closest element with the position <= point.
Operation complexity: log2(N), where N = size.
RoadEventMapObjectRouteEntry
Route element: a point and a value in it.
Route element: a point and a value in it.
RoadEventPhoto
Photograph of a traffic event.
Photo preview URL.
Submits a complaint about a photo.
Complaining your photo will not be processed.
RoadEventRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
RoadEventRouteEntry
Route element - point and value in it.
Route element - point and value in it.
RoadEventSource
Interface of the class that controls the display of traffic events (tUGC) on the map.
Creates a source that displays traffic events on the map.
context
directoryObjectIds
IDs of changeable events. Can be obtained from RoadEventMapObject.
highlighted
RoadRuleRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
RoadRuleRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
RoadSubtypeRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
RoadSubtypeRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
RoadSurfaceRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
RoadSurfaceRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
RoadTypeRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
RoadTypeRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
RotateMapToNorthEvent
RotationGestureSettings
Settings of the map rotation gesture.
RotationKinematicSettings
val enabled
Enables or disables rotation kinematics. If false, rotation stops immediately after the gesture ends, and all other parameters are ignored.
val decelerationCoefficient
Coefficient of rotation deceleration after the gesture ends. The higher the value, the faster the rotation slows down.
val maxInitialForwardAngularSpeed
Maximum initial angular speed after the gesture ends, in radians per second.
val initialBackwardAngularSpeed
Initial angular speed of the map return to its original position, in radians per second.
val angleThreshold
Threshold of angular deviation at which the map continues rotating in the direction of the gesture, in radians. If the value is lower, moves toward its original position.
RotationRecognizeSettings
Settings for recognizing the map rotation gesture.
Settings for recognizing the map rotation gesture.
RotationRecognizeThresholds
Route
Class that describes a route. A route is a set of attributes, each of which is a container of the RouteAttribute or the RouteLongAttribute type, which stores elements of route attributes. Route attributes are divided into point and length attributes. Point attributes (for example, geometry points or speed bumps) are specified as a pair of a RoutePoint and an attribute value. Long attributes (such as the width of a roadway or a speed limit) are specified as a pair of a RoutePoint specifying the beginning of the attribute's action and the attribute's value. A terminator is placed at the end of the route. For example, let the width of the roadway be given as a set of pairs {{0m, 3m}, {10m, 7m}, {20m, 5m}, {30m, 0m}}, then the first 10 meters of the route the carriageway has a width of 3 meters, at the interval [10m., 20m.) - 7m., from 20m. to the end of the route - 5m.
val geometry
Route geometry.
It is not guaranteed that the RoutePoint of geometry points will match the RoutePoint of other attribute elements, so to calculate the geographic coordinate of an attribute element, you do not need to search the geometry for an element RoutePoint of which matches the RoutePoint attribute element, calculate_geo_point should be used instead.
val instructions
Instructions to be followed on the route.
val intermediatePoints
Intermediate points through which the route passes. The route may not pass directly through the intermediate point, but near it. The attribute value stores the coordinate at which the intermediate point was set, the key contains the coordinate of the projection of the intermediate point onto the route.
val altitudes
Altitudes on the route.
val badRoads
Bad road (there are bumps and potholes on the road that impede the passage).
val obstacles
Obstacles on the route.
val roadNames
Road/street names.
val settlements
Sign that the route section passes through the settlement.
val transportTypes
Type of transport for which the route section is built.
val crossingTypes
val tollPaymentPointInfos
val cameras
Road cameras.
val carriagewaysWidth
Width of the roadway in meters. 0 - width is unknown.
val exitSigns
Exit signs.
val humps
Speed bumps.
val lanes
Traffic lanes.
val levels
Floors of buildings.
val maxSpeedLimits
Maximum allowed speed limits.
0 - speed limit is unknown.
val roadRules
Side of traffic.
val roadSubtypes
Additional description for the road type where the route is built.
val roadSurfaces
Road paving.
val roadTypes
Type of road along which the route passes.
val tolls
Segments of the route that run along toll roads.
val truckData
Sign of the presence or absence of data for cargo navigation.
val truckPassZoneIds
Checkpoints for trucks.
val truckRestrictedAreas
Indication of the validity of the sign prohibiting of the trucks passage.
val vehicleRestrictedAreas
Indication of the validity of the sign prohibiting the passage of any vehicles (overlapping).
val bicycleLanes
Indication of the presence of a dedicated cycle lane.
val trafficLights
Indication of the presence of traffic lights.
val immersiveData
val publicTransportTransfers
Description of ways to travel between transfer points by public transport.
RouteBuildOptions
Structure that describes parameters for building a route in the navigator.
RouteCamera
Structure describing a traffic camera.
Structure describing a traffic camera.
purposes
rangeAgainst
rangeAlong
direction
maxSpeedLimit
mobility
val purposes
Camera purpose.
val rangeAgainst
Camera operation range against the direction of movement.
val rangeAlong
Camera operation range along the direction of movement.
val direction
Camera operation direction.
val maxSpeedLimit
Speed in m/s, the exceeding of which is captured by a camera. Missing if the camera does not detect exceeding the speed limit.
val mobility
Mobility of a road camera.
RouteDistance
Distance along the route.
RouteEditor
Interface for the route editor. The route editor obtains the starting and the finish points of the route, builds routes, and notifies about their updates and rebuilds via channels.
All methods of this interface are called from a single thread.
Function of creating a route editor.
context
trafficRouter
Route search engine to be used in the route editor. If not specified, the hybrid search engine is used by default.
Sets route editor parameters. Starts searching for a new route according to the given parameters.
Sets the active route index.
val routesInfoChannel
Channel through which you can monitor updates about the routes operated by the editor.
val routesInfo
Channel through which you can monitor updates about the routes operated by the editor.
val activeRouteIndexChannel
Channel through which you can monitor the active route index updates. If there are no routes, null is placed in this channel.
val activeRouteIndex
Channel through which you can monitor the active route index updates. If there are no routes, null is placed in this channel.
RouteEditorRouteParams
Information about route parameters.
Information about route parameters.
startPoint
finishPoint
routeSearchOptions
intermediatePoints
RouteEditorRoutesInfo
Information about routes operated by the editor.
Information about routes operated by the editor.
val routes
When updating the list of routes, the first route is active, if the list is not empty.
val error
Information about an error when searching for a route.
val routeParams
Parameters of the route that were searched for. May differ from the parameters passed to the editor if the routes were already found after the parameters were changed in the editor.
RouteEditorSource
Interface of the class that controls the display of routes on the map.
Function to create IRouteEditorSource.
context
routeEditor
activeDisplayFlags
inactiveDisplayFlags
activeCalloutLabelFlags
inactiveCalloutLabelFlags
calloutLabelDisplayMode
activePermanentDisplayFlags
inactivePermanentDisplayFlags
Enables or disables the routes display on the map.
Shows all routes on the map (false) or only the current active route (true).
Changes the method of visualizing the distance traveled along a route.
val objects
Route objects on the map.
val routeSourceSettings
Settings for displaying maneuvers on the route.
var activeDisplayFlags
Display flags for the active route. See IRouteMapObject::display_flags.
var inactiveDisplayFlags
Display flags for inactive routes. See IRouteMapObject::display_flags.
var activeCalloutLabelFlags
Flags enabling the display of content in callouts for active routes. See IRouteMapObject::callout_label_flags.
var inactiveCalloutLabelFlags
Flags enabling the display of content in callouts for inactive routes. See IRouteMapObject::callout_label_flags.
var calloutLabelDisplayMode
Display mode for values in route callouts. See IRouteMapObject::callout_label_display_mode.
var activePermanentDisplayFlags
Flags excluding the hiding of components of the active route from the map. See IRouteMapObject::permanent_display_flags.
var inactivePermanentDisplayFlags
Flags excluding the hiding of components of inactive routes from the map. See IRouteMapObject::permanent_display_flags.
RouteEnclosingRectsOptions
Options for obtaining a set of rectangles enclosing a simplified route geometry.
Options for obtaining a set of rectangles enclosing a simplified route geometry.
val offset
Offset to the left/right from the polyline approximating the route geometry, in meters. Must be a non-zero positive value.
val segmentSize
Size of one segment of the polyline approximating the route geometry. Must be a positive value.
val maxSliceSize
Maximum number of rectangles included in a single geometry.
val maxArea
Maximum total area of rectangles in square kilometers included in a single geometry.
RouteExitSign
Information about the exit sign.
Information about the exit sign.
RouteExitSignRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
RouteExitSignRouteEntry
Route element - point and value in it.
Route element - point and value in it.
RouteExitSignTable
Information about the exit plate.
Information about the exit plate.
RouteIndex
Active route index.
RouteInfo
Route description with maneuvers.
val route
Route.
val routeBuildOptions
Route building parameters in the navigator. A null value means that the route has no finish point. In this case, based on the road graph and user movement parameters, a section of the road on which the user is likely to move is calculated and returned as a route in the route field. Therefore, such a "route" cannot contain instructions, and the last point in this "route" is not a destination where the user is moving to, but just a point where the navigator managed to predict the user's movement. Where they will go next is unknown. This navigation mode is called free roam.
val external
Route source. True - the route is passed to the navigator externally in the start method. False - the route is generated by the navigator.
RouteInfoCalloutMapObject
Callout object with information about the length and/or duration of the route on the map.
RouteInstruction
Instruction to follow while moving along the route.
Instruction to follow while moving along the route.
RouteLane
Structure describing one traffic lane.
Structure describing one traffic lane.
routeManeuver
maneuvers
speedLimit
prohibited
onlyPublicTransport
RouteLaneSign
Description of traffic lanes.
Description of traffic lanes.
val lanes
Car lanes on a road section. Ordered from the edge to middle of roadgeway.
If the number of lanes is unknown, or there is one lane on the road in the direction of the route, this array is empty.
val signStartPoint
Point on the route where the operation of the sign regulating lane traffic begins. null if the position of the sign operation start is unknown.
val signPoint
Point on the route where the sign regulating lane traffic is placed. null if the position of the sign is unknown.
val signEndPoint
Point on the route where the operation of the sign regulating lane traffic ends. null if the position the sign operation end is unknown.
RouteLevelInfo
Information about the floor of the building corresponding to the route section.
val beginId
Identifier of the floor plan at the starting point of the route segment. None if the point is not in a building.
val endId
Identifier of the floor plan at the finish point of the route segment. None if the point is not in a building.
val name
Name of the floor. Empty if the route segment connects different floors.
RouteLevelInfoRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
RouteLevelInfoRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
RouteMapObject
Route object on the map.
trafficRoute
isActive
index
displayFlags
calloutLabelFlags
calloutLabelDisplayMode
permanentDisplayFlags
val displayFlagsChannel
Set of flags to display various parts of the route. If not specified, display logic based on the activity status of the route is used.
var displayFlags
Set of flags to display various parts of the route. If not specified, display logic based on the activity status of the route is used.
val permanentDisplayFlagsChannel
Set of flags to prevent various parts of the route from being hidden from the map when updating the distance traveled along the route. If not specified, then when updating the distance traveled along the route, all route elements that fall into the undisplayed part of the route are hidden from the map.
var permanentDisplayFlags
Set of flags to prevent various parts of the route from being hidden from the map when updating the distance traveled along the route. If not specified, then when updating the distance traveled along the route, all route elements that fall into the undisplayed part of the route are hidden from the map.
val isActiveChannel
Route activity status.
var isActive
Route activity status.
val route
Route.
val routeIndex
Route index in the route editor.
val passedDistanceChannel
Distance traveled along the route.
var passedDistance
Distance traveled along the route.
val passedDistanceVisualizationChannel
var passedDistanceVisualization
val calloutPositionChannel
Route callout position.
val calloutPosition
Route callout position.
val calloutLabelFlagsChannel
Set of flags for displaying the contents of the route callouts. If not specified, both the time of movement along the route and its length are displayed for the active route, and only the time of movement for inactive routes.
var calloutLabelFlags
Set of flags for displaying the contents of the route callouts. If not specified, both the time of movement along the route and its length are displayed for the active route, and only the time of movement for inactive routes.
val calloutLabelDisplayModeChannel
Mode for displaying values in route callouts. By default, values are displayed as absolute values.
var calloutLabelDisplayMode
Mode for displaying values in route callouts. By default, values are displayed as absolute values.
val roadEventObjectsChannel
Road event objects along the route that are displayed on the map.
val roadEventObjects
Road event objects along the route that are displayed on the map.
RouteMapObjectSource
Source of route objects on the map.
Function to create IRouteMapObjectSource.
Adds a route object to the source.
Removes the route object from the source.
Replacing one route object in the source with another. Unlike deleting and adding route objects through successive calls to remove_object and add_object, replacing one route to another is executed atomically - the old route is deleted and a new one appears on the map at the same time.
If the old route is not found in the source, then the call is equivalent to calling add_object.
Replaces all objects previously added to the source with the passed list of objects. In contrast to deleting and adding objects one at a time, the replacement is performed atomically - old routes are deleted, and new routes appear on the map at the same time.
RouteMapObjectsProvider
Interface for getting route objects on the map.
RouteMapSettings
Settings for displaying the route on the map.
var onRouteDisplayFlags
Flags for displaying the route on the map for the route navigation mode. By default, all flags are enabled except for the InactiveFloors flag.
var freeRoamDisplayFlags
Flags for displaying the route on the map for the free roam mode. The flags Cameras, Humps, Accidents, RoadWorks, Comments, RoadRestrictions, OtherEvents are enabled by default.
var onRoutePermanentDisplayFlags
Flags to prevent hiding various parts of the route from the map when updating the distance traveled along the route for route navigation mode. By default, all route elements are hidden.
var freeRoamPermanentDisplayFlags
Flags that prevent hiding various parts of the route from the map when updating the distance traveled along the route for free roam mode. By default, all route elements are hidden.
RouteOverviewControl
RoutePoint
Point on the route, specified as the distance along the route relatively to the beginning of the route.
Point on the route, specified as the distance along the route relatively to the beginning of the route.
distance
val distance
RoutePointMapObject
Feature that is part of a route on the map (for example, the starting or the finish point of a route).
val route
Route, the part of which the given feature represents.
val routeIndex
Route index.
val kind
Route feature type.
val routePoint
Position on the route corresponding to the given feature.
val pointChannel
Geographic coordinates at which this feature is located.
var point
Geographic coordinates at which this feature is located.
RouteRebuilder
Controller for searching for a new route when leaving the current route.
RouterErrorInfo
Information about an error when searching for a route.
Information about an error when searching for a route.
RouteSearchOptions
Route search options.
motorcycle
pedestrian
publicTransport
bicycle
car
motorcycle
pedestrian
publicTransport
scooter
taxi
truck
RouteSearchPoint
Description of the points by which the route is built.
Description of the points by which the route is built.
RouteSourceSettings
Route source settings.
Minimum allowable distance in meters between successive maneuver arrows for a large scale. If the distance is less than the specified one, then the arrows are merged.
Sets the minimum allowed distance in meters between successive maneuver arrows for large scale.
distance
Distance in meters.
transportType
Type of transport for which the distance is set.
Minimum allowable distance in meters between successive maneuver arrows for a small scaling. If the distance is less than the specified one, the arrows are merged.
Sets the minimum allowable distance in meters between successive maneuver arrows for small scaling.
distance
Distance in meters.
transportType
Type of transport for which the distance is set.
Offset in meters from the intersection point to the start and end of the large scale maneuver arrow.
Sets the offset in meters from the intersection point to the start and end of the maneuver arrow for the large scale. Allows you to set the size of the maneuver arrow.
offset
Offset in meters.
transportType
Transport type for which the offset is set.
Offset from the intersection point to the start and end of the maneuver arrow for the small scale.
Sets the offset from the intersection point to the start and end of the maneuver arrow for the small scale. Allows you to set the size of the maneuver arrow.
offset
Offset in meters.
transportType
Transport type for which the offset is set.
var largeScaleRingroadOffsetMeters
Offset from the roundabout exit point to the start and end of the maneuver arrow for large scale. Allows you to set the size of the maneuver arrow.
var smallScaleRingroadOffsetMeters
Offset from the roundabout exit point to the beginning and end of the maneuver arrow for small scale. Allows you to set the size of the maneuver arrow.
var calloutVisualizationMode
Mode for displaying callouts with time and route length.
RouteTollPaymentInfo
Information about toll costs for paid sections of the route.
RouteTollPaymentPointInfo
Information about a payment point on a toll road.
Information about a payment point on a toll road.
RouteTollPaymentPointInfoRouteAttribute
Container describing a point route attribute. Each element is stored as a point on the route where the element is located and an attribute value.
Elements falling within the [begin, end) interval.
Searches for the nearest element with position <= point.
Operation complexity is log2(N), where N = size (number of elements).
Searches for the nearest element with position <= point.
Operation complexity is log2(N), where N = size (number of elements).
RouteTollPaymentPointInfoRouteEntry
Route element: point and attribute value.
Route element: point and attribute value.
RubricId
Identifier of the rubric.
ScaleMapEvent
Map scale change event.
Zoom event constructor.
zoomDelta
Value by which the current zoom value changes.
scalingCenter
Point on the screen around which the map is scaled. If no point is given, then scaling is relative to the map's position point.
ScalingGestureSettings
Settings of the map scaling gesture.
ScalingKinematicSettings
val enabled
Enables or disables scaling kinematics. If false, scaling stops immediately after the gesture ends, and all other parameters are ignored.
val decelerationCoefficient
Coefficient of scaling deceleration after the gesture ends. The higher the value, the faster the scaling slows down.
val maxInitialForwardZoomSpeed
Maximum initial speed after the gesture ends, in dgis::map::Zoom per second.
val zoomThreshold
Threshold of dgis::map::Zoom deviation, above which the map continues scaling in the direction of the gesture. If the value is lower, the map moves toward its original position.
ScalingRecognizeSettings
Settings for recognizing the map scaling gesture. The scaling coefficient is calculated as the ratio of the distance between points after movement to the original distance between points.
Settings for recognizing the map scaling gesture. The scaling coefficient is calculated as the ratio of the distance between points after movement to the original distance between points.
val scaleRatioThreshold
Threshold value of the coefficient for activating the scaling gesture. Applied when rotation is disabled. The scaling coefficient must be outside the range (1 / scaleRatioThreshold, scaleRatioThreshold).
val scaleRatioThresholdInRotation
Threshold value of the coefficient for activating the scaling gesture. Applied when rotation is enabled. The scaling coefficient must be outside the range (1 / scaleRatioThresholdInRotation, scaleRatioThresholdInRotation).
val zoomScaleRatio
Ratio of logarithms of the previous zoom level to the current one when processing an instant zoom change event.
val scaleLogDiffPerMm
Difference in logarithms of zoom levels when shifting by 1 mm on the screen.
val disableZoom
Disabling ZoomEvent and DirectMapScaleEvent gestures.
Schedule
Traffic event schedule.
Traffic event schedule.
ScooterBriefRouteInfo
Basic information about the scooter route.
Basic information about the scooter route.
ScooterInstructionCrossroad
Description of maneuvers when passing through an intersection or a pedestrian crossing.
Description of maneuvers when passing through an intersection or a pedestrian crossing.
ScooterInstructionCrossroadManeuver
ScooterInstructionFinish
End of the scooter part of the route.
End of the scooter part of the route.
ScooterInstructionStart
Beginning of the scooter part of the route.
Beginning of the scooter part of the route.
ScooterRouteSearchOptions
Scooter route search options.
Scooter route search options.
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
avoidUnpavedRoads
excludedAreas
ScreenDistance
Distance between objects on the screen, in millimeters. The value cannot be negative.
Distance between objects on the screen, in millimeters. The value cannot be negative.
value
ScreenPoint
Point in screen coordinates.
Axis directions: x is to the right, y is downward. (0.0, 0.0) is the origin point (the top-left corner of the top-left pixel).
The integer part of the coordinate is the pixel number, the fractional part is the relative location within the pixel.
Point in screen coordinates.
Axis directions: x is to the right, y is downward. (0.0, 0.0) is the origin point (the top-left corner of the top-left pixel).
The integer part of the coordinate is the pixel number, the fractional part is the relative location within the pixel.
ScreenShift
Horizontal and vertical map offset in the screen coordinate space.
Positive offset direction: dx is to the right, dy is downward.
ScreenSize
Size in pixels.
SearchHistory
Returns a page of the search history. Items are sorted by addition time (from recent to oldest).
Adds an item to the search history. If the same item already exists, the earlier duplicate is removed.
Adds a list of items to the search history. The list is considered to be in chronological order. Any duplicates are removed.
Removes an item from the search history.
Removes a list of items from the search history.
Sets the strategy for creating keys for search history items. Migration of existing records created using a different keyStrategy strategy must be performed manually. If the parameter is not specified, the default algorithm is used.
SearchHistoryItem
Data type of the item in the search history: object or search query.
SearchHistoryPage
SearchHistoryResult
Result of the search history.
val items
Set of search history items.
SearchLayout
UI control that provides a search bar and displays search results.
Adds SearchViewCallback to respond to different states and work results of the search and the suggester.
Removes SearchViewCallback from the list.
Clears the list of currently used SearchViewCallback.
Configures the work of the search and the suggester. Methods of the SearchViewConfigurator interface are available inside the block.
Hides the UI of the search results and leaves only the search string. Method works only for the current query, when it is updated and new results appear, the output will be displayed again.
Specifies and enables speech recognition function for the search interface.
Important: to enable voice search, call the method explicitly. Otherwise, the voice input is disabled.
speechRecognizer
Implementation of the SpeechRecognizer interface for speech recognition. If null is passed, voice input is disabled.
Usage example:
// Enable voice inputsearchLayout.setupSpeechRecognition( DefaultSpeechRecognizer(activity, "Speak") )
// Disable voice input
searchLayout.setupSpeechRecognition(null)
SearchManager
Search engine. Main entry point for the directory API.
Gets suggestions matching the given query.
query
Future that resolves to a non-null pointer to the result of suggestion or exceptional future if an error occurred while getting suggestions.
query
Future that resolves to a non-null pointer to the search result or exceptional future if an error occurred while getting the search results.
Gets directory objects matching the given query.
suggest
searchSettings
Future that resolves to a non-null pointer to the search result or exceptional future if an error occurred while getting the search results.
Gets the directory object by string identifier.
id
Future that resolves to a pointer to a reference object. If the object is not found, a null pointer is returned.
Gets the directory object by identifier.
objectId
Future that resolves to a pointer to a reference object. If the object is not found, a null pointer is returned.
Gets a directory objecy by a string indentifier with the specified locale.
id
locale
Future that resolves to a pointer to a reference object. If the object is not found, a null pointer is returned.
Gets a directory objecy by an indentifier with the specified locale.
objectId
locale
Future that resolves to a pointer to a reference object. If the object is not found, a null pointer is returned.
Creates an online search engine.
Creates a search engine that works with preloaded data.
Creates a search engine that works online or with preloaded data depending on the presence of Internet connection.
SearchOptions
Options for creating SearchLayout.
Options for creating SearchLayout.
val searchType
Search engine type. Possible values depend on the SDK delivery type. See SearchType for details. The default value depends on the SDK delivery type.
val pageSize
Limit on the number of hints in suggest and of search results. Valid values range from 1 to 50. Default: 10.
val sortingType
Search results sorting type. Default: SortingType.BY_RELEVANCE.
val suggestorType
Suggester type. Default: SuggestorType.GENERAL
SearchQuery
Search query.
SearchQueryBuilder
Search query builder. The search is performed on the global index and local segment indexes, where a segment is a subdivision of the global map. The process of selecting segments for search is done as follows (in descending priority order):
This condition is not working yet.
Sets the search query text.
Sets rubric identifiers.
Sets a filter by the organization identifier to which the company belongs.
Sets the building identifier for filtering objects within a building.
Sets the search area limit in the form of a polygon. The first and the last points of the polygon do not have to match.
No limit by default.
Sets a strict search area restriction by geometry. Conflicts with the set_spatial_restriction, set_geo_point, and from_geo_point methods. For GeometryKind.Point, set_geo_point will be applied. GeometryKind.Polyline and GeometryKind.Polygon will be set as polygons. Geometry of type GeometryKind.Complex will be set as a multipolygon. For GeometryKind.Point inside GeometryKind.Complex, the geometry will be converted to a polygon contour with a radius from set_radius.
By default, no restriction is applied.
Sets a rectangular region of interest in geographic coordinates. A typical value is visible_rect from ICamera - the enclosing rectangle of the viewport.
Sets a non-strict search area restriction: if an object is not within the area, it is not discarded, but its rank in search results is lowered. Works only in online mode. Ignored if a strict restriction is set.
Sets the object types allowed in the query result.
By default, all types except Route are allowed.
Sets the preferred number of elements on the results page. Valid values are 1;50
. The default value is 10.
Sets filtering for the search query.
Sets sorting for the search query.
Sets the center of the search area. The default radius value is 250. Conflicts with the setSpatialRestriction method.
Sets the radius of the search area in meters. Works only with the set GeoPoint value. For a search query at a point, the limit is from 0 to 2000. For other queries, the limit is from 0 to 50,000.
Sets a locale for the search query.
Search for objects near the user. Increases the importance of distance from the user in search results.
Starts building a text search query with the specified text.
Starts building a search query based on the rubric identifiers.
Starts building a text search query with filtering by rubric identifiers.
Starts building a query based on #query to change some of the parameters.
The original #query remains unchanged.
Starts building a search query based on the specified organization ID.
Starts building a search query based on the specified building ID.
Starts building a search query based on the specified center of the search area. The default radius value is 250. Conflicts with the setSpatialRestriction method. The method works only with online search.
SearchQueryWithInfo
Additional information about the search query to display in UI controls.
val searchQuery
Returns the search query object.
val title
Returns the title text that describes the search query objects. For example, the text from the title field of the ISuggest object.
val subtitle
Returns the subtitle text. For example, the text from the subtitle field of the ISuggest object.
val rubrics
Returns a list of rubric to search by.
SearchResult
Result of the search engine work.
Gets texts of markers by their IDs.
A vector
val firstPage
First page of search results.
val representativeArea
Rectangular area suitable for displaying search results.
val itemMarkerInfos
Asynchronous receiving of markers.
val searchResultType
Search query type.
val dynamicFilters
Dynamic filters for this query.
val actionWidgets
Quick filter widgets.
These are the so-called “quick filters” - filters that are most interesting to the user. There are no more than 5.
val mainWidgets
Filter widgets.
val autoUseFirstResult
Indicates that the first result is suitable for direct use.
val nearbyRequested
Flag indicating that nearby objects were requested during the search.
SearchSettings
SegmentGeoPoint
Describes a geographic point on a segment and the direction of the segment. The geometry of the route is a sequence of points that form segments pairwise. In all functions that work with the geometry of the route, it is assumed that the first point from the pair forming the segment belongs to this segment, and the second one does not: [point_1, point_2),[point_2, point_3),...,[point_n-1, point_n)point_last. The last point forms a zero-length segment with itself. Thus, each point on the route belongs to exactly one segment. The direction of the point_last is not defined.
Describes a geographic point on a segment and the direction of the segment. The geometry of the route is a sequence of points that form segments pairwise. In all functions that work with the geometry of the route, it is assumed that the first point from the pair forming the segment belongs to this segment, and the second one does not: [point_1, point_2),[point_2, point_3),...,[point_n-1, point_n)point_last. The last point forms a zero-length segment with itself. Thus, each point on the route belongs to exactly one segment. The direction of the point_last is not defined.
SettlementRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
SettlementRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
SharedRouteData
Information on a pre-built route and its search parameters.
ShowRouteControl
A control that controls the map flyover to the route.
SimpleCheckableItem
Simple checkable element from CheckableItemsGroup.
SimpleClusterObject
Cluster of simple marker objects.
val position
Gets the position of the cluster on the map.
val objectCount
Gets the number of markers in the cluster.
val objects
Gets a list of markers in the cluster.
var anchor
Gets and sets the anchor point of the cluster icon.
var iconOpacity
Gets and sets the transparency of the cluster icon.
var text
Gets and sets cluster caption.
var textStyle
Gets and sets the cluster caption style.
var iconWidth
Gets and sets the target cluster width used for scaling.
var iconMapDirection
Gets and sets the rotation angle of the cluster on the map relative to the north direction, clockwise.
var animatedAppearance
Gets and sets the cluster appearance animation flag.
var zIndex
Gets and sets the rendering level of an object.
var suppressOnOverlap
Whether to hide the icon when objects on the map (markers and labels of other objects) overlay.
SimpleClusterOptions
Marker settings for a cluster of simple marker objects.
Marker settings for a cluster of simple marker objects.
icon
iconMapDirection
anchor
text
textStyle
iconOpacity
iconWidth
userData
zIndex
labelingPriority
animatedAppearance
iconAnimationMode
suppressOnOverlap
val icon
val iconMapDirection
val anchor
val text
val textStyle
val iconOpacity
val iconWidth
Target width used for scaling.
val userData
val zIndex
Object rendering level.
val labelingPriority
Priority of the marker icon if objects on the map overlay.
val animatedAppearance
Whether to animate appearance.
val iconAnimationMode
Animation mode.
val suppressOnOverlap
Whether to hide the icon when objects on the map (markers and labels of other objects) overlay.
SimpleMapObject
Object on the map for which visibility can be set.
SimulationAutoWithOverSpeed
Structure for setting the motion mode, taking into account the maximum speed on the edge of the route.
SimulationConstantSpeed
Structure for setting the motion mode at a constant speed
SimulationSettings
Settings for simulation of navigating the route.
var speedMode
Simulator operation mode.
SimulationSpeedMode
SnapToMapLayout
Layout that allows you to bind the View to a point on the map.
Layout that allows you to bind the View to a point on the map.
SortingFilter
Sorting filter.
SoundNotificationSettings
Settings for sound alerts in the navigator. By default, all values of the alert sound categories are enabled. The user can change the values while working with the navigator.
Source
Data source for the map.
This can be a source of traffic data, routes, markers, arbitrary geometric or other map objects. Any map object can have its own properties. The object properties affect which rules and display parameters, described in map styles, are applied to it. Style is a set of parameters and rules for displaying map objects, obtained through the style editor and used for rendering the map.
The object properties can be set:
- directly for the object;
- for the data source (all objects added to the source obtain these properties);
- for the map (all objects added to the map obtain these properties);
- for the style (all objects to which the style is applied obtain these properties). The list is presented in descending order of priority for applying properties. Even if no data sources are added to the map, the style and map properties still affect the map, since there are special displayable objects such as background.
SpecialSpace
Special parking spot.
Special parking spot.
SpeedInfoControl
SpeedRange
Speed interval. Speed is specified in meters per second.
SpeedRangeToStyleZoom
Mapping of a speed interval to a style zoom.
val range
Speed interval.
val minDistanceToManeuver
Minimum distance before a maneuver at which the logic of smooth increase of the zoom level must be enabled.
val maxDistanceToManeuver
Maximum distance after a maneuver at which smooth decrease of the zoom level must end.
val roadClassesStyleZooms
Style zoom level for a particular road class. Overrides the default styleZoom value.
val roadClassesTilts
Style tilt angle for a particular road class. Overrides the default styleTilt value.
val styleZoom
Style zoom.
val styleTilt
Style tilt angle for all road classes.
StorageOptions
Offline data storage parameters.
Offline data storage parameters.
downloadStoragePath
StringRouteAttribute
Container describing a point route attribute. Each element is stored as a point on the route where the element is located and an attribute value.
Elements falling within the [begin, end) interval.
Searches for the nearest element with position <= point.
Operation complexity is log2(N), where N = size (number of elements).
Searches for the nearest element with position <= point.
Operation complexity is log2(N), where N = size (number of elements).
StringRouteEntry
Route element: point and attribute value.
Route element: point and attribute value.
StringRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
StringRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
Style
Style with a set of map object properties (see ISource).
val styleAttributes
Gets default properties for objects that have the specified layer applied to them.
StyleBuilder
Style builder.
StyleLayerId
ID of the style layer.
StyleZoom
Style zoom level.
It is set in the style editor and differs from the usual zoom level in that for one StyleZoom the map scale is the same regardless of latitude. However, with Zoom < 9 or with latitude > 60 degrees StyleZoom == Zoom and map scale is different at different latitudes.
StyleZoom cannot be negative.
Style zoom level.
It is set in the style editor and differs from the usual zoom level in that for one StyleZoom the map scale is the same regardless of latitude. However, with Zoom < 9 or with latitude > 60 degrees StyleZoom == Zoom and map scale is different at different latitudes.
StyleZoom cannot be negative.
value
StyleZoomFollowController
Controller for following the style zoom level of the map.
Creates a controller for following the style zoom level of the map.
animationDuration
Sets a new value for the style zoom level.
Suggest
Search suggestion.
SuggestHandler
Suggestion selection handler.
performSearchHandler
incompleteTextHandler
objectHandler
performSearchHandler
incompleteTextHandler
SuggestObjectHandler
Specific object from a directory is suggested.
val item
Suggested object.
SuggestQuery
Request a search suggestion.
SuggestQueryBuilder
Builder of queries to the suggestor.
Sets the search area limit in the form of a polygon. The first and the last points of the polygon do not have to match.
No limit by default
Sets a strict search area restriction by geometry. Conflicts with the set_spatial_restriction() method.
By default, no restriction is applied.
Sets a non-strict search area restriction: if an object is not within the area, it is not discarded, but its rank in search results is lowered. Works only in online mode. Ignored if a strict restriction is set.
Sets a rectangular region of interest in geographic coordinates. A typical value is visible_rect from ICamera - the enclosing rectangle of the viewport.
Sets the object types allowed in the query result.
By default, all types except Route are allowed.
Sets the type of suggester.
The default value is #SuggestorType::General.
Sets the desired number of suggestions. Valid values are from the range 1;50.
The default value is 10.
Locale where a hint request is executed and results are returned.
Search for objects near the user. Increases the importance of distance from the user in search results.
Starts building a suggestion query for the given text and the area of interest.
Starts building a suggestion query based on #query to change some of the parameters.
The original #query remains unchanged.
SuggestResult
Result of the suggester work.
val suggests
Set of suggestions.
The set is empty if no matching suggestions are found.
SystemCertificate
System SSL certificate.
System SSL certificate.
SystemMemoryManager
Interface of the system memory management.
Memory usage decrease by clearing various caches and buffers.
Obtains an object for managing system memory.
TaxiRouteSearchOptions
Taxi route search options.
Taxi route search options.
val car
Route search options common to other car routes.
TerritoriesAlongRouteProvider
Interface for finding a route based on traffic data.
Obtains an object for extracting a list of territories along a route from the context.
context
Returns the minimum required list of offline territories in route order.
Territory
Territory. Data in 2GIS is divided into some indivisible units called segments. For more convenient and flexible work with data, not segments themselves are used for updating, but their sets, called territories. Sets of segments in two territories can intersect, including that one territory may be entirely nested within another.
TerritoryManager
Interface for interacting with the list of territories: Subscriptions to changes in information about territories; Search for territories by coordinates and geometries; Subscriptions to changes in information about the overall progress of installing/updating territories; Pausing and resuming the process of installing/updating territories.
Searches for territories that own the given point. Throws an exception if incorrect point coordinates are passed. Returns an empty list if:
- Point coordinates are outside the projection.
- An internal error occurred during the processing of a territories list.
Searches for territories that own the given point. Throws an exception if an unsupported geometry is used. Returns an empty list if the geometry is outside of the project
Obtains an object for managing territories from the context.
val territoriesChannel
Channel with a list of all known territories. Updated when information about at least one of the territories or the list composition changes. The channel's contents is a subset of the general package list obtained from IPackageManager::packages. To avoid desynchronization of package descriptions, do not use data obtained simultaneously from multiple channels containing subsets of the general package list.
val territories
Channel with a list of all known territories. Updated when information about at least one of the territories or the list composition changes. The channel's contents is a subset of the general package list obtained from IPackageManager::packages. To avoid desynchronization of package descriptions, do not use data obtained simultaneously from multiple channels containing subsets of the general package list.
TextStyle
Text appearance settings.
Text appearance settings.
fontSize
color
strokeWidth
strokeColor
textHorizontalAlignment
textPlacement
textOffset
fontName
labelingPriority
suppressOnOverlap
val fontSize
val color
val strokeWidth
val strokeColor
val textHorizontalAlignment
val textPlacement
val textOffset
val fontName
val labelingPriority
Priority of the marker label if objects on the map overlay.
val suppressOnOverlap
Whether to hide text when it overlaps other objects (markers, labels of other objects).
Tilt
Tilt angle in degrees, where 0 is nadir (looking vertically down), 90 is horizon in front.
Values in the range of 0 to 60 degrees are allowed. In cases where the camera position point is closer to the bottom of the screen, the value may be additionally reduced.
Tilt angle in degrees, where 0 is nadir (looking vertically down), 90 is horizon in front.
Values in the range of 0 to 60 degrees are allowed. In cases where the camera position point is closer to the bottom of the screen, the value may be additionally reduced.
value
TiltFollowController
Controller for following the tilt angle of the map.
Creating a map angle tracking controller.
styleZoomToTilt
Dependence of the camera tilt angle on the style zoom level.
TiltGestureSettings
Settings of the map tilting gesture.
TiltKinematicSettings
val enabled
Enables or disables tilting kinematics. If false, tilting stops immediately after the gesture ends, and all other parameters are ignored.
val decelerationCoefficient
Coefficient of tilting deceleration after the gesture ends. The higher the value, the faster the tilting slows down.
val initialForwardSpeedMultiplier
Initial multiplier of tilt speed.
val maxInitialForwardAngularSpeed
Maximum initial angular speed after the gesture ends, in radians per second. When calculating the speed, it first multiplies by the initial multiplier of tilt speed initialForwardSpeedMultiplier, then applies the constraint.
val minTiltAdditionalBorder
val maxTiltAdditionalBorder
val tiltThreshold
Threshold of angular deviation, above which the map continues tilting in the direction of the gesture, in radians. If the value is lower, the map moves toward its original position.
TiltRecognizeSettings
Settings for recognizing the map tilting gesture.
Settings for recognizing the map tilting gesture.
val lenOnDegreeMm
Distance to move fingers on the screen to change the camera tilt angle by 1 degree, in millimeters. With a negative value, the direction is inverted. The value cannot be zero.
val horizontalSwerveDeg
Maximum angle of finger line deviation from horizontal for vertical swipe, in degrees.
val verticalSwerveDeg
Maximum angle of deviation of the swipe direction from the vertical, in degrees.
val thresholdMm
Threshold value of the weighted average shift of points for activating the tilting gesture, in millimeters.
val maxParallelsDeviationDeg
Maximum angle between vectors, exceeding which indicates a violation of co-direction, in degrees.
TimePoint
Class representing a point in time.
Class representing a point in time.
timeFromEpoch
Time elapsed since 00:00:00 UTC, January 1, 1970 (Unix time).
TradeLicense
Organization license.
Traffic
Description of the traffic data.
TrafficAndParkingControl
Container with controls for displaying parking lots and traffic jams.
TrafficCollector
Interface for managing traffic information collection service.
This interface is thread-safe.
Obtains an object for managing the service for traffic information collection. The service analyzes traffic conditions on the road the user is traveling on and sends the analysis results to the server in anonymized form.
context
Context: the environment required for the SDK to run.
Service for traffic information collection.
TrafficControl
Traffic jam visibility control. It is a button that switches the visibility of traffic jams on the map. The control visually displays the traffic jam score, which also affects color: green - low level of traffic, yellow - medium, red - high. The appearance of the control changes depending on the state, see TrafficControlStatus for details.
Traffic jam visibility control. It is a button that switches the visibility of traffic jams on the map. The control visually displays the traffic jam score, which also affects color: green - low level of traffic, yellow - medium, red - high. The appearance of the control changes depending on the state, see TrafficControlStatus for details.
TrafficControl
Traffic jam visibility control. It is a button that switches the visibility of traffic jams on the map. The control visually displays the traffic jam score, which also affects color: green - low level of traffic, yellow - medium, red - high. The appearance of the control changes depending on the state, see TrafficControlStatus for details.
TrafficControlModel
Model of a traffic jam visibility control.
This interface is thread-safe.
Function of creating a model of a traffic jam visibility control.
map
Map.
Action when clicking on the control. Toggles the visibility of traffic jams on the map.
TrafficControlState
Traffic control status.
Traffic control status.
TrafficJamDetector
Determining user proximity to traffic jam on the route.
TrafficJamInfo
Information about a traffic jam.
TrafficLineColors
TrafficLineControl
Control that displays the level of traffic jams along the route.
var pointObjectsPosition
TrafficLinePointObject
TrafficLinePointObjectView
TrafficRoute
TrafficRouter
Interface for finding a route based on traffic jam data.
Searches for a route with the given parameters.
startPoint
Starting point of the route.
finishPoint
Finish point of the route.
routeSearchOptions
Route search options.
intermediatePoints
Intermediate points to pass in the same order in which the points are given in the vector.
Future with a set of found routes, or throw a NativeException on failure.
An empty route set is a valid result, meaning that a route matching the specified search criteria cannot be found.
When searching for routes for freight transport, it is possible to return routes passing through the access zones for which passes were not provided, if it was not possible to route only through the access zones for which the passes were provided. To check if the list of passes is sufficient to pass a route, use the route_matches_truck_pass_zone_passes function.
Searches for a route using previously serialized parameters.
request
Serialized request parameters.
serverEndpoint
Type of route specified in the request endpoint: bicycle, carrouting, pedestrian, truck.
Future with a set of found routes or throwing a NativeException on failure.
Not suitable for finding public transport routes.
If it is not possible to find truck routes, it does not try to find car routes without taking into account truck restrictions.
Searches for basic route information for a matching set of search points.
searchPoints
Set of points for finding basic information about the route.
routeSearchOptions
Route search options.
Future with basic information about the set of routes corresponding to the set of search points, or throwing a NativeException on failure.
If the basic information for any of the pairs of points is not found, the element at the corresponding index in the returned result is null.
val truckPassZonePasses
Returns a list of all supported passes that allow truck traffic within the pass zones.
TrafficScore
Traffic score.
Traffic score.
TrafficScoreProvider
Subscribtion to updates of the traffic jam score.
This interface is thread-safe.
TrafficSource
Interface of the class that controls the display of traffic jams on the map.
TrafficSpeedColorRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
TrafficSpeedColorRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
TransportTypeRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
TransportTypeRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
TraversalTypeRouteLongAttribute
Container storing an extended route attribute. Each element is stored as a pair consisting of a point and an attribute value. The attribute value is effective from the current point to the point, where the action of the next element attribute starts.
Element that contains the specified point.
Elements falling within the [begin, end) interval.
TraversalTypeRouteLongEntry
Extended route element: interval and attribute value.
Extended route element: interval and attribute value.
TruckPassZoneId
Identifier of the pass zone for trucks. Value 0 means no pass zone.
Identifier of the pass zone for trucks. Value 0 means no pass zone.
value
TruckPassZoneIdRouteLongAttribute
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.
Element that the specified point falls into.
Elements partially or completely covered by the begin,end range.
TruckPassZoneIdRouteLongEntry
Extended route element - segment and value on it.
Extended route element - segment and value on it.
TruckPassZonePass
Pass allowing the movement of trucks in pass zones.
Pass allowing the movement of trucks in pass zones.
TruckPassZonePassId
Identifier of the pass that allows the movement of trucks in pass zones.
Identifier of the pass that allows the movement of trucks in pass zones.
value
TruckRouteSearchOptions
Parameters for finding a truck route . When searching for a route, only filled-in parameters are taken into account.
Parameters for finding a truck route . When searching for a route, only filled-in parameters are taken into account.
val car
Route search options common to other car routes.
val truckLength
Length of the truck in millimeters.
val truckHeight
Height of the truck in millimeters.
val truckWidth
Width of the truck in millimeters.
val actualMass
Actual weight of the truck in kilograms.
val maxPermittedMass
Maximum authorized mass of a truck in kilograms.
val axleLoad
Axle load in kilograms.
val dangerousCargo
Sign of the presence of dangerous cargo.
val explosiveCargo
Sign of the presence of explosive cargo.
val passIds
Identifiers of the user passes required for moving within the pass zones.
val fallbackOnCar
Use automatic fallback from truck route search to car route search, if you cannot find a truck route that matches the search parameters.
UIMarkerInfo
Object ID with a caption.
Object ID with a caption.
VendorConfig
Overwrites SDK configuration.
none
fromAsset
fromFile
fromString
VendorConfigFromAsset
Overwrites SDK settings by specifying the path to the application asset. For Android - assets directory. For iOS - Bundle.main directory.
Overwrites SDK settings by specifying the path to the application asset. For Android - assets directory. For iOS - Bundle.main directory.
path
VendorConfigFromFile
Overwrites SDK settings by specifying the path to a file in the device file system.
Overwrites SDK settings by specifying the path to a file in the device file system.
path
VendorConfigFromString
Overwrites SDK settings by specifying the file contents.
Overwrites SDK settings by specifying the file contents.
contents
Voice
Voice package for the navigator.
VoiceManager
Interface for interacting with the list of navigator voice packages.
val voicesChannel
Channel with a list of all known voice packages. Updated if information about at least one of the voices or the list composition changes. The content of the channel is a subset of the total list of packages. To avoid desynchronization of package descriptions, you should not use data that are obtained simultaneously from multiple channels containing subsets of a common package list.
val voices
Channel with a list of all known voice packages. Updated if information about at least one of the voices or the list composition changes. The content of the channel is a subset of the total list of packages. To avoid desynchronization of package descriptions, you should not use data that are obtained simultaneously from multiple channels containing subsets of a common package list.
val defaultVoice
Voice package based on the list of supported locales.
VoiceSelector
Manages voice packages in the current navigator session.
var voice
Voice package that plays voice notifications in the current navigator session.
VoidRouteAttribute
Container that describes a point attribute of a route. Each element is stored as the point on the route (where the element is located) and the value of the element itself.
Elements falling within the [begin, end) range.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
Finds the nearest element the position of which is < = point.
The complexity of the operation is log2(N), where N = size.
WeekTime
Time point within a week.
WeekTimeInterval
Time interval within a week.
Widget
Base class representing a widget for filtering search results.
Widgets are returned as a result of a search and are designed to filter or sort the result by certain parameters. Widgets are generated dynamically for each search result and may not be available for some requests. The widget represents one specific filter or a group of them, united by a common feature. For example, the type of cuisine in search results for the "Eat" query.
WmsRasterUrlTemplate
WorkStatus
Work status.
val isOpen
Open now.
val description
Text description. For example, "Open until 9:00 pm", "24 hours", "Closes in 5 minutes".
val openStatus
Status.
val openStatusHint
Text hint for the current working status. For example: "Opens in 15 minutes", "Today 10:00-22:00", "Daily 09:00-21:00", "Open", "Closes in 15 minutes", "Closed", "Lunch until 14:00", "Break until 16:15".
val scheduleHint
Text hint for the work schedule. For example: "Today 10:00-22:00", "Daily 09:00-21:00", "Closed today".
val breakHint
Text hint about the current or upcoming break. For example: "Lunch until 14:00", "Break until 11:30".
WorkTimeFilter
Filter by the object's opening hours. Either open now or open for a specific date and time.
ZIndex
Index specifying the rendering order of objects within a layer.
Index specifying the rendering order of objects within a layer.
value
Zoom
Zoom level.
Zoom = 0 is the scale at which the entire world is inscribed in a square of 256x256 logical pixels (see LogicalPixel). Zoom = 1 is the scale at which the entire world is inscribed in a square of 512x512 logical pixels. The scale is proportional value of 2^Zoom.
Zoom cannot be negative.
Zoom level.
Zoom = 0 is the scale at which the entire world is inscribed in a square of 256x256 logical pixels (see LogicalPixel). Zoom = 1 is the scale at which the entire world is inscribed in a square of 512x512 logical pixels. The scale is proportional value of 2^Zoom.
Zoom cannot be negative.
value
ZoomControl
Container with controls to increase and decrease the zoom level.
ZoomControl
Container with controls to increase and decrease the zoom level.
Container with controls to increase and decrease the zoom level.
ZoomControlModel
Zoom control model. The control consists of +/- buttons, which, when pressed, change the map scale. When the allowable scale limit is reached, the zoom button in this direction becomes inactive. Object methods must be called on one thread.
ZoomFollowSettings
Interface that allows you to manage map scaling settings during navigation.
During navigation, the scale depends on the speed of movement, the presence of maneuvers ahead and behind on the route, and the type of road.
If there are no maneuvers ahead and behind, or on roads with low value (minor streets in settlements, highways, intercity or federal highways), the scale value is selected based on the values SpeedRangeToStyleZoom, which are stored in the speed_range_to_style_zoom_sequence. The sequence speed_range_to_style_zoom_sequence must contain speed intervals sorted in ascending order of min_speed values, and the conditions below must be met: max_speedi > min_speedi+1
max_speedi < max_speedi+1. That is, speed intervals should touch or even intersect, but the speed value should not fall into more than two intervals. However, the minimum speed value is not considered to fall within the interval, i.e. the same speed value may be the maximum speed for one interval, the minimum speed for another, and be inside the interval for a third interval. An exception is the first speed interval, which must contain min_speed == 0.
The map scale is selected from the speed_range_to_style_zoom_sequence using the algorithm:
When approaching a maneuver at the current speed, the scale will increase smoothly. The duration of the increase depends on the speed and distance to the maneuver. When the speed is increased, the animation time increases, and when the speed is decreased, it decreases. The increase in zoom level is completed at some distance from the maneuver.
After passing the maneuver, the zoom level smoothly decreases.
var speedRangeToStyleZoomSequence
Sequence of speed intervals and their corresponding scales. Used for automatic map scaling in the navigator based on speed.
var speedRangeToStyleZoomFreeRoamSequence
var styleZoomSpeedRangesAnimationDuration
Duration of smooth zoom in the navigation mode as speed changes when there are no maneuvers ahead/behind at a sufficiently close distance, or on roads with low value.
var zoomInBeforeManeuverAnimationDuration
Duration of smooth zoom increase when approaching a maneuver. Used only if the speed is lower than get_min_speed_to_consider_in_zoom_in_before_maneuver_animation.
var zoomOutAfterManeuverAnimationDuration
Duration of smooth decrease of the zoom level after completing the maneuver.
var minSpeedToConsiderInZoomInBeforeManeuverAnimation
Minimum movement speed in m/s at which the duration of the smooth zoom level change is calculated taking into account not only the proximity to the maneuver, but also the current speed. Must be at least 0.1 m/s, values less than are ignored.
var zoomInBeforeManeuverAnimationAcceleration
Acceleration factor for the zoom increase animation when approaching a maneuver. Must be at least 1, values less than this are ignored.
var distanceGapToManeuver
Distance to the maneuver at which the zoom-in animation must be completed so that the zoom does not change during the maneuver. For example, if there is 300 m before the maneuver, then the zoom-in animation must be completed 50 m before start of the maneuver. Must be at least 1 m, values less than are ignored.
var minAnimationDuration
Minimum animation time. Used to prevent abrupt changes in the zoom level during animation. Must be at least 200, values below are ignored.