Skip to main content

enumeration

ActionResult​

Properties

ok​

Action successfully completed.

networkError​

Network error.

AddEventError​

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.

User has refused to collect and submit personal data.

userBlocked​

User is blocked.

tooManyRequests​

User creates events too often.

AddEventResult​

Properties

event​

error​

AddressComponent​

Properties

streetAddress​

number​

location​

Alignment​

Properties

topLeft​

topRight​

bottomLeft​

bottomRight​

AnimationMode​

Properties

normal​

Normal. Object animation is displayed once.

loop​

Looped. Object animation is displayed in a loop.

AttributeValue​

Properties

empty​

boolean​

number​

integer​

string​

data​

array​

object​

AudioFocusPolicy​

Properties

ignore​

Ignore other applications.

mute​

Disable sounds of other applications while playing.

duck​

Muffle up sounds of other applications.

AuthorType​

Properties

anonymous​

Anonymous user.

doubleGis​

2GIS company.

user​

Authorized user.

me​

Current user of the application.

BearingSource​

Properties

auto​

Automatic selection of the direction source depending on the geolocation parameters.

satellite​

Orient the map by the direction obtained from GNSS.

magnetic​

Orient the map by compass.

BetterRouteResponse​

Properties

accept​

User accepted the offer to switch to an alternative route.

reject​

User explicitly declined the offer to switch to an alternative route.

timeout​

BicycleInstructionCrossroadLandmark​

Properties

none​

No landmark.

crosswalk​

Pedestrian crossing.

trafficLight​

Traffic light.

BicycleInstructionCrossroadManeuverDirection​

Properties

straight​

Straight ahead.

left​

Left.

right​

Right.

sharplyLeft​

Sharp turn to the left.

sharplyRight​

Sharp turn to the right.

keepLeft​

Keep to the left.

keepRight​

Keep to the right.

BriefExtraRouteInfo​

Properties

bicycle​

car​

pedestrian​

publicTransport​

scooter​

CalloutVisualizationMode​

Properties

always​

Shows callouts (including DisplayFlag) and calculates positions for them if at least one route is added to the source.

multipleRoutes​

Show bubbles (considering DisplayFlag) and calculate positions for them only if more than one route object is added to the source.

none​

Do not show bubbles and do not calculate positions for them.

CameraAnimatedMoveReason​

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​

Properties

finished​

Moving the camera position is complete when the finish 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​

Properties

`default`​

Type of flyover is selected depending on the distance between the starting and the finish 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 restrictions (see ICamera::zoom_restrictions()) do not allow setting such a small zoom level.

CameraBehaviourChangeReason​

Properties

application​

Changes the mode by the application, setting the position (explicitly or indirectly via ICamera::set_position_point()), launching 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​

Properties

off​

Camera is not in tracking mode.

followPosition​

Camera is in position tracking mode.

followDirection​

Camera is in position and direction tracking mode.

CameraPurpose​

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​

Properties

busy​

Camera is user-controlled.

fly​

There is an active flyover.

free​

Camera is not user controlled and there are no active flyovers.

CarBriefRouteInfoTrafficSpeed​

Properties

unknown​

Speed unknown.

slow​

Low travel speed.

normal​

Normal speed.

fast​

High travel speed.

CarInstructionCrossroadDirection​

Properties

straight​

Straight.

slightlyLeft​

Smooth turn left.

left​

Left.

sharplyLeft​

Sharp left turn.

uTurn​

U-turn.

sharplyRight​

Sharp turn to the right.

right​

Right.

slightlyRight​

Make a slight turn to the right.

keepLeft​

Keep to the left.

keepRight​

Keep to the right.

CarInstructionCrossroadLandmark​

Properties

none​

No landmark.

tunnelBefore​

In front of the tunnel.

tunnelEntry​

Tunnel entrance.

bridgeBefore​

Before the bridge.

bridgeEntry​

Bridge entrance.

archwayEntry​

Arch entrace.

onTrafficLight​

