enumeration
ActionResult
Type of action result.
Properties
AddEventError
Type of error adding a road event.
Properties
networkError
Network error.
territoryNotSupported
Attempted to add an event outside of 2GIS projects.
unknownUserLocation
Unknown current user position. Road events can only be added with a known position.
userLocationTooFarFromEvent
The user is too far away from the location of the event to be added.
notAuthorized
Attempted to add an anonymous event in an area where user authorization is required.
noPersonalDataCollectionConsent
User has refused to collect and submit personal data.
userBlocked
User is blocked.
tooManyRequests
User creates events too often.
AddEventResult
Result of adding an event (event object or error).
Properties
AddressComponent
Address component: street, house number, or verbal description of the location.
Properties
Alignment
AttributeValue
Map object properties.
Properties
empty
boolean
number
integer
string
data
array
object
AudioVolume
Properties
AuthorType
Content author category.
Properties
anonymous
Anonymous user.
doubleGis
2GIS Company.
user
Authorized user.
me
Current user of the application.
BetterRouteResponse
User response to an alternative route suggestion.
Properties
accept
The user accepted the offer to switch to an alternative route.
reject
The user explicitly declined the offer to switch to an alternative route.
timeout
BicycleInstructionCrossroadLandmark
Landmark.
Properties
none
No landmark.
crosswalk
Pedestrian crossing.
trafficLight
Traffic light.
BicycleInstructionCrossroadManeuverDirection
Direction of travel.
Properties
straight
left
right
Steep left turn.
Steep turn to the right.
keepLeft
Keep to the left.
keepRight
Keep to the right.
BriefExtraRouteInfo
Additional route information for a specific vehicle type.
Properties
bicycle
car
pedestrian
publicTransport
scooter
CalloutVisualizationMode
Mode of displaying callouts with the time and length of the route. Unlike DisplayFlag, this mode affects not only the display but also the calculation of the positions of the callouts for each individual route object. See IRouteMapObject::display_flags. See IRouteMapObject::callout_position.
Properties
always
Show callouts (including DisplayFlag) and calculate positions for them if at least one route is added to the source.
multipleRoutes
Show callouts (considering DisplayFlag) and calculate positions for them only if more than one route object is added to the source.
none
Do not show callouts and do not calculate positions for them.
CameraAnimatedMoveReason
Caused by animated camera movement.
Properties
application
Explicit call of ICamera::move()
event
Animated move is caused by event handling (kinematics after moving the map, turning north, and others).
`internal`
Internal causes, e.g., due to active tracking of the user's position.
CameraAnimatedMoveResult
Result of a camera move.
Properties
finished
Moving the camera position is complete when the end point is reached.
cancelledByEvent
Camera position movement canceled by a map event (shift, zoom, etc.).
cancelledByApplication
New flyover is started, position is changed (explicitly or implicitly via ICamera::set_position_point() or ICamera::set_padding()), or tracking mode is changed.
CameraAnimationType
Flight type.
Properties
`default`
The type of overflight is selected depending on the distance between the start and end positions.
linear
Linear change of camera position parameters
showBothPositions
Zoom is changed to try and display the start and end positions at some point in the flyover. Positions may not be displayed if the current constraints (see ICamera::zoom_restrictions()) do not allow such a small zoom.
CameraBehaviourChangeReason
Reason for changing the camera tracking mode.
Properties
application
Changing the mode by the application, setting the position (explicitly or indirectly through ICamera::set_position_point()), starting the flyover.
event
Tracking mode changed because of a map event. Depending on the event, the tracking mode for position, rotation angle, tilt angle, or scale may reset, see CameraBehaviour.
CameraFollowState
Camera tracking status of the user's current location.
Properties
off
Camera is not in tracking mode.
followPosition
Camera is in position tracking mode.
followDirection
The camera is in position and direction tracking mode.
CameraPurpose
Camera assignment.
Properties
speedControl
Recording of exceeding the speed limit.
averageSpeedControl
Recording of exceeding the average speed on the section.
publicTransportLaneMovementControl
Recording of movement on the dedicated lane for public transport.
roadMarkingsCrossingControl
Recording of crossing the solid line of road markings, driving on the side of the road.
trafficLightsViolationControl
Recording of passing at the forbidden signal of traffic lights.
stopLineCrossingControl
Recording of driving over the stop line, driving without stopping the stop sign, driving to the intersection during a jam.
oncomingTrafficLaneMovementControl
Recording driving in the oncoming lane.
pedestrianAdvantageViolationControl
Recording failure to give priority to pedestrians.
laneDisciplineControl
Recording of violation of lane rotation at the intersection.
noStoppingViolationControl
Recording of violation of prohibition of stopping.
dummy
Fake item
truck
Platon system camera, truck restriction control camera.
CameraState
Camera status.
Properties
busy
The camera is user controlled.
fly
There is an active overflight.
followPosition
Camera is in position tracking mode.
free
The camera is not user controlled and there are no active overflights.
CarBriefRouteInfoTrafficSpeed
Travel speed.
Properties
unknown
Speed unknown.
slow
Low travel speed.
normal
Normal speed.
fast
High travel speed.
CarInstructionCrossroadDirection
Direction of traffic at the intersection.
Properties
straight
Straight.
slightlyLeft
Smooth turn left.
left
Steep left turn.
uTurn
Steep turn to the right.
right
slightlyRight
Make a slight turn to the right.
keepLeft
Keep to the left.
keepRight
Keep to the right.
CarInstructionCrossroadLandmark
Landmark.
Properties
none
No landmark.
tunnelBefore
In front of the tunnel.
tunnelEntry
Tunnel entrance.
bridgeBefore
Before the bridge.
bridgeEntry
Bridge entrance.
archwayEntry
Archway entrace.
onTrafficLight
At the traffic lights.
courtyardEntry
Yard entrance.
CarInstructionRoundaboutType
Type of maneuver at traffic circle intersection.
Properties
entry
Roundabout entry.
intermediate
Intermediate instruction on the roundabout.
exit
Exiting the roundabout.
CopyrightAlignment
Copywriting alignment on the map.
Properties
topLeft
bottomLeft
bottomRight
topRight
DesiredAccuracy
Expected positioning accuracy.
Properties
low
Low accuracy of geopositioning. The most suitable mode for determining the current city/area. This mode is featured by low power consumption. In this mode, the device can either rely solely on networks (Wi-Fi, 3GPP, IP) or use the GNSS receiver in a low-power mode (with geopositioning cached for a long time).
medium
Geo-positioning accuracy provided by a standard GNSS receiver. The most appropriate mode for displaying your current location on the map. If a GNSS receiver is installed on your device and the satellites are in view, the data from the satellites is used to determine your location. Otherwise, alternative geo-positioning sources are used.
high
Geo-positioning accuracy provided by a standard GNSS receiver and possibly enhanced by additional means. The most suitable mode for route guidance. Similar to the Medium mode, but the GNSS receiver can be switched to a higher accuracy mode or additional sensors can be used to refine geopositioning. May consume a lot of power (the device in this mode is usually connected to a power source).
DgisSourceWorkingMode
Setting the working mode of the IDgisSource data source.
Properties
online
Getting data from 2GIS servers.
offline
Working with pre-loaded data.
hybridOnlineFirst
Hybrid mode, which gives priority to receiving data from 2GIS servers. Pre-loaded data is used if, for some reason, it was not possible to obtain data from the servers or the pre-loaded data matches the data on the server.
hybridOfflineFirst
Hybrid mode, which gives priority to using pre-loaded data. Data from 2GIS servers is used if there is no pre-loaded data.
DistanceFormattingStrategy
A way of formatting distances.
Properties
`default`
formatted
custom
DurationFormattingStrategy
A way to format the time interval.
Properties
`default`
formatted
custom
DurationValueFormattingStrategy
Method of formatting the time interval value.
Properties
`default`
formatted
custom
DynamicFilter
Dynamic search filters.
Properties
ExcludedAreaSeverity
Priority of the area exception.
Properties
soft
Low exception priority, area will be avoided if possible.
hard
High exception priority, area will be avoided necessarily.
ExcludedAreaType
Type of the excluded region.
Properties
point
The excluded region is a circle with the center at the first point of 'points' and a radius equal to 'extent'. The 'points' must contain exactly one point, otherwise the query fails.
polyline
The excluded area is a polyline with width equal to 'extent' (points - line nodes).
polygon
The excluded region is a polygon with vertices at 'points'. In this case, the sides of the polygon are additionally indented by 'extent'.
ExtraInstructionInfo
Properties
bicycleStart
bicycleFinish
bicycleCrossroad
carStart
carFinish
carCrossroad
carRoundabout
carUturn
pedestrianStart
pedestrianFinish
pedestrianCrossroad
pedestrianIndoorFloorChange
pedestrianIndoorEnter
pedestrianIndoorExit
scooterStart
scooterFinish
scooterCrossroad
FilterType
Properties
FollowBearing
Properties
FollowStyleZoom
Properties
FollowTilt
Properties
FollowValue
Properties
coordinates
satelliteBearing
magneticBearing
tilt
styleZoom
accuracy
FormattingType
Length requirement for string representation of address.
Properties
short
Short form of address. For multi-part addresses, some components may be omitted.
full
Full address form. All components will be represented.
GeometryKind
Properties
ImageFormat
Properties
InstructionManeuver
Maneuver to be performed to move along the route.
Properties
none
No maneuver.
start
Start of movement.
finish
End of movement.
crossroadStraight
Moving through the intersection straight ahead.
crossroadSlightlyLeft
Moving through the intersection slightly to the left.
crossroadLeft
Moving through the intersection to the left.
crossroadSharplyLeft
Moving through the intersection steeply to the left.
crossroadSlightlyRight
Moving through the intersection slightly to the right.
crossroadRight
Moving through the intersection to the right.
crossroadSharplyRight
Moving through the intersection steeply to the right.
crossroadKeepLeft
Going through the intersection - keep to the left.
crossroadKeepRight
Going through the intersection - keep to the right.
crossroadUTurn
Turning at the intersection.
roundaboutForward
Going through the roundabout straight ahead.
roundaboutLeft45
Going through the roundabout slightly to the left.
roundaboutLeft90
Going through the roundabout to the left.
roundaboutLeft135
Going through the roundabout steeply to the left.
roundaboutRight45
Going through the roundabout slightly to the right.
roundaboutRight90
Going through the roundabout to the right.
roundaboutRight135
Going through the roundabout steeply to the right.
roundaboutBackward
Going through an intersection with traffic circle traffic in the opposite direction.
roundaboutExit
Exiting a traffic circle intersection.
uTurn
U-turn.
roadCrossing
A compound maneuver at an intersection (e.g., crossing two roads at an intersection for a pedestrian route).
JSONValue
```swift
public init(nilLiteral: ())
```
Creates an instance initialized with .
```swift
public init(booleanLiteral value: Bool)
```
Creates an instance initialized to the given Boolean value.
Parameters
value
The value of the new instance.
```swift
public init(integerLiteral value: Int64)
```
Creates an instance initialized to the specified integer value.
Parameters
value
Int64
The value to create.
```swift
public init(floatLiteral value: Double)
```
Creates an instance initialized to the specified floating-point value.
Parameters
value
The value to create.
```swift
public init(stringLiteral value: String)
```
Creates an instance initialized to the given string value.
Parameters
value
The value of the new instance.
```swift
public init(arrayLiteral elements: JSONValue...)
```
Creates an instance initialized with the given elements.
Parameters
elements
```swift
public init(dictionaryLiteral elements: (String, JSONValue)...)
```
Creates an instance initialized with the given key-value pairs.
```swift
public init(from decoder: Decoder) throws
```
Creates a new instance by decoding from the given decoder.
Parameters
decoder
Decoder
The decoder to read data from.
Methods
public func encode(to encoder: Encoder) throws
Encodes this value into the given encoder.
Parameters
encoder
Encoder
The encoder to write data to.
Lane
The lane affected by the traffic event.
LanesControlImage
Representation of the maneuver icon in the navigator UI.
Properties
dotsLeft
Dots on left side.
dotsRight
Dots on the right side.
nonInformation
No appropriate icon to display the maneuver.
separator
Separator.
prohibited_0
Traffic prohibited, no highlight.
prohibited_1
Traffic prohibited, highlighted.
publicTransport_0
Public traffic lane, no highlight.
publicTransport_1
Public traffic lane, highlighted.
left_0
Left, no highlight.
left_1
Left, highlighted.
left_Right_0_0
Combined manoeuvre - left or right, no highlight.
left_Right_0_1
Combined maneuver - left or right, right highlighted.
left_Right_1_0
Combined maneuver - left or right, left highlighted.
left_Right_1_1
Combined maneuver - left or right, both are highlighted.
left_SlightlyLeft_0_0
Combined maneuver - left or slightly left, no highlight..
left_SlightlyLeft_0_1
Combined maneuver - left or slightly left, slightly left highlighted.
left_SlightlyLeft_1_0
Combined maneuver - left or slightly left, left is highlighted.
left_SlightlyLeft_1_1
Combined maneuver - left or slightly left, both are highlighted.
left_SlightlyRight_0_0
Combined maneuver - left or slightly right, no highlight.
left_SlightlyRight_0_1
Combined maneuver - left or slightly right, slightly right highlighted.
left_SlightlyRight_1_0
Combined maneuver - left or slightly right, right highlighted.
left_SlightlyRight_1_1
Combined maneuver - left or slightly right, both highlighted.
left_Forward_0_0
Combined maneuver - left or right, no highlight.
left_Forward_0_1
Combined maneuver - left or straight, straight highlighted.
left_Forward_1_0
Combined manoeuvre - left or straight, left highlighted.
left_Forward_1_1
Combined maneuver - left or straight, both highlighted.
left_Forward_Right_0_0_0
Combined maneuver - left, straight or right, no highlight.
left_Forward_Right_0_0_1
Combined maneuver - left, straight or right, right highlighted.
left_Forward_Right_0_1_0
Combined maneuver - left, straight or right, straight highlighted.
left_Forward_Right_1_0_0
Combined manoeuvre - left, straight or right, left highlighted.
left_Forward_Right_1_1_1
Combined maneuver - left, straight or right, all options highlighted.
rightWithLeftTurn_0
Right with left turn, no highlight.
rightWithLeftTurn_1
Right with left turn, highlighted.
right_0
Right, no highlight.
right_1
Right, highlighted.
right_SharplyRight_0_0
Combined manoeuvre - right or steep right, no highlight.
right_SharplyRight_0_1
Combined maneuver - right or steep right, steep right highlighted.
right_SharplyRight_1_0
Combined maneuver - right or steep right, right highlighted.
right_SharplyRight_1_1
Combined maneuver - right or steep right, both highlighted.
Steep left, no highlight.
Steep left, highlighted.
Combined maneuver - steep left or left, no highlight
Combined maneuver - steep left or left, left highlighted.
Combined maneuver - steep left or left, steep left highlighted.
Combined maneuver - steep left or left, both highlighted.
Combined maneuver - steep left or slightly left, no highlight.
Combined maneuver - steep left or slightly left, slightly left highlighted.
Combined maneuver - steep left or slightly left, steep left highlighted.
Combined maneuver - steep left or slightly left, both are highlighted.
Combined maneuver - steep left or slightly right, no highlight.
Combined maneuver - steeply to the left or slightly to the right, slightly to the right highlighted.
Combined maneuver - steep left or slightly right, steep left highlighted.
Combined maneuver - steep left or slightly right, both highlighted.
Combined maneuver - steep left or straight, no highlight.
Combined maneuver - steep left or straight, straight highlighted.
Combined maneuver - steep left or straight, steep left highlighted.
Combined maneuver - steep left or straight, both highlighted.
Steep right, no highlight.
Steep right, highlighted.
slightlyLeft_0
Slightly to the left, no highlight.
slightlyLeft_1
Slightly to the left, highlighted.
slightlyLeft_Right_0_0
Combined maneuver - slightly left or right, no highlight.
slightlyLeft_Right_0_1
Combined maneuver - slightly left or right, right highlighted.
slightlyLeft_Right_1_0
Combined maneuver - slightly left or right, slightly left highlighted.
slightlyLeft_Right_1_1
Combined maneuver - slightly left or right, both highlighted.
slightlyLeft_SharplyRight_0_0
Combined maneuver - slightly left or steeply right, no highlight.
slightlyLeft_SharplyRight_0_1
Combined maneuver - slightly to the left or steeply to the right, steeply to the right is highlighted.
slightlyLeft_SharplyRight_1_0
Combined manoeuvre - slightly to the left or steeply to the right, slightly to the left highlighted.
slightlyLeft_SharplyRight_1_1
Combined maneuver - slightly left or steeply right, both highlighted.
slightlyLeft_SlightlyRight_0_0
Combined maneuver - slightly left or slightly right, no highlight.
slightlyLeft_SlightlyRight_0_1
Combined maneuver - slightly left or slightly right, slightly right highlighted.
slightlyLeft_SlightlyRight_1_0
Combined maneuver - slightly left or slightly right, slightly left highlighted.
slightlyLeft_SlightlyRight_1_1
Combined maneuver - slightly left or slightly right, both highlighted.
slightlyLeft_Forward_0_0
Combined maneuver - slightly left or slightly right, no highlight.
slightlyLeft_Forward_0_1
Combined maneuver - slightly left or straight, straight highlighted.
slightlyLeft_Forward_1_0
Combined maneuver - slightly left or straight, slightly left highlighted.
slightlyLeft_Forward_1_1
Combined maneuver - slightly left or straight, both highlighted.
slightlyRight_0
Slightly right, no highlight.
slightlyRight_1
Slightly right, highlighted.
slightlyRight_Right_0_0
Combined manoeuvre - slightly to the right or right, no highlight.
slightlyRight_Right_0_1
Combined maneuver - slightly right or right, right highlighted.
slightlyRight_Right_1_0
Combined maneuver - slightly right or right, slightly right highlighted.
slightlyRight_Right_1_1
Combined maneuver - slightly right or right, both highlighted.
slightlyRight_SharplyRight_0_0
Combined maneuver - slightly to the right or steeply to the right, no highlight.
slightlyRight_SharplyRight_0_1
Combined maneuver - slightly to the right or steeply to the right, steeply to the right highlighted.
slightlyRight_SharplyRight_1_0
Combined maneuver - slightly right or steep right, slightly right highlighted.
slightlyRight_SharplyRight_1_1
Combined maneuver - slightly right or steep right, both highlighted.
forward_0
Straight, no highlight.
forward_1
Straight, highlighted.
forward_RightWithLeftTurn_0_0
Combined maneuver - straight or right with left turn, no highlight.
forward_RightWithLeftTurn_0_1
Combined maneuver - straight or right with left turn, right with left turn highlighted.
forward_RightWithLeftTurn_1_0
Combined maneuver - straight or right with left turn, straight highlighted.
forward_RightWithLeftTurn_1_1
Combined maneuver - straight or right with left turn, both highlighted.
forward_Right_0_0
Combined maneuver - straight or right, no highlight.
forward_Right_0_1
Combined maneuver - straight or right, right highlighted.
forward_Right_1_0
Combined manoeuvre - straight or right, straight highlighted.
forward_Right_1_1
Combined manoeuvre - straight or right, both highlighted.
forward_SharplyRight_0_0
Combined maneuver - straight or steep right, no highlight.
forward_SharplyRight_0_1
Combined maneuver - straight or steep right, steep right highlighted.
forward_SharplyRight_1_0
Combined maneuver - straight or steep right, straight highlighted.
forward_SharplyRight_1_1
Combined maneuver - straight or steep right, both highlighted.
forward_SlightlyRight_0_0
Combined maneuver - straight or slightly to the right, no highlight.
forward_SlightlyRight_0_1
Combined maneuver - straight or slightly to the right, slightly to the right highlighted.
forward_SlightlyRight_1_0
Combined maneuver - straight or slightly to the right, slightly to the right highlighted.
forward_SlightlyRight_1_1
Combined maneuver - straight or slightly to the right, both highlighted.
turnover_0
U-turn, no highlight.
turnover_1
U-turn, highlighted.
LogLevel
Permitted level of SDK logging.
MapAppearance
Appearance of the map depending on the environment.
Properties
`default`
Use default theme.
universal
Use a single current style theme in any environment.
automatic
Use an automatically switching light and dark theme. The automatic switching is done according to the change of the environment: see `UITraitEnvironment`. `UITraitEnvironment` and `UIView.traitCollection`. Available starting iOS 13. For iOS 12, the default theme is used.
var description
A textual representation of this instance.
var defaultBackgroundColor
Default backgroud color depending of the system theme.
MapDataLoadingState
Properties
loading
Data is being loaded and will probably be added later.
loaded
The data is loaded.
MapRendererType
Map renderer type.
Properties
openGL
OpenGL is used to render the map.
metal
Metal is used to render the map.
MapRotationDirection
Map rotation direction
Properties
clockwise
Map rotation clockwise.
counterclockwise
Map rotation counterclockwise.
MapScalingDirection
Direction of map zoom.
Properties
zoomIn
Increasing zoom, i.e. magnifying objects.
zoomOut
Decreasing zoom, i.e. decreasing objects.
MapShiftDirection
Map shift direction.
Properties
left
right
up
down
leftUp
leftDown
rightUp
rightDown
MapVisibilityState
Visibility status of the map.
Properties
visible
The map is fully visible.
The map is completely hidden from the user
MyLocationDirectionBehaviour
Properties
none
followSatelliteHeading
followMagneticHeading
NavigationViewMapControlsBehaviour
Behavior of the camera controllers in navigation mode.
Properties
alwaysVisible
Always visible.
Visible during active navigation, see `Model.navigationActive`.
invisible
NavigatorFollowDriverType
Navigation type.
Properties
NavigatorFollowMode
Location tracking mode type.
Properties
none
Tracking disabled.
position
Position control.
positionAndDirection
Position and rotation control.
positionDirectionAndScale
Position, rotation, and zoom control.
ObjectType
Reference object type.
Properties
admDiv
Administrative unit.
attraction
Sightseeing attraction.
branch
Branch of an organization.
building
Building.
coordinates
Global coordinates.
crossroad
Intersection.
parking
Parking.
road
Road.
route
Public transportation route.
station
Stop.
stationEntrance
Station entrance.
street
Street.
unknown
In case of an unexpected type.
Obstacle
Obstacle type.
ObstaclePassLimitation
Limitations on passing the obstacle.
Properties
unlimited
Unrestricted obstacle.
paid
Passing an obstacle requires payment.
passRequired
Passing an obstacle requires a pass.
PackageUpdateStatus
Package upgrade status.
Properties
notAvailable
There is no newer version available for the package.
inProgress
The package is in the process of installing or upgrading to a newer version available.
paused
The process of upgrading the package to a newer version available is not running or has been suspended.
ParkingAccess
Parking access type.
Properties
`public`
Public.
handicappedOnly
For people with disabilities only.
customersOnly
For customers only.
residentsOnly
For residents only.
taxiOnly
Parking space for taxi.
ParkingPavingType
Parking lot surface type.
Properties
asphalt
Asphalt surface.
concrete
Concrete surface.
gravel
Gravel surface
unpaved
No surface.
ParkingPurpose
Parking assignment.
Properties
car
For cars.
bike
For bicycles.
motorbike
For motorcycles/mopeds.
babyCarriage
For strollers.
scooter
For scooters.
ParkingType
Parking type.
Properties
ground
On-ground parking.
underground
Underground parking.
multilevel
Multi-level parking.
PedestrianInstructionCrossroadLandmark
Landmark.
Properties
none
No landmark.
crosswalk
Pedestrian crossing.
trafficLight
Traffic light.
PedestrianInstructionCrossroadManeuverDirection
Direction of travel.
Properties
straight
left
right
Steep left turn.
Steep turn to the right.
keepLeft
Keep to the left.
keepRight
Keep to the right.
PedestrianInstructionIndoorFloorChangeType
Floor change type.
Properties
undefined
Path without steps or unknown.
stairway
elevator
escalator
PersonalDataCollectionConsent
Status of the user's consent to collect and send personal data.
Properties
granted
User agrees.
denied
User does not agree.
PointGeometryData
Point object geometry data.
Properties
PublicTransportType
Type of public transport.
Properties
bus
trolleybus
Trolleybus.
tram
Tram.
shuttleBus
Shuttle bus.
metro
Subway.
suburbanTrain
Suburban train.
funicularRailway
Funicular.
monorail
Monorail.
waterwayTransport
Water transport.
cableCar
Cable car.
speedTram
High-speed tram.
premetro
Underground tram.
lightMetro
Light metro.
aeroexpress
Aeroexpress.
moscowCentralRing
Moscow Central Ring.
moscowCentralDiameters
Moscow Central Diameters.
RoadEventActionState
Action state.
Properties
RoadEventActionType
Road event action type.
Properties
like
Adding the 'like' mark.
dislike
Adding the "dislike" mark.
confirmation
Event confirmation.
disproof
Refutation of event.
RoadEventDisplayCategory
Traffic event category to display on the map.
Properties
camera
Cameras of all types, including those added by the user.
comment
Comments on the roads.
accident
Ttaffic accident.
roadRestriction
Road closures.
roadWorks
Roadworks.
other
Events in the Other category.
user
Always displays events created by the current user, regardless of their category.
RoadEventType
Event type.
Properties
accident
Ttaffic accident.
roadWorks
Roadworks.
camera
Camera.
comment
Comment.
roadRestriction
Traffic closure.
other
Other event.
RoadRule
Driving side.
RoadSubtype
Additional description to the type of road on which the route runs.
Properties
none
No additional description to the road type.
archway
Arch.
bridge
Bridge.
crosswalk
Pedestrian crossing.
footbridge
Pedestrian bridge.
ford
Ford.
indoor
Room.
overgroundCrossing
Overpass.
parkFootpath
Park path.
parkPath
Parkway.
residentialArea
Residential area.
stairway
Stairs.
subwayCrossing
Subway crossing.
tunnel
Tunnel.
underpass
Underpass.
RoadSurface
Road surface.
Properties
unknown
Unknown.
asphalt
Asphalt.
gravel
Gravel.
ground
Soil.
concrete
Concrete.
RoadType
Describes the type of road the route takes.
Properties
unknown
Unknown.
walkway
A pedestrian path, or a section of road where pedestrian traffic is allowed.
bikeway
Bicycle lane, or section of road where bicycles are permitted.
pathway
A roadway of minimal importance.
fieldForestRoad
A field or forest road.
serviceRoad
Access road/intra-block driveway.
otherStreetRoad
A road that passes through other streets of a settlement.
mainStreetRoad
A roadway running through the main streets of a settlement.
highway
Highway.
intercityRoad
'Intercity highway'.
federalRoad
A road of federal importance.
RouteCameraDirection
Direction of camera action.
Properties
along
Along the traffic direction (to the back).
against
Against the traffic direction.
both
Bi-directional camera.
RouteCameraPurpose
Camera assignment.
Properties
speedControl
Recording of exceeding the speed limit.
trafficLightsControl
Recording of passing at the forbidden signal of traffic lights.
stopLineControl
Recording of driving over the stop line, driving without stopping the stop sign, driving to the intersection during a jam.
publicTransportLaneControl
Recording of movement on the dedicated lane for public transport.
oncomingTrafficLaneControl
Recording driving in the oncoming lane.
pedestrianAdvantageControl
Recording of failure to give preference to pedestrians.
laneDisciplineControl
Recording of violation of lane rotation at the intersection.
roadMarkingsCrossingControl
Recording of crossing the solid line of road markings, driving on the side of the road.
averageSpeedControl
Recording of exceeding the average speed on the section.
noStoppingControl
Recording of violation of prohibition of stopping.
dummy
Fake item
platon
Camera of the “Platon” system: https://platon.ru/ru/about/
RouteExitSignTableColor
Color of the exit sign table. Corresponds to the background color of the sign set in the appropriate place on the route.
Properties
undefined
Color of the exit sign table is undefined.
white
White.
red
green
Green.
blue
brown
Brown.
RouteExitSignType
Exit type.
Properties
RouteLaneManeuver
Manoeuvre in the lane.
Properties
undefined
Not set.
forward
Straight ahead.
right
To the right.
left
To the left.
slightlyRight
Slightly to the right.
slightlyLeft
Slightly to the left.
Steeply to the right.
Steeply to the left.
rightWithLeftTurns
To the right, then to the left.
turnover
U-turn.
RouteMapObjectCalloutLabelDisplayMode
Mode for displaying values in route callouts.
Properties
absoluteValues
Travel time and/or route length are displayed in absolute values (for example: N km, M min).
relativeToActiveRouteValues
Travel time and/or route length are displayed in absolute values only for the active route, and for inactive routes the difference with the corresponding value of the active route is displayed (for example: +/-N km, +/-M min). If there is no active route or if there is more than one active route on the map, travel time and/or length are displayed in absolute values for all routes.
RouteMapObjectCalloutLabelFlag
Flags to enable the display of content in the route's callouts.
Properties
duration
Time of travel along the route.
length
Route length.
RouteMapObjectDisplayFlag
Flags to include displaying different parts of the route.
Properties
routeParts
Route segments.
startPoint
The start point of the route.
finishPoint
The end point of the route.
intermediatePoints
Intermediate Waypoints.
transportConnectionPoints
Connection points of route segments (except for routes on public transport). For example, a point at the junction point of a pedestrian and automobile segment.
maneuvers
Maneuvers.
cameras
Cameras.
humps
Artificial bumps.
barriers
Road closures.
gates
Gates, barriers.
stairways
Stairs.
publicTransportPlatforms
Public transport stops.
accidents
Ttaffic accident.
roadWorks
Roadworks.
comments
Comments.
roadRestrictions
Traffic closures.
otherEvents
Other" events.
tollRoads
Start and end of toll road.
lanesBubbles
Lane callouts (displayed only in source with navigation mode).
bubbles
Lane callouts with travel time and route length.
indoorInstructions
Instructions in buildings. Move by elevator, escalator, etc.
inactiveFloors
Show parts of the route inside buildings not just for the active floor.
RouteMapObjectPassedDistanceVisualization
A way to visualize the route taking into account the distance traveled along the route.
Properties
showRemainingRoutePart
Show only the rest of the route - from the passed distance to the finish.
showPassedRoutePart
Show only the passed part of the route - from the start to the passed distance.
showWholeRoute
Show the entire route regardless of the distance traveled along it.
RouteMapObjectPermanentDisplayFlag
Flags to prevent the different parts of the route from being hidden from the map when updating the distance traveled along the route, if passed_distance_visualization() has a value other than ShowWholeRoute.
Properties
startPoint
The start point of the route.
finishPoint
The end point of the route.
intermediatePoints
Intermediate Waypoints.
cameras
accidents
Ttaffic accident.
roadWorks
Roadworks.
comments
Comments.
roadRestrictions
Traffic closures.
otherEvents
Other" events.
tollRoads
Start and end of toll road.
RoutePointKind
Route point object type on the map.
Properties
start
The start point of the route.
finish
The end point of the route.
intermediate
Intermediate point of the route.
camera
Camera.
accident
Ttaffic accident.
roadWork
Roadworks.
comment
Comment.
roadRestriction
Traffic closure.
otherEvent
Other event.
tollRoad
Start and end of toll road.
transportConnectionPoint
Point of connection of route segments (except public transport routes). For example, the point at the connection of a pedestrian and car segment.
hump
Speed bump.
gate
Gate or barrier.
barrier
Road closure.
stairway
Stairs.
indoorInstruction
Instructions in a building. Moving by elevator, escalator, etc.
badRoad
Bad road.
publicTransportPlatform
Public transport platform.
ground
Beginning and end of a dirt road.
gravel
Beginning and end of gravel coverage.
carRoad
Start and end of a car section of the road (for bicycle/scooter routes).
bicycleRoad
Beginning and end of a bicycle track.
RouteSearchOptions
Route search parameters.
Properties
bicycle
car
pedestrian
publicTransport
scooter
taxi
truck
RouteSearchType
Route search type.
Properties
jam
Route search with current traffic data.
statistic
Route search with statistical traffic data.
shortest
Search for the shortest route.
RouteVisualizationType
Type of route visualization.
Properties
normal
Standard visualization - used in the route editor.
Visualization for navigation mode - used in the navigator.
ScooterInstructionCrossroadLandmark
Landmark.
Properties
none
No landmark.
crosswalk
Pedestrian crossing.
trafficLight
Traffic light.
ScooterInstructionCrossroadManeuverDirection
Direction of travel.
Properties
straight
left
right
Steep left turn.
Steep turn to the right.
keepLeft
Keep to the left.
keepRight
Keep to the right.
SearchResultType
Type of result (not search query).
Properties
recovery
A specific object was found by the query.
discovery
A heading was found by the query, and the results contain a list of objects from that heading.
Settlement
Sign of the road section passing through the settlement.
Properties
unknown
Information about the settlement is unknown.
inside
Inside the settlement.
outside
Outside the settlement.
SimulationSpeedMode
Properties
SortingType
Sort type.
Properties
byRelevance
By relevance. Used by default.
byDistance
By distance from the user's current position.
byRating
By rating.
SoundCategory
Sound alert categories.
Properties
crossroadCameras
Intersection control cameras.
laneCameras
Cameras recording traffic in the dedicated lane for public transport.
noStoppingControlCameras
Stop control cameras.
roadMarkingCameras
Traffic lane cameras.
averageSpeedCameras
Average speed cameras.
maxSpeedCameras
Instant speed cameras.
accidents
Accidents.
roadWorks
Roadworks.
tolls
Toll roads.
exceedSpeedLimits
Violations of maximum permitted speed.
intermediatePoints
Intermediate points on the route.
routeRebuild
Route is rebuilt.
instructions
Instructions (maneuvers) on route.
obstacles
Obstacles.
roadSubtypes
Road subtypes.
lostLocation
Lost GPS signal.
routeEnd
Route completion.
SpecialSpaceType
Special place type.
Properties
bicycle
For bicycles.
motorbike
For motorcycles.
family
For families.
handicapped
For handicapped people.
babyCarriage
For strollers.
truck
For trucks.
scooter
For scooters.
SpeedFormattingStrategy
Method of formatting speed.
Properties
State
Navigator state.
SuggestedType
Type of search hint.
Properties
admDiv
Administrative unit.
attraction
Sightseeing attraction.
attribute
Additional attribute.
branch
Branch of an organization.
building
Building.
coordinates
Global coordinates.
crossroad
Intersection.
districtArea
Region.
org
Organization.
orgCategory
Rubric.
parking
Parking.
region
Регион.
road
Road.
route
Public transportation route.
station
Stop.
stationEntrance
Station entrance.
street
Street.
text
Text hint.
unknown
In case of an unexpected type.
SuggestHandler
The hint selection handler.
Properties
SuggestorType
Type of tooltip.
Properties
general
Tooltip for the main search line.
routeEndpoint
A tooltip for selecting waypoints. Optimized for searching for point objects in a single action. Rejects objects without points.
TextPlacement
Options for the position of the caption relative to the icon. The position is defined as follows:
Properties
noLabel
No caption.
bottomCenter
At the center of the area below the square around the marker.
bottomRight
On the right side of the area below the square around the marker.
bottomLeft
On the left side of the area below the square around the marker.
circleBottomRight
At the bottom right of the area relative to the circle around the marker.
rightBottom
Bottom of the area to the right of the square around the marker.
rightCenter
At the center of the area to the right of the square around the marker.
rightTop
Above the area to the right of the square around the marker.
circleTopRight
Top right area relative to the circle around the marker.
topCenter
At the center of the area above the square around the marker.
topRight
Right side of the area above the square around the marker.
topLeft
Left side of the area above the square around the marker.
circleTopLeft
Top left of area relative to the circle around the marker.
leftTop
Above the area to the left of the square around the marker.
leftCenter
At the center of the area to the left of the square around the marker.
leftBottom
Bottom of area to the left of the square around the marker.
circleBottomLeft
Bottom left area relative to the circle around the marker.
centerCenter
Center of the square around the marker.
ThermometerEventsPosition
Position of traffic events and intermediate points on the thermometer.
Properties
left
Events are displayed on the left.
right
Events are displayed on the right.
TimeFormattingStrategy
Way of formatting date/time.
Properties
TrafficControlStatus
Status of the traffic congestion control.
Properties
Control is hidden. Appears when there is no traffic information in the region.
enabled
Control is active. Appears when the data on traffic jams is up to date, and there is a layer of traffic jams on the map.
disabled
Control in inactive state. Appears when there is no traffic jams layer on the map.
loading
Load indicator. Appears when the data on traffic jams in the inactive state, and there is a layer of traffic jams on the map.
TrafficScoreState
Relevance of the traffic rate value.
Properties
pending
Value unknown, will be requested later. Initial state.
valid
The value is current.
expired
The value is obsolete. The state is reached if the data could not be updated within a certain time.
TrafficSpeedColor
Properties
undefined
green
yellow
red
deepRed
TransitionType
Moving mode while tracking a position.
Properties
smooth
Smooth flight to a new position.
instant
Instant movement, teleport.
TransportType
Describes the type of transport for which a section of the route is built.
Properties
unknown
Unknown how to traverse this section of the route and it may not be passable.
bicycle
Bicycle.
car
Car.
pedestrian
Pedestrian.
`public`
Public transport.
scooter
Scooter.
WeekDay
Day of the week.
```swift
public static func < (lhs: WeekDay, rhs: WeekDay) -> Bool
```
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
WorkTimeFilter
Filter by object operating time. Either open now, or open for a specific date and time.
Properties
ZoomControlButton
Properties