Skip to main content

struct

Address​

Address as a set of individual components.
public init(
    drillDown: [AddressAdmDiv],
    components: [AddressComponent],
    buildingName: String?,
    buildingId: BuildingId?,
    postCode: String?,
    buildingCode: String?,
    fiasCode: String?,
    addressComment: String?
)
Parameters
drillDown
components
buildingName
buildingId
postCode
buildingCode
fiasCode
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 buildingId
Unique identifier of the building.
var postCode
ZIP code.
var buildingCode
The unique ZIP code of the building.
var fiasCode
FIAS code of the building.
var addressComment
Address comment. Example: “office 301; floor 9”.

AddressAdmDiv​

Administrative unit object.
public init(
    type: String,
    name: String
)
Parameters
type
name
Properties
var type
Type of administrative unit. One of the following:
var name

AddressLocation​

Applies to components that are hard to describe with a specific address.
public init(
    comment: String
)
Parameters
comment
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).
public init(
    number: String,
    fiasCode: String?
)
Parameters
number
fiasCode
Properties
var number
Building number, including fractions and letters. Possibly a proper name, if that is the custom.
var fiasCode
FIAS street code.

AddressStreet​

Normal address, there is a street and house number.
public init(
    street: String,
    number: String,
    fiasCode: String?
)
Parameters
street
number
fiasCode
Properties
var street
Street name.
var number
Building number, including fractions, cases, and letters.
var fiasCode
FIAS street code.

Aggregate​

EV charging station description.
public init(
    connectorsFree: UInt16,
    connectorsTotal: UInt16,
    isActive: Bool,
    isBusy: Bool,
    power: UInt16
)
Parameters
connectorsFree
connectorsTotal
isActive
isBusy
power
Properties
var connectorsFree
Number of available connectors (in the `Available` status).
var connectorsTotal
Total number of connectors, except for connectors in the `Unavailable` status.
var isActive
Shows whether connectors are active. `true` if there is at least one available (in the `Available` status), reserved (`Reserved`), or busy (`Charging`) connector.
var isBusy
Shows whether connectors are busy. `true` if half or more of the connectors are busy (in the `Charging` status).
var power
The maximum power of the connector at the station.

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.
public init(
    start: String,
    end: String? = nil
)
Parameters
start
end
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.

Attribute​

Additional attribute. Example: { tag: “hotel_room_internet”, name: “Free internet in the rooms” }.
public init(
    tag: String,
    value: String
)
Parameters
tag
value
Properties
var tag
Tag.
var value
Value.

AuthorInfo​

Information about the author of the event or photo.
public init(
    type: AuthorType,
    name: String
)
Parameters
type
name
Properties
var type
Content author category.
var name
String containing the name of the user who added the event or photo.

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(
    value: Double = 0
)
Parameters
value
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
trafficRoute
startPoint
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.
public init(
    length: RouteDistance,
    landmark: String
)
Parameters
length
landmark
Properties
var length
Route length.
var landmark
Landmark.

BicycleInstructionCrossroad​

Description of maneuvers when passing through an intersection or crosswalk.
public init(
    landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.`none`,
    maneuvers: [BicycleInstructionCrossroadManeuver]
)
Parameters
landmark
maneuvers
Properties
var landmark
Landmark.
var maneuvers
Chain of sequential maneuvers.

BicycleInstructionCrossroadManeuver​

public init(
    direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.straight,
    turnAngle: Int32 = 0
)
Parameters
direction
turnAngle
Int32
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
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
excludedAreas
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
point
length
value
Properties
var point
var length
var value

Borders​

Describes a continuous set of sorted values.
public init(
    snapping: Double?,
    isLg: Bool,
    value: String,
    min: Double,
    max: Double,
    currentMin: Double? = nil,
    currentMax: Double? = nil
)
Parameters
snapping
isLg
value
min
max
currentMin
currentMax
Properties
var snapping
Defines snapping to the value multiple of this number.
var isLg
Indication of using the logarithmic scale.
var value
Value by which filtering is done.
var min
Lower bound of the values set.
var max
Upper bound of the values set.
var currentMin
Currently set minimum value.
var currentMax
Currently set maximum value.

BriefRoadEvent​

public init(
    id: UInt64 = 0,
    eventType: RoadEventType = RoadEventType.other,
    lanes: LaneOptionSet
)
Parameters
id
eventType
lanes
Properties
var id
var eventType
var lanes

BriefRouteInfo​

Basic route information.
public init(
    duration: TimeInterval,
    extraInfo: BriefExtraRouteInfo
)
Parameters
duration
TimeInterval
extraInfo
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
startPoint
finishPoint
Properties
var startPoint
Starting point of the route.
var finishPoint
Finish point of the route.

BuildingId​

Building ID.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

BuildingInfo​

Information about building.
public init(
    buildingName: String? = nil,
    purposeName: String? = nil,
    purposeCode: PurposeCode? = nil,
    buildingLevels: BuildingLevels? = nil,
    buildingId: BuildingId?
)
Parameters
buildingName
purposeName
purposeCode
buildingLevels
buildingId
Properties
var buildingName
Name of the building.
var purposeName
Description of the purpose of the building.
var purposeCode
Code of the purpose of the building.
var buildingLevels
Information about floor plans of the building.
var buildingId
Unique identifier of the building.

BuildingLevels​

Information about the floor plans of the building. To get this information, please request additional key setup.
public init(
    defaultLevelId: LevelId,
    levels: [LevelInfo]
)
Parameters
defaultLevelId
levels
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
mapId
calloutPosition
routePoint
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?,
    tilt: FollowTilt = FollowTilt.off
)
Parameters
position
tilt
Properties
var position
var tilt

CameraBehaviourChange​

Changes tracking mode.
public init(
    newBehaviour: CameraBehaviour,
    changeReason: CameraBehaviourChangeReason = CameraBehaviourChangeReason.application
)
Parameters
newBehaviour
changeReason
Properties
var newBehaviour
New tracking mode.
var changeReason
Reason for changing tracking mode.

CameraPosition​

Camera position.
public init(
    point: GeoPoint,
    zoom: Zoom,
    tilt: Tilt = Tilt(value: 0),
    bearing: Bearing = Bearing(value: 0)
)
Parameters
point
zoom
tilt
bearing
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.

CameraPositionChange​

Changing specific parameters of camera position.
public init(
    point: GeoPoint? = nil,
    zoom: Zoom? = nil,
    tilt: Tilt? = nil,
    bearing: Bearing? = nil
)
Parameters
point
zoom
tilt
bearing
Properties
var point
var zoom
var tilt
var bearing

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
camera
position
progress
Float
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.
public init(
    point: RoutePoint,
    value: RouteCamera
)
Parameters
point
value
Properties
var point
var value

CameraViewPoint​

The relative position of the screen point with the camera viewpoint.
public init(
    x: Float = 0.5,
    y: Float = 0.5
)
Parameters
x
Float
y
Float
Properties
var x
Float
var y
Float

CameraZoomRestrictions​

Allowed range of zoom level variation.
public init(
    minZoom: Zoom = Zoom(value: 0),
    maxZoom: Zoom = Zoom(value: 20)
)
Parameters
minZoom
maxZoom
Properties
var minZoom
Minimum zoom level must be less than the maximum.
var maxZoom
Maximum zoom level is limited to a value of 20.

CarBriefRouteInfo​

