enumeration
ActionResult
Properties
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.
noPersonalDataCollectionConsent
User has refused to collect and submit personal data.
userBlocked
User is blocked.
tooManyRequests
User creates events too often.
AddEventResult
Properties
AddressComponent
Properties
Alignment
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
AudioVolume
Properties
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
right
Sharp turn to the left.
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.