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.
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).
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.
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.
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.
Zero identifier does not correspond to any object.

var entranceId​

Stable numeric identifier of the entrance for object_id.
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.

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​