Basic information about the automobile route.
public init(
    length: RouteDistance,
    landmark: String,
    trafficSpeed: CarBriefRouteInfoTrafficSpeed
)
Parameters
length
landmark
trafficSpeed
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
type
turnAngle
Int32
exitNumber
exitName
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.
public init(
    exitName: String
)
Parameters
exitName
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).

ChargingStation​

Attributes of EV charging stations.
public init(
    aggregate: Aggregate,
    connectors: [Connector]
)
Parameters
aggregate
connectors
Properties
var aggregate
var connectors

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(),
    dashedStrokeOptions: DashedStrokeCircleOptions? = nil,
    visible: Bool = true,
    userData: Any = (),
    zIndex: ZIndex = ZIndex(value: 0),
    levelId: LevelId? = nil
)
Parameters
position
radius
color
strokeWidth
strokeColor
dashedStrokeOptions
visible
zIndex
levelId
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 dashedStrokeOptions
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.
public init(
    argb: UInt32 = 4278190080
)
Parameters
argb
init(
	red: CGFloat,
	green: CGFloat,
	blue: CGFloat,
	alpha: CGFloat
)
Parameters
red
green
blue
alpha
init?(_ color: UIColor)
Parameters
color
Properties
var argb

CompassView​

UI control of the compass in SwiftUI.
Properties
var body
some View
Contents and behavior of the control.

Connector​

public init(
    power: UInt16,
    price: UInt16,
    status: StatusType,
    type: String
)
Parameters
power
price
status
type
Properties
var power
Charging power in kW.
var price
Cost per kWh.
var status
Status.
var type
Connector type.

ContactInfo​

Way to contact the organization.
public init(
    type: String,
    displayText: String,
    value: String,
    comment: String?
)
Parameters
type
displayText
value
comment
Properties
var type
Type of contact. One of the following:
var displayText
Value of the contact to display on the screen.
var value
Technical value of the contact. Depending on the type of contact, it has the following semantics:
var comment
Clarifying information about the contact.

CurrentLocationView​

Control of the current location in SwiftUI.
Properties
var body
some View
Contents and behavior of the control.

DashboardButtonSettings​

Settings for a button in the bottom panel of the NavigationView.
Properties
var enabled
Button visibility.
var icon
Icon. By default, the icon for adding road events is used.
var callback
(() -> ())?
Callback function that is called when a button is pressed. By default, the function for creating road events is set.
static var `default`
Default settings for a button in the bottom panel.

DashedPolylineOptions​

Parameters of the dotted polyline.
public init(
    dashLength: LogicalPixel = LogicalPixel(value: 5),
    dashSpaceLength: LogicalPixel = LogicalPixel(value: 2)
)
Parameters
dashLength
dashSpaceLength
Properties
var dashLength
Dotted line length.
var dashSpaceLength
Interdot length.

DashedStrokeCircleOptions​

public init(
    dashLength: LogicalPixel = LogicalPixel(value: 5),
    dashSpaceLength: LogicalPixel = LogicalPixel(value: 2)
)
Parameters
dashLength
dashSpaceLength
Properties
var dashLength
Dash length.
var dashSpaceLength
Length of the space between dashes.

DayTime​

Time moment within a day.
public init(
    hours: UInt8,
    minutes: UInt8
)
Parameters
hours
minutes
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.
Properties
var hours
Hours, 0-23.
var minutes
Minutes, 0-59.

DefaultRasterUrlTemplate​

public init(
    urlTemplate: String
)
Parameters
urlTemplate
Properties
var urlTemplate

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​

public init(
    objectId: UInt64 = 0,
    entranceId: UInt64 = 0
)
Parameters
objectId
entranceId
Properties
var objectId
Stable numeric object identifier.<br/>Zero identifier does not correspond to any object.
var entranceId
Stable numeric identifier of the entrance for object_id.<br/>Zero identifier means that the entrance is not set.

DirectoryFilter​

Filters for the directory.
public init(
    workTime: WorkTimeFilter?,
    dynamic: [DynamicFilter]
)
Parameters
workTime
dynamic
Properties
var workTime
Filter by operating time.
var dynamic
Dynamic filters.

DirectoryViewTheme​

Directory theme.
public init(colors: Colors, fonts: Fonts)
Parameters
colors
Colors
fonts
Fonts
public init(
	colors: Colors,
	searchResultItemViewTheme: SearchResultItemViewTheme
)
Parameters
colors
Colors
searchResultItemViewTheme
SearchResultItemViewTheme
Properties
let colors
DirectoryViewTheme.Colors
var searchResultItemViewTheme
DirectoryViewTheme.SearchResultItemViewTheme
static let `default`
Default directory theme.

DoubleRouteEntry​

Route element - a point and a value in it.
public init(
    point: RoutePoint,
    value: Double
)
Parameters
point
value
Properties
var point
var value

DynamicRouteInfo​

public init(
    roadEvents: RoadEventRouteAttribute,
    traffic: Traffic
)
Parameters
roadEvents
traffic
Properties
var roadEvents
var traffic

Elevation​

Non-negative elevation of the point above the surface, in meters.
public init(
    value: Float = 0
)
Parameters
value
Float
init(_ distance: CLLocationDistance)
Parameters
distance
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
entrancePoints
entrancePolylines
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?,
    entranceNumber: String?
)
Parameters
id
buildingNumber
porchName
porchNumber
apartmentRanges
geometry
entranceNumber
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.
var entranceNumber
Number of the station entrance. Contains information for an object of the `ObjectType.StationEntrance` type.

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
type
severity
extent
points
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.
public init(
    tagName: String,
    displayName: String,
    flagValue: Bool?
)
Parameters
tagName
displayName
flagValue
Properties
var tagName
Filter tag.
var displayName
Name of the filter to display.<br/>Depends on the output language. Not all names can be translated.
var flagValue
Flag value.

FloatRouteLongEntry​

Extended route element - a segment and a value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: Float
)
Parameters
point
length
value
Float
Properties
var point
var length
var value
Float

FloorInfo​

Information about the floor plan for the marker - element of the search output.
public init(
    levelId: LevelId,
    buildingId: BuildingId
)
Parameters
levelId
buildingId
Properties
var levelId
Floor plan identifier.
var buildingId
Building ID.

FollowPosition​

Tracking settings for direction, tilt, and zoom level.
public init(
    bearing: FollowBearing = FollowBearing.off,
    styleZoom: FollowStyleZoom = FollowStyleZoom.off
)
Parameters
bearing
styleZoom
Properties
var bearing
var styleZoom

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 bearing
static let tilt
static let styleZoom

FormattedAddress​

A human-readable representation of the address.
public init(
    drilldownAddress: String?,
    streetAddress: String?,
    addressComment: String?,
    postCode: String?
)
Parameters
drilldownAddress
streetAddress
addressComment
postCode
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).
public init(
    latitude: Latitude,
    longitude: Longitude
)
Parameters
latitude
longitude
init(latitude: CLLocationDegrees, longitude: CLLocationDegrees)
Parameters
latitude
longitude
init(coordinate: CLLocationCoordinate2D)
Parameters
coordinate
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
point
Returns
func distance(point: GeoPoint) -> Meter
Calculates the minimum distance (along a great circle) between two points.
Parameters
point
Returns
func move(bearing: Bearing, meter: Meter) -> GeoPoint
Calculates the point obtained by moving the source point in the specified direction by the specified distance.
Parameters
bearing
meter
Returns
Properties
var latitude
var longitude
var isValid

GeoPointRouteEntry​

Route element - a point and a value in it.
public init(
    point: RoutePoint,
    value: GeoPoint
)
Parameters
point
value
Properties
var point
var value

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
latitude
longitude
elevation
init(
	point: GeoPoint,
	elevation: Elevation = 0.0
)
Parameters
point
elevation
init(
	latitude: CLLocationDegrees,
	longitude: CLLocationDegrees,
	elevation: CLLocationDistance
)
Parameters
latitude
longitude
elevation
init(
	coordinate: CLLocationCoordinate2D,
	elevation: CLLocationDistance
)
Parameters
coordinate
elevation
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
point
Returns
func distance(point: GeoPoint) -> Meter
Calculates the minimum distance (along a great circle) between two points.
Parameters
point
Returns
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
bearing
meter
Returns
Properties
var latitude
var longitude
var elevation
var point

GeoRect​

Rectangular area in a spherical coordinate system (e.g. WGS84). This structure is not tied to a specific geodetic coordinate system.
public init(
    southWestPoint: GeoPoint,
    northEastPoint: GeoPoint
)
Parameters
southWestPoint
northEastPoint
Methods
func contains(
    rect2: GeoRect
) -> Bool
Parameters
rect2
Returns
func contains(
    point: GeoPoint
) -> Bool
Whether the rectangle contains the point. Points on the border are also considered to belong to the rectangle.
Parameters
point
Returns
func expand(
    rect2: GeoRect
) -> GeoRect
Parameters
rect2
Returns
func expand(
    point: GeoPoint
) -> GeoRect
Expands a rectangle. Return a minimum-sized rectangle containing the original rectangle and a point.
Parameters
point
Returns
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
rect2
Returns
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.

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.

GroupItem​

Element of a combined card that contains information about an object.
public init(
    id: DgisObjectId,
    type: ObjectType
)
Parameters
id
type
Properties
var id
Object indentifier.
var type
Object type.

HttpOptions​

HTTP client options.
public init(
    timeout: TimeInterval = 15,
    useCache: Bool = true,
    cacheStoragePath: String? = nil,
    cacheMaxSize: UInt64? = nil
)
Parameters
timeout
TimeInterval
useCache
cacheStoragePath
cacheMaxSize
Properties
var timeout
Timeout for HTTP requests.
var useCache
Use the HTTP cache.
var cacheStoragePath
Path to the root-level directory for the primary HTTP cache file storage. File storage will be located in the http_cache subdirectory of this directory. If the path is not specified, the default directory is used.
var cacheMaxSize
Maximum size of the HTTP cache in bytes. If not specified, the default maximum HTTP cache size is 300 Mb.

ImageData​

Image data: size, format, and binary data.
public init(
    size: ScreenSize,
    format: ImageFormat,
    data: Data
)
Parameters
size
format
data
Data
Properties
var size
var format
var data
Data

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.

IndoorView​

Ui control of floor switching in SwiftUI.
Properties
var body
some View
Contents and behavior of the control.

InstructionRouteEntry​

Route element - a point and a value in it.
public init(
    point: RoutePoint,
    value: RouteInstruction
)
Parameters
point
value
Properties
var point
var value

IntRouteEntry​

Route element - a point and a value in it.
public init(
    point: RoutePoint,
    value: Int32
)
Parameters
point
value
Int32
Properties
var point
var value
Int32

IsOpenNow​

Open now.
public init()

KeyFromAsset​

Key from an asset. For Android - assets directory. For iOS - Bundle.main directory.
public init(
    path: String
)
Parameters
path
Properties
var path
Path relative to the asset root directory.

KeyFromFile​

Key from a file.
public init(
    path: String
)
Parameters
path
Properties
var path
File path.

KeyFromString​

Key from a string.
public init(
    contents: String
)
Parameters
contents
Properties
var contents
Contents.

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
mapId
routePoint
geoPoint
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
point
length
value
Properties
var point
var length
var value

Latitude​

Geographic latitude.
public init(
    value: Double = 0
)
Parameters
value
static func + (lhs: Latitude, rhs: Latitude) -> Latitude
static func - (lhs: Latitude, rhs: Latitude) -> Latitude
static func * (lhs: Latitude, rhs: Double) -> Self
static func * (lhs: Double, rhs: Latitude) -> Self
static func / (lhs: Latitude, rhs: Double) -> Self
static func <= (lhs: Latitude, rhs: Latitude) -> Bool
static func >= (lhs: Latitude, rhs: Latitude) -> Bool
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Parameters
value
Value to create.
Properties
var value

LevelId​

Floor plan identifier.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

LevelInfo​

Building floor information.
public init(
    id: LevelId,
    name: String
)
Parameters
id
name
Properties
var id
Floor plan identifier.
var name
Floor name.

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(
    language: String,
    region: String
)
Parameters
language
region
Methods
static func makeLocale(
    localeStr: String
) -> Locale?
Creates a locale from a string representation in the LanguageTag or POSIX format.
Parameters
localeStr
Returns
func toLocalePosix() -> String
Returns
Properties
var language
Language code the follows the ISO 639-1 standard.
var region
Country code that follows the ISO 3166-1 standard.

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​

public init(
    value: GeoPoint,
    accuracy: Double
)
Parameters
value
accuracy
Properties
var value
var accuracy

LocationCourse​

public init(
    value: Bearing,
    accuracy: Bearing?
)
Parameters
value
accuracy
Properties
var value
var accuracy

LocationFuzzyDouble​

public init(
    value: Double,
    accuracy: Double?
)
Parameters
value
accuracy
Properties
var value
var accuracy

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.
public init(
    level: LogLevel,
    text: String,
    file: String,
    line: UInt32
)
Parameters
level
text
file
line
Properties
var level
Logging level.
var text
Message content.
var file
Path to the file (full or relative) from which the entry was made.
var line
Line number in which the message was recorded.

LogOptions​

SDK logging settings.
public init(
    systemLevel: LogLevel = LogLevel.warning,
    customLevel: LogLevel = LogLevel.warning,
    customSink: LogSink? = nil
)
Parameters
systemLevel
customLevel
customSink
Properties
var systemLevel
Level of logging to the system log.
var customLevel
Level of logging to the user log sink.
var customSink
Custom logging receiver.
static let `default`
Default settings. Warnings and more critical events are logged.

Longitude​

Geographic longitude.
public init(
    value: Double = 0
)
Parameters
value
static func + (lhs: Longitude, rhs: Longitude) -> Longitude
static func - (lhs: Longitude, rhs: Longitude) -> Longitude
static func * (lhs: Longitude, rhs: Double) -> Self
static func * (lhs: Double, rhs: Longitude) -> Self
static func / (lhs: Longitude, rhs: Double) -> Self
static func <= (lhs: Longitude, rhs: Longitude) -> Bool
static func >= (lhs: Longitude, rhs: Longitude) -> Bool
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.
public init(
    value: Double = 0
)
Parameters
value
Properties
var value

MapGestureViewFactory​

Default gesture processing factory.
Implements: IMapGestureViewFactory
public init(options: MapGestureViewOptions = .default)
Parameters
options
Methods
public func makeGestureView(
	map: Map,
	eventProcessor: IMapEventProcessor,
	coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureView
Creates a gesture handling layer.
Parameters
map
eventProcessor
coordinateSpace
Returns

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

MapMarkerView​

public init(
	viewModel: MapMarkerViewModel,
	content: AnyView,
	tapHandler: (() -> Void)? = nil
)
Parameters
viewModel
content
AnyView
public static func == (lhs: MapMarkerView, rhs: MapMarkerView) -> Bool
Returns a Boolean value indicating whether two values are equal.
Methods
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
Parameters
hasher
Hasher
The hasher to use when combining the components of this instance.
Properties
var tapHandler
(() -> ())?
var body
some View
The content and behavior of the view.

MapMarkerViewOverlay​

Methods
public func add(_ marker: MapMarkerView)
Parameters
marker
public func add(_ markers: [MapMarkerView])
Parameters
markers
public func remove(_ marker: MapMarkerView)
Parameters
marker
public func remove(_ markers: [MapMarkerView])
Parameters
markers
public func removeAll()
Properties
var body
some View
The content and behavior of the view.

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 graphicsPreset
Selects a graphic preset.
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.
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.

MapViewOverlay​

Protocol of the SwiftUI map layer.
Methods
func mapViewOverlayGestureView(_ view: (UIView & IMapGestureView)?) -> MapViewOverlay
Additional layer placed above the whole map surface. Used for intercepting gestures. If this layer is replaced with another one, you must also implement sending the map gestures via `IMapEventProcessor`. If the `nil` value is set, the built-in gesture handling is stopped.
Returns
func mapViewOverlayAppearance(_ value: MapAppearance) -> MapViewOverlay
Sets an active theme set of the current style and enables automatic theme switching depending on the environment. If `.automatic` is selected, the map switches to the selected theme depending on the current look (light or dark).
Parameters
value
Returns
func mapViewOverlayShowsAPIVersion(_ value: Bool) -> MapViewOverlay
Whether to show the API version in the copyright. Default value is `false`.
Parameters
value
Returns
func mapViewOverlayCopyrightAlignment(_ alignment: CopyrightAlignment) -> MapViewOverlay
Copyright location.
Parameters
alignment
Returns
func mapViewOverlayCopyrightInsets(_ insets: EdgeInsets) -> MapViewOverlay
Margin between the copyright and map borders. Default value is `.zero`. During positioning, `safeAreaInsets` of the map view are considered. Margin values cannot be negative.
Parameters
insets
EdgeInsets
Returns
func mapViewOverlayUrlOpener(_ url: ((URL) -> Void)?) -> MapViewOverlay
Custom handler of opening the URL when a user taps the copyright.<br/>Enables redefining the default behavior when following the link is done without user confirmation.
Returns
func mapViewOverlayObjectTappedCallback(callback: MapObjectTappedCallback) -> MapViewOverlay
Adds a callback function that is called after a click on the map.
Parameters
callback
Returns
func mapViewOverlayObjectLongPressCallback(callback: MapObjectTappedCallback) -> MapViewOverlay
Adds a callback function that is called after a long click on the map.
Parameters
callback
Returns
func mapViewOverlayRemoveObjectTappedCallback(callback: MapObjectTappedCallback) -> MapViewOverlay
Removes a callback function that is called after a click on the map.
Parameters
callback
Returns
func mapViewOverlayRemoveLongPressCallback(callback: MapObjectTappedCallback) -> MapViewOverlay
Removes a callback function that is called after a long click on the map.
Parameters
callback
Returns
Properties
var body
some View
Contents and behavior of the control.

MarkedUpText​

Span text.
public init(
    text: String,
    matchedParts: [MarkedUpTextSpan]
)
Parameters
text
matchedParts
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.
public init(
    offset: UInt64,
    length: UInt64
)
Parameters
offset
length
Properties
var offset
var length

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.
public init(formattedMeasurement: String, unit: String)
Parameters
formattedMeasurement
unit
Properties
let formattedMeasurement
Localized string representation of the measurement. For example: “40 km/h”.
let unit
Localized string representation of a unit of measurement. For example: “km/h”.

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.
public init(
    point: RoutePoint,
    value: TimeInterval
)
Parameters
point
value
TimeInterval
Properties
var point
var value

MiniMapView​

Properties
var body
some View
Content and behavior of the view.

ModelMapObjectOptions​

Model parameters.
public init(
    position: GeoPointWithElevation,
    data: ModelData?,
    size: ModelSize,
    mapDirection: MapDirection? = nil,
    opacity: Opacity = Opacity(value: 1),
    visible: Bool = true,
    userData: Any = (),
    levelId: LevelId? = nil
)
Parameters
position
data
size
mapDirection
opacity
visible
levelId
Properties
var position
Location.
var data
Data.
var size
Target width for scaling.
var mapDirection
Angle of the model rotation on the map relative to the north direction in degrees, counted clockwise.
var opacity
Opacity.
var visible
Visibility.
var userData
Any
User data.
var levelId
Binding to the floor plan of the building.

ModelScale​

Model scaling factor selected manually. Available values are from 0.0 to 64.0.
public init(
    value: Float = 0
)
Parameters
value
Float
Properties
var value
Float

MTLDeviceError​

Implements: ISDKError
public init(description: String)
Parameters
description
Properties
let description
Textual representation of this instance.
var debugDescription
Textual representation of this instance, suitable for debugging.

MyLocationControllerSettings​

Settings of the controller of a geolocation marker moving.
public init(
    bearingSource: BearingSource? = BearingSource.auto,
    animationDuration: TimeInterval = 1,
    coordinatesThreshold: Meter = Meter(value: 0.10000000149011612),
    bearingThreshold: Bearing = Bearing(value: 1)
)
Parameters
bearingSource
animationDuration
TimeInterval
coordinatesThreshold
bearingThreshold
Properties
var bearingSource
Bearing source. If missing, a marker without bearing is displayed.
var animationDuration
Non-negative duration of the real direction change.
var coordinatesThreshold
Non-negative threshold value of the considered change of the real position and its precision.
var bearingThreshold
Non-negative threshold value of the considered change of the real bering.
public init(
	viewModel: NavigationMiniMapViewModel
)
Parameters
viewModel
Properties
var body
some View
Content and behavior of the view.
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,
	dashboardButtonSettings: DashboardButtonSettings = .default
)
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.
dashboardButtonSettings
Settings for a button in the bottom panel of the NavigationView.
Properties
var mapControlsBehaviour
var distanceFormattingStrategy
var durationFormattingStrategy
var durationValueFormattingStrategy
var timeFormattingStrategy
var speedFormattingStrategy
var theme
var roadEventCardViewOptions
var roadEventCreationEnabled
var dashboardButtonSettings
static var `default`
Navigator default interface settings.
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,
	routeOverviewControlTheme: RouteOverviewControlTheme
)
Parameters
colors
Colors
dashboardTheme
DashboardTheme
remainingRouteInfoControlTheme
RemainingRouteInfoControlTheme
nextManeuverControlTheme
NextManeuverControlTheme
speedControlTheme
SpeedControlTheme
cameraControlTheme
CameraControlTheme
messageBarControlTheme
MessageBarControlTheme
mapControlsTheme
MapControlsTheme
betterRouteControlTheme
BetterRouteControlTheme
thermometerTheme
ThermometerTheme
routeOverviewControlTheme
RouteOverviewControlTheme
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
var routeOverviewControlTheme
NavigationViewTheme.RouteOverviewControlTheme
static let `default`
Default navigator theme.
Methods
func navigatorViewFinishButtonCallback(_ callback: (() -> Void)?) -> NavigatorView
Closure of the callback when clicking the route ending.
Returns
Properties
var body
some View
Content and behavior of the View.

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
type
limitation
Properties
var type
var limitation

ObstacleInfoRouteEntry​

