struct
Address
Address as a set of individual components.
public init(
drillDown: [AddressAdmDiv],
components: [AddressComponent],
buildingName: String?,
postCode: String?,
buildingCode: String?,
addressComment: String?
)
Parameters
drillDown
components
buildingName
postCode
buildingCode
addressComment
Properties
var drillDown
Set of administrative division objects in which the object being described is located.
var components
Complete address of an object may contain several separate address components.
var buildingName
Name of the building.
var postCode
ZIP code.
var buildingCode
The unique ZIP code of the building.
var addressComment
Address comment. Example: “office 301; floor 9”.
AddressAdmDiv
Administrative unit object.
AddressLocation
Applies to components that are hard to describe with a specific address.
Properties
var comment
Verbal description of the location of a building.
AddressNumber
Some localities designate only the house number, without the street (e.g., Krasnoobsk).
Properties
var number
Building number, including fractions and letters. Possibly a proper name, if that is the custom.
AddressStreet
Normal address, there is a street and house number.
Anchor
Image anchor point (0, 0) - upper left corner, (1, 1) - lower right corner.
public init(
x: Float = 0.5,
y: Float = 0.5
)
Parameters
x
Float
y
Float
Properties
var x
Float
var y
Float
ApartmentRange
Range of apartments.
Properties
var start
Range start/Stored value. Currently only numeric values are supported, apartments with suffixes are not yet available in the data.
var end
End of range. If absent, the range consists of a single start value. Otherwise it is an arithmetic progression from start to end in steps of 1.
ApiKeyOptions
Key settings for working with 2GIS SDK.
Properties
Attribute
Additional attribute. Example: { tag: “hotel_room_internet”, name: “Free internet in the rooms” }.
AudioOptions
Sound settings.
public init(muteOtherSounds: Bool, audioVolume: AudioVolume)
Parameters
Properties
static let `default`
Default settings. Mutes the sound of other applications and maximizes the playback volume.
AuthorInfo
Information about the author of the event or photo.
Properties
var type
Content author category.
var name
String containing the name of the user who added the event or photo.
BatteryOptions
Battery condition monitoring settings. Used to configure the battery condition monitoring service needed to optimize power consumption when the charge level is low or to activate power saving mode.
public init(lowBatteryThreshold: Int, delegate: IBatteryManagerDelegate?)
Parameters
Properties
var lowBatteryThreshold
Percentage of battery charge starting at and below which the charge is considered low. When the battery charge is low, aggressive power saving tools may be activated and warnings may be displayed. Value range: 0...100.
var delegate
Delegate of the battery monitoring service. Required to control turning on and off the battery status monitoring (see `UIDevice.isBatteryMonitoringEnabled`), which allows you to automatically enable power optimization.
static let `default`
Default settings. The low battery limit is 15%. Battery status monitoring is disabled. Power optimization is not automatically enabled.
Bearing
Angle between the direction to one object and another object or between the direction to the object and north. The angle is counted clockwise. The value range is [0°, 360°].
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Value to create.
Properties
var value
BetterRouteInfo
Information on available alternative route.
public init(
trafficRoute: TrafficRoute,
startPoint: RoutePoint
)
Parameters
Properties
var trafficRoute
Alternative route.
var startPoint
Point on the alternative route from which traffic starts if you switch to this route.
BicycleBriefRouteInfo
Basic cycling route information.
Properties
BicycleInstructionCrossroad
Description of maneuvers when passing through an intersection or crosswalk.
public init(
landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.`none`,
maneuvers: [BicycleInstructionCrossroadManeuver]
)
Parameters
Properties
var landmark
Landmark.
var maneuvers
Chain of sequential maneuvers.
BicycleInstructionCrossroadManeuver
public init(
direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.straight,
turnAngle: Int32 = 0
)
Parameters
Properties
var direction
Direction of travel.
var turnAngle
Int32
Turning angle in degrees [-180, 180].
BicycleInstructionFinish
End of the cycling part of the route.
public init()
BicycleInstructionStart
The beginning of the cycling part of the route.
public init()
BicycleRouteSearchOptions
Bicycle route search options.
public init(
avoidCarRoads: Bool = false,
avoidStairways: Bool = false,
avoidUnderpassesAndOverpasses: Bool = false,
excludedAreas: [ExcludedArea] = []
)
Parameters
Properties
var avoidCarRoads
Avoid roads.
var avoidStairways
Avoid stairs.
var avoidUnderpassesAndOverpasses
Avoid underpasses and overpasses.
var excludedAreas
Excluded areas (not more than 25).
BoolRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: Bool
)
Parameters
Properties
BriefRoadEvent
public init(
id: UInt64 = 0,
eventType: RoadEventType = RoadEventType.other,
lanes: LaneOptionSet
)
Parameters
Properties
BriefRouteInfo
Basic route information.
public init(
duration: TimeInterval,
extraInfo: BriefExtraRouteInfo
)
Parameters
Properties
var duration
Time of travel along the route.
var extraInfo
Additional route information for a specific vehicle type.
BriefRouteInfoSearchPoints
Points to query for basic route information search.
public init(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint
)
Parameters
Properties
var startPoint
Starting point of the route.
var finishPoint
Finish point of the route.
BuildingId
BuildingLevels
Information about the floor plans of the building.
public init(
defaultLevelId: LevelId,
levels: [LevelInfo]
)
Parameters
Properties
var defaultLevelId
Default floor plan identifier.
var levels
All floor plans of the building.
CalloutMapPosition
Route bubble position.
public init(
mapId: MapId,
calloutPosition: GeoPoint?,
routePoint: RoutePoint?
)
Parameters
Properties
var mapId
Identifier of the map for which the position is given.
var calloutPosition
Position on the map.
var routePoint
Lane bubble position on the route.
CameraBehaviour
Camera tracking mode.
public init(
position: FollowPosition?,
transitionType: TransitionType = TransitionType.smooth
)
Parameters
Properties
CameraBehaviourChange
Changes tracking mode.
public init(
newBehaviour: CameraBehaviour,
changeReason: CameraBehaviourChangeReason
)
Parameters
Properties
var newBehaviour
New tracking mode.
var changeReason
Reason for changing tracking mode.
CameraPosition
Camera position.
Properties
var point
Terrain point that is located at the camera position point (see ICamera::position_point()).
var zoom
Zoom level. 0 is the entire world inscribed in a square of 256x256 logical pixels (see LogicalPixel).
var tilt
Tilt angle of the gaze direction vertically.<br/>0 is nadir (vertically downward), maximum value is 60 degrees.
var bearing
Angle of rotation of the view direction horizontally relative to the north direction. Counted clockwise, in degrees.
CameraPositionPoint
Relative screen position of the point to which the camera is linked.
public init(
x: Float = 0.5,
y: Float = 0.5
)
Parameters
x
Float
y
Float
Properties
var x
Float
var y
Float
CameraProgressInfo
Information about the progress of the camera zone.
public init(
camera: RouteCamera,
position: RoutePoint,
progress: Float = 0
)
Parameters
Properties
var camera
Camera for the area for which progress is being tracked.
var position
Camera position on the route.
var progress
Float
Progress of the camera area, [0, 1].
CameraPurposeOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let speedControl
Recording of exceeding the speed limit.
static let averageSpeedControl
Recording of exceeding the average speed on the section.
static let publicTransportLaneMovementControl
Recording of movement on the dedicated lane for public transport.
static let roadMarkingsCrossingControl
Recording of crossing the solid line of road markings, driving on the side of the road.
static let trafficLightsViolationControl
Recording of passing at the forbidden signal of traffic lights.
static let stopLineCrossingControl
Recording of driving over the stop line, driving without stopping the stop sign, driving to the intersection during a jam.
static let oncomingTrafficLaneMovementControl
Recording driving in the oncoming lane.
static let pedestrianAdvantageViolationControl
Recording failure to give priority to pedestrians.
static let laneDisciplineControl
Recording of violation of lane rotation at the intersection.
static let noStoppingViolationControl
Recording of violation of prohibition of stopping.
static let dummy
Fake item.
static let truck
Platon system camera, truck restriction control camera.
CameraRouteEntry
Route element - a point and a value in it.
Properties
CameraZoomRestrictions
Allowed range of zoom level variation.
CarBriefRouteInfo
Basic information about the automobile route.
public init(
length: RouteDistance,
landmark: String,
trafficSpeed: CarBriefRouteInfoTrafficSpeed
)
Parameters
Properties
var length
Route length.
var landmark
Landmark.
var trafficSpeed
Travel speed.
CarInstructionCrossroad
Description of maneuvers at the intersection.
public init(
direction: CarInstructionCrossroadDirection = CarInstructionCrossroadDirection.straight,
turnAngle: Int32 = 0,
landmark: CarInstructionCrossroadLandmark = CarInstructionCrossroadLandmark.`none`,
exitName: String
)
Parameters
direction
turnAngle
Int32
landmark
exitName
Properties
var direction
Direction of traffic at the intersection.
var turnAngle
Int32
Turning angle in degrees [-180, 180].
var landmark
Landmark.
var exitName
Exit name.
CarInstructionFinish
End of the automobile part of the route.
public init()
CarInstructionRoundabout
Description of maneuvers at a traffic circle intersection.
public init(
type: CarInstructionRoundaboutType = CarInstructionRoundaboutType.entry,
turnAngle: Int32 = 0,
exitNumber: UInt32 = 0,
exitName: String
)
Parameters
Properties
var type
Type of instruction.
var turnAngle
Int32
Turning angle in degrees [-180, 180].
var exitNumber
Exit number - [1, inf] or 0 if the exit number is unknown.
var exitName
Exit name.
CarInstructionStart
Start of the automobile part of the route.
public init()
CarInstructionUTurn
U-turn on the road (not at an intersection).<br/>U-turn at an intersection is described by the Crossroad instruction.
Properties
var exitName
Exit name.
CarRouteSearchOptions
Route search parameters in a passenger car.
public init(
avoidTollRoads: Bool = false,
avoidUnpavedRoads: Bool = false,
avoidFerries: Bool = false,
avoidLockedRoads: Bool = true,
routeSearchType: RouteSearchType = RouteSearchType.jam,
excludedAreas: [ExcludedArea] = []
)
Parameters
avoidTollRoads
avoidUnpavedRoads
avoidFerries
avoidLockedRoads
routeSearchType
excludedAreas
Properties
var avoidTollRoads
Avoid toll roads.
var avoidUnpavedRoads
Avoid unpaved roads.
var avoidFerries
Avoid ferry crossings.
var avoidLockedRoads
Avoid closed roads. If true, the route search will not take into account road closures. If false is set, the route can be created through roadblocks if you cannot build a route without passing through roadblocks.
var routeSearchType
Route search type.
var excludedAreas
Excluded areas (not more than 25).
CircleOptions
Parameters for creating a geometric map object of the Circle type.
public init(
position: GeoPoint,
radius: Meter,
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value: 0),
strokeColor: Color = Color(),
visible: Bool = true,
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
levelId: LevelId? = nil
)
Parameters
Properties
var position
Geographic position.
var radius
Radius in meters.
var color
Fill color.
var strokeWidth
Circle border line width.
var strokeColor
Color of the circle boundary line.
var visible
Visibility flag.
var userData
Any
User data. (not used inside SDK, only for API users).
var zIndex
Object drawing level.
var levelId
Binding to the floor plan of the building.
ClusterOptions
Cluster marker parameters.
public init(
attributes: [String: AttributeValue],
userData: Any = ()
)
Parameters
attributes
String[ : ]
Properties
var attributes
[String : AttributeValue]
Cluster attributes.
var userData
Any
User data returned to IClusterObject.
Color
Color.
init(
red: CGFloat,
green: CGFloat,
blue: CGFloat,
alpha: CGFloat
)
Parameters
Properties
var argb
ContactInfo
Way to contact the organization.
Properties
DashedPolylineOptions
Parameters of the dotted polyline.
public init(
dashLength: LogicalPixel = LogicalPixel(value: 5),
dashSpaceLength: LogicalPixel = LogicalPixel(value: 2)
)
Parameters
Properties
DayTime
Time moment within a day.
public static func < (lhs: DayTime, rhs: DayTime) -> Bool
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
DeviceDensity
Multiplier that is calculated as the ratio of DPI to the base DPI of the device.<br/>Must be positive.
public init(
value: Float = 0
)
Parameters
value
Float
Properties
var value
Float
DevicePpi
Resolution of the device display, in pixels per inch.<br/>Must be positive.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
The value to create.
Properties
var value
Float
static let autodetected
PPI of the head unit screen. For example, for a smartphone connected to CarPlay, this is the PPI of the smartphone screen. The value is `nil` if the current device has an unknown PPI (unsupported device, e.g. from future). In such cases, you need to set the PPI yourself using the entry in `Map.devicePpi`.
static let defaultForFailedAutodetection
This PPI is used by default in cases where it was not possible to automatically determine from the device model. See `.autodetected'.
DgisObjectId
DirectoryFilter
Filters for the directory.
public init(
workTime: WorkTimeFilter?,
dynamic: [DynamicFilter]
)
Parameters
Properties
DoubleRouteEntry
Route element - a point and a value in it.
Properties
DynamicRouteInfo
public init(
roadEvents: RoadEventRouteAttribute,
traffic: Traffic
)
Parameters
Properties
Elevation
Non-negative elevation of the point above the surface, in meters.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
Value to create.
Properties
var value
Float
EntranceGeometry
Geometries for displaying the entrance on the map.
public init(
entrancePoints: [GeoPoint],
entrancePolylines: [[GeoPoint]]
)
Parameters
Properties
var entrancePoints
Entrance location.
var entrancePolylines
Geometries for arrows pointing to the entrance.
EntranceInfo
Information about the entrance to the building.
public init(
id: DgisObjectId,
buildingNumber: String?,
porchName: String?,
porchNumber: String?,
apartmentRanges: [ApartmentRange],
geometry: EntranceGeometry?
)
Parameters
id
buildingNumber
porchName
porchNumber
apartmentRanges
geometry
Properties
var id
Input object ID.
var buildingNumber
Number of the house to which the entrance belongs.
var porchName
Non-empty entrance name. Filled in for entrances only. Can take values of the entrance name (e.g. "Entrance 1 ") or building number if the entrance has its own address.
var porchNumber
Non-empty entrance number. Filled in for entrances only. Can take values of entrance number (e.g. "1 ") or building number if the entrance has its own address.
var apartmentRanges
Apartment numbers pertaining to the entryway.
var geometry
Geometries for displaying the entrance on the map.
ExcludedArea
Excluded area to be avoided when building a route.
public init(
type: ExcludedAreaType = ExcludedAreaType.point,
severity: ExcludedAreaSeverity = ExcludedAreaSeverity.soft,
extent: RouteDistance,
points: [GeoPoint]
)
Parameters
Properties
var type
Type of the excluded area.
var severity
Priority of area exclusion.
var extent
Size of the excluded area (not more than 25 km).
var points
Coordinates of the points of the excluded area (not more than 500).
FlagFilter
Flag filter.
FloatRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: Float
)
Parameters
Properties
FloorInfo
Information about the floor plan for the marker - element of the search output.
Properties
FollowPosition
Tracking settings for direction, tilt, and zoom level.
public init(
bearing: FollowBearing = FollowBearing.off,
tilt: FollowTilt = FollowTilt.off,
styleZoom: FollowStyleZoom = FollowStyleZoom.off
)
Parameters
Properties
FollowValueOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let coordinates
static let satelliteBearing
static let magneticBearing
static let tilt
static let styleZoom
static let accuracy
FormattedAddress
A human-readable representation of the address.
Properties
var drilldownAddress
Address from a drill-down. Example: “Novosibirsk, Kirovsky district”.
var streetAddress
Address inside a settlement. Example: “Nikolaeva str., 11”.
var addressComment
Address comment. Example: “office 301; floor 9”.
var postCode
Postal code of the object with a building code, if any. Example: “630088”, “630007/XBVJF8”.
GeoPoint
Point in a spherical coordinate system that, together with a geodetic coordinate system (e.g., WGS84), points to a point on the Earth's surface. This structure is not bound to a specific geodetic coordinate system. But this module contains free functions that operate with this structure already in a specific coordinate system (see the documentation to the functions).
init(latitude: CLLocationDegrees, longitude: CLLocationDegrees)
Parameters
Methods
func bearing(point: GeoPoint) -> Bearing
Calculates the bearing (the angle between the geographic north direction and the direction of movement, counted clockwise) between two points.
Parameters
func distance(point: GeoPoint) -> Meter
Calculates the minimum distance (along a great circle) between two points.
Parameters
GeoPointRouteEntry
Route element - a point and a value in it.
Properties
GeoPointWithElevation
Point in a geographic coordinate system (latitude, longitude, elevation).<br/>Elevation is defined in meters above the surface, not above the sea level.
public init(
latitude: Latitude,
longitude: Longitude,
elevation: Elevation = Elevation(value: 0)
)
Parameters
init(
latitude: CLLocationDegrees,
longitude: CLLocationDegrees,
elevation: CLLocationDistance
)
Parameters
init(
coordinate: CLLocationCoordinate2D,
elevation: CLLocationDistance
)
Parameters
Methods
func bearing(point: GeoPoint) -> Bearing
Calculates the bearing (the angle between the geographic north direction and the direction of movement, counted clockwise) for the projection of a point on the map and for a given point.
Parameters
func distance(point: GeoPoint) -> Meter
Calculates the minimum distance (along a great circle) between two points.
Parameters
func move(bearing: Bearing, meter: Meter) -> GeoPointWithElevation
Calculates the point obtained by moving the source point in the specified direction by the specified distance.
Parameters
GeoRect
Rectangular area in a spherical coordinate system (e.g. WGS84). This structure is not tied to a specific geodetic coordinate system.
Methods
func contains(
point: GeoPoint
) -> Bool
Whether the rectangle contains the point. Points on the border are also considered to belong to the rectangle.
Parameters
func intersects(
rect2: GeoRect
) -> Bool
Whether the rectangles intersect, i.e. have common points. The rectangles with common points located only on the boundary are also considered intersecting.
Parameters
Properties
var southWestPoint
Southwest point, bottom left border of rectangle.
var northEastPoint
Northeast point, top right of rectangle.
var isValid
Checks rectangle for correctness.
var isDegenerate
Checks the rectangle for degeneracy. If the points in the rectangle are equal, the rectangle is degenerate to a point. A degenerate rectangle is a correct rectangle. An incorrect rectangle is not degenerate.
GLContextError
Implements: ISDKError
GradientPolylineOptions
Parameters of the gradient polyline.
public init(
borderWidth: LogicalPixel = LogicalPixel(value: 0),
secondBorderWidth: LogicalPixel = LogicalPixel(value: 0),
gradientLength: LogicalPixel = LogicalPixel(value: 1),
borderColor: Color = Color(),
secondBorderColor: Color = Color(),
colors: [Color],
colorIndices: Data
)
Parameters
borderWidth
secondBorderWidth
gradientLength
borderColor
secondBorderColor
colors
colorIndices
Data
Properties
var borderWidth
Line border width.
var secondBorderWidth
Width of the second line border.
var gradientLength
Gradient line length.
var borderColor
Outline color.
var secondBorderColor
Color of the second outline.
var colors
Gradient polyline color palette.
var colorIndices
Data
Gradient polyline color indexes. The number of indexes must be 1 less than the number of polyline points.
HttpHeader
HTTPOptions
Keys for accessing 2GIS services.
public init(
timeout: TimeInterval,
cacheOptions: CacheOptions?
)
Parameters
timeout
TimeInterval
cacheOptions
CacheOptions?
Properties
let timeout
Network protocol wait time. Defaults to 15 seconds.
let cacheOptions
HTTPOptions.CacheOptions?
Caching mode. If `nil`, no cache is used. The default is to use the disk cache in the user's cache directory (`NSCachesDirectory`).
static let `default`
Default settings. Maximum cache size: 300 MB.
HttpRequest
public init(
url: String,
method: HttpMethod = HttpMethod.gET,
headers: [HttpHeader] = [],
body: Data? = nil
)
Parameters
Properties
HttpResponse
public init(
statusCode: HttpStatusCode,
headers: [HttpHeader]
)
Parameters
Properties
HttpStatusCode
public init(
value: Int32 = 0
)
Parameters
value
Int32
Properties
var value
Int32
ImageData
Image data: size, format, and binary data.
public init(
size: ScreenSize,
format: ImageFormat,
data: Data
)
Parameters
Properties
IndoorControlOptions
Settings for the floor control element in the building.
public init(visibilityBehavior: VisibilityBehavior)
Parameters
visibilityBehavior
VisibilityBehavior
init(
visibilityBehavior: VisibilityBehavior,
markingByRoute: MarkingByRoute
)
Parameters
visibilityBehavior
VisibilityBehavior
markingByRoute
MarkingByRoute
Properties
var visibilityBehavior
IndoorControlOptions.VisibilityBehavior
static let `default`
Default settings. Automatic visibility control.
InstructionRouteEntry
Route element - a point and a value in it.
public init(
point: RoutePoint,
value: RouteInstruction
)
Parameters
Properties
IntRouteEntry
Route element - a point and a value in it.
Properties
IsOpenNow
Open now.
public init()
LaneOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let left
Left lane.
static let center
Middle lane.
static let right
Right lane.
LanesCalloutMapPosition
Position of the lane bubble for the route.
public init(
mapId: MapId,
routePoint: RoutePoint,
geoPoint: GeoPoint
)
Parameters
Properties
var mapId
Identifier of the map for which the position is given.
var routePoint
The lane callout position on the route.
var geoPoint
Position of the lane bubble on the map.
LaneSignRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RouteLaneSign
)
Parameters
Properties
Latitude
Geographic latitude.
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Value to create.
Properties
var value
LevelId
LevelInfo
Building floor information.
Locale
Locale identifier in the format `[language designer]-[region designer]`. Where `language designer` is the language code described in ISO 639-1, `region designer` is the country code described in ISO 3166-1.
public init(stringLiteral value: String)
Creates an instance initialized to the given string value.
Parameters
value
Value of the new instance.
Properties
var description
Textual representation of this instance.
LocalizationOptions
Application localization settings. Allows you to set the set of locales used to localize the map and guide.
public init(locales: [Locale], systemLocales: [Locale])
Parameters
public init(locales: [Locale])
Localization settings constructor.<br/>The `systemLocales` parameter is a list of the user's preferred languages.
Parameters
locales
List of locales supported by the application.
Properties
let locales
List of locales supported by the application. If an empty list is passed, system locales are used.
let systemLocales
List of system locales. If an empty list is passed, `en-EN` is used.
static let `default`
Default settings. Using the list of user's preferred languages.
Location
Geoposition.
public init(
coordinates: LocationCoordinates,
altitude: LocationFuzzyDouble?,
course: LocationCourse?,
groundSpeed: LocationFuzzyDouble?,
source: String,
timestamp: TimeInterval
)
Parameters
coordinates
altitude
course
groundSpeed
source
timestamp
TimeInterval
Properties
var coordinates
coordinates::value - geoposition coodinates. coordinates::accuracy - horizontal accuracy of geopositioning coordinates (DRMS), m. https://en.wikipedia.org/wiki/Circular_error_probable Value range: >= 0.
var altitude
altitude::value - altitude above the WGS84 reference ellipsoid, m. altitude::accuracy - standard deviation of the altitude measurement error, m. nil means that the platform does not provide this field. https://en.wikipedia.org/wiki/Standard_deviation Value range: (nil, > 0).
var course
course::value - bearing (direction of travel along the Earth's surface. The angle is measured relative to geographic north). course::accuracy - standard deviation of the error of the bearing measurement. nil means that the platform does not provide this field. https://en.wikipedia.org/wiki/Standard_deviation Value range: (nil, > 0).
var groundSpeed
ground_speed - speed along the Earth surface, m/s. Value range: >= 0. ground_speed::accuracy - mean square deviation of the speed measurement error, m/s. nil means that the platform does not provide this field. https://en.wikipedia.org/wiki/Rayleigh_distribution Value range: (nil, > 0).
var source
Name of the geoposition source.<br/>The timestamps between different geoposition sources are not synchronized, so you cannot compare the timestamps of geopositions that are derived from different sources.
var timestamp
Time point at which the geoposition was determined. This point is not attached to any specific date and is used solely to calculate the time between two geopositioning measurements obtained from one geopositioning source in one session. This field should increase monotonically (even when the system is in sleep mode).
LocationCoordinates
LocationCourse
LocationFuzzyDouble
LogicalPixel
Pixel the size of which is independent of screen density.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
Value to create.
Properties
var value
Float
LogMessage
Message being logged.
LogOptions
SDK logging settings.
Properties
var osLogLevel
Minimum level of errors that go into the system log (os_log).
var customLogLevel
Minimal level of errors in the user's logging receiver.
var customSink
Custom logging receiver.
static let `default`
Default settings. Warnings and more critical events are logged.
Longitude
Geographic longitude.
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Value to create.
Properties
var value
MapDirection
Angle of the object relative to the north direction, in degrees, counted clockwise.
Properties
var value
MapGestureViewFactory
Default gesture processing factory.
Implements: IMapGestureViewFactory
Methods
public func makeGestureView(
map: Map,
eventProcessor: IMapEventProcessor,
coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureView
Creates a gesture handling layer.
Parameters
MapGestureViewOptions
Default gesture layer settings.
public init(
doubleTapScalingCenter: ScalingCenter,
twoFingerTapScalingCenter: ScalingCenter,
pinchScalingCenter: ScalingCenter
)
Parameters
doubleTapScalingCenter
ScalingCenter
twoFingerTapScalingCenter
ScalingCenter
pinchScalingCenter
ScalingCenter
Properties
var doubleTapScalingCenter
MapGestureViewOptions.ScalingCenter
var twoFingerTapScalingCenter
MapGestureViewOptions.ScalingCenter
var pinchScalingCenter
MapGestureViewOptions.ScalingCenter
static let `default`
Default settings. For double tap and two-finger tap gestures, zooming is relative to the location of the gesture.
MapId
Identifier of the map instance, unique within the process.
public init(
value: Int32 = 0
)
Parameters
value
Int32
Properties
var value
Int32
MapOptions
Initial map properties that can be set during its initialization. A property set to nil will not be applied, so the default value will be used.
Properties
var devicePPI
Number of physical screen points in a line 2.54 cm long.
var deviceDensity
Multiplier that is calculated as the ratio of devicePPI to the device's base DPI. The multiplier value corresponds to the nativeScale of the target screen.
var position
Camera location relative to the map.
var positionPoint
Relative location of the map location point in the camera view space.
var zoomRestrictions
Boundaries of the map zoom.
var sources
Map data sources.
var sourceDescriptors
Set<MapOptions.SourceDescriptor>?
Simplified way to specify map data sources.
var styleFuture
Future<Style>?
Initial map style with delayed loading. The style can be loaded using an `IStyleFactory` instance, see. `Container.styleFactory'. Use `Future.makeReadyValue(style)` if the style is already loaded.
var gestureViewFactory
Gesture processing layer factory. If `nil`, gestures are not processed until the `IMapView.gestureView` property is set.
var appearance
Selection of a theme within the selected map style, taking into account the environment.
var maxFps
Maximum allowable map refresh frequency.
var powerSavingMaxFps
Maximum allowable map refresh frequency in energy saving mode.
var backgroundColor
Backgroud color for loading styles.
var mapRendererType
Map renderer type.
static var `default`
Initial settings set when creating map objects. The DPI is determined based on the main device screen (see `DevicePpi.autodetected`). If autodetected fails, `DevicePpi.defaultForFailedAutodetection` is used.
MarkedUpText
Span text.
public init(
text: String,
matchedParts: [MarkedUpTextSpan]
)
Parameters
Properties
var text
Text.
var matchedParts
Set of non-overlapping Span, in order, in a text string describing parts that match the user's query.
MarkedUpTextSpan
Describes a subset of bytes of the string text.
MarkerOptions
Marker settings.
public init(
position: GeoPointWithElevation,
icon: Image?,
iconMapDirection: MapDirection? = nil,
anchor: Anchor = Anchor(x: 0.5, y: 0.5),
text: String? = nil,
textStyle: TextStyle? = nil,
iconOpacity: Opacity = Opacity(value: 1),
visible: Bool = true,
draggable: Bool = false,
iconWidth: LogicalPixel = LogicalPixel(value: 0),
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
animatedAppearance: Bool = true,
levelId: LevelId? = nil,
iconAnimationMode: AnimationMode = AnimationMode.normal
)
Parameters
position
icon
iconMapDirection
anchor
text
textStyle
iconOpacity
visible
draggable
iconWidth
zIndex
animatedAppearance
levelId
iconAnimationMode
Properties
var position
var icon
var iconMapDirection
var anchor
var text
var textStyle
var iconOpacity
var visible
var draggable
var iconWidth
Target width used for scaling.
var userData
Any
var zIndex
Object drawing level.
var animatedAppearance
Whether to animate the appearance.
var levelId
Binding to the floor plan of the building.
var iconAnimationMode
Animation mode.
MeasurementFormatterOutput
Result of the formatting of the measurement.
Meter
Length/distance in meters.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
Value to create.
Properties
var value
Float
MillisecondsRouteEntry
Route element - a point and a value in it.
Properties
MTLDeviceError
Implements: ISDKError
NavigationViewOptions
Navigator interface settings.
public init(
mapControlsBehaviour: NavigationViewMapControlsBehaviour = .visibleWhenNavigationActive,
distanceFormattingStrategy: DistanceFormattingStrategy = .default,
durationFormattingStrategy: DurationFormattingStrategy = .default,
durationValueFormattingStrategy: DurationValueFormattingStrategy = .default,
timeFormattingStrategy: TimeFormattingStrategy = .default,
speedFormattingStrategy: SpeedFormattingStrategy = .default,
theme: NavigationViewTheme = .default,
roadEventCardViewOptions: RoadEventCardViewOptions = .default,
roadEventCreationEnabled: Bool = true
)
Settings constructor.
Parameters
mapControlsBehaviour
Behavior of the camera controllers in navigation mode.
distanceFormattingStrategy
Way of formatting distances.
durationFormattingStrategy
Way to format the time interval.
durationValueFormattingStrategy
Formats the time interval value.
timeFormattingStrategy
Formats date/time.
speedFormattingStrategy
Formats speed.
theme
Navigator theme.
roadEventCardViewOptions
Traffic event card settings.
roadEventCreationEnabled
Whether a traffic event creation controller is needed.
Properties
var mapControlsBehaviour
var distanceFormattingStrategy
var durationFormattingStrategy
var durationValueFormattingStrategy
var timeFormattingStrategy
var speedFormattingStrategy
var theme
var roadEventCardViewOptions
var roadEventCreationEnabled
static var `default`
Navigator default interface settings.
NavigationViewTheme
Navigator theme.
public init(colors: Colors)
Parameters
colors
Colors
public init(
colors: Colors,
dashboardTheme: DashboardTheme,
remainingRouteInfoControlTheme: RemainingRouteInfoControlTheme,
nextManeuverControlTheme: NextManeuverControlTheme,
speedControlTheme: SpeedControlTheme,
cameraControlTheme: CameraControlTheme,
messageBarControlTheme: MessageBarControlTheme,
mapControlsTheme: MapControlsTheme,
betterRouteControlTheme: BetterRouteControlTheme,
thermometerTheme: ThermometerTheme
)
Parameters
colors
Colors
dashboardTheme
DashboardTheme
remainingRouteInfoControlTheme
RemainingRouteInfoControlTheme
nextManeuverControlTheme
NextManeuverControlTheme
speedControlTheme
SpeedControlTheme
cameraControlTheme
CameraControlTheme
messageBarControlTheme
MessageBarControlTheme
mapControlsTheme
MapControlsTheme
betterRouteControlTheme
BetterRouteControlTheme
thermometerTheme
ThermometerTheme
Properties
let colors
NavigationViewTheme.Colors
var dashboardTheme
NavigationViewTheme.DashboardTheme
var remainingRouteInfoControlTheme
NavigationViewTheme.RemainingRouteInfoControlTheme
var nextManeuverControlTheme
NavigationViewTheme.NextManeuverControlTheme
var speedControlTheme
NavigationViewTheme.SpeedControlTheme
var cameraControlTheme
NavigationViewTheme.CameraControlTheme
var messageBarControlTheme
NavigationViewTheme.MessageBarControlTheme
var mapControlsTheme
NavigationViewTheme.MapControlsTheme
var betterRouteControlTheme
NavigationViewTheme.BetterRouteControlTheme
var thermometerTheme
NavigationViewTheme.ThermometerTheme
static let `default`
Default navigator theme.
NoopCancellable
Ready-made ICancellable implementation that does not override anything.
Implements: ICancellable
public init()
Methods
public func cancel()
ObstacleInfo
Obstacle information on the route.
public init(
type: Obstacle = Obstacle.other,
limitation: ObstaclePassLimitation = ObstaclePassLimitation.unlimited
)
Parameters
Properties
ObstacleInfoRouteEntry
Route element - a point and a value in it.
Properties
ObstacleInfoRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: ObstacleInfo
)
Parameters
Properties
Opacity
Opacity - from 0.0 (full transparency) to 1.0 (full opacity).
public init(
value: Float = 0
)
Parameters
value
Float
Properties
var value
Float
OpeningHours
Hours of operation for the organization.
public init(
weekOpeningHours: [[WeekTimeInterval]],
isOpen24x7: Bool
)
Parameters
Properties
var weekOpeningHours
Hours of operation for each day of the week, starting on Monday.
var isOpen24x7
PackageInfo
Package information. See IPackage.
public init(
name: String,
installed: Bool = false,
incomplete: Bool = false,
preinstalled: Bool = false,
compatible: Bool = true,
hasUpdate: Bool = false,
updateStatus: PackageUpdateStatus
)
Parameters
Properties
var name
Localized name of the package.
var installed
Installation sign - true if the package has been selected for installation.
var incomplete
Sign of incomplete installation - true if there is no fully downloaded version of the package (possibly incompatible with the current SDK version).
var preinstalled
Sign of preinstalled packages. Preinstalled packages are always installed and fully loaded, and cannot be removed.
var compatible
Compatibility sign - true in case the downloaded package is compatible with the current SDK version.
var hasUpdate
Update availability sign is true in case there is an update for the downloaded package. It is possible situation, when during update process to new version even newer version of the package became available on the server. In this case the value will be true both during and after the upgrade.
var updateStatus
Package upgrade status.
Padding
Padding the edges of the camera.
ParkingCapacity
Parking capacity.
public init(
total: String?,
specialSpaces: [SpecialSpace]
)
Parameters
Properties
var total
Total parking capacity, parking spaces.
var specialSpaces
Description of special parking spaces.
ParkingInfo
General information about the parking lot.
public init(
type: ParkingType?,
purpose: ParkingPurpose,
access: ParkingAccess,
pavingType: ParkingPavingType?,
isPaid: Bool,
isIncentive: Bool,
forTrucks: Bool,
levelCount: UInt16?,
capacity: ParkingCapacity?
)
Parameters
type
purpose
access
pavingType
isPaid
isIncentive
forTrucks
levelCount
capacity
Properties
var type
Type.
var purpose
Value.
var access
Access type.
var pavingType
Coverage type.
var isPaid
Whether the parking lot is a paid parking lot.
var isIncentive
Whether the parking lot is intercepting.
var forTrucks
Are there spaces for trucks.
var levelCount
Number of levels.
var capacity
Capacity.
PedestrianBriefRouteInfo
Basic information about the walking route.
Properties
PedestrianInstructionCrossroad
Description of maneuvers when passing through an intersection or crosswalk.
public init(
landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.`none`,
maneuvers: [PedestrianInstructionCrossroadManeuver]
)
Parameters
Properties
var landmark
var maneuvers
Chain of sequential maneuvers.
PedestrianInstructionCrossroadManeuver
public init(
direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.straight,
turnAngle: Int32 = 0
)
Parameters
Properties
var direction
Direction of travel.
var turnAngle
Int32
Turning angle in degrees [-180, 180].
PedestrianInstructionFinish
End of the pedestrian part of the route.
public init()
PedestrianInstructionIndoorEnter
Entrance to the building.
Properties
var levelId
Floor ID after entering the building.
PedestrianInstructionIndoorExit
Building exit.
public init()
PedestrianInstructionIndoorFloorChange
Floor change in the building.
public init(
type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.undefined,
beginId: LevelId = LevelId(),
endId: LevelId = LevelId()
)
Parameters
Properties
var type
Floor change type.
var beginId
Floor ID before shift.
var endId
Floor ID after shift.
PedestrianInstructionStart
Starts of the walking part of the route.
public init()
PedestrianRouteSearchOptions
Pedestrian route search options.
public init(
avoidStairways: Bool = false,
useIndoor: Bool = true,
excludedAreas: [ExcludedArea] = []
)
Parameters
Properties
var avoidStairways
Avoid stairs.
var useIndoor
Build routes inside buildings.
var excludedAreas
Excluded areas (not more than 25).
PersonalDataCollectionOptions
Personal data collection and processing settings.
public init(personalDataCollectionConsent: PersonalDataCollectionConsent)
Parameters
personalDataCollectionConsent
Properties
let personalDataCollectionConsent
User choice regarding the collection and processing of personal data.
static let `default`
Default settings. Permission to collect and process personal data has been granted.
PlatformPositioningServicesFactory
Implementation of CLLocationManager-based geopositioning services.
Implements: IPositioningServicesFactory
public init(
locationManager: CLLocationManager = CLLocationManager()
)
Parameters
locationManager
Properties
let locationProvider
Geopositioning source interface. If `nil`, SDK geopositioning functions are not available.
let magneticHeadingProvider
Magnetic orientation source interface. If `nil`, the SDK magnetic orientation functions are not available.
PolygonOptions
Polygon parameters.
public init(
contours: [[GeoPoint]],
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value: 0),
strokeColor: Color = Color(),
visible: Bool = true,
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
levelId: LevelId? = nil
)
Parameters
contours
color
strokeWidth
strokeColor
visible
zIndex
levelId
Properties
var contours
var color
var strokeWidth
var strokeColor
var visible
var userData
Any
var zIndex
Object drawing level.
var levelId
Binding to the floor plan of the building.
PolylineOptions
Polyline parameters.
public init(
points: [GeoPoint],
width: LogicalPixel = LogicalPixel(value: 1),
color: Color = Color(),
erasedPart: Double = 0,
dashedPolylineOptions: DashedPolylineOptions? = nil,
gradientPolylineOptions: GradientPolylineOptions? = nil,
visible: Bool = true,
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
levelId: LevelId? = nil
)
Parameters
points
width
color
erasedPart
dashedPolylineOptions
gradientPolylineOptions
visible
zIndex
levelId
Properties
var points
Polyline points.
var width
Polyline width.
var color
Main color of the polyline.
var erasedPart
Proportion of erased part of the polyline, must be in the [0; 1] range.
var dashedPolylineOptions
Dashed polyline options.<br/>Dashed gradient line is not currently supported, so if both dashed_polyline_options and gradient_polyline_options are present in PolylineOptions, the dashed_polyline_options will be ignored when creating a polyline.
var gradientPolylineOptions
Gradient polyline options.<br/>Dashed gradient line is not currently supported, so if both dashed_polyline_options and gradient_polyline_options are present in PolylineOptions, the dashed_polyline_options will be ignored when creating a polyline.
var visible
Visibility of a polyline.
var userData
Any
User data.
var zIndex
Object drawing level.
var levelId
Binding to the floor plan of the building.
PublicBriefRouteInfo
Basic information about the route on public transportation.
public init(
publicTransportInfos: [PublicBriefRouteTransportInfo]
)
Parameters
publicTransportInfos
Properties
var publicTransportInfos
Description of route options on public transportation.
PublicBriefRouteTransportInfo
Description of the means of public transportation.
public init(
type: PublicTransportType = PublicTransportType.bus,
names: [String],
color: UInt32?,
routeLogo: String
)
Parameters
Properties
var type
Type of public transport vehicle.
var names
Names of the used public transport routes.
var color
ARGB representation of the color associated with a given public transport mode, such as the color of a subway line. If there is no information about the color, the field will be nil.
var routeLogo
Icon identifier for route stops. An empty string if no information is available. Technical field.
PublicRoutePart
Description of the section of the route on public transportation.
public init(
transports: [PublicTransportInfo],
intermediateStops: [PublicTransportStop]
)
Parameters
Properties
var transports
Types of public transport that can be used to travel this section of the route.<br/>If the list is empty, this route section is suggested to be traveled by private or rented transport or on foot.
var intermediateStops
Intermediate stops that transport will pass before reaching the transfer point.
PublicTransportInfo
Description of the means of public transportation.
Properties
var type
Type of public transport vehicle.
var names
Names of the used public transport routes.
var suggestedCarNumbers
Car numbers in that boarding recommended.<br/>If a vehicle consists of a single car or one can board any car, this list will be empty.
var boardingSuggest
Text description of the cars in which boarding is recommended.
var color
ARGB representation of the color associated with a given public transport mode, such as the color of a subway line. If there is no information about the color, the field will be nil.
var routeLogo
Icon identifier for route stops. An empty string if no information is available. Technical field.
PublicTransportRouteSearchOptions
Route search options on public transport.
public init(
startTime: Date? = nil,
useSchedule: Bool = false,
transportTypes: PublicTransportTypeOptionSet = []
)
Parameters
Properties
var startTime
Date?
Time in UTC for which the route is to be plotted. If not specified, the current time is used.
var useSchedule
Public transport schedules are taken into account when constructing the route.
var transportTypes
Types of public transport. If not filled in, routes will be built for all supported public transport types.
PublicTransportStop
Description of the public transport stop.
PublicTransportTransfer
Description of the way to get by public transport to the next transfer point.
public init(
startPointName: String,
finishPointName: String,
routeParts: [PublicRoutePart]
)
Parameters
Properties
var startPointName
Name of the point from which the movement starts for this section of the route.
var finishPointName
Name of the destination point for this section of the route.
var routeParts
Description of the route section on public transport to get to the next transfer point.
PublicTransportTransferRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: PublicTransportTransfer
)
Parameters
Properties
PublicTransportTypeOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let bus
static let trolleybus
Trolleybus.
static let tram
static let shuttleBus
Shuttle bus.
static let metro
Subway.
static let suburbanTrain
Suburban train.
static let funicularRailway
Funicular.
static let monorail
Monorail.
static let waterwayTransport
Water transport.
static let cableCar
Cable car.
static let speedTram
High-speed tram.
static let premetro
Underground tram.
static let lightMetro
Light metro.
static let aeroexpress
Aeroexpress.
static let moscowCentralRing
Moscow Central Ring.
static let moscowCentralDiameters
Moscow Central Diameters.
RangeFilter
Filter of value ranges.
RenderedObject
Displayed map object.
RenderedObjectInfo
Detailed information about the displayed map object.
public init(
closestViewportPoint: ScreenPoint,
closestMapPoint: GeoPointWithElevation,
item: RenderedObject
)
Parameters
Properties
var closestViewportPoint
Nearest object point in the screen coordinates.
var closestMapPoint
Nearest point of the object in map coordinates.
var item
Displayed object on the map.
Reviews
Reviews.
Properties
RoadCameraInfo
Camera information.
public init(
purposes: CameraPurposeOptionSet,
speedLimit: UInt16?
)
Parameters
Properties
var purposes
Camera purpose.<br/>May be missing if there is no information, or if the camera was added by a user.
var speedLimit
Speed limit in km/h.
RoadEventActionInfo
Action information.
public init(
state: RoadEventActionState,
count: UInt32?
)
Parameters
Properties
var state
Action state.
var count
Number of actions applied to the event by all users (for custom events only).
RoadEventCardViewOptions
Traffic event card settings.
public init(
timeFormattingStrategy: TimeFormattingStrategy = .default
)
Settings constructor.
Parameters
timeFormattingStrategy
Method of formatting date/time.
Properties
var timeFormattingStrategy
static var `default`
Default traffic event card settings.
RoadEventDisplayCategoryOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let camera
Cameras of all types, including those added by the user.
static let comment
Comments on the roads.
static let accident
Traffic accident.
static let roadRestriction
Road closures.
static let roadWorks
Road works.
static let other
Events in the Other category.
static let user
Always displays events created by the current user, regardless of their category.
RoadEventRouteEntry
Route element - a point and a value in it.
Properties
RoadRuleRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadRule
)
Parameters
Properties
RoadSubtypeRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadSubtype
)
Parameters
Properties
RoadSurfaceRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadSurface
)
Parameters
Properties
RoadTypeRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadType
)
Parameters
Properties
RouteBuildOptions
The structure that describes the route building parameters in the navigator.
public init(
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions
)
Parameters
Properties
var finishPoint
The point to which the route is built.
var routeSearchOptions
Route search parameters.
RouteCamera
Structure describing the traffic camera.
public init(
purposes: RouteCameraPurposeOptionSet,
rangeAgainst: RouteDistance,
rangeAlong: RouteDistance,
direction: RouteCameraDirection
)
Parameters
purposes
rangeAgainst
rangeAlong
direction
Properties
var purposes
Camera purposes.
var rangeAgainst
Range of camera action against the motion.
var rangeAlong
Range of the camera against the motion.
var direction
Direction of camera action.
RouteCameraPurposeOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let speedControl
Recording of exceeding the speed limit.
static let trafficLightsControl
Recording of passing at the forbidden signal of traffic lights.
static let stopLineControl
Recording of driving over the stop line, driving without stopping the stop sign, driving to the intersection during a jam.
static let publicTransportLaneControl
Recording of movement on the dedicated lane for public transport.
static let oncomingTrafficLaneControl
Recording driving in the oncoming lane.
static let pedestrianAdvantageControl
Recording of failure to give preference to pedestrians.
static let laneDisciplineControl
Recording of violation of lane rotation at the intersection.
static let roadMarkingsCrossingControl
Recording of crossing the solid line of road markings, driving on the side of the road.
static let averageSpeedControl
Recording of exceeding the average speed on the section.
static let noStoppingControl
Recording of violation of prohibition of stopping.
static let dummy
Fake item.
static let platon
Platon” system camera: https://platon.ru/en/about/.
RouteDistance
Distance along the route.
public init(
millimeters: Int64 = 0
)
Parameters
millimeters
Int64
Properties
var millimeters
Int64
RouteEditorRouteParams
Route parameter information.
public init(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: [RouteSearchPoint] = []
)
Parameters
startPoint
finishPoint
routeSearchOptions
intermediatePoints
Properties
var startPoint
var finishPoint
var routeSearchOptions
var intermediatePoints
RouteEditorRoutesInfo
Information about the routes the editor operates on.
public init(
routes: [TrafficRoute],
routeParams: RouteEditorRouteParams
)
Parameters
Properties
var routes
When the route list is updated, the first route will be active if the route list is not empty.
var routeParams
Route parameters for which the search was performed. Can be different from the parameters passed to the editor, if routes were found already after the parameters were changed in the editor.
RouteExitSign
Exit sign information.
public init(
type: RouteExitSignType = RouteExitSignType.undefined,
roadNameTable: RouteExitSignTable,
roadNumberTable: RouteExitSignTable?
)
Parameters
Properties
var type
Exit type.
var roadNameTable
Exit sign with the road name.
var roadNumberTable
Exit sign with the road number.
RouteExitSignRouteEntry
Route element - a point and a value in it.
Properties
RouteExitSignTable
Exit sign information.
public init(
backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.undefined,
text: String
)
Parameters
Properties
var backgroundColor
Background color of an exit sign.
var text
Exit sign text.
RouteIndex
RouteInfo
Route description with maneuvers.
public init(
route: Route,
routeBuildOptions: RouteBuildOptions?
)
Parameters
Properties
var route
Route.
var routeBuildOptions
Route construction parameters in the navigator. The `nil` value means that the route has no finish point. In this case, a section of road, which is supposedly used by the user, is calculated based on the road graph and parameters of the user's movement and is returned as a route in the route field. Consequently, this route cannot contain instructions, and the last point in this route is not the destination point to which the user is moving, but simply the point to which the user's movement was predicted. It is not known where the user will go next. This mode of the navigator operation is called a mode of guidance without a route or free roam.
RouteInstruction
The instruction that must be executed to drive the route.
public init(
roadName: String,
range: RouteDistance,
extraInstructionInfo: ExtraInstructionInfo
)
Parameters
Properties
var roadName
Name of the road on which the user will end up after performing the maneuver.
var range
Distance after the instruction point, during which the user is considered to be in the instruction coverage area.
var extraInstructionInfo
Specific information for a particular type of instruction.
RouteLane
Structure describing a single lane.
public init(
routeManeuver: RouteLaneManeuver = RouteLaneManeuver.undefined,
maneuvers: RouteLaneManeuverOptionSet,
speedLimit: Float = 0,
prohibited: Bool = false,
onlyPublicTransport: Bool = false
)
Parameters
routeManeuver
maneuvers
speedLimit
Float
prohibited
onlyPublicTransport
Properties
var routeManeuver
Maneuver to be performed to move along the route.
var maneuvers
Allowed maneuvers to be made in the lane.
var speedLimit
Float
Maximum permitted speed on the lane is m/s. 0 - speed limit is unknown.
var prohibited
No passing in the lane.
var onlyPublicTransport
Public transportation lane.
RouteLaneManeuverOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let undefined
Not set.
static let forward
Straight ahead.
static let right
To the right.
static let left
To the left.
static let slightlyRight
Slightly to the right.
static let slightlyLeft
Slightly to the left.
static let sharplyRight
Sharply to the right.
static let sharplyLeft
Sharply to the left.
static let rightWithLeftTurns
To the right, then to the left.
static let turnover
U-turn.
RouteLaneSign
Description of the lanes.
public init(
lanes: [RouteLane],
signStartPoint: RoutePoint?,
signPoint: RoutePoint?,
signEndPoint: RoutePoint?
)
Parameters
Properties
var lanes
Lanes for cars on a road section. Listed in order from the edge to the middle of the roadway.<br/>If the number of lanes is unknown or there is only one lane on the road in the direction of the route, this array is empty.
var signStartPoint
Point on the route at which the lane traffic sign starts. nil if the starting position of the sign is unknown.
var signPoint
Point on the route at which the lane control sign begins. nil if the position of the sign is unknown.
var signEndPoint
Point on the route at which the lane control sign ends. nil if the end position of the sign is unknown.
RouteLevelInfo
Building floor information corresponding to the route section.
Properties
var beginId
Floor plan ID at the starting point of the route section. Not present if the point is not in a building.
var endId
Floor plan ID at the end point of the route section. Not present if the point is not in a building.
var name
Floor name. Empty if the route section connects different floors.
RouteLevelInfoRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RouteLevelInfo
)
Parameters
Properties
RouteMapObjectCalloutLabelFlagOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let duration
Time of travel along the route.
static let length
Route length.
RouteMapObjectDisplayFlagOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let routeParts
Route segments.
static let startPoint
Starting point of the route.
static let finishPoint
Finish point of the route.
static let intermediatePoints
Intermediate waypoints.
static let 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.
static let maneuvers
Maneuvers.
static let cameras
static let humps
Artificial bumps.
static let barriers
Road closures.
static let gates
Gates, barriers.
static let stairways
static let publicTransportPlatforms
Public transport stops.
static let accidents
Traffic accident.
static let roadWorks
Road works.
static let comments
Comments.
static let roadRestrictions
Traffic closures.
static let otherEvents
Other" events.
static let tollRoads
Start and end of toll road.
static let lanesBubbles
Lane bubbles (displayed only in source with navigation mode).
static let bubbles
Lane bubbles with travel time and route length.
static let indoorInstructions
Instructions in buildings. Move by elevator, escalator, etc.
static let inactiveFloors
Shows parts of the route inside buildings not just for the active floor.
RouteMapObjectPermanentDisplayFlagOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
The corresponding value of the raw type.
static let startPoint
Starting point of the route.
static let finishPoint
Finish point of the route.
static let intermediatePoints
Intermediate waypoints.
static let cameras
static let accidents
Traffic accident.
static let roadWorks
Road works.
static let comments
static let roadRestrictions
Traffic closures.
static let otherEvents
Other" events.
static let tollRoads
Start and finish of toll road.
RoutePoint
Point on the route, set as the distance along the route relative to the start of the route.
Properties
var distance
RouteSearchPoint
Description of the points on which the route is built.
public init(
coordinates: GeoPoint,
course: Bearing? = nil,
objectId: DgisObjectId = DgisObjectId(objectId: 0, entranceId: 0),
levelId: LevelId? = nil
)
Parameters
Properties
var coordinates
Coordinates through which to route.
var course
Direction in which to traverse the point.
var objectId
ID of the object to which the walking part of the route will be traversed.
var levelId
Identifier of the floor plan (for pedestrian routes).
RubricId
Schedule
Road event action schedule.
public init(
startTime: Date?,
finishTime: Date?,
weekTimeIntervals: [WeekTimeInterval]
)
Parameters
Properties
var startTime
Date?
Start time of action. None if unknown.
var finishTime
Date?
Start time of action. None if unknown.
var weekTimeIntervals
Intervals of operation within the week.
ScooterBriefRouteInfo
Basic route information on the scooter.
Properties
ScooterInstructionCrossroad
Description of maneuvers when passing through an intersection or crosswalk.
public init(
landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.`none`,
maneuvers: [ScooterInstructionCrossroadManeuver]
)
Parameters
Properties
var landmark
Landmark.
var maneuvers
Chain of sequential maneuvers.
ScooterInstructionCrossroadManeuver
public init(
direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.straight,
turnAngle: Int32 = 0
)
Parameters
Properties
var direction
Direction of travel.
var turnAngle
Int32
Turning angle in degrees [-180, 180].
ScooterInstructionFinish
End of the scooter part of the route.
public init()
ScooterInstructionStart
Start of the scooter part of the route.
public init()
ScooterRouteSearchOptions
Search parameters for scooter routes.
public init(
avoidCarRoads: Bool = true,
avoidStairways: Bool = true,
avoidUnderpassesAndOverpasses: Bool = true,
excludedAreas: [ExcludedArea] = []
)
Parameters
Properties
var avoidCarRoads
Avoid roads.
var avoidStairways
Avoid stairs.
var avoidUnderpassesAndOverpasses
Avoid underpasses and overpasses.
var excludedAreas
Excluded areas (not more than 25).
ScreenDistance
Distance between objects on the screen in millimeters.<br/>Cannot be negative.
public init(
value: Float = 0
)
Parameters
value
Float
Properties
var value
Float
ScreenPoint
Point in screen coordinates.
public init(
x: Float = 0,
y: Float = 0
)
Parameters
x
Float
y
Float
Properties
var x
Float
var y
Float
ScreenShift
Horizontal and vertical displacement of the map in the coordinates space of the screen.
public init(
dx: Float = 0,
dy: Float = 0
)
Parameters
dx
Float
dy
Float
Properties
var dx
Float
var dy
Float
ScreenSize
Size in pixels.
SDKError
Implements: ISDKError
SegmentGeoPoint
Describes a geographic point on the segment and the direction of the segment. The route geometry is a sequence of points that form segments in pairs. For all functions working with the route geometry, it is considered that the first point of the pair forming the segment is included in this segment, and the second one is 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 of the route belongs to exactly one segment. The direction of point_last is not defined.
SettlementRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: Settlement
)
Parameters
Properties
SimpleClusterOptions
Parameters of the cluster marker simple marker objects.
public init(
icon: Image?,
iconMapDirection: MapDirection? = nil,
anchor: Anchor = Anchor(x: 0.5, y: 0.5),
text: String? = nil,
textStyle: TextStyle? = nil,
iconOpacity: Opacity = Opacity(value: 1),
iconWidth: LogicalPixel = LogicalPixel(value: 0),
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
animatedAppearance: Bool = true,
iconAnimationMode: AnimationMode = AnimationMode.normal
)
Parameters
icon
iconMapDirection
anchor
text
textStyle
iconOpacity
iconWidth
zIndex
animatedAppearance
iconAnimationMode
Properties
var icon
var iconMapDirection
var anchor
var text
var textStyle
var iconOpacity
var iconWidth
Target width used for scaling.
var userData
Any
var zIndex
Object drawing level.
var animatedAppearance
Whether to animate the appearance.
var iconAnimationMode
Animation mode.
SimpleError
public static func == (lhs: SimpleError, rhs: SimpleError) -> Bool
Returns a Boolean value indicating whether two values are equal.
SimulationAutoWithOverSpeed
Structure for setting the mode of driving taking into account the maximum speed on the route edge.
Properties
var overSpeed
Used exceeding of the speed limit in m/s. Only values >= 0 are acceptable.
SimulationConstantSpeed
Structure for setting the mode of driving with constant speed.
Properties
var speed
Travel speed in m/s. Only values >= 0 are acceptable.
SoundCategoryOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Parameters
rawValue
Raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.
Properties
var rawValue
Corresponding value of the raw type.
static let crossroadCameras
Intersection control cameras.
static let laneCameras
Cameras recording traffic in the dedicated lane for public transport.
static let noStoppingControlCameras
Stop control cameras.
static let roadMarkingCameras
Traffic lane cameras.
static let averageSpeedCameras
Average speed cameras.
static let maxSpeedCameras
Instant speed cameras.
static let accidents
Accidents.
static let roadWorks
Road works.
static let tolls
Toll roads.
static let exceedSpeedLimits
Violations of maximum permitted speed.
static let intermediatePoints
Intermediate points on the route.
static let routeRebuild
Route is rebuilt.
static let instructions
Instructions (maneuvers) on route.
static let obstacles
Obstacles.
static let roadSubtypes
Road subtypes.
static let lostLocation
Lost GPS signal.
static let routeEnd
Route completion.
SpecialSpace
Special parking space.
public init(
type: SpecialSpaceType,
name: String,
count: String?
)
Parameters
Properties
var type
Type.
var name
Localized name of a special place.
var count
Number of spaces of this type in the parking lot.
SpeedRange
Speed interval. Speeds are specified in meters per second.
SpeedRangeToStyleZoom
Matching speed interval and style zoom.
public init(
range: SpeedRange,
minDistanceToManeuver: RouteDistance,
maxDistanceToManeuver: RouteDistance,
styleZoom: StyleZoom
)
Parameters
range
minDistanceToManeuver
maxDistanceToManeuver
styleZoom
Properties
var range
Speed interval.
var minDistanceToManeuver
Minimum distance to the maneuver at which the smooth zoom level logic should be activated.
var maxDistanceToManeuver
Maximum distance after the maneuver at which the smooth zoom level reduction should end.
var styleZoom
Style zoom.
StringRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: String
)
Parameters
Properties
StyleLayerId
StyleZoom
Style zoom level.<br/>Cannot be negative.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
Value to create.
Properties
var value
Float
TaxiRouteSearchOptions
Parameters for route search by taxi.
Properties
var car
Route search parameters common to other car routes.
TextStyle
Text appearance settings.
public init(
fontSize: LogicalPixel = LogicalPixel(value: 8),
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value: 0.3499999940395355),
strokeColor: Color = Color(argb: 4294967295),
textPlacement: TextPlacement = TextPlacement.bottomCenter,
textOffset: LogicalPixel = LogicalPixel(value: 0),
fontName: String? = nil
)
Parameters
fontSize
color
strokeWidth
strokeColor
textPlacement
textOffset
fontName
Properties
var fontSize
var color
var strokeWidth
var strokeColor
var textPlacement
var textOffset
var fontName
Theme
Specifies a theme within some style (see `Style`).
public init(stringLiteral value: String)
Creates an instance initialized to the given string value.
Parameters
value
Value of the new instance.
Properties
var description
Textual representation of this instance.
Tilt
Tilt angle in degrees, where 0 is nadir (looking vertically down), 90 is front horizon.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
Value to create.
Properties
var value
Float
TradeLicense
License of the organization.
TrafficControlState
State of the traffic control.
public init(
status: TrafficControlStatus = TrafficControlStatus.hidden,
score: UInt32?
)
Parameters
Properties
var status
Status, depending on which changes the appearance of the control.
var score
Traffic score. Displayed as an inscription on the control. If absent, a blank icon is displayed.
TrafficScore
Traffic rate.
public init(
state: TrafficScoreState = TrafficScoreState.pending,
value: UInt32?
)
Parameters
Properties
var state
Value relevance.
var value
Value in points. Typically values are in the range of 1 to 10. Blank value if the information is not yet received, or is already out of date, or is not available for the given location.
TrafficSpeedColorRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: TrafficSpeedColor
)
Parameters
Properties
TransportTypeRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: TransportType
)
Parameters
Properties
TruckPassZoneId
Identifier of the pass zone for trucks. The value 0 corresponds to the absence of the pass zone.
Properties
var value
TruckPassZoneIdRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: TruckPassZoneId
)
Parameters
Properties
TruckPassZonePass
Pass allowing truck traffic in the pass zones.
public init(
id: TruckPassZonePassId,
name: String,
passZoneIds: Set<TruckPassZoneId>
)
Parameters
Properties
var id
Skip ID.
var name
Skip name.
var passZoneIds
Set<TruckPassZoneId>
IDs of the pass zones that can be accessed with this pass.
TruckPassZonePassId
TruckRouteSearchOptions
Truck route search parameters. Only filled parameters are taken into account when searching a route.
public init(
car: CarRouteSearchOptions,
truckLength: UInt32? = nil,
truckHeight: UInt32? = nil,
truckWidth: UInt32? = nil,
actualMass: UInt32? = nil,
maxPermittedMass: UInt32? = nil,
axleLoad: UInt32? = nil,
dangerousCargo: Bool = false,
explosiveCargo: Bool = false,
passIds: Set<TruckPassZonePassId> = [],
fallbackOnCar: Bool = false
)
Parameters
Properties
var car
Route search parameters common to other car routes.
var truckLength
Length of cargo vehicle in millimeters.
var truckHeight
Cargo vehicle height in millimeters.
var truckWidth
Cargo vehicle width in millimeters.
var actualMass
Actual weight of cargo vehicle in kilograms.
var maxPermittedMass
Permissible maximum weight of cargo vehicle in kilograms.
var axleLoad
Axle load in kilograms.
var dangerousCargo
Dangerous cargo indication.
var explosiveCargo
Indication of the presence of explosives in cargo.
var passIds
Set<TruckPassZonePassId>
Identifiers of the user's existing passes required to move within the pass zones.
var fallbackOnCar
Use of automatic fallback from cargo route search to vehicle route search when unable to find a cargo route that satisfies the search parameters.
UIMarkerInfo
ID of an object with caption.
Properties
UIntRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: UInt32
)
Parameters
Properties
UnavailablePositioningServicesFactory
Implementation of geopositioning services that disables access to these functions.
Implements: IPositioningServicesFactory
public init()
Properties
let locationProvider
Geopositioning source interface. If `nil`, SDK geopositioning functions are not available.
let magneticHeadingProvider
Magnetic orientation source interface. If `nil`, the SDK magnetic orientation functions are not available.
VendorConfigOptions
2GIS SDK settings for working in standalone configurations.
Properties
let vendorConfigFile
File with settings overrides.
WeekTime
Timestamp within a week.
public static func < (lhs: WeekTime, rhs: WeekTime) -> Bool
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
WeekTimeInterval
Time interval during the week.
WorkStatus
Operating status.
ZIndex
Index that sets the order in which objects are rendered within a layer.
Properties
var value
Zoom
Zoom level.<br/>Cannot be negative.
public init(
value: Float = 0
)
Parameters
value
Float
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Float
Value to create.
Properties
var value
Float