At the traffic lights.

courtyardEntry​

Yard entrance.

CarInstructionRoundaboutType​

Properties

entry​

Roundabout entry.

intermediate​

Intermediate instruction on the roundabout.

exit​

Exiting the roundabout.

CheckableItemType​

Properties

simple​

Simple element.

group​

Set of elements that works as a radio group.

Properties

DesiredAccuracy​

Properties

low​

Low geopositioning accuracy. The most suitable mode for determining the current city/district. This mode is notable for its low power consumption. In this mode, the device can either rely solely on networks (Wi-Fi, 3GPP, IP) or use the GNSS receiver in the low-power mode (caching the geoposition 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​

Properties

online​

Gets data from 2GIS servers.

offline​

Works with pre-loaded data.

hybridOnlineFirst​

Hybrid mode, which gives priority to obtaining 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​

Properties

`default`​

formatted​

custom​

DurationFormattingStrategy​

Properties

`default`​

formatted​

custom​

DurationValueFormattingStrategy​

Properties

`default`​

formatted​

custom​

DynamicFilter​

Properties

flagFilter​

rangeFilter​

sortingFilter​

ExcludedAreaSeverity​

Properties

soft​

Low exception priority, area will be avoided if possible.

hard​

High exception priority, area will be avoided necessarily.

ExcludedAreaType​

Properties

point​

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​

Excluded area is a polyline with width equal to 'extent' (points - line nodes).

polygon​

Excluded region is a polygon with vertices at 'points'. In this case, the sides of the polygon are additionally padded by 'extent'.

ExtraInstructionInfo​

Properties

bicycleStart​

bicycleFinish​

bicycleCrossroad​

carStart​

carFinish​

carCrossroad​

carRoundabout​

carUturn​

pedestrianStart​

pedestrianFinish​

pedestrianCrossroad​

pedestrianIndoorFloorChange​

pedestrianIndoorEnter​

pedestrianIndoorExit​

scooterStart​

scooterFinish​

scooterCrossroad​

FilterType​

Properties

sort​

Filter defines the order of sorting search results.

filter​

Filter indicates that an object in the search results has a certain feature.

FollowBearing​

Properties

off​

on​

FollowStyleZoom​

Properties

off​

on​

FollowTilt​

Properties

off​

on​

FollowValue​

Properties

coordinates​

bearing​

tilt​

styleZoom​

FormattingType​

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

point​

polyline​

polygon​

complex​

GraphicsPreset​

Properties

lite​

Simplified rendering mode: "heavy" graphic effects are disabled whenever possible.

normal​

Standard rendering mode: visual quality of the image and resource consumption are balanced.

immersive​

Immersive mode: all "heavy" graphic effects are enabled.
This can lead to significant performance degradation on weak devices.

ImageFormat​

Properties

png​

svg​

rgba8888​

lottieJson​

IndoorManagerState​

Properties

disabled​

Floors are not displayed.

enabled​

Floors are displayed.

InstructionManeuver​

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 sharply 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 sharply 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 sharply 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 sharply 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​

Compound maneuver at an intersection (e.g., crossing two roads at an intersection for a pedestrian route).

JSONValue​

public init(nilLiteral: ())

Creates an instance initialized with .
This documentation comment was inherited from .

public init(booleanLiteral value: Bool)

Creates an instance initialized to the given Boolean value.
This documentation comment was inherited from .

Parameters

value

Value of the new instance.

public init(integerLiteral value: Int64)

Creates an instance initialized to the specified integer value.
This documentation comment was inherited from .

Parameters

value

Int64

The value to create.

public init(floatLiteral value: Double)

Creates an instance initialized to the specified floating-point value.
This documentation comment was inherited from .

Parameters

value

The value to create.

public init(stringLiteral value: String)

Creates an instance initialized to the given string value.
This documentation comment was inherited from .

Parameters

value

Value of the new instance.

public init(arrayLiteral elements: JSONValue...)

Creates an instance initialized with the given elements.
This documentation comment was inherited from .

Parameters

elements

JSONValue...
public init(dictionaryLiteral elements: (String, JSONValue)...)

Creates an instance initialized with the given key-value pairs.
This documentation comment was inherited from .

public init(from decoder: Decoder) throws

Creates a new instance by decoding from the given decoder.

Parameters

decoder

Decoder

Decoder to read data from.

Methods
public func encode(to encoder: Encoder) throws

Encodes this value into the given encoder.

Parameters

encoder

Encoder

Encoder to write data to.

Properties

null​

bool​

number​

string​

array​

object​

KeySource​

Properties

fromAsset​

fromFile​

fromString​

static let `default`​

Default settings.

Lane​

Properties

left​

Left lane.

center​

Middle lane.

right​

Right lane.

LanesControlImage​

Properties

dotsLeft​

Dots on the 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 maneuver - left or right, no highlight.

left_Right_0_1​

Combined maneuver - left or right, right is highlighted.

left_Right_1_0​

Combined maneuver - left or right, left is 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 is 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 is highlighted.

left_SlightlyRight_1_0​

Combined maneuver - left or slightly right, right is highlighted.

left_SlightlyRight_1_1​

Combined maneuver - left or slightly right, both are highlighted.

left_Forward_0_0​

Combined maneuver - left or right, no highlight.

left_Forward_0_1​

Combined maneuver - left or straight ahead, straight ahead is highlighted.

left_Forward_1_0​

Combined maneuver - left or straight, left is highlighted.

left_Forward_1_1​

Combined maneuver - left or straight, both are highlighted.

left_Forward_Right_0_0_0​

Combined maneuver - left, straight ahead or right, no highlight.

left_Forward_Right_0_0_1​

Combined maneuver - left, straight ahead or right, right is highlighted.

left_Forward_Right_0_1_0​

Combined maneuver - left, straight ahead or right, straight ahead is highlighted.

left_Forward_Right_1_0_0​

Combined maneuver - left, straight ahead or right, left is highlighted.

left_Forward_Right_1_1_1​

Combined maneuver - left, straight ahead or right, all options are 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 maneuver - right or sharply right, no highlight.

right_SharplyRight_0_1​

Combined maneuver - right or sharply right, sharply right is highlighted.

right_SharplyRight_1_0​

Combined maneuver - right or sharply right, right is highlighted.

right_SharplyRight_1_1​

Combined maneuver - right or shaply right, both are highlighted.

sharplyLeft_0​

Shaply left, no highlight.

sharplyLeft_1​

Sharply left, highlighted.

sharplyLeft_Left_0_0​

Combined maneuver - sharply left or left, no highlight

sharplyLeft_Left_0_1​

Combined maneuver - sharply left or left, left is highlighted.

sharplyLeft_Left_1_0​

Combined maneuver - sharply left or left, sharply left is highlighted.

sharplyLeft_Left_1_1​

Combined maneuver - sharply left or left, both are highlighted.

sharplyLeft_SlightlyLeft_0_0​

Combined maneuver - sharply left or slightly left, no highlight.

sharplyLeft_SlightlyLeft_0_1​

Combined maneuver - sharply left or slightly left, slightly left is highlighted.

sharplyLeft_SlightlyLeft_1_0​

Combined maneuver - sharply left or slightly left, sharply left is highlighted.

sharplyLeft_SlightlyLeft_1_1​

Combined maneuver - sharply left or slightly left, both are highlighted.

sharplyLeft_SlightlyRight_0_0​

Combined maneuver - sharply left or slightly right, no highlight.

sharplyLeft_SlightlyRight_0_1​

Combined maneuver - sharply left or slightly right, slightly right is highlighted.

sharplyLeft_SlightlyRight_1_0​

Combined maneuver - sharply left or slightly right, sharply left are highlighted.

sharplyLeft_SlightlyRight_1_1​

Combined maneuver - sharply left or slightly right, both are highlighted.

sharplyLeft_Forward_0_0​

Combined maneuver - sharply left or straight ahead, no highlight.

sharplyLeft_Forward_0_1​

Combined maneuver - sharply left or straight ahead, straight ahead is highlighted.

sharplyLeft_Forward_1_0​

Combined maneuver - sharply left or straight ahead, sharply left is highlighted.

sharplyLeft_Forward_1_1​

Combined maneuver - sharply left or straight ahead, both are highlighted.

sharplyRight_0​

Sharply right, no highlight.

sharplyRight_1​

Sharply to the right, highlighted.

slightlyLeft_0​

Slightly left, no highlight.

slightlyLeft_1​

Slightly 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 is highlighted.

slightlyLeft_Right_1_0​

Combined maneuver - slightly left or right, slightly left is highlighted.

slightlyLeft_Right_1_1​

Combined maneuver - slightly left or right, both highlighted.

slightlyLeft_SharplyRight_0_0​

Combined maneuver - slightly left or sharply right, no highlight.

slightlyLeft_SharplyRight_0_1​

Combined maneuver - slightly left or sharply right, sharply right is highlighted.

slightlyLeft_SharplyRight_1_0​

Combined maneuver - slightly left or sharply right, slightly left is highlighted.

slightlyLeft_SharplyRight_1_1​

Combined maneuver - slightly left or sharply to right, both are 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 is highlighted.

slightlyLeft_SlightlyRight_1_0​

Combined maneuver - slightly left or slightly right, slightly left is highlighted.

slightlyLeft_SlightlyRight_1_1​

Combined maneuver - slightly left or slightly right, both are highlighted.

slightlyLeft_Forward_0_0​

Combined maneuver - slightly left or slightly right, no highlight.

slightlyLeft_Forward_0_1​

Combined maneuver - slightly left or straight ahead, straight ahead is highlighted.

slightlyLeft_Forward_1_0​

Combined maneuver - slightly left or straight ahead, slightly left is highlighted.

slightlyLeft_Forward_1_1​

Combined maneuver - slightly left or straight ahead, both are highlighted.

slightlyRight_0​

Slightly right, no highlight.

slightlyRight_1​

Slightly right, highlighted.

slightlyRight_Right_0_0​

Combined maneuver - slightly right or right, no highlight.

slightlyRight_Right_0_1​

Combined maneuver - slightly right or right, right is highlighted.

slightlyRight_Right_1_0​

Combined maneuver - slightly right or right, slightly right is highlighted.

slightlyRight_Right_1_1​

Combined maneuver - slightly right or right, both are highlighted.

slightlyRight_SharplyRight_0_0​

Combined maneuver - slightly right or sharply right, no highlight.

slightlyRight_SharplyRight_0_1​

Combined maneuver - slightly right or sharply right, sharply right is highlighted.

slightlyRight_SharplyRight_1_0​

Combined maneuver - slightly right or sharply right, slightly right is highlighted.

slightlyRight_SharplyRight_1_1​

Combined maneuver - slightly right or sharply right, both are highlighted.

forward_0​

Straight ahead, no highlight.

forward_1​

Straight ahead, highlighted.

forward_RightWithLeftTurn_0_0​

Combined maneuver - straight ahead or right with left turn, no highlight.

forward_RightWithLeftTurn_0_1​

Combined maneuver - straight ahead or right with left turn, right with left turn is highlighted.

forward_RightWithLeftTurn_1_0​

Combined maneuver - straight ahead or right with left turn, straight ahead is highlighted.

forward_RightWithLeftTurn_1_1​

Combined maneuver - straight ahead or right with left turn, both are highlighted.

forward_Right_0_0​

Combined maneuver - straight ahead or right, no highlight.

forward_Right_0_1​

Combined maneuver - straight ahead or right, right is highlighted.

forward_Right_1_0​

Combined maneuver - straight ahead or right, straight ahead is highlighted.

forward_Right_1_1​

Combined maneuver - straight ahead or right, both are highlighted.

forward_SharplyRight_0_0​

Combined maneuver - straight ahead or sharply right, no highlight.

forward_SharplyRight_0_1​

Combined maneuver - straight ahead or sharply right, sharply right is highlighted.

forward_SharplyRight_1_0​

Combined maneuver - straight ahead or sharply right, straight ahead is highlighted.

forward_SharplyRight_1_1​

Combined maneuver - straight ahead or sharply right, both are highlighted.

forward_SlightlyRight_0_0​

Combined maneuver - straight ahead or slightly right, no highlight.

forward_SlightlyRight_0_1​

Combined maneuver - straight ahead or slightly right, slightly right is highlighted.

forward_SlightlyRight_1_0​

Combined maneuver - straight ahead or slightly right, slightly right is highlighted.

forward_SlightlyRight_1_1​

Combined maneuver - straight ahead or slightly right, both are highlighted.

turnover_0​

U-turn, no highlight.

turnover_1​

U-turn, highlighted.

LogLevel​

Properties

verbose​

info​

warning​

error​

fatal​

off​

MapAppearance​

Properties

`default`​

Uses default theme.

universal​

Uses a single current style theme in any environment.

automatic​

Uses an automatically switched light and dark theme. The automatic switching is done according to the environment change: see UITraitEnvironment and UIView.traitCollection. Available for iOS versions 13 or higher. For iOS 12, the default theme is used.

var description​

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.

MapRotationDirection​

Properties

clockwise​

Map rotation clockwise.

counterclockwise​

Map rotation counterclockwise.

MapScalingDirection​

Properties

zoomIn​

Increases zoom, i.e. magnifying objects.

zoomOut​

Decreases zoom, i.e. decreasing objects.

MapShiftDirection​

Properties

left​

right​

up​

down​

leftUp​

leftDown​

rightUp​

rightDown​

MapVisibilityState​

Properties

visible​

Map is fully visible.

hidden​

Map is completely hidden from the user.

MyLocationMapObjectMarkerType​

Properties

model​

Use standard models from styles. No customization available.

svgIcon​

Use SVG icons. You can change the icon in the styles editor in the following layers: s_dvg_foot_gps_marker_with_direction, s_dvg_foot_gps_marker2, s_dvg_foot_gps_marker_degraded2

Properties

Always visible.

Visible during active navigation, see Model.navigationActive.

Hidden.

Properties

Automobile.

Pedestrian.

Properties

Tracking disabled.

Position control.

Position and rotation control.

Position, rotation, and zoom control.

ObjectType​

Properties

admDiv​

Administrative unit.

admDivCity​

City.

admDivCountry​

Country/state.

admDivDistrict​

District (of a city).

admDivDistrictArea​

Region or province district.

admDivDivision​

Division.

admDivLivingArea​

Living area.

admDivPlace​

Miscellaneous polygon objects: parks, beaches, recreation facilities, lakes, and other places.

admDivRegion​

Region/province.

admDivSettlement​

Settlement (village).

attraction​

Sightseeing attraction.

branch​

Branch of an organization.

building​

Building.

coordinates​

Global coordinates.

crossroad​

Intersection.

gate​

Gate/passage.

kilometerRoadSign​

Kilometer marker.

parking​

Parking.

road​

Road.

route​

Public transportation route.

station​

Stop.

stationEntrance​

Station entrance.

stationMetro​

Metro station.

stationPlatform​

Station platform.

street​

Street.

unknown​

In case of an unexpected type.

Obstacle​

Properties

other​

Other.

barrier​

Barrier.

gate​

Gate.

tourniquet​

Tourniquet.

wicket​

Wicket.

ObstaclePassLimitation​

Properties

unlimited​

Unrestricted obstacle.

paid​

Passing through the obstacle is tolled.

passRequired​

A pass is required to pass through the obstacle.

PackageInfoError​

Properties

noNetwork​

Network connection is missing.

noFreeSpace​

No storage space left on the device to download and/or install a package.

downloadError​

Loading error.

PackageUpdateStatus​

Properties

notAvailable​

There is no newer version available for the package.

inProgress​

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​

Properties

`public`​

Public.

handicappedOnly​

For handicapped only.

customersOnly​

For customers only.

residentsOnly​

For residents only.

taxiOnly​

Parking space for taxi.

ParkingPavingType​

Properties

asphalt​

Asphalt surface.

concrete​

Concrete surface.

gravel​

Gravel surface

unpaved​

No surface.

ParkingPurpose​

Properties

car​

For cars.

bike​

For bicycles.

motorbike​

For motorcycles/mopeds.

babyCarriage​

For strollers.

scooter​

For scooters.

ParkingType​

Properties

ground​

On-ground parking.

underground​

Underground parking.

multilevel​

Multi-level parking.

PedestrianInstructionCrossroadLandmark​

Properties

none​

No landmark.

crosswalk​

Pedestrian crossing.

trafficLight​

Traffic light.

PedestrianInstructionCrossroadManeuverDirection​

Properties

straight​

Straight.

left​

Left.

right​

Right.

sharplyLeft​

Sharp turn to the left.

sharplyRight​

Sharp turn to the right.

keepLeft​

Keep to the left.

keepRight​

Keep to the right.

PedestrianInstructionIndoorFloorChangeType​

Properties

undefined​

Path without steps or unknown.

stairway​

Stairs.

elevator​

Elevator.

escalator​

Escalator.

Properties

granted​

User agrees.

denied​

User does not agree.

PointGeometryData​

Properties

geoPoint​

geoPointWithElevation​

PublicTransportType​

Properties

bus​

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.

Range​

Properties

borders​

orderedValues​

RasterUrlTemplate​

Properties

defaultSource​

wmsSource​

RoadEventActionState​

Properties

set​

Applied.

notSet​

Not applied.

RoadEventActionType​

Properties

like​

Adds the 'like' mark.

dislike​

Adds the "dislike" mark.

confirmation​

Event confirmation.

disproof​

Refutation of event.

RoadEventDisplayCategory​

Properties

camera​

Cameras of all types, including those added by the user.

comment​

Comments on the roads.

accident​

Traffic accident.

roadRestriction​

Road closures.

roadWorks​

Road works.

other​

Events in the Other category.

user​

Always displays events created by the current user, regardless of their category.

RoadEventType​

Properties

accident​

Traffic accident.

roadWorks​

Road works.

camera​

Camera.

comment​

Comment.

roadRestriction​

Traffic closure.

other​

Other event.

RoadRule​

Properties

unknown​

Unknown.

rightHandTraffic​

Right-hand driving.

leftHandTraffic​

Right-hand driving.

RoadSubtype​

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.

stairwayUp​

Stairway going upwards.

stairwayDown​

Stairway going downwards.

subwayCrossing​

Subway crossing.

tunnel​

Tunnel.

underpass​

Underpass.

RoadSurface​

Properties

unknown​

Unknown.

asphalt​

Asphalt.

gravel​

Gravel.

ground​

Soil.

concrete​

Concrete.

RoadType​

Properties

unknown​

Unknown.

walkway​

Pedestrian path or a section of road where pedestrian traffic is allowed.

bikeway​

Bicycle lane or section of road where bicycles are permitted.

pathway​

Roadway of minimal importance.

fieldForestRoad​

Field or forest road.

serviceRoad​

Access road/intra-block driveway.

otherStreetRoad​

Road that passes through other streets of a settlement.

mainStreetRoad​

Roadway running through the main streets of a settlement.

highway​

Highway.

intercityRoad​

'Intercity highway'.

federalRoad​

Road of federal importance.

RouteCameraDirection​

Properties

against​

Against the traffic direction.

along​

Along the traffic direction (to the back).

both​

Bi-directional camera.

RouteCameraPurpose​

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​

“Platon” system camera: https://platon.ru/en/about/

RouteExitSignTableColor​

Properties

undefined​

Color of the exit sign table is undefined.

white​

White.

red​

Red.

green​

Green.

blue​

Blue.

brown​

Brown.

RouteExitSignType​

Properties

undefined​

Undefined

airport​

Exit to the airport.

RouteLaneManeuver​

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.

sharplyRight​

Sharply to the right.

sharplyLeft​

Sharply to the left.

rightWithLeftTurns​

To the right, then to the left.

turnover​

U-turn.

RouteMapObjectCalloutLabelDisplayMode​

Properties

absoluteValues​

Travel time and/or route length are displayed in absolute values (e.g. N km, M min).

relativeToActiveRouteValues​

Travel time and/or route length are displayed in absolute values only for the active route. For inactive routes, the difference from the corresponding value of the active route is displayed (e.g. +/-N km, +/-M min). If there is no active route or if there is more than one active route on the map, the travel time and/or route length are displayed in absolute values for all routes.

RouteMapObjectCalloutLabelFlag​

Properties

duration​

Time of travel along the route.

length​

Route length.

RouteMapObjectDisplayFlag​

Properties

routeParts​

Route segments.

startPoint​

Starting point of the route.

finishPoint​

Finish 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​

Traffic accident.

roadWorks​

Road works.

comments​

Comments.

roadRestrictions​

Traffic closures.

otherEvents​

Other" events.

tollRoads​

Start and end of toll road.

lanesBubbles​

Lane bubbles (displayed only in source with navigation mode).

bubbles​

Lane bubbles with travel time and route length.

indoorInstructions​

Instructions in buildings. Move by elevator, escalator, etc.

inactiveFloors​

Shows parts of the route inside buildings not just for the active floor.

trafficLights​

Highlight traffic lights on the route.

immersiveRouteParts​

Use immersive geometry for route parts (used together with RouteParts).

RouteMapObjectPassedDistanceVisualization​

Properties

showRemainingRoutePart​

Shows only the rest of the route - from the passed distance to the finish.

showPassedRoutePart​

Shows only the passed part of the route - from the start to the passed distance.

showWholeRoute​

Shows the entire route regardless of the distance traveled along it.

RouteMapObjectPermanentDisplayFlag​

Properties

startPoint​

Starting point of the route.

finishPoint​

Finish point of the route.

intermediatePoints​

Intermediate waypoints.

cameras​

Cameras.

accidents​

Traffic accident.

roadWorks​

Road works.

comments​

Comments.

roadRestrictions​

Traffic closures.

otherEvents​

Other" events.

tollRoads​

Start and end of toll road.

RoutePointKind​

Properties

start​

Starting point of the route.

finish​

Finish point of the route.

intermediate​

Intermediate point of the route.

camera​

Camera.

accident​

Traffic accident.

roadWork​

Road works.

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​

Beginning and end of the motorized section of road (for bicycle/scooter routes).

bicycleRoad​

Beginning and end of a bicycle track.

bicycleLane​

Beginning and end of a cycle lane.

trafficLight​

Traffic lights.

RouterType​

Properties

online​

Online search engine for routes.

offline​

Offline search engine for routes.

hybrid​

Hybrid (online/offline) search engine for routes.

RouteSearchOptions​

Properties

bicycle​

car​

pedestrian​

publicTransport​

scooter​

taxi​

truck​

RouteSearchType​

Properties

jam​

Route search with current traffic data.

statistic​

Route search with statistical traffic data.

shortest​

Search for the shortest route.

RouteVisualizationType​

Properties

normal​

Standard visualization - used in the route editor.

navigation​

Visualization for navigation mode - used in the navigator.

ScooterInstructionCrossroadLandmark​

Properties

none​

No landmark.

crosswalk​

Pedestrian crossing.

trafficLight​

Traffic light.

ScooterInstructionCrossroadManeuverDirection​

Properties

straight​

Straight ahead.

left​

Left.

right​

Right.

sharplyLeft​

Sharp turn to the left.

sharplyRight​

Sharp turn to the right.

keepLeft​

Keep to the left.

keepRight​

Keep to the right.

SearchResultType​

Properties

recovery​

Specific object found by the query.

discovery​

Heading found by the query. The results contain a list of objects from that heading.

Settlement​

Properties

unknown​

Information about the settlement is unknown.

inside​

Inside the settlement.

outside​

Outside the settlement.

SimulationSpeedMode​

Properties

speed​

overSpeed​

SortingType​

Properties

byRelevance​

By relevance. Used by default.

byDistance​

By distance from the user's current position.

byRating​

By rating.

SoundCategory​

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​

Road works.

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​

Properties

bicycle​

For bicycles.

motorbike​

For motorcycles.

family​

For families.

handicapped​

For handicapped people.

babyCarriage​

For strollers.

truck​

For trucks.

scooter​

For scooters.

SpeedFormattingStrategy​

Properties

`default`​

formatted​

custom​

State​

Properties

disabled​

Not active (initial state, goes to it after the Stop method is called).

navigation​

Route guidance mode.

Searching for a new route.

finished​

Reaching end point.

SuggestedType​

Properties

admDivCity​

City.

admDivCountry​

Country/state.

admDivDistrict​

District (of a city).

admDivDistrictArea​

Region or province district.

admDivDivision​

Division.

admDivLivingArea​

Living area.

admDivPlace​

Miscellaneous polygon objects: parks, beaches, recreation facilities, lakes, and other places.

admDivRegion​

Region/province.

admDivSettlement​

Settlement (village).

attraction​

Sightseeing attraction.

attribute​

Additional attribute.

branch​

Branch of an organization.

building​

Building.

coordinates​

Global coordinates.

crossroad​

Intersection.

kilometerRoadSign​

Kilometer marker.

marketAttribute​

Names of goods.

marketBrand​

Goods brand.

marketCategory​

Category of goods. Requires market.suggestor_category.

marketSuggestorCategory​

Required to expand the goods categories.

metaRubric​

Metacategory.

org​

Organization.

parking​

Parking.

road​

Road.

route​

Public transportation route.

routeType​

Route type.

rubric​

Category.

station​

Stop.

stationEntrance​

Station entrance.

stationMetro​

Metro station.

street​

Street.

text​

Text hint.

unknown​

In case of an unexpected type.

SuggestHandler​

Properties

objectHandler​

performSearchHandler​

incompleteTextHandler​

SuggestorType​

Properties

address​

Address suggestor.

citySelector​

Settlement suggestor. Can be used without specifying a project.

object​

Directory object (categories, branches, streets, cities, etc.) suggestor.

places​

Place suggestor.

routeEndpoint​

A tooltip for selecting waypoints. Optimized for searching for point objects in a single action. Rejects objects without points.

rubric​

Category suggestor.

TextPlacement​

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​

Properties

left​

Events are displayed on the left.

right​

Events are displayed on the right.

TimeFormattingStrategy​

Properties

`default`​

formatted​

custom​

TrafficControlStatus​

Properties

hidden​

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​

Properties

pending​

Value unknown, will be requested later. Initial state.

valid​

Value is current.

expired​

Value is outdated. The state is reached if the data could not be updated within a certain time.

TrafficSpeedColor​

Properties

undefined​

green​

yellow​

red​

deepRed​

TransportType​

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.

VendorConfig​

Properties

none​

fromAsset​

fromFile​

fromString​

WeekDay​

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.

Properties

sunday​

monday​

tuesday​

wednesday​

thursday​

friday​

saturday​

WidgetType​

Properties

checkbox​

Single checkbox.

checkableItemGroup​

Group of elements where each one can be checked independently or grouped into

range​

Representation of a continuous or discrete set of ordered values.

WorkTimeFilter​

Properties

workTime​

isOpenNow​

ZoomControlButton​

Properties

zoomIn​

zoomOut​