Route element - a point and a value in it.
public init(
    point: RoutePoint,
    value: ObstacleInfo
)
Parameters
point
value
Properties
var point
var value

ObstacleInfoRouteLongEntry​

Extended route element - segment and value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: ObstacleInfo
)
Parameters
point
length
value
Properties
var point
var length
var value

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
weekOpeningHours
isOpen24x7
Properties
var weekOpeningHours
Hours of operation for each day of the week, starting on Monday.
var isOpen24x7

OrderedValue​

Describes one value from the set.
public init(
    value: String,
    text: String?
)
Parameters
value
text
Properties
var value
Value by which filtering is done.
var text
Value name.

OrderedValues​

Describes a set of sorted values.
public init(
    values: [OrderedValue],
    currentMinIndex: UInt64? = nil,
    currentMaxIndex: UInt64? = nil
)
Parameters
values
currentMinIndex
currentMaxIndex
Properties
var values
Set of values. Sorted in the ascending order.
var currentMinIndex
Index of the currently set minimum value.
var currentMaxIndex
Index of the currently set maximum value.

OrgId​

Identifier of the organization.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

OrgInfo​

Information about the organization.
public init(
    branchCount: UInt32,
    id: OrgId,
    name: String?
)
Parameters
branchCount
id
name
Properties
var branchCount
Number of branches of the organization.
var id
Unique identifier of the organization.
var name
Name of the organization.

PackageInfo​

Package information. See IPackage.
public init(
    name: String,
    installed: Bool = false,
    incomplete: Bool = true,
    preinstalled: Bool = false,
    compatible: Bool = false,
    hasUpdate: Bool = false,
    error: PackageInfoError?,
    updateStatus: PackageUpdateStatus = PackageUpdateStatus.notAvailable,
    finalSizeOnDisk: UInt64? = nil,
    currentSizeOnDisk: UInt64 = 0
)
Parameters
name
installed
incomplete
preinstalled
compatible
hasUpdate
error
updateStatus
finalSizeOnDisk
currentSizeOnDisk
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 error
Error that occurs during an attempt to download and/or install a package. If no error occurs, nil is returned.
var updateStatus
Package upgrade status.
var finalSizeOnDisk
Size of the disk space that the territory takes after installation, in bytes. Uninitialized value indicates that the territory does not contain files (this information is obtained from a preinstalled status file that does not contain a list of territory files).
var currentSizeOnDisk
Size of the disk space that currently installed territory files take, in bytes

Padding​

Padding the edges of the camera.
public init(
    left: UInt32 = 0,
    top: UInt32 = 0,
    right: UInt32 = 0,
    bottom: UInt32 = 0
)
Parameters
left
top
right
bottom
Properties
var left
Padding from left to inside.
var top
Padding from top to bottom inward.
var right
Padding right inward.
var bottom
Padding at bottom inward.

ParkingCapacity​

Parking capacity.
public init(
    total: String?,
    specialSpaces: [SpecialSpace]
)
Parameters
total
specialSpaces
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.
public init(
    length: RouteDistance,
    landmark: String
)
Parameters
length
landmark
Properties
var length
Route length.
var landmark
Landmark.

PedestrianInstructionCrossroad​

Description of maneuvers when passing through an intersection or crosswalk.
public init(
    landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.`none`,
    maneuvers: [PedestrianInstructionCrossroadManeuver]
)
Parameters
landmark
maneuvers
Properties
var landmark
Landmark.
var maneuvers
Chain of sequential maneuvers.

PedestrianInstructionCrossroadManeuver​

public init(
    direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.straight,
    turnAngle: Int32 = 0
)
Parameters
direction
turnAngle
Int32
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.
public init(
    levelId: LevelId = LevelId()
)
Parameters
levelId
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
type
beginId
endId
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,
    avoidUnderpassesAndOverpasses: Bool = false,
    useIndoor: Bool = true,
    excludedAreas: [ExcludedArea] = []
)
Parameters
avoidStairways
avoidUnderpassesAndOverpasses
useIndoor
excludedAreas
Properties
var avoidStairways
Avoid stairs.
var avoidUnderpassesAndOverpasses
Avoid underpasses and overpasses.
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.

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
type
names
color
routeLogo
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.
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
transports
intermediateStops
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.

PublicTransportDirectoryPlatformDepartureInfo​

Information about the departure from the stop platform.
public init(
    platformId: DgisObjectId,
    departureTime: DayTime = DayTime(hours: 0, minutes: 0)
)
Parameters
platformId
departureTime
Properties
var platformId
Identifier of the stop platform.
var departureTime
Exact time of transport departure from the stop platform in the `HH:MM` format (in the local timezone of the object).

PublicTransportDirectoryRouteDirectionNamesInfo​

Names of the start and the end stops of the route.
public init(
    fromName: String,
    toName: String
)
Parameters
fromName
toName
Properties
var fromName
Start stop of the route.
var toName
End stop of the route.

PublicTransportDirectoryRouteInfo​

Information about public transport route.
public init(
    id: DgisObjectId,
    name: String,
    routeType: PublicTransportRouteType,
    color: UInt32?,
    fromToStationNames: PublicTransportDirectoryRouteDirectionNamesInfo?,
    directions: [PublicTransportRouteDirection]
)
Parameters
id
name
routeType
color
fromToStationNames
directions
Properties
var id
Route identifier.
var name
Route name.
var routeType
Route type.
var color
Route color coding.
var fromToStationNames
Names of the start and the end stops of the route.
var directions
Route directions.

PublicTransportDirectoryRouteScheduleInfo​

Information about schedules on stop platforms and directions on the route.
public init(
    fullDayPlatforms: [PublicTransportRouteDirectionId: [DgisObjectId: [PublicTransportPlatformSchedule]]],
    nearTrips: [PublicTransportRouteDirectionId: [DgisObjectId: PublicTransportNearTripSchedule]],
    intervalTrips: [PublicTransportRouteDirectionId: PublicTransportIntervalSchedule]
)
Properties
var fullDayPlatforms
[PublicTransportRouteDirectionId : [DgisObjectId : [PublicTransportPlatformSchedule]]]
Schedules at stop platforms until the end of the day.
var nearTrips
[PublicTransportRouteDirectionId : [DgisObjectId : PublicTransportNearTripSchedule]]
The nearest trips for the route directions to the end stop platform.
var intervalTrips
[PublicTransportRouteDirectionId : PublicTransportIntervalSchedule]
The nearest interval schedules for the directions.

PublicTransportDirectoryScheduleInfo​

Information about schedules at stop platforms and directions.
public init(
    routeSchedules: [DgisObjectId: PublicTransportDirectoryRouteScheduleInfo],
    fullDayPlatforms: [DgisObjectId: [PublicTransportRouteDirectionId: [PublicTransportPlatformSchedule]]],
    nearTrips: [DgisObjectId: [PublicTransportRouteDirectionId: PublicTransportNearTripSchedule]]
)
Properties
var routeSchedules
[DgisObjectId : PublicTransportDirectoryRouteScheduleInfo]
Schedules at stop platforms and route directions.
var fullDayPlatforms
[DgisObjectId : [PublicTransportRouteDirectionId : [PublicTransportPlatformSchedule]]]
Routes schedules at the stop platform until the end of the day. The field is filled for an object with the type `ObjectType.StationPlatform`.
var nearTrips
[DgisObjectId : [PublicTransportRouteDirectionId : PublicTransportNearTripSchedule]]
The nearest trips for the route directions to the end stop platform. The field is filled for an object with the type `ObjectType.StationPlatform`.

PublicTransportInfo​

Description of the means of public transportation.
public init(
    type: PublicTransportType = PublicTransportType.bus,
    names: [String],
    suggestedCarNumbers: [UInt32],
    boardingSuggest: String,
    color: UInt32?,
    routeLogo: String
)
Parameters
type
names
suggestedCarNumbers
boardingSuggest
color
routeLogo
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.
Icon identifier for route stops. An empty string if no information is available. Technical field.

PublicTransportIntervalSchedule​

Interval transport schedule (at a certain time of day, transport transits with the same interval).
public init(
    period: UInt8 = 0,
    workHours: PublicTransportIntervalWorkingHours?
)
Parameters
period
workHours
Properties
var period
Transport transit interval in minutes.
var workHours
Work period of the interval schedule.

PublicTransportIntervalWorkingHours​

Work period of the interval schedule.
public init(
    startTime: UInt64 = 0,
    startTimeUtc: UInt64 = 0,
    finishTime: UInt64 = 0,
    finishTimeUtc: UInt64 = 0
)
Parameters
startTime
startTimeUtc
finishTime
finishTimeUtc
Properties
var startTime
Unix time of the interval schedule start (in the local timezone of the object).
var startTimeUtc
Unix time of the interval schedule start in UTC.
var finishTime
Unix time of the interval schedule end (in the local timezone of the object).
var finishTimeUtc
Unix time of the interval schedule end in UTC.

PublicTransportNearTripSchedule​

Interval transport schedule (at a certain time of day, transport transits with the same interval).
public init(
    period: UInt8?,
    platformTimes: [PublicTransportDirectoryPlatformDepartureInfo]
)
Parameters
period
platformTimes
Properties
var period
Transport transit interval in minutes.
var platformTimes
Departure schedule at stop platforms.

PublicTransportPlatform​

Information about the stop platform - a place where you can board the public transport, which is displayed on the map. A public transport stop ([PublicTransportStop](/en/ios/sdk/reference/stable/PublicTransportStop)) consists of one or more stop platforms.
public init(
    id: DgisObjectId,
    stationId: DgisObjectId,
    name: String,
    description: String?,
    transitions: [PublicTransportPlatformTransition],
    position: GeoPoint?
)
Parameters
id
stationId
name
description
transitions
position
Properties
var id
Identifier of the stop platform.
var stationId
Identifier of the stop to which the platform belongs. For example, the bus stop or subway station where the platform is located.
var name
Stop name.
var description
Short description of the location of the stop platform.
var transitions
Information about other public transport routes that you can transfer to at the stop platform.
var position
Geoposition.

PublicTransportPlatformSchedule​

Schedule at the stop platform.
public init(
    schedule: PublicTransportSchedule,
    startTime: UInt64 = 0,
    startTimeUtc: UInt64 = 0
)
Parameters
schedule
startTime
startTimeUtc
Properties
var schedule
Transport schedule.
var startTime
Event time (in the local timezone of the object).
var startTimeUtc
Event time in UTC.

PublicTransportPlatformTransition​

Information about the public transport route that you can transfer to at the stop platform.
public init(
    routeId: DgisObjectId,
    routeName: String,
    routeType: PublicTransportRouteType,
    color: UInt32?,
    stationId: DgisObjectId,
    stationName: String
)
Parameters
routeId
routeName
routeType
color
stationId
stationName
Properties
var routeId
Route identifier.
var routeName
Route name.
var routeType
Route type.
var color
Route color coding.
var stationId
Stop identifier.
var stationName
Stop or station name.

PublicTransportPreciseSchedule​

Exact arrival schedule of public transport to the stop platform.
public init(
    preciseTime: DayTime,
    nextTrips: [UInt64],
    nextTripsUtc: [UInt64]
)
Parameters
preciseTime
nextTrips
nextTripsUtc
Properties
var preciseTime
Exact arrival time of the transport in the `HH:MM` format (in the local timezone of the object).
var nextTrips
Arrival times of the next trips (in the local timezone of the object).
var nextTripsUtc
Times of the next trips in UTC.

PublicTransportRouteDirection​

Route direction of the public transport.
public init(
    id: PublicTransportRouteDirectionId,
    type: PublicTransportRouteDirectionType,
    geometry: PublicTransportRouteGeometry?,
    platforms: [PublicTransportPlatform]
)
Parameters
id
type
geometry
platforms
Properties
var id
Identifier of the route direction.
var type
Type of the route direction.
var geometry
Geometry of the route direction.
var platforms
Sequence of stop platforms along the route.

PublicTransportRouteDirectionId​

Identifier of the route direction of the public transport.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

PublicTransportRouteGeometry​

Geometry of the route direction of the public transport.
public init(
    line: PolylineGeometry,
    centroid: GeoPoint?
)
Parameters
line
centroid
Properties
var line
Route line.
var centroid
Visual center of the object geometry.

PublicTransportRouteSearchOptions​

Route search options on public transport.
public init(
    startTime: Date? = nil,
    useSchedule: Bool = false,
    transportTypes: PublicTransportTypeOptionSet = []
)
Parameters
startTime
Date?
useSchedule
transportTypes
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.
public init(
    name: String,
    coordinates: GeoPoint
)
Parameters
name
coordinates
Properties
var name
The name of the stop.
var coordinates
Geographic coordinates of the 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
startPointName
finishPointName
routeParts
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
point
length
value
Properties
var point
var length
var value

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
Bus.
static let trolleybus
Trolleybus.
static let tram
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.

PurposeCode​

Code of the purpose of the building.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

RangeFilter​

Filter of value ranges.
public init(
    tagName: String,
    displayName: String,
    minValue: Double,
    maxValue: Double
)
Parameters
tagName
displayName
minValue
maxValue
Properties
var tagName
Filter tag.
var displayName
Name of the filter to display.<br/>Depends on the output language. Not all names can be translated.
var minValue
Minimum value of the range.
var maxValue
Maximum value of the range.

RemainingRouteInfoView​

Properties
var body
some View
Content and behavior of the view.

RenderedObject​

Displayed map object.
public init(
    item: MapObject,
    source: Source,
    levelId: LevelId? = nil
)
Parameters
item
source
levelId
Properties
var item
Map object.
var source
Data source containing the map object.
var levelId
Identifier of the floor plan of the building on which the object is located.

RenderedObjectInfo​

Detailed information about the displayed map object.
public init(
    closestViewportPoint: ScreenPoint,
    closestMapPoint: GeoPointWithElevation,
    item: RenderedObject
)
Parameters
closestViewportPoint
closestMapPoint
item
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.
public init(
    rating: Float,
    count: UInt32
)
Parameters
rating
Float
count
Properties
var rating
Float
Rating between 0 and 5.
var count
Number of reviews.

RoadCameraInfo​

Camera information.
public init(
    purposes: CameraPurposeOptionSet,
    speedLimit: UInt16?
)
Parameters
purposes
speedLimit
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
state
count
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.

RoadEventCreatorButtonView​

SwiftUI element for creating a road event.
Methods
func roadEventCreatorButtonViewOnButtonTapped(_ callback: (() -> Void)?) -> RoadEventCreatorButtonView
Returns
Properties
var body
some View
Content and behavior of the view.

RoadEventCreatorView​

Methods
func roadEventCreatorViewOnCreateRequest(_ callback: ((CreateRoadEventResult) -> Void)?) -> RoadEventCreatorView
Returns
func roadEventCreatorViewOnCancel(_ callback: (() -> Void)?) -> RoadEventCreatorView
Returns
Properties
var visibleAreaEdgeInsets
EdgeInsets
var body
some View
Content and behavior of the view.

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.

RoadEventInfoView​

Methods
func roadEventInfoViewCloseButtonCallback(_ callback: (() -> Void)?) -> RoadEventInfoView
Returns
func roadEventInfoViewActionResultCallback(_ callback: ((RoadEventActionResult) -> Void)?) -> RoadEventInfoView
Returns
func roadEventInfoViewRemoveRoadEventActionResultCallback(_ callback: ((RoadEventRemoveResult) -> Void)?) -> RoadEventInfoView
Returns
func roadEventInfoViewSetRoadEvent(_ roadEvent: RoadEvent) -> RoadEventInfoView
Parameters
roadEvent
Returns
Properties
var body
some View
Content and behavior of the view.

RoadEventMapObjectRouteEntry​

Route element: a point and a value in it.
public init(
    point: RoutePoint,
    value: RoadEventMapObject
)
Parameters
point
value
Properties
var point
var value

RoadEventRouteEntry​

Route element - a point and a value in it.
public init(
    point: RoutePoint,
    value: BriefRoadEvent
)
Parameters
point
value
Properties
var point
var value

RoadRuleRouteLongEntry​

Extended route element - a segment and a value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadRule
)
Parameters
point
length
value
Properties
var point
var length
var value

RoadSubtypeRouteLongEntry​

Extended route element - a segment and a value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadSubtype
)
Parameters
point
length
value
Properties
var point
var length
var value

RoadSurfaceRouteLongEntry​

Extended route element - segment and value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadSurface
)
Parameters
point
length
value
Properties
var point
var length
var value

RoadTypeRouteLongEntry​

Extended route element - segment and value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadType
)
Parameters
point
length
value
Properties
var point
var length
var value

RouteBuildOptions​

The structure that describes the route building parameters in the navigator.
public init(
    finishPoint: RouteSearchPoint,
    routeSearchOptions: RouteSearchOptions
)
Parameters
finishPoint
routeSearchOptions
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 = RouteCameraDirection.against,
    maxSpeedLimit: Float?
)
Parameters
purposes
rangeAgainst
rangeAlong
direction
maxSpeedLimit
Float?
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.
var maxSpeedLimit
Float?
Speed in m/s, the exceeding of which is captured by a camera. Missing if the camera does not detect exceeding the speed limit.

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
routes
routeParams
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
type
roadNameTable
roadNumberTable
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.
public init(
    point: RoutePoint,
    value: RouteExitSign
)
Parameters
point
value
Properties
var point
var value

RouteExitSignTable​

Exit sign information.
public init(
    backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.undefined,
    text: String
)
Parameters
backgroundColor
text
Properties
var backgroundColor
Background color of an exit sign.
var text
Exit sign text.

RouteIndex​

Active route index.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

RouteInfo​

Route description with maneuvers.
public init(
    route: Route,
    routeBuildOptions: RouteBuildOptions?,
    external: Bool = false
)
Parameters
route
routeBuildOptions
external
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.
var external
Route source. True - the route is passed to the navigator externally in the start method. False - the route is generated by the navigator.

RouteInstruction​

The instruction that must be executed to drive the route.
public init(
    roadName: String,
    range: RouteDistance,
    extraInstructionInfo: ExtraInstructionInfo
)
Parameters
roadName
range
extraInstructionInfo
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
lanes
signStartPoint
signPoint
signEndPoint
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.
public init(
    beginId: LevelId?,
    endId: LevelId?,
    name: String
)
Parameters
beginId
endId
name
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
point
length
value
Properties
var point
var length
var value

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
Cameras.
static let humps
Artificial bumps.
static let barriers
Road closures.
static let gates
Gates, barriers.
static let stairways
Stairs.
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.
static let trafficLights
Highlight traffic lights on the route.
static let immersiveRouteParts
Use immersive geometry for route parts (used together with RouteParts).

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
Cameras.
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 finish of toll road.

RoutePoint​

Point on the route, set as the distance along the route relative to the start of the route.
public init(
    distance: RouteDistance
)
Parameters
distance
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
coordinates
course
objectId
levelId
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).

RouteTollPaymentInfo​

Information about toll costs for paid sections of the route.
public init(
    currencyCode: String,
    cost: Float = 0
)
Parameters
currencyCode
cost
Float
Properties
var currencyCode
Three-digit ISO 4217 currency code of the toll cost.
var cost
Float
Toll costs for a paid section of the route.

RubricId​

Rubric ID.
public init(
    value: UInt64 = 0
)
Parameters
value
Properties
var value

Schedule​

Road event action schedule.
public init(
    startTime: Date?,
    finishTime: Date?,
    weekTimeIntervals: [WeekTimeInterval]
)
Parameters
startTime
Date?
finishTime
Date?
weekTimeIntervals
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.
public init(
    length: RouteDistance,
    landmark: String
)
Parameters
length
landmark
Properties
var length
Route length.
var landmark
Landmark.

ScooterInstructionCrossroad​

Description of maneuvers when passing through an intersection or crosswalk.
public init(
    landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.`none`,
    maneuvers: [ScooterInstructionCrossroadManeuver]
)
Parameters
landmark
maneuvers
Properties
var landmark
Landmark.
var maneuvers
Chain of sequential maneuvers.

ScooterInstructionCrossroadManeuver​

public init(
    direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.straight,
    turnAngle: Int32 = 0
)
Parameters
direction
turnAngle
Int32
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
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
excludedAreas
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
init(_ cgPoint: CGPoint)
Parameters
cgPoint
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
init(_ cgVector: CGVector)
Parameters
cgVector
Properties
var dx
Float
var dy
Float

ScreenSize​

Size in pixels.
public init(
    width: UInt32 = 0,
    height: UInt32 = 0
)
Parameters
width
height
init(_ cgSize: CGSize)
Parameters
cgSize
Properties
var width
var height

SDKError​

Implements: ISDKError
public init(description: String)
Parameters
description
Properties
let description
Textual representation of this instance.
var debugDescription
Textual representation of this instance, suitable for debugging.

SearchHistoryFilterOptionSet​

public init(rawValue: UInt32)
Creates a new `OptionSet` from the given raw value.
Parameters
rawValue
The raw value of the option set (`OptionSet`) to create. Each bit of `rawValue` potentially represents an element of the `OptionSet`, but 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 none
static let object
static let searchQuery

SearchHistoryPage​

public init(
    limit: UInt64 = 100,
    offset: UInt64 = 0,
    filter: SearchHistoryFilterOptionSet = []
)
Parameters
limit
offset
filter
Properties
var limit
var offset
var filter

SearchResultItemView​

public init(
	viewModel: SearchResultItemViewModel,
	theme: DirectoryViewTheme.SearchResultItemViewTheme,
	viewFactory: ISearchResultItemViewFactory? = nil
)
Parameters
viewModel
viewFactory
Properties
var body
some View
Content and behavior of the view.

SearchResultItemViewModel​

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.
public init(
    point: GeoPoint,
    bearing: Bearing
)
Parameters
point
bearing
Properties
var point
var bearing

SettlementRouteLongEntry​

Extended route element - segment and value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: Settlement
)
Parameters
point
length
value
Properties
var point
var length
var value

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 init(description: String)
Parameters
description
public static func == (lhs: SimpleError, rhs: SimpleError) -> Bool
Returns a Boolean value indicating whether two values are equal.
Properties
let description
Textual representation of this instance.
var debugDescription
Textual representation of this instance, suitable for debugging.

SimulationAutoWithOverSpeed​

Structure for setting the mode of driving taking into account the maximum speed on the route edge.
public init(
    overSpeed: Double = 0
)
Parameters
overSpeed
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.
public init(
    speed: Double = 0
)
Parameters
speed
Properties
var speed
Travel speed in m/s. Only values >= 0 are acceptable.

SortingFilter​

Sorting type.
public init(
    tagName: String,
    displayName: String
)
Parameters
tagName
displayName
Properties
var tagName
Filter tag.
var displayName
Filter name to display.<br/>Depends on the resulting language. Not all names can be translated.

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
type
name
count
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.
public init(
    minSpeed: Double = 0,
    maxSpeed: Double = 0
)
Parameters
minSpeed
maxSpeed
Properties
var minSpeed
var maxSpeed

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
point
length
value
Properties
var point
var length
var value

StyleLayerId​

Style layer ID.
public init(
    id: String
)
Parameters
id
Properties
var id

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.
public init(
    car: CarRouteSearchOptions
)
Parameters
car
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),
    textHorizontalAlignment: TextHorizontalAlignment = TextHorizontalAlignment.auto,
    textPlacement: TextPlacement = TextPlacement.bottomCenter,
    textOffset: LogicalPixel = LogicalPixel(value: 0),
    fontName: String? = nil,
    suppressOnOverlap: Bool = true
)
Parameters
fontSize
color
strokeWidth
strokeColor
textHorizontalAlignment
textPlacement
textOffset
fontName
suppressOnOverlap
Properties
var fontSize
var color
var strokeWidth
var strokeColor
var textHorizontalAlignment
var textPlacement
var textOffset
var fontName
var suppressOnOverlap
Whether to hide text when it overlaps other objects (markers, labels of other objects).

Theme​

Specifies a theme within some style (see `Style`).
public init(name: String)
Parameters
name
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.
public init(
    type: String,
    license: String,
    legalForm: String,
    endDate: String
)
Parameters
type
license
legalForm
endDate
Properties
var type
Type.
var license
Number.
var legalForm
Company's form of ownership.
var endDate
Date until that the license is valid.

TrafficControlState​

State of the traffic control.
public init(
    status: TrafficControlStatus = TrafficControlStatus.hidden,
    score: UInt32?
)
Parameters
status
score
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
state
value
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
point
length
value
Properties
var point
var length
var value

TrafficView​

UI control of the traffic jam visibility.
Properties
var body
some View
Contents and behavior of the control.

TrafficViewColors​

public init(
	titleColor: SwiftUI.Color,
	enabledTitleColor: SwiftUI.Color,
	iconColor: SwiftUI.Color,
	enabledIconColor: SwiftUI.Color,
	emptyStateLoadingColor: SwiftUI.Color,
	disabledInnerBackgroundColor: SwiftUI.Color,
	lowScoreColor: SwiftUI.Color,
	mediumScoreColor: SwiftUI.Color,
	highScoreColor: SwiftUI.Color,
	lowScoreDisabledColor: SwiftUI.Color,
	mediumScoreDisabledColor: SwiftUI.Color,
	highScoreDisabledColor: SwiftUI.Color
)
Parameters
titleColor
ColorSwiftUI.
enabledTitleColor
ColorSwiftUI.
iconColor
ColorSwiftUI.
enabledIconColor
ColorSwiftUI.
emptyStateLoadingColor
ColorSwiftUI.
disabledInnerBackgroundColor
ColorSwiftUI.
lowScoreColor
ColorSwiftUI.
mediumScoreColor
ColorSwiftUI.
highScoreColor
ColorSwiftUI.
lowScoreDisabledColor
ColorSwiftUI.
mediumScoreDisabledColor
ColorSwiftUI.
highScoreDisabledColor
ColorSwiftUI.
Properties
static let `default`

TransportTypeRouteLongEntry​

Extended route element - a segment and a value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: TransportType
)
Parameters
point
length
value
Properties
var point
var length
var value

TruckPassZoneId​

Identifier of the pass zone for trucks. The value 0 corresponds to the absence of the pass zone.
public init(
    value: UInt32 = 0
)
Parameters
value
Properties
var value

TruckPassZoneIdRouteLongEntry​

Extended route element - segment and value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: TruckPassZoneId
)
Parameters
point
length
value
Properties
var point
var length
var value

TruckPassZonePass​

Pass allowing truck traffic in the pass zones.
public init(
    id: TruckPassZonePassId,
    name: String,
    passZoneIds: Set<TruckPassZoneId>
)
Parameters
id
name
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​

Skip ID.
public init(
    value: UInt32 = 0
)
Parameters
value
Properties
var value

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
car
truckLength
truckHeight
truckWidth
actualMass
maxPermittedMass
axleLoad
dangerousCargo
explosiveCargo
fallbackOnCar
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.
public init(
    objectId: DgisObjectId,
    label: String?
)
Parameters
objectId
label
Properties
var objectId
var label

UIntRouteLongEntry​

Extended route element - a segment and a value on it.
public init(
    point: RoutePoint,
    length: RouteDistance,
    value: UInt32
)
Parameters
point
length
value
Properties
var point
var length
var value

VendorConfigFromAsset​

Overwrites SDK settings by specifying the path to the application asset. For Android - assets directory. For iOS - Bundle.main directory.
public init(
    path: String
)
Parameters
path
Properties
var path
Path relative to the asset root directory.

VendorConfigFromFile​

Overwrites SDK settings by specifying the path to a file in the device file system.
public init(
    path: String
)
Parameters
path
Properties
var path
File path.

VendorConfigFromString​

Overwrites SDK settings by specifying the file contents.
public init(
    contents: String
)
Parameters
contents
Properties
var contents
Contents of the file for overwriting settings.

VoiceAssistantView​

SwiftUI element for voice input.
Methods
func permissionDeniedCallback(callback: @escaping (() -> Void)) -> VoiceAssistantView
Returns
func recognitionProcessCallback(callback: @escaping ((VoiceRecognitionState) -> Void)) -> VoiceAssistantView
Returns
func recognitionCompleteCallback(callback: @escaping ((VoiceRecognitionResult) -> Void)) -> VoiceAssistantView
Returns
func startRecognition()
Properties
var body
some View
The content and behavior of the view.

WeekTime​

Timestamp within a week.
public init(
    weekDay: WeekDay,
    time: DayTime
)
Parameters
weekDay
time
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.
Properties
var weekDay
Day of the week.
var time
Time.

WeekTimeInterval​

Time interval during the week.
public init(
    startTime: WeekTime,
    finishTime: WeekTime
)
Parameters
startTime
finishTime
Properties
var startTime
Start time.
var finishTime
End time.

WmsRasterUrlTemplate​

public init(
    urlTemplate: String
)
Parameters
urlTemplate
Properties
var urlTemplate

WorkStatus​

Operating status.
public init(
    isOpen: Bool,
    description: String
)
Parameters
isOpen
description
Properties
var isOpen
Is open now.
var description
Textual description. For example: “Open till 21:00”, “Open 24/7”, “Closes in 5 minutes”.

ZIndex​

Index that sets the order in which objects are rendered within a layer.
public init(
    value: UInt32 = 0
)
Parameters
value
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

ZoomView​

UI control of zooming in and out in SwiftUI.
Properties
var body
some View
Contents and behavior of the control.