Перейти к основному содержимому

struct

Address​

Адрес в виде набора отдельных компонентов.

public init(
    drillDown: [AddressAdmDiv],
    components: [AddressComponent],
    buildingName: String?,
    postCode: String?,
    buildingCode: String?,
    fiasCode: String?,
    addressComment: String?
)
Parameters

drillDown

components

buildingName

postCode

buildingCode

fiasCode

addressComment

Properties

var drillDown​

Набор объектов административного деления, в которых находится описываемый объект.

var components​

Полный адрес объекта может содержать несколько отдельных адресных компонент.

var buildingName​

Название здания.

var postCode​

Почтовый индекс.

var buildingCode​

Уникальный почтовый код здания.

var fiasCode​

Код ФИАС объекта.

var addressComment​

Комментарий к адресу. Пример: “301 офис; 9 этаж”

AddressAdmDiv​

Объект административного деления.

public init(
    type: String,
    name: String
)
Parameters

type

name

Properties

var type​

Тип административной единицы. Один из следующих:

var name​

AddressLocation​

Применяется для компонентов, которые тяжело описать конкретным адресом.

public init(
    comment: String
)
Parameters

comment

Properties

var comment​

Словесное описание местоположения строения.

AddressNumber​

В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).

public init(
    number: String,
    fiasCode: String?
)
Parameters

number

fiasCode

Properties

var number​

Номер дома, включая дроби и буквенные обозначения. Возможно, имя собственное, если так принято.

var fiasCode​

Код ФИАС улицы.

AddressStreet​

Обычный адрес, есть улица и номер дома.

public init(
    street: String,
    number: String,
    fiasCode: String?
)
Parameters

street

number

fiasCode

Properties

var street​

Название улицы.

var number​

Номер дома, включая дроби, корпусы и буквенные обозначения.

var fiasCode​

Код ФИАС улицы.

Anchor​

Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний

public init(
    x: Float = 0.5,
    y: Float = 0.5
)
Parameters

x

Float

y

Float
Properties

var x​

Float

var y​

Float

ApartmentRange​

Диапазон квартир.

public init(
    start: String,
    end: String? = nil
)
Parameters

start

end

Properties

var start​

Начало диапазона/хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.

var end​

Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1.

ApiKeyOptions​

Настройки ключа для работы с SDK 2ГИС.

public init(apiKeyFile: File)
Parameters

apiKeyFile

Properties

let apiKeyFile​

Файл с информацией о ключе.

static let `default`​

Настройки по умолчанию.

Attribute​

Дополнительный атрибут. Пример: { tag: “hotel_room_internet”, name: “Бесплатный интернет в номерах” }

public init(
    tag: String,
    value: String
)
Parameters

tag

value

Properties

var tag​

Тег.

var value​

Значение.

AudioOptions​

Настройки звука.

public init(muteOtherSounds: Bool, audioVolume: AudioVolume)
Parameters

muteOtherSounds

audioVolume

Properties

static let `default`​

Настройки по умолчанию. Приглушение звука других приложений и максимальная громкость воспроизведения.

AuthorInfo​

Информация об авторе события или фотографии.

public init(
    type: AuthorType,
    name: String
)
Parameters

type

name

Properties

var type​

Категория автора контента.

var name​

Строка, содержащая имя пользователя, добавившего событие или фотографию.

BatteryOptions​

Настройки слежения за состоянием батареи. Используются для настройки сервиса мониторинга состояния батареи, необходимого для оптимизации энергопотребления при низком уровне заряда или активации режима экономии энергии.

public init(lowBatteryThreshold: Int, delegate: IBatteryManagerDelegate?)
Parameters

lowBatteryThreshold

delegate

Properties

var lowBatteryThreshold​

Проценты заряда батареи, начиная с которого и ниже заряд считается низким. При низком заряде батареи могут быть задействованы средства агрессивного энергосбережения и отображаться предупреждения. Диапазон значений: 0…100.

var delegate​

Делегат сервиса слежения за состоянием батареи. Необходим для управления включением и выключением мониторинга состояния батареи (см. UIDevice.isBatteryMonitoringEnabled), что позволяет автоматически включать оптимизацию энергопотребления.

static let `default`​

Настройки по умолчанию. Граница низкого уровня заряда батареи - 15%. Мониторинг состояния батареи выключен. Оптимизация энергопотребления автоматически не включается.

Bearing​

Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений [0°, 360°].

public init(
    value: Double = 0
)
Parameters

value

public init(floatLiteral value: Double)

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

Parameters

value

The value to create.

Properties

var value​

BetterRouteInfo​

Информация о доступном альтернативном маршруте.

public init(
    trafficRoute: TrafficRoute,
    startPoint: RoutePoint
)
Parameters

trafficRoute

startPoint

Properties

var trafficRoute​

Альтернативный маршрут.

var startPoint​

Точка на альтернативном маршруте, с которой начнётся движение в случае перехода на этот маршрут

BicycleBriefRouteInfo​

Базовая информация о велосипедном маршруте.

public init(
    length: RouteDistance,
    landmark: String
)
Parameters

length

landmark

Properties

var length​

Длина маршрута.

var landmark​

Ориентир.

BicycleInstructionCrossroad​

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

public init(
    landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.`none`,
    maneuvers: [BicycleInstructionCrossroadManeuver]
)
Parameters

landmark

maneuvers

Properties

var landmark​

Ориентир.

var maneuvers​

Цепочка идущих подряд манёвров.

BicycleInstructionCrossroadManeuver​

public init(
    direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.straight,
    turnAngle: Int32 = 0
)
Parameters

direction

turnAngle

Int32
Properties

var direction​

Направление движения.

var turnAngle​

Int32

Угол поворота в градусах [-180, 180].

BicycleInstructionFinish​

Конец велосипедной части маршрута.

public init()

BicycleInstructionStart​

Начало велосипедной части маршрута.

public init()

BicycleRouteSearchOptions​

Параметры поиска маршрута на велосипеде.

public init(
    avoidCarRoads: Bool = false,
    avoidStairways: Bool = false,
    avoidUnderpassesAndOverpasses: Bool = false,
    excludedAreas: [ExcludedArea] = []
)
Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

var avoidCarRoads​

Избегать автомобильных дорог.

var avoidStairways​

Избегать лестниц.

var avoidUnderpassesAndOverpasses​

Избегать подземных и надземных переходов.

var excludedAreas​

Исключаемые области (не больше 25).

BoolRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: Bool
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

Borders​

Описывает набор непрерывного упорядоченных значений.

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​

Задаёт притяжку до значения, кратного этому числу.

var isLg​

Признак использования логарифмической шкалы.

var value​

Значение, по которым происходит фильтрация.

var min​

Нижняя граница набора значений.

var max​

Верхняя граница набора значений.

var currentMin​

Текущее установленное минимальное значение.

var currentMax​

Текущее установленное максимальное значение.

BriefRoadEvent​

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

id

eventType

lanes

Properties

var id​

var eventType​

var lanes​

BriefRouteInfo​

Базовая информация о маршруте.

public init(
    duration: TimeInterval,
    extraInfo: BriefExtraRouteInfo
)
Parameters

duration

TimeInterval

extraInfo

Properties

var duration​

Время движения по маршруту.

var extraInfo​

Дополнительная информация о маршруте для конкретного типа транспорта.

BriefRouteInfoSearchPoints​

Точки для запроса поиска базовой информации о маршруте.

public init(
    startPoint: RouteSearchPoint,
    finishPoint: RouteSearchPoint
)
Parameters

startPoint

finishPoint

Properties

var startPoint​

Начальная точка маршрута.

var finishPoint​

Конечная точка маршрута.

BuildingId​

Идентификатор здания.

public init(
    value: UInt64 = 0
)
Parameters

value

Properties

var value​

BuildingInfo​

Информация о здании.

public init(
    buildingName: String? = nil,
    purposeName: String? = nil,
    purposeCode: PurposeCode? = nil,
    buildingLevels: BuildingLevels? = nil
)
Parameters

buildingName

purposeName

purposeCode

buildingLevels

Properties

var buildingName​

Собственное имя здания.

var purposeName​

Описание назначения здания.

var purposeCode​

Код назначения здания.

var buildingLevels​

Информация об этажных планах здания.

BuildingLevels​

Информация об этажных планах здания.

public init(
    defaultLevelId: LevelId,
    levels: [LevelInfo]
)
Parameters

defaultLevelId

levels

Properties

var defaultLevelId​

Идентификатор этажного плана по умолчанию.

var levels​

Все этажные планы здания.

CalloutMapPosition​

Положение бабла маршрута.

public init(
    mapId: MapId,
    calloutPosition: GeoPoint?,
    routePoint: RoutePoint?
)
Parameters

mapId

calloutPosition

routePoint

Properties

var mapId​

Идентификатор карты, для которой приведена позиция.

var calloutPosition​

Позиция на карте.

var routePoint​

Позиция бабла на маршруте.

CameraBehaviour​

Режим слежения камеры.

public init(
    position: FollowPosition?,
    tilt: FollowTilt = FollowTilt.off
)
Parameters

position

tilt

Properties

var position​

var tilt​

CameraBehaviourChange​

Изменение режима слежения.

public init(
    newBehaviour: CameraBehaviour,
    changeReason: CameraBehaviourChangeReason
)
Parameters

newBehaviour

changeReason

Properties

var newBehaviour​

Новый режим слежения.

var changeReason​

Причина изменения режима слежения.

CameraPosition​

Позиция камеры.

public init(
    point: GeoPoint,
    zoom: Zoom,
    tilt: Tilt = Tilt(value: 0),
    bearing: Bearing = Bearing(value: 0)
)
Parameters

point

zoom

tilt

bearing

Properties

var point​

Точка местности, которая находится в точке позиции камеры (см. ICamera::position_point()).

var zoom​

Уровень масштабирования. 0 - это весь мир, вписанный в квадрат 256x256 логических пикселей (см. LogicalPixel)

var tilt​

Угол наклона направления взгляда по вертикали.
0 - надир (смотрим вертикально вниз), максимальное значение - 60 градусов.

var bearing​

Угол поворота направления взгляда по горизонтали относительно направления на север. Отсчитывается по часовой стрелке, в градусах.

CameraPositionChange​

Описание изменения части параметров позиции камеры.

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​

Относительная экранная позиция точки, к которой привязана камера.

public init(
    x: Float = 0.5,
    y: Float = 0.5
)
Parameters

x

Float

y

Float
Properties

var x​

Float

var y​

Float

CameraProgressInfo​

Информация о прогрессе прохождения зоны камеры.

public init(
    camera: RouteCamera,
    position: RoutePoint,
    progress: Float = 0
)
Parameters

camera

position

progress

Float
Properties

var camera​

Камера, для зоны действия которой отслеживается прогресс.

var position​

Позиция камеры на маршруте.

var progress​

Float

Прогресс прохождения зоны действия камеры, [0, 1].

CameraPurposeOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let speedControl​

Фиксация превышения скорости.

static let averageSpeedControl​

Фиксация превышения средней скорости на участке.

static let publicTransportLaneMovementControl​

Фиксация движения по выделенной полосе для общественного транспорта.

static let roadMarkingsCrossingControl​

Фиксация пересечения сплошной линии разметки, движения по обочине.

static let trafficLightsViolationControl​

Фиксация проезда на запрещающий сигнал светофора.

static let stopLineCrossingControl​

Фиксация выезда за стоп-линию, проезда без остановки знака “Стоп”, выезда на перекрёсток во время затора.

static let oncomingTrafficLaneMovementControl​

Фиксация движения по встречной полосе.

static let pedestrianAdvantageViolationControl​

Фиксация непредоставления приоритета пешеходам.

static let laneDisciplineControl​

Фиксация нарушения рядности поворота на перекрёстке.

static let noStoppingViolationControl​

Фиксация нарушения запрета остановки.

static let dummy​

Муляж.

static let truck​

Камера системы “Платон”, камера контроля ограничений для грузовых автомобилей

CameraRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: RouteCamera
)
Parameters

point

value

Properties

var point​

var value​

CameraZoomRestrictions​

Допустимый диапазон изменения уровня масштабирования.

public init(
    minZoom: Zoom = Zoom(value: 0),
    maxZoom: Zoom = Zoom(value: 20)
)
Parameters

minZoom

maxZoom

Properties

var minZoom​

Минимальный уровень масштабирования должен быть меньше максимального.

var maxZoom​

Максимальный масштаб ограничен величиной 20.

CarBriefRouteInfo​

Базовая информация об автомобильном маршруте.

public init(
    length: RouteDistance,
    landmark: String,
    trafficSpeed: CarBriefRouteInfoTrafficSpeed
)
Parameters

length

landmark

trafficSpeed

Properties

var length​

Длина маршрута.

var landmark​

Ориентир.

var trafficSpeed​

Скорость движения.

CarInstructionCrossroad​

Описание манёвров на перекрёстке.

public init(
    direction: CarInstructionCrossroadDirection = CarInstructionCrossroadDirection.straight,
    turnAngle: Int32 = 0,
    landmark: CarInstructionCrossroadLandmark = CarInstructionCrossroadLandmark.`none`,
    exitName: String
)
Parameters

direction

turnAngle

Int32

landmark

exitName

Properties

var direction​

Направление движения на перекрёстке.

var turnAngle​

Int32

Угол поворота в градусах [-180, 180].

var landmark​

Ориентир.

var exitName​

Название съезда.

CarInstructionFinish​

Конец автомобильной части маршрута.

public init()

CarInstructionRoundabout​

Описание манёвров на перекрёстке с круговым движением.

public init(
    type: CarInstructionRoundaboutType = CarInstructionRoundaboutType.entry,
    turnAngle: Int32 = 0,
    exitNumber: UInt32 = 0,
    exitName: String
)
Parameters

type

turnAngle

Int32

exitNumber

exitName

Properties

var type​

Тип инструкции.

var turnAngle​

Int32

Угол поворота в градусах [-180, 180].

var exitNumber​

Номер съезда - [1, inf] или 0, если номер съезда неизвестен.

var exitName​

Название съезда.

CarInstructionStart​

Начало автомобильной части маршрута.

public init()

CarInstructionUTurn​

Разворот на дороге (не на перекрёстке).
Разворот на перекрестке описывается инструкцией Crossroad.

public init(
    exitName: String
)
Parameters

exitName

Properties

var exitName​

Название съезда.

CarRouteSearchOptions​

Параметры поиска маршрута на легковом автомобиле.

public init(
    avoidTollRoads: Bool = false,
    avoidUnpavedRoads: Bool = false,
    avoidFerries: Bool = true,
    avoidLockedRoads: Bool = true,
    routeSearchType: RouteSearchType = RouteSearchType.jam,
    excludedAreas: [ExcludedArea] = []
)
Parameters

avoidTollRoads

avoidUnpavedRoads

avoidFerries

avoidLockedRoads

routeSearchType

excludedAreas

Properties

var avoidTollRoads​

Избегать платных дорог.

var avoidUnpavedRoads​

Избегать грунтовых дорог.

var avoidFerries​

Избегать паромных переправ.

var avoidLockedRoads​

Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.

var routeSearchType​

Тип поиска маршрута.

var excludedAreas​

Исключаемые области (не больше 25).

CircleOptions​

Параметры для создания геометрического объекта карты типа “Окружность”.

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​

Географическая позиция.

var radius​

Радиус в метрах.

var color​

Цвет заливки.

var strokeWidth​

Ширина линии границы окружности.

var strokeColor​

Цвет линии границы окружности.

var dashedStrokeOptions​

Параметры пунктирной границы.

var visible​

Флаг видимости.

var userData​

Any

Пользовательские данные (не используются внутри SDK, нужны только для пользователя API).

var zIndex​

Уровень отрисовки объекта.

var levelId​

Привязка к поэтажному плану здания.

ClusterOptions​

Параметры маркера кластера.

public init(
    attributes: [String: AttributeValue],
    userData: Any = ()
)
Parameters

attributes

String[ : ]
Properties

var attributes​

[String : AttributeValue]

Атрибуты кластера.

var userData​

Any

Пользовательские данные. Возвращаются в IClusterObject.

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​

Контрол компаса на SwiftUI.

Properties

var body​

some View

The content and behavior of the view.
This documentation comment was inherited from .

ContactInfo​

Способ связаться с организацией.

public init(
    type: String,
    displayText: String,
    value: String,
    comment: String?
)
Parameters

type

displayText

value

comment

Properties

var type​

Тип контакта. Один из следующих:

var displayText​

Значение контакта для вывода на экран.

var value​

Техническое значение контакта. В зависимости от типа контакта имеет следующую семантику:

var comment​

Уточняющая информация о контакте.

CurrentLocationView​

Контрол текущего местоположения на SwiftUI.

Properties

var body​

some View

The content and behavior of the view.
This documentation comment was inherited from .

DashedPolylineOptions​

Параметры пунктирной полилинии.

public init(
    dashLength: LogicalPixel = LogicalPixel(value: 5),
    dashSpaceLength: LogicalPixel = LogicalPixel(value: 2)
)
Parameters

dashLength

dashSpaceLength

Properties

var dashLength​

Длина пунктира.

var dashSpaceLength​

Длина межпунктирного расстояния.

DashedStrokeCircleOptions​

public init(
    dashLength: LogicalPixel = LogicalPixel(value: 5),
    dashSpaceLength: LogicalPixel = LogicalPixel(value: 2)
)
Parameters

dashLength

dashSpaceLength

Properties

var dashLength​

Длина пунктира.

var dashSpaceLength​

Длина межпунктирного расстояния.

DayTime​

Момент времени внутри дня.

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.
This documentation comment was inherited from .

Properties

var hours​

Часы, 0-23.

var minutes​

Минуты, 0-59.

DeviceDensity​

Множитель, который вычисляется как отношение DPI к базовому DPI устройства.
должен быть положительным.

public init(
    value: Float = 0
)
Parameters

value

Float
Properties

var value​

Float

DevicePpi​

Разрешающая способность дисплея устройства, в пикселях на дюйм.
должна быть положительной.

public init(
    value: Float = 0
)
Parameters

value

Float
public init(floatLiteral value: Float)

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

Parameters

value

Float

The value to create.

Properties

var value​

Float

static let autodetected​

PPI экрана головного устройства. Например, у смартфона, подключенного к CarPlay, это PPI экрана смартфона. Значение равно nil, если текущее устройство имеет неизвестный PPI (неподдерживаемое устройство, например из будущего). В таких случаях нужно самостоятельно задавать PPI с помощью записи в Map.devicePpi.

static let defaultForFailedAutodetection​

Этот PPI используется по умолчанию в том случае, когда не удалось автоматически определить по модели устройства. См. .autodetected.

DgisObjectId​

public init(
    objectId: UInt64 = 0,
    entranceId: UInt64 = 0
)
Parameters

objectId

entranceId

Properties

var objectId​

Стабильный числовой идентификатор объекта.
Нулевой идентификатор не соответствует ни одному объекту.

var entranceId​

Стабильный числовой идентификатор входа/подъезда для объекта object_id.
Нулевой идентификатор означает что вход/подъезд не задан.

DirectoryFilter​

Фильтры для справочника.

public init(
    workTime: WorkTimeFilter?,
    dynamic: [DynamicFilter]
)
Parameters

workTime

dynamic

Properties

var workTime​

Фильтр по времени работы.

var dynamic​

Динамические фильтры.

DoubleRouteEntry​

Элемент маршрута - точка и значение в ней.

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​

Неотрицательная высота точки над поверхностью в метрах.

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.
This documentation comment was inherited from .

Parameters

value

Float

The value to create.

Properties

var value​

Float

EntranceGeometry​

Геометрии для отображения входа на карте.

public init(
    entrancePoints: [GeoPoint],
    entrancePolylines: [[GeoPoint]]
)
Parameters

entrancePoints

entrancePolylines

Properties

var entrancePoints​

Местоположение входа.

var entrancePolylines​

Геометрии стрелок, указывающих на вход.

EntranceInfo​

Информация о входе в здание.

public init(
    id: DgisObjectId,
    buildingNumber: String?,
    porchName: String?,
    porchNumber: String?,
    apartmentRanges: [ApartmentRange],
    geometry: EntranceGeometry?
)
Parameters

id

buildingNumber

porchName

porchNumber

apartmentRanges

geometry

Properties

var id​

Идентификатор объекта входа.

var buildingNumber​

Номер дома, к которому относится вход.

var porchName​

Непустое имя подъезда. Заполняется только для подъездов. Может принимать значения имени подъезда (например “Подъезд 1”) или номера здания, если подъезд имеет собственный адрес.

var porchNumber​

Непустой номер подъезда. Заполняется только для подъездов. Может принимать значения номера подъезда (например “1”) или номера здания, если подъезд имеет собственный адрес.

var apartmentRanges​

Номера квартир, относящихся к подъезду.

var geometry​

Геометрии для отображения входа на карте.

ExcludedArea​

Исключаемая область, которую следует избегать при построении маршрута.

public init(
    type: ExcludedAreaType = ExcludedAreaType.point,
    severity: ExcludedAreaSeverity = ExcludedAreaSeverity.soft,
    extent: RouteDistance,
    points: [GeoPoint]
)
Parameters

type

severity

extent

points

Properties

var type​

Тип исключаемой области.

var severity​

Приоритет исключения области.

var extent​

Размер исключаемой области (не больше 25 км).

var points​

Координаты точек исключаемой области (не больше 500).

FlagFilter​

Фильтр - флаг.

public init(
    tagName: String,
    displayName: String,
    flagValue: Bool?
)
Parameters

tagName

displayName

flagValue

Properties

var tagName​

Тэг фильтра.

var displayName​

Название фильтра для отображения.
Зависит от языка выдачи. Не все названия могут быть переведены.

var flagValue​

Значение флага.

FloatRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: Float
)
Parameters

point

length

value

Float
Properties

var point​

var length​

var value​

Float

FloorInfo​

Информация об этажном плане для маркера - элемента поисковой выдачи.

public init(
    levelId: LevelId,
    buildingId: BuildingId
)
Parameters

levelId

buildingId

Properties

var levelId​

Идентификатор этажного плана.

var buildingId​

Идентификатор здания.

FollowPosition​

Настройки слежения за позицией.

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.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let coordinates​

static let bearing​

static let tilt​

static let styleZoom​

FormattedAddress​

Человекочитаемое представление адреса.

public init(
    drilldownAddress: String?,
    streetAddress: String?,
    addressComment: String?,
    postCode: String?
)
Parameters

drilldownAddress

streetAddress

addressComment

postCode

Properties

var drilldownAddress​

Адрес из дриллдауна. Пример: “Новосибирск, Кировский район”.

var streetAddress​

Адрес внутри населённого пункта. Пример: “Николаева, 11”.

var addressComment​

Комментарий к адресу. Пример: “301 офис; 9 этаж”.

var postCode​

Почтовый индекс объекта с кодом здания, если есть. Пример: “630088”, “630007/XBVJF8”.

GeoPoint​

Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).

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

Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) между двумя точками.

Parameters

point

Returns
Bearing
func distance(point: GeoPoint) -> Meter

Вычисляет минимальное (по ортодромии) расстояние между двумя точками.

Parameters

point

Returns
Meter
func move(bearing: Bearing, meter: Meter) -> GeoPoint

Вычисляет точку, полученную перемещением исходной точки в указанном направлении на указанное расстояние.

Parameters

bearing

meter

Returns
GeoPoint
Properties

var latitude​

var longitude​

var isValid​

GeoPointRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: GeoPoint
)
Parameters

point

value

Properties

var point​

var value​

GeoPointWithElevation​

Точка в географической системе координат (широта, долгота, возвышение).
возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.

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

Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) для проекции точки на карту и заданной точкой.

Parameters

point

Returns
Bearing
func distance(point: GeoPoint) -> Meter

Вычисляет минимальное (по ортодромии) расстояние между двумя точками.

Parameters

point

Returns
Meter
func move(bearing: Bearing, meter: Meter) -> GeoPointWithElevation

Вычисляет точку, полученную перемещением исходной точки в указанном направлении на указанное расстояние.

Parameters

bearing

meter

Returns
GeoPointWithElevation
Properties

var latitude​

var longitude​

var elevation​

var point​

GeoRect​

Прямоугольная область в сферической системе координат (например, WGS84). Данная структура не привязана к конкретной геодезической системе координат.

public init(
    southWestPoint: GeoPoint,
    northEastPoint: GeoPoint
)
Parameters

southWestPoint

northEastPoint

Methods
func contains(
    rect2: GeoRect
) -> Bool

Содержится ли rect2 внутри rect1, т.е. все его точки находятся внутри.

Parameters

rect2

Returns
Bool
func contains(
    point: GeoPoint
) -> Bool

Содержит ли прямоугольник точку. Точки, расположенные на границе, так же считаются принадлежащими прямоугольнику.

Parameters

point

Returns
Bool
func expand(
    rect2: GeoRect
) -> GeoRect

Расширить прямоугольник. Вернуть прямоугольник минимального размера, содержащий оба переданных прямоугольника.

Parameters

rect2

Returns
GeoRect
func expand(
    point: GeoPoint
) -> GeoRect

Расширить прямоугольник. Вернуть прямоугольник минимального размера, содержащий исходный прямоугольник и точку.

Parameters

point

Returns
GeoRect
func intersects(
    rect2: GeoRect
) -> Bool

Пересекаются ли прямоугольники, т.е. имеют общие точки. Прямогольники, с общими точками лишь на границе, так же считаются пересекающимися.

Parameters

rect2

Returns
Bool
Properties

var southWestPoint​

Юго-западная точка, левая нижняя граница прямоугольника.

var northEastPoint​

Северо-восточная точка, правая верхняя граница прямоугольника.

var isValid​

Проверяет прямоугольник на корректность.

var isDegenerate​

Проверяет прямоугольник на вырожденность. Если точки в прямоугольнике равны, то он вырождается в точку. Вырожденный прямоугольник является корректным прямоугольником. Некорректный прямоугольник не является вырожденным.

GradientPolylineOptions​

Параметры градиентной полилинии.

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​

Ширина границы линии.

var secondBorderWidth​

Ширина второй границы линии.

var gradientLength​

Длина градиентной линии.

var borderColor​

Цвет окантовки.

var secondBorderColor​

Цвет второй окантовки.

var colors​

Палитра цветов градиентной полилинии.

var colorIndices​

Data

Индексы цветов градиентной полилинии. Количество индексов должно быть на 1 меньше количества точек полилинии.

HttpHeader​

public init(
    name: String,
    value: String
)
Parameters

name

value

Properties

var name​

var value​

HTTPOptions​

Ключи для доступа к сервисам 2GIS.

public init(
	timeout: TimeInterval,
	cacheOptions: CacheOptions?
)
Parameters

timeout

TimeInterval

cacheOptions

CacheOptions?
Properties

let timeout​

Время ожидания по сетевому протоколу. По умолчанию 15 секунд.

let cacheOptions​

HTTPOptions.CacheOptions?

Режим кеширования. Если nil, кеш не используется. По умолчанию используется дисковый кеш в пользовательской директории кешей (NSCachesDirectory).

static let `default`​

Настройки по умолчанию. Максимальный размер кеша: 300 МБ.

HttpRequest​

Структура для представления HTTP запроса.

public init(
    url: String,
    method: HttpMethod = HttpMethod.gET,
    headers: [HttpHeader] = [],
    body: Data? = nil
)
Parameters

url

method

headers

body

Data?
Properties

var url​

Строковое представление URL запроса.

var method​

Метод HTTP запроса. По умолчанию GET.

var headers​

Заголовки запроса. По умолчанию пусто.

var body​

Data?

Тело запроса. По умолчанию отсутствует.

HttpResponse​

Структура для представления ответа на HTTP запрос.
тело ответа хранится и обрабатывается отдельно.

public init(
    statusCode: HttpStatusCode,
    headers: [HttpHeader]
)
Parameters

statusCode

headers

Properties

var statusCode​

HTTP статус код ответа от сервера.

var headers​

Заголовки ответа.

HttpStatusCode​

HTTP статус код ответа.

public init(
    value: Int32 = 0
)
Parameters

value

Int32
Properties

var value​

Int32

ImageData​

Данные изображения: размер, формат и бинарные данные.

public init(
    size: ScreenSize,
    format: ImageFormat,
    data: Data
)
Parameters

size

format

data

Data
Properties

var size​

var format​

var data​

Data

IndoorControlOptions​

Настройки UI-элемента управления этажами в здании.

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

Настройки по умолчанию. Автоматическое управление видимостью.

IndoorView​

Контрол этажей на SwiftUI.

Properties

var body​

some View

The content and behavior of the view.
This documentation comment was inherited from .

InstructionRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: RouteInstruction
)
Parameters

point

value

Properties

var point​

var value​

IntRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: Int32
)
Parameters

point

value

Int32
Properties

var point​

var value​

Int32

IsOpenNow​

Открыто сейчас.

public init()

LaneOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let left​

Левая полоса.

static let center​

Средняя полоса.

static let right​

Правая полоса.

LanesCalloutMapPosition​

Положение бабла полосности для маршрута.

public init(
    mapId: MapId,
    routePoint: RoutePoint,
    geoPoint: GeoPoint
)
Parameters

mapId

routePoint

geoPoint

Properties

var mapId​

Идентификатор карты, для которой приведена позиция.

var routePoint​

Позиция бабла полосности на маршруте.

var geoPoint​

Позиция бабла полосности на карте.

LaneSignRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RouteLaneSign
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

Latitude​

Географическая широта.

public init(
    value: Double = 0
)
Parameters

value

public init(floatLiteral value: Double)

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

Parameters

value

The value to create.

Properties

var value​

LevelId​

Идентификатор этажного плана.

public init(
    value: UInt64 = 0
)
Parameters

value

Properties

var value​

LevelInfo​

Информация об этаже здания.

public init(
    id: LevelId,
    name: String
)
Parameters

id

name

Properties

var id​

Идентификатор этажного плана.

var name​

Название этажа.

Locale​

Локаль.

public init(
    language: String,
    region: String
)
Parameters

language

region

Methods
static func makeLocale(
    localeStr: String
) -> Locale?

Создать локаль по строковому представлению в виде LanguageTag или POSIX.

Parameters

localeStr

Returns
Locale?
func toLocalePosix() -> String
Returns
String
Properties

var language​

Код языка, описанный в стандарте ISO 639-1,

var region​

Код страны, описанный в стандарте ISO 3166-1.

var description​

A textual representation of this instance.
This documentation comment was inherited from .

LocalizationOptions​

Настройки локализации приложения. Позволяют задать набор локалей, используемых для локализации карты и справочника.

public init(locales: [Locale], systemLocales: [Locale])

Конструктор настроек локализации.

Parameters

locales

Список локалей, поддерживаемых приложением.

systemLocales

Список системных локалей.

public init(locales: [Locale])

Конструктор настроек локализации.
В качестве параметра systemLocales используется список предпочтительных языков пользователя.

Parameters

locales

Список локалей, поддерживаемых приложением.

Properties

let locales​

Список локалей, поддерживаемых приложением. Если передать пустой список, будут использованы системные локали.

let systemLocales​

Список системных локалей. Если передать пустой список, будет использована en-EN.

static let `default`​

Настройки по умолчанию. Используется список предпочтительных языков пользователя.

Location​

Геопозиция.

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 - координаты геопозиции в системе координат WGS 84. coordinates::accuracy - горизонтальная точность определения координат геопозиции (DRMS), м. https://en.wikipedia.org/wiki/Circular_error_probable Область значений: >= 0.

var altitude​

altitude::value - высота над опорным эллипсоидом WGS 84, м. altitude::accuracy - стандартное отклонение ошибки измерения высоты, м. nil означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (nil, > 0).

var course​

course::value - путевой угол (направление движения вдоль поверхности Земли). Угол измеряется относительно географического севера). course::accuracy - стандартное отклонение ошибки измерения путевого угла. nil означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (nil, > 0).

var groundSpeed​

ground_speed - скорость движения вдоль поверхности Земли, м/с. Область значений: >= 0. ground_speed::accuracy - среднеквадратичное отклонение ошибки измерения скорости, м/с. nil означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (nil, > 0).

var source​

Название источника геопозиции.
timestamp’ы между разными источниками геопозиции не синхронизированы, поэтому сравнивать timestamp’ы у геопозиций, которые получены из разных источников нельзя.

var timestamp​

Временная точка, в которой была определена геопозиция. Эта точка не привязана ни к какой конкретной дате и используется исключительно для того, чтобы вычислить время между двумя измерениями геопозиции, полученными от одного источника геопозиции в одной сессии. Это поле должно монотонно возрастать (даже когда система находится в спящем режиме).

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​

Пиксель, размер которого не зависит от плотности экрана.

public init(
    value: Float = 0
)
Parameters

value

Float
public init(floatLiteral value: Float)

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

Parameters

value

Float

The value to create.

Properties

var value​

Float

LogMessage​

Сообщение, записываемое в лог.

public init(
    level: LogLevel,
    text: String,
    file: String,
    line: UInt32
)
Parameters

level

text

file

line

Properties

var level​

Уровень логирования.

var text​

Содержимое сообщения.

var file​

Путь до файла (полный или относительный), из которого произведена запись.

var line​

Номер строки, в которой было записано сообщение.

LogOptions​

Настройки ведения журнала SDK.

public init(
    osLogLevel: LogLevel,
    customLogLevel: LogLevel,
    customSink: LogSink?
)
Parameters

osLogLevel

customLogLevel

customSink

Properties

var osLogLevel​

Минимальный уровень ошибок, попадающих в системный журнал (os_log).

var customLogLevel​

Минимальный уровень ошибок, попадающих в пользовательский приемник логирования.

var customSink​

Пользовательский приемник логирования.

static let `default`​

Настройки по умолчанию. В журнал пишутся предупреждения и более серьёзные события.

Longitude​

Географическая долгота.

public init(
    value: Double = 0
)
Parameters

value

public init(floatLiteral value: Double)

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

Parameters

value

The value to create.

Properties

var value​

MapDirection​

Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.

public init(
    value: Double = 0
)
Parameters

value

Properties

var value​

MapGestureViewFactory​

Фабрика обработки жестов по умолчанию.

Implements: IMapGestureViewFactory
public init(options: MapGestureViewOptions = .default)
Parameters

options

Methods
public func makeGestureView(
	map: Map,
	eventProcessor: IMapEventProcessor,
	coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureView

Создать слой обработки жестов.
This documentation comment was inherited from .

Parameters

map

eventProcessor

coordinateSpace

Returns
UIView &

MapGestureViewOptions​

Настройки слоя жестов по умолчанию.

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

Настройки по умолчанию. Для жестов двойного тапа и тапа двумя пальцами масштабирование происходит относительно местоположение жеста.

MapId​

Идентификатор экземпляра карты, уникальный в рамках процесса.

public init(
    value: Int32 = 0
)
Parameters

value

Int32
Properties

var value​

Int32

MapOptions​

Первоначальные свойства карты, которые возможно задать при её инициализации. Установленное в nil свойство не будет применено, вследствие чего будет использовано значение по умолчанию.

Properties

var devicePPI​

Число физических экранных точек в линии длиной 2,54 см.

var deviceDensity​

Множитель, который вычисляется как отношение devicePPI к базовому DPI устройства. Значение множителя соответствует nativeScale целевого экрана.

var position​

Расположение камеры относительно карты.

var positionPoint​

Относительное расположение точки местоположения карты в пространстве вида камеры.

var zoomRestrictions​

Границы изменения масштаба карты.

var sources​

Источники данных карты.

var sourceDescriptors​

Set<MapOptions.SourceDescriptor>?

Упрощённый способ задания источников данных карты.

var styleFuture​

Future<Style>?

Начальный стиль карты с отложенной загрузкой. Стиль можно загрузить с помощью экземпляра IStyleFactory, см. Container.styleFactory. Используйте Future.makeReadyValue(style), если стиль уже загружен.

var gestureViewFactory​

Фабрика слоя обработки жестов. Если nil, жесты не обрабатываются, пока не будет установлено свойство IMapView.gestureView.

var appearance​

Выбор темы внутри выбранного стиля карты с учётом окружения.

var maxFps​

Максимально допустимая частота обновления карты.

var powerSavingMaxFps​

Максимально допустимая частота обновления карты в режиме сохранения энергии.

var backgroundColor​

Цвет фона до подгрузки стилей.

static var `default`​

Начальные настройки, устанавливаемые при создании объектов карты. DPI определяется на основании главного экрана устройства (см. DevicePpi.autodetected). Если автоопределение провалилось, то используется DevicePpi.defaultForFailedAutodetection.

MapViewOverlay​

Протокол слоя карты для SwiftUI.

Methods
func mapViewOverlayGestureView(_ view: (UIView & IMapGestureView)?) -> MapViewOverlay

Дополнительный слой, располагающийся над всей поверхностью карты. Используется для перехвата жестов. Если заменить этот слой на иной, нужно также реализовать отправку событий карты через IMapEventProcessor. В случае установки nil встроенная обработка жестов прекратится.

Returns
MapViewOverlay
func mapViewOverlayAppearance(_ value: MapAppearance) -> MapViewOverlay

Задать активный набор тем текущего стиля и возможность автоматического переключения тем в зависимости от окружения. Если выбран .automatic, карта переключится на выбранную пару тем с учётом текущего отображения (светлого или тёмного).

Parameters

value

Returns
MapViewOverlay
func mapViewOverlayShowsAPIVersion(_ value: Bool) -> MapViewOverlay

Показывать ли версию API в копирайте. По умолчанию false.

Parameters

value

Returns
MapViewOverlay
func mapViewOverlayCopyrightAlignment(_ alignment: CopyrightAlignment) -> MapViewOverlay

Положение копирайта.

Parameters

alignment

Returns
MapViewOverlay
func mapViewOverlayCopyrightInsets(_ insets: EdgeInsets) -> MapViewOverlay

Отступы копирайта от границ карты. По умолчанию .zero. При позиционировании учитываются safeAreaInsets представления карты. Значения отступов не должны быть отрицательными.

Parameters

insets

EdgeInsets
Returns
MapViewOverlay
func mapViewOverlayUrlOpener(_ url: ((URL) -> Void)?) -> MapViewOverlay

Пользовательский обработчик открытия URL при тапе в копирайт.
Позволяет переопределить поведение по умолчанию, при котором переход по ссылке будет осуществлен без подтверждения со стороны пользователя.

Returns
MapViewOverlay
func mapViewOverlayObjectTappedCallback(callback: MapObjectTappedCallback) -> MapViewOverlay

Добавить функцию обратного вызова, которая будет вызываться при клике на карту.

Parameters

callback

Returns
MapViewOverlay
func mapViewOverlayObjectLongPressCallback(callback: MapObjectTappedCallback) -> MapViewOverlay

Добавить функцию обратного вызова, которая будет вызываться при долгом клике на карту.

Parameters

callback

Returns
MapViewOverlay
func mapViewOverlayRemoveObjectTappedCallback(callback: MapObjectTappedCallback) -> MapViewOverlay

Удалить функцию обратного вызова, которая вызывалась при клике на карту.

Parameters

callback

Returns
MapViewOverlay
func mapViewOverlayRemoveLongPressCallback(callback: MapObjectTappedCallback) -> MapViewOverlay

Удалить функцию обратного вызова, которая вызывалась при долгом клике на карту.

Parameters

callback

Returns
MapViewOverlay
Properties

var body​

some View

The content and behavior of the view.
This documentation comment was inherited from .

MarkedUpText​

Размеченный текст.

public init(
    text: String,
    matchedParts: [MarkedUpTextSpan]
)
Parameters

text

matchedParts

Properties

var text​

Текст.

var matchedParts​

Набор непересекающихся Span в порядке их расположения в строке text, описывающих части, совпадающие с пользовательским запросом.

MarkedUpTextSpan​

Описывает поднабор байтов строки text.

public init(
    offset: UInt64,
    length: UInt64
)
Parameters

offset

length

Properties

var offset​

var length​

MarkerOptions​

Параметры маркера.

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​

Целевая ширина, используемая для масштабирования.

var userData​

Any

var zIndex​

Уровень отрисовки объекта.

var animatedAppearance​

Анимировать ли появление.

var levelId​

Привязка к поэтажному плану здания.

var iconAnimationMode​

Режим анимации.

MeasurementFormatterOutput​

Результат форматирования измерения.

public init(formattedMeasurement: String, unit: String)
Parameters

formattedMeasurement

unit

Properties

let formattedMeasurement​

Локализованное строковое представление измерения. Например: “40 км/ч”.

let unit​

Локализованное строковое представление единицы измерения. Например: “км/ч”.

Meter​

Длина/расстояние в метрах.

public init(
    value: Float = 0
)
Parameters

value

Float
public init(floatLiteral value: Float)

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

Parameters

value

Float

The value to create.

Properties

var value​

Float

MillisecondsRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: TimeInterval
)
Parameters

point

value

TimeInterval
Properties

var point​

var value​

MTLDeviceError​

Implements: ISDKError
public init(description: String)
Parameters

description

Properties

let description​

A textual representation of this instance.
This documentation comment was inherited from .

var debugDescription​

A textual representation of this instance, suitable for debugging.
This documentation comment was inherited from .

Настройки интерфейса навигатора.

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
)

Конструктор настроек.

Parameters

mapControlsBehaviour

Поведение UI-элементов камеры в режиме навигации.

distanceFormattingStrategy

Способ форматирования расстояний.

durationFormattingStrategy

Способ форматирования временного интервала.

durationValueFormattingStrategy

Способ форматирования значения временного интервала.

timeFormattingStrategy

Способ форматирования даты/времени.

speedFormattingStrategy

Способ форматирования скорости.

theme

Тема навигатора.

roadEventCardViewOptions

Настройки карточки дорожного события.

roadEventCreationEnabled

Нужен ли элемент создания дорожных событий.

Properties

static var `default`​

Настройки интерфейса навигатора по умолчанию..

Тема навигатора.

public init(colors: Colors)
Parameters

colors

Colors
public init(
	colors: Colors,
	dashboardTheme: DashboardTheme,
	remainingRouteInfoControlTheme: RemainingRouteInfoControlTheme,
	nextManeuverControlTheme: NextManeuverControlTheme,
	speedControlTheme: SpeedControlTheme,
	cameraControlTheme: CameraControlTheme,
	messageBarControlTheme: MessageBarControlTheme,
	mapControlsTheme: MapControlsTheme,
	betterRouteControlTheme: BetterRouteControlTheme,
	thermometerTheme: ThermometerTheme
)
Parameters

colors

Colors

dashboardTheme

DashboardTheme

remainingRouteInfoControlTheme

RemainingRouteInfoControlTheme

nextManeuverControlTheme

NextManeuverControlTheme

speedControlTheme

SpeedControlTheme

cameraControlTheme

CameraControlTheme

messageBarControlTheme

MessageBarControlTheme

mapControlsTheme

MapControlsTheme

betterRouteControlTheme

BetterRouteControlTheme

thermometerTheme

ThermometerTheme
Properties
NavigationViewTheme.Colors
NavigationViewTheme.DashboardTheme
NavigationViewTheme.RemainingRouteInfoControlTheme
NavigationViewTheme.NextManeuverControlTheme
NavigationViewTheme.SpeedControlTheme
NavigationViewTheme.CameraControlTheme
NavigationViewTheme.MessageBarControlTheme
NavigationViewTheme.MapControlsTheme
NavigationViewTheme.BetterRouteControlTheme
NavigationViewTheme.ThermometerTheme

static let `default`​

Тема навигатора по умолчанию.

NoopCancellable​

Готовая реализация ICancellable, которая ничего не отменяет.

Implements: ICancellable
public init()
Methods
public func cancel()

ObstacleInfo​

Информация о препятствии на маршруте.

public init(
    type: Obstacle = Obstacle.other,
    limitation: ObstaclePassLimitation = ObstaclePassLimitation.unlimited
)
Parameters

type

limitation

Properties

var type​

var limitation​

ObstacleInfoRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: ObstacleInfo
)
Parameters

point

value

Properties

var point​

var value​

ObstacleInfoRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: ObstacleInfo
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

Opacity​

Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность).

public init(
    value: Float = 0
)
Parameters

value

Float
Properties

var value​

Float

OpeningHours​

Часы работы организации.

public init(
    weekOpeningHours: [[WeekTimeInterval]],
    isOpen24x7: Bool
)
Parameters

weekOpeningHours

isOpen24x7

Properties

var weekOpeningHours​

Часы работы для каждого дня недели, начиная с понедельника.

var isOpen24x7​

OrderedValue​

Описывает одно значение из набора.

public init(
    value: String,
    text: String?
)
Parameters

value

text

Properties

var value​

Значение, по которым происходит фильтрация.

var text​

Название значения.

OrderedValues​

Описывает набор дискретных упорядоченных значений.

public init(
    values: [OrderedValue],
    currentMinIndex: UInt64? = nil,
    currentMaxIndex: UInt64? = nil
)
Parameters

values

currentMinIndex

currentMaxIndex

Properties

var values​

Набор значений. Упорядочен по возрастанию.

var currentMinIndex​

Индекс текущего установленного минимального значения.

var currentMaxIndex​

Индекс текущего установленного максимального значения.

PackageInfo​

Информация о пакете. См. 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​

Локализованное название пакета.

var installed​

Признак установки - true в случае, если пакет был выбран для установки.

var incomplete​

Признак незавершенности установки - true, если нет полностью загруженной версии пакета (возможно, несовместимой с текущей версией SDK).

var preinstalled​

Признак предустановленных пакетов. Предустановленные пакеты всегда установлены и полностью загружены, и их нельзя удалить.

var compatible​

Признак совместимости - true в случае, если загруженный пакет совместим с текущей версией SDK.

var hasUpdate​

Признак наличия обновления - true в случае наличия обновления для загруженного пакета. Возможна ситуация, когда во время процесса обновления до новой версии на сервере стала доступна ещё более новая версия пакета. В этом случае значение будет true как во время обновления, так и по его окончании.

var error​

Ошибка, произошедшая при попытке загрузки и/или установки пакета, или nil, если ошибки нет.

var updateStatus​

Статус обновления пакета.

var finalSizeOnDisk​

Размер территории в байтах, который она занимает на диске после установки. Неинициализированное значение означает, что территория не содержит файлов (информация получена на основе предустановленного файла состояния, в котором нет списка файлов для территории).

var currentSizeOnDisk​

Размер в байтах, который занимают на данный момент уже установленные файлы территории.

Padding​

Отступы от краёв камеры.

public init(
    left: UInt32 = 0,
    top: UInt32 = 0,
    right: UInt32 = 0,
    bottom: UInt32 = 0
)
Parameters

left

top

right

bottom

Properties

var left​

Отступ слева внутрь.

var top​

Отступ сверху внутрь.

var right​

Отступ справа внутрь.

var bottom​

Отступ снизу внутрь.

ParkingCapacity​

Вместимость парковки.

public init(
    total: String?,
    specialSpaces: [SpecialSpace]
)
Parameters

total

specialSpaces

Properties

var total​

Общая вместимость парковки, машиномест.

var specialSpaces​

Описание особых мест для парковки.

ParkingInfo​

Общая информация о парковке.

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​

Тип.

var purpose​

Назначение.

var access​

Тип доступа.

var pavingType​

Тип покрытия.

var isPaid​

Является ли парковка платной.

var isIncentive​

Является ли парковка перехватывающей.

var forTrucks​

Есть места для грузовиков.

var levelCount​

Количество уровней.

var capacity​

Вместимость.

PedestrianBriefRouteInfo​

Базовая информация о пешеходном маршруте.

public init(
    length: RouteDistance,
    landmark: String
)
Parameters

length

landmark

Properties

var length​

Длина маршрута.

var landmark​

Ориентир.

PedestrianInstructionCrossroad​

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

public init(
    landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.`none`,
    maneuvers: [PedestrianInstructionCrossroadManeuver]
)
Parameters

landmark

maneuvers

Properties

var landmark​

Ориентир.

var maneuvers​

Цепочка идущих подряд манёвров.

PedestrianInstructionCrossroadManeuver​

public init(
    direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.straight,
    turnAngle: Int32 = 0
)
Parameters

direction

turnAngle

Int32
Properties

var direction​

Направление движения.

var turnAngle​

Int32

Угол поворота в градусах [-180, 180].

PedestrianInstructionFinish​

Конец пешеходной части маршрута.

public init()

PedestrianInstructionIndoorEnter​

Вход в здание.

public init(
    levelId: LevelId = LevelId()
)
Parameters

levelId

Properties

var levelId​

Идентификатор этажа после входа в здание.

PedestrianInstructionIndoorExit​

Выход из здания.

public init()

PedestrianInstructionIndoorFloorChange​

Смена этажа в здании.

public init(
    type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.undefined,
    beginId: LevelId = LevelId(),
    endId: LevelId = LevelId()
)
Parameters

type

beginId

endId

Properties

var type​

Тип смены этажа.

var beginId​

Идентификатор этажа до смены.

var endId​

Идентификатор этажа после смены.

PedestrianInstructionStart​

Начало пешеходной части маршрута.

public init()

PedestrianRouteSearchOptions​

Параметры поиска пешеходного маршрута.

public init(
    avoidStairways: Bool = false,
    avoidUnderpassesAndOverpasses: Bool = false,
    useIndoor: Bool = true,
    excludedAreas: [ExcludedArea] = []
)
Parameters

avoidStairways

avoidUnderpassesAndOverpasses

useIndoor

excludedAreas

Properties

var avoidStairways​

Избегать лестниц.

var avoidUnderpassesAndOverpasses​

Избегать подземных и надземных переходов.

var useIndoor​

Строить маршруты внутри зданий.

var excludedAreas​

Исключаемые области (не больше 25).

PersonalDataCollectionOptions​

Настройки сбора и обработки персональных данных.

public init(personalDataCollectionConsent: PersonalDataCollectionConsent)
Parameters

personalDataCollectionConsent

Properties

Выбор пользователя в отношении сбора и обработки персональных данных.

static let `default`​

Настройки по умолчанию. Разрешение на сбор и обработку персональных данных предоставлено.

PlatformPositioningServicesFactory​

Реализация сервисов геопозиционирования на основе CLLocationManager.

Implements: IPositioningServicesFactory
public init(
	locationManager: CLLocationManager = CLLocationManager()
)
Parameters

locationManager

Properties

let locationProvider​

Интерфейс источника геопозиционирования. Если nil, то функции геопозиционирования SDK оказываются недоступны.
This documentation comment was inherited from .

let magneticHeadingProvider​

Интерфейс источника магнитного ориентирования. Если nil, то функции магнитного ориентирования SDK оказываются недоступны.
This documentation comment was inherited from .

PolygonOptions​

Параметры полигона.

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​

Уровень отрисовки объекта.

var levelId​

Привязка к поэтажному плану здания.

PolylineOptions​

Параметры полилинии.

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​

Точки полилинии.

var width​

Ширина полилинии.

var color​

Основной цвет полилинии.

var erasedPart​

Доля стёртой части полилинии, должна быть в диапазоне [0; 1]

var dashedPolylineOptions​

Параметры пунктирной полилинии.
Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.

var gradientPolylineOptions​

Параметры градиентной полилинии.
Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.

var visible​

Видимость полилинии.

var userData​

Any

Пользовательские данные.

var zIndex​

Уровень отрисовки объекта.

var levelId​

Привязка к поэтажному плану здания.

PublicBriefRouteInfo​

Базовая информация о маршруте на общественном транспорте.

public init(
    publicTransportInfos: [PublicBriefRouteTransportInfo]
)
Parameters

publicTransportInfos

Properties

var publicTransportInfos​

Описание способов проезда на общественном транспорте.

PublicBriefRouteTransportInfo​

Описание общественного транспортного средства.

public init(
    type: PublicTransportType = PublicTransportType.bus,
    names: [String],
    color: UInt32?,
    routeLogo: String
)
Parameters

type

names

color

routeLogo

Properties

var type​

Тип общественного транспортного средства.

var names​

Названия маршрутов общественного транспорта, на которых происходит проезд.

var color​

Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение nil.

Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.

PublicRoutePart​

Описание участка маршрута на общественном транспорте.

public init(
    transports: [PublicTransportInfo],
    intermediateStops: [PublicTransportStop]
)
Parameters

transports

intermediateStops

Properties

var transports​

Виды общественного транспорта, на котором можно проехать данный участок маршрута.
Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.

var intermediateStops​

Промежуточные остановки, которые транспорт проедет прежде, чем доберется до точки пересадки.

PublicTransportInfo​

Описание общественного транспортного средства.

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​

Тип общественного транспортного средства.

var names​

Названия маршрутов общественного транспорта, на которых происходит проезд.

var suggestedCarNumbers​

Номера вагонов, в которые рекомендуется посадка.
Если транспортное средство состоит из одного вагона или можно садиться в любой вагон, то этот список будет пустым.

var boardingSuggest​

Текстовое описание вагонов, в которые рекомендуется посадка.

var color​

Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение nil.

Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.

PublicTransportRouteSearchOptions​

Параметры поиска маршрута на общественном транспорте.

public init(
    startTime: Date? = nil,
    useSchedule: Bool = false,
    transportTypes: PublicTransportTypeOptionSet = []
)
Parameters

startTime

Date?

useSchedule

transportTypes

Properties

var startTime​

Date?

Время в UTC, на которое нужно построить маршрут. Если не задано, используется текущее время.

var useSchedule​

Учёт расписания движения общественного транспорта при построении маршрута.

var transportTypes​

Типы общественного транспорта. Если не заполнены, маршруты будут строиться для всех поддерживаемых типов общественного транспорта.

PublicTransportStop​

Описание остановки общественного транспорта.

public init(
    name: String,
    coordinates: GeoPoint
)
Parameters

name

coordinates

Properties

var name​

Название остановки.

var coordinates​

Географические координаты остановки.

PublicTransportTransfer​

Описание способа добраться на общественном транспорте до следующей точки пересадки.

public init(
    startPointName: String,
    finishPointName: String,
    routeParts: [PublicRoutePart]
)
Parameters

startPointName

finishPointName

routeParts

Properties

var startPointName​

Название точки, из которой начинается движение для данного участка маршрута.

var finishPointName​

Название точки назначения для данного участка маршрута.

var routeParts​

Описание участка маршрута на общественном транспорте, по которому можно добраться до следующей точки пересадки.

PublicTransportTransferRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

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.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let bus​

Автобус.

static let trolleybus​

Троллейбус.

static let tram​

Трамвай.

static let shuttleBus​

Маршрутное такси.

static let metro​

Метро.

static let suburbanTrain​

Пригородный поезд.

static let funicularRailway​

Фуникулёр.

static let monorail​

Монорельс.

static let waterwayTransport​

Водный транспорт.

static let cableCar​

Канатная дорога.

static let speedTram​

Скоростной трамвай.

static let premetro​

Подземный трамвай.

static let lightMetro​

Лёгкое метро.

static let aeroexpress​

Аэроэкспресс.

static let moscowCentralRing​

Московское центральное кольцо.

static let moscowCentralDiameters​

Московские центральные диаметры.

PurposeCode​

Код назначения здания.

public init(
    value: UInt64 = 0
)
Parameters

value

Properties

var value​

RangeFilter​

Фильтр диапазонов значений.

public init(
    tagName: String,
    displayName: String,
    minValue: Double,
    maxValue: Double
)
Parameters

tagName

displayName

minValue

maxValue

Properties

var tagName​

Тэг фильтра.

var displayName​

Название фильтра для отображения.
Зависит от языка выдачи. Не все названия могут быть переведены.

var minValue​

Минимальное значение диапазона.

var maxValue​

Максимальное значение диапазона.

RenderedObject​

Отображаемый объект карты.

public init(
    item: MapObject,
    source: Source,
    levelId: LevelId? = nil
)
Parameters

item

source

levelId

Properties

var item​

Объект карты.

var source​

Источник данных, содержащий объект карты.

var levelId​

Идентификатор этажного плана здания, на котором расположен объект.

RenderedObjectInfo​

Подробная информация об отображаемом объекте карты.

public init(
    closestViewportPoint: ScreenPoint,
    closestMapPoint: GeoPointWithElevation,
    item: RenderedObject
)
Parameters

closestViewportPoint

closestMapPoint

item

Properties

var closestViewportPoint​

Ближайшая точка объекта в координатах экрана.

var closestMapPoint​

Ближайшая точка объекта в координатах карты.

var item​

Отображаемый объект карты.

Reviews​

Отзывы.

public init(
    rating: Float,
    count: UInt32
)
Parameters

rating

Float

count

Properties

var rating​

Float

Рейтинг в диапазоне от 0 до 5.

var count​

Количество отзывов.

RoadCameraInfo​

Информация о камере.

public init(
    purposes: CameraPurposeOptionSet,
    speedLimit: UInt16?
)
Parameters

purposes

speedLimit

Properties

var purposes​

Назначения камеры.
Могут отсутствовать, если нет информации, или если камеру добавил пользователь.

var speedLimit​

Ограничение скорости в км/ч.

RoadEventActionInfo​

Информация о действии.

public init(
    state: RoadEventActionState,
    count: UInt32?
)
Parameters

state

count

Properties

var state​

Состояние действия.

var count​

Количество действий, применённых к событию всеми пользователями (только для пользовательских событий).

RoadEventCardViewOptions​

Настройки карточки дорожного события.

public init(
	timeFormattingStrategy: TimeFormattingStrategy = .default
)

Конструктор настроек.

Parameters

timeFormattingStrategy

Способ форматирования даты/времени.

Properties

var timeFormattingStrategy​

static var `default`​

Настройки карточки дорожного события по умолчанию.

RoadEventDisplayCategoryOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let camera​

Камеры всех типов, в том числе и добавленные пользователем.

static let comment​

Комментарии на дорогах.

static let accident​

ДТП.

static let roadRestriction​

Перекрытия дорог.

static let roadWorks​

Дорожные работы.

static let other​

События категории “Другое”.

static let user​

Всегда отображать события, созданные текущим пользователем, вне зависимости от их категории.

RoadEventRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: BriefRoadEvent
)
Parameters

point

value

Properties

var point​

var value​

RoadRuleRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadRule
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

RoadSubtypeRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadSubtype
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

RoadSurfaceRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadSurface
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

RoadTypeRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: RoadType
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

RouteBuildOptions​

Структура, которая описывает параметры построения маршрута в навигаторе.

public init(
    finishPoint: RouteSearchPoint,
    routeSearchOptions: RouteSearchOptions
)
Parameters

finishPoint

routeSearchOptions

Properties

var finishPoint​

Точка, к которой строится маршут.

var routeSearchOptions​

Параметры поиска маршрута.

RouteCamera​

Структура, описывающая дорожную камеру.

public init(
    purposes: RouteCameraPurposeOptionSet,
    rangeAgainst: RouteDistance,
    rangeAlong: RouteDistance,
    direction: RouteCameraDirection = RouteCameraDirection.against
)
Parameters

purposes

rangeAgainst

rangeAlong

direction

Properties

var purposes​

Назначения камеры.

var rangeAgainst​

Дальность действия камеры против хода движения.

var rangeAlong​

Дальность действия камеры по ходу движения.

var direction​

Направление действия камеры.

RouteCameraPurposeOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let speedControl​

Фиксация превышения скорости.

static let trafficLightsControl​

Фиксация проезда на запрещающий сигнал светофора.

static let stopLineControl​

Фиксация выезда за стоп-линию, проезда без остановки знака “Стоп”, выезда на перекрёсток во время затора.

static let publicTransportLaneControl​

Фиксация движения по выделенной полосе для общественного транспорта.

static let oncomingTrafficLaneControl​

Фиксация движения по встречной полосе.

static let pedestrianAdvantageControl​

Фиксация непредоставления преимущества пешеходам.

static let laneDisciplineControl​

Фиксация нарушения рядности поворота на перекрёстке.

static let roadMarkingsCrossingControl​

Фиксация пересечения сплошной линии разметки, движения по обочине.

static let averageSpeedControl​

Фиксация превышения средней скорости на участке.

static let noStoppingControl​

Фиксация нарушения запрета остановки.

static let dummy​

Муляж.

static let platon​

Камера системы “Платон”: https://platon.ru/ru/about/

RouteDistance​

Расстояние вдоль маршрута.

public init(
    millimeters: Int64 = 0
)
Parameters

millimeters

Int64
Properties

var millimeters​

Int64

RouteEditorRouteParams​

Информация о параметрах маршрута.

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​

Информация о маршрутах, которыми оперирует редактор.

public init(
    routes: [TrafficRoute],
    routeParams: RouteEditorRouteParams
)
Parameters

routes

routeParams

Properties

var routes​

При обновлении списка маршрутов активным будет первый маршрут, если список маршрутов непустой.

var routeParams​

Параметры маршрута, для которых выполнялся поиск. Могут отличаться от параметров, переданных редактору, если маршруты были найдены уже после изменения параметров в редакторе.

RouteExitSign​

Информация о знаке съезда.

public init(
    type: RouteExitSignType = RouteExitSignType.undefined,
    roadNameTable: RouteExitSignTable,
    roadNumberTable: RouteExitSignTable?
)
Parameters

type

roadNameTable

roadNumberTable

Properties

var type​

Тип съезда.

var roadNameTable​

Табличка съезда с названием дороги.

var roadNumberTable​

Табличка съезда с номером дороги.

RouteExitSignRouteEntry​

Элемент маршрута - точка и значение в ней.

public init(
    point: RoutePoint,
    value: RouteExitSign
)
Parameters

point

value

Properties

var point​

var value​

RouteExitSignTable​

Информация о табличке съезда.

public init(
    backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.undefined,
    text: String
)
Parameters

backgroundColor

text

Properties

var backgroundColor​

Цвет фона таблички съезда.

var text​

Текст на табличке съезда.

RouteIndex​

Индекс активного маршрута.

public init(
    value: UInt64 = 0
)
Parameters

value

Properties

var value​

RouteInfo​

Описание маршрута с манёврами.

public init(
    route: Route,
    routeBuildOptions: RouteBuildOptions?
)
Parameters

route

routeBuildOptions

Properties

var route​

Маршрут.

var routeBuildOptions​

Параметры построения маршрута в навигаторе. Значение равное nil означает, что у маршрута отсутствует конечная точка. В этом случае, на основании дорожного графа и параметров движения пользователя, вычисляется участок дороги, по которому предположительно движется пользователь и возвращается в виде маршрута в поле route. Следовательно, такой “маршрут” не может содержать инструкции и последняя точка в этом “маршруте” не является точкой назначения, в которую движется пользователь, а просто является точкой, до которой удалось предугадать движение пользователя. Куда он поедет дальше - неизвестно. Такой режим работы навигатора называется режим ведения без маршрута или free roam.

RouteInstruction​

Инструкция, которую необходимо выполнить для движения по маршруту.

public init(
    roadName: String,
    range: RouteDistance,
    extraInstructionInfo: ExtraInstructionInfo
)
Parameters

roadName

range

extraInstructionInfo

Properties

var roadName​

Название дороги, на которой окажется пользователь после совершения манёвра.

var range​

Расстояние после точки инструкции, на протяжении которого считается, что пользователь находится в зоне действия инструкции.

var extraInstructionInfo​

Специфичная для конкретного типа инструкции информация.

RouteLane​

Структура, описывающая одну полосу движения.

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​

Манёвр, который необходимо совершить для движения по маршруту.

var maneuvers​

Допустимые манёвры на полосе.

var speedLimit​

Float

Максимальная разрешенная скорость на полосе, м/с. 0 - ограничение скорости неизвестно.

var prohibited​

Проезд по полосе запрещён.

var onlyPublicTransport​

Полоса для общественного транспорта.

RouteLaneManeuverOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let undefined​

Не задан.

static let forward​

Прямо.

static let right​

Направо.

static let left​

Налево.

static let slightlyRight​

слегка направо.

static let slightlyLeft​

слегка налево.

static let sharplyRight​

резко направо.

static let sharplyLeft​

резко налево.

static let rightWithLeftTurns​

Направо с последующим поворотом налево.

static let turnover​

Разворот.

RouteLaneSign​

Описание полос движения.

public init(
    lanes: [RouteLane],
    signStartPoint: RoutePoint?,
    signPoint: RoutePoint?,
    signEndPoint: RoutePoint?
)
Parameters

lanes

signStartPoint

signPoint

signEndPoint

Properties

var lanes​

Полосы движения для автомобилей на участке дороги. Перечислены в порядке следования от середины проезжей части к обочине.
Если количество полос неизвестно либо в направлении маршрута на дороге находится одна полоса движения, то этот массив будет пустым.

var signStartPoint​

Точка на маршруте, в которой начинается действие знака, регулирующего движение по полосам. nil, если положение начала действия знака неизвестно.

var signPoint​

Точка на маршруте, в которой установлен знак, регулирующий движение по полосам. nil, если положение знака неизвестно.

var signEndPoint​

Точка на маршруте, в которой заканчивается действие знака, регулирующего движение по полосам. nil, если положение окончания действия знака неизвестно.

RouteLevelInfo​

Информация об этаже здания, соответствующая участку маршрута.

public init(
    beginId: LevelId?,
    endId: LevelId?,
    name: String
)
Parameters

beginId

endId

name

Properties

var beginId​

Идентификатор этажного плана в начальной точке участка маршрута. Отсутствует, если точка не находится в здании.

var endId​

Идентификатор этажного плана в конечной точке участка маршрута. Отсутствует, если точка не находится в здании.

var name​

Название этажа. Пусто, если участок маршрута соединяет разные этажи.

RouteLevelInfoRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

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.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let duration​

Время движения по маршруту.

static let length​

Длина маршрута.

RouteMapObjectDisplayFlagOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let routeParts​

Отрезки маршрута.

static let startPoint​

Стартовая точка маршрута.

static let finishPoint​

Конечная точка маршрута.

static let intermediatePoints​

Промежуточные точки маршрута.

static let transportConnectionPoints​

Точки соединения отрезков маршрута (кроме маршрутов на общественном транспорте). Например, точка в месте соединения пешеходного и автомобильного отрезка.

static let maneuvers​

Манёвры.

static let cameras​

Камеры.

static let humps​

Искуcственные неровности.

static let barriers​

Перекрытия дороги.

static let gates​

Ворота, шлагбаумы.

static let stairways​

Лестницы.

static let publicTransportPlatforms​

Остановки общественного транспорта.

static let accidents​

ДТП.

static let roadWorks​

Дорожные работы.

static let comments​

Комментарии.

static let roadRestrictions​

Перекрытия дорожного движения.

static let otherEvents​

События “Другое”.

static let tollRoads​

Начало и конец платной дороги.

static let lanesBubbles​

Баблы полосности (отображаются только в источнике с режимом навигации).

static let bubbles​

Баблы с временем движения и длиной маршрута.

static let indoorInstructions​

Перемещение внутри здания на лифте, эскалаторе и т.д.

static let inactiveFloors​

Показывать части маршрута внутри зданий не только для активного этажа.

static let trafficLights​

Подсвечивать светофоры на маршруте.

RouteMapObjectPermanentDisplayFlagOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let startPoint​

Стартовая точка маршрута.

static let finishPoint​

Конечная точка маршрута.

static let intermediatePoints​

Промежуточные точки маршрута.

static let cameras​

Камеры.

static let accidents​

ДТП.

static let roadWorks​

Дорожные работы.

static let comments​

Комментарии.

static let roadRestrictions​

Перекрытия дорожного движения.

static let otherEvents​

События “Другое”.

static let tollRoads​

Начало и конец платной дороги.

RoutePoint​

Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.

public init(
    distance: RouteDistance
)
Parameters

distance

Properties

var distance​

RouteSearchPoint​

Описание точек, по которым строится маршрут.

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​

Координаты, через которые нужно проложить маршрут.

var course​

Направление, в котором нужно преодолеть точку.

var objectId​

ID объекта, до которого будет проложена пешеходная часть маршрута.

var levelId​

Идентификатор этажного плана (для пешеходных маршрутов).

RubricId​

Идентификатор рубрики.

public init(
    value: UInt64 = 0
)
Parameters

value

Properties

var value​

Schedule​

Расписание действия дорожного события.

public init(
    startTime: Date?,
    finishTime: Date?,
    weekTimeIntervals: [WeekTimeInterval]
)
Parameters

startTime

Date?

finishTime

Date?

weekTimeIntervals

Properties

var startTime​

Date?

Время начала действия. Отсутствует, если неизвестно.

var finishTime​

Date?

Время начала действия. Отсутствует, если неизвестно.

var weekTimeIntervals​

Интервалы работы внутри недели.

ScooterBriefRouteInfo​

Базовая информация о маршруте на самокате.

public init(
    length: RouteDistance,
    landmark: String
)
Parameters

length

landmark

Properties

var length​

Длина маршрута.

var landmark​

Ориентир.

ScooterInstructionCrossroad​

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

public init(
    landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.`none`,
    maneuvers: [ScooterInstructionCrossroadManeuver]
)
Parameters

landmark

maneuvers

Properties

var landmark​

Ориентир.

var maneuvers​

Цепочка идущих подряд манёвров.

ScooterInstructionCrossroadManeuver​

public init(
    direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.straight,
    turnAngle: Int32 = 0
)
Parameters

direction

turnAngle

Int32
Properties

var direction​

Направление движения.

var turnAngle​

Int32

Угол поворота в градусах [-180, 180].

ScooterInstructionFinish​

Конец самокатной части маршрута.

public init()

ScooterInstructionStart​

Начало самокатной части маршрута.

public init()

ScooterRouteSearchOptions​

Параметры поиска маршрута на самокате.

public init(
    avoidCarRoads: Bool = true,
    avoidStairways: Bool = true,
    avoidUnderpassesAndOverpasses: Bool = true,
    excludedAreas: [ExcludedArea] = []
)
Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

var avoidCarRoads​

Избегать автомобильных дорог.

var avoidStairways​

Избегать лестниц.

var avoidUnderpassesAndOverpasses​

Избегать подземных и надземных переходов.

var excludedAreas​

Исключаемые области (не больше 25).

ScreenDistance​

Расстояние между объектами на экране в миллиметрах.
не может быть отрицательным

public init(
    value: Float = 0
)
Parameters

value

Float
Properties

var value​

Float

ScreenPoint​

Точка в экранных координатах.

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​

Смещение карты по горизонтали и вертикали в координатном пространстве экрана.

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​

Размер в пикселях.

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​

A textual representation of this instance.
This documentation comment was inherited from .

var debugDescription​

A textual representation of this instance, suitable for debugging.
This documentation comment was inherited from .

SegmentGeoPoint​

Описывает географическую точку на сегменте и направление сегмента. Геометрия маршрута представляет собой последовательность точек, которые попарно образуют отрезки (сегменты). При этом во всех функциях, работающих с геометрией маршрута считается, что первая точка из образующей отрезок пары входит в этот отрезок, а вторая - нет: [point_1, point_2),[point_2, point_3),…,[point_n-1, point_n)[point_last]. Последняя точка образует сама с собой отрезок нулевой длины. Т.о. каждая точка маршрута принадлежит ровно одному отрезку. Направление точки point_last не определено.

public init(
    point: GeoPoint,
    bearing: Bearing
)
Parameters

point

bearing

Properties

var point​

var bearing​

SettlementRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: Settlement
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

SimpleClusterOptions​

Параметры маркера кластера простых (simple) объектов-маркеров.

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​

Целевая ширина, используемая для масштабирования.

var userData​

Any

var zIndex​

Уровень отрисовки объекта.

var animatedAppearance​

Анимировать ли появление.

var iconAnimationMode​

Режим анимации.

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.
This documentation comment was inherited from .

Properties

let description​

A textual representation of this instance.
This documentation comment was inherited from .

var debugDescription​

A textual representation of this instance, suitable for debugging.
This documentation comment was inherited from .

SimulationAutoWithOverSpeed​

Структура для задания режима движения с учетом максимальной скорости на ребре маршрута.

public init(
    overSpeed: Double = 0
)
Parameters

overSpeed

Properties

var overSpeed​

Используемое превышение скорости в м/с. Допустимы значения только >= 0.

SimulationConstantSpeed​

Структура для задания режима движения с постоянной скоростью.

public init(
    speed: Double = 0
)
Parameters

speed

Properties

var speed​

Скорость движения в м/с. Допустимы значения только >= 0.

SortingFilter​

Фильтр сортировки.

public init(
    tagName: String,
    displayName: String
)
Parameters

tagName

displayName

Properties

var tagName​

Тэг фильтра.

var displayName​

Название фильтра для отображения.
Зависит от языка выдачи. Не все названия могут быть переведены.

SoundCategoryOptionSet​

public init(rawValue: UInt32)

Creates a new option set from the given raw value.
This documentation comment was inherited from .

Parameters

rawValue

The 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.
This documentation comment was inherited from .

static let crossroadCameras​

Камеры контроля перекрёстка.

static let laneCameras​

Камеры, фиксирующие движение по выделенной полосе для общественного транспорта.

static let noStoppingControlCameras​

Камеры контроля остановки.

static let roadMarkingCameras​

Камеры контроля разметки.

static let averageSpeedCameras​

Камеры контроля средней скорости.

static let maxSpeedCameras​

Камеры контроля мгновенной скорости.

static let accidents​

Аварии.

static let roadWorks​

Дорожные работы.

static let tolls​

Платные дороги.

static let exceedSpeedLimits​

Превышения максимально разрешённой скорости.

static let intermediatePoints​

Промежуточные точки на маршруте.

static let routeRebuild​

Маршрут перестроен.

static let instructions​

Инструкции (манёвры) на маршруте.

static let obstacles​

Препятствия.

static let roadSubtypes​

Подтипы дорог.

static let lostLocation​

Потерян сигнал GPS.

static let routeEnd​

Завершение маршрута.

SpecialSpace​

Особое место для парковки.

public init(
    type: SpecialSpaceType,
    name: String,
    count: String?
)
Parameters

type

name

count

Properties

var type​

Тип.

var name​

Локализованное название особого места.

var count​

Количество мест такого типа на парковке.

SpeedRange​

Интервал скоростей. Скорости задаются в метрах в секунду.

public init(
    minSpeed: Double = 0,
    maxSpeed: Double = 0
)
Parameters

minSpeed

maxSpeed

Properties

var minSpeed​

var maxSpeed​

SpeedRangeToStyleZoom​

Соответствие интервала скоростей и стилевого уровня масштабирования.

public init(
    range: SpeedRange,
    minDistanceToManeuver: RouteDistance,
    maxDistanceToManeuver: RouteDistance,
    styleZoom: StyleZoom
)
Parameters

range

minDistanceToManeuver

maxDistanceToManeuver

styleZoom

Properties

var range​

Интервал скоростей.

var minDistanceToManeuver​

Минимальное расстояние до манёвра, при котором должна включаться логика плавного увеличения уровня зума.

var maxDistanceToManeuver​

Максимальное расстояние после манёвра, при котором плавное уменьшение уровня зума должно завершиться.

var styleZoom​

Стилевой уровень масштабирования.

StringRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: String
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

StyleLayerId​

Идентификатор слоя стиля.

public init(
    id: String
)
Parameters

id

Properties

var id​

StyleZoom​

Стилевой уровень масштабирования.
StyleZoom не может быть отрицательным.

public init(
    value: Float = 0
)
Parameters

value

Float
public init(floatLiteral value: Float)

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

Parameters

value

Float

The value to create.

Properties

var value​

Float

TaxiRouteSearchOptions​

Параметры поиска маршрута на такси.

public init(
    car: CarRouteSearchOptions
)
Parameters

car

Properties

var car​

Параметры поиска маршрута, общие с прочими автомобильными.

TextStyle​

Настройки внешнего вида текста.

public init(
    fontSize: LogicalPixel = LogicalPixel(value: 8),
    color: Color = Color(),
    strokeWidth: LogicalPixel = LogicalPixel(value: 0.3499999940395355),
    strokeColor: Color = Color(argb: 4294967295),
    textPlacement: TextPlacement = TextPlacement.bottomCenter,
    textOffset: LogicalPixel = LogicalPixel(value: 0),
    fontName: String? = nil
)
Parameters

fontSize

color

strokeWidth

strokeColor

textPlacement

textOffset

fontName

Properties

var fontSize​

var color​

var strokeWidth​

var strokeColor​

var textPlacement​

var textOffset​

var fontName​

Theme​

Указание темы внутри некоторого стиля (см. Style).

public init(name: String)
Parameters

name

public init(stringLiteral value: String)

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

Parameters

value

The value of the new instance.

Properties

var description​

A textual representation of this instance.
This documentation comment was inherited from .

Tilt​

Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.

public init(
    value: Float = 0
)
Parameters

value

Float
public init(floatLiteral value: Float)

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

Parameters

value

Float

The value to create.

Properties

var value​

Float

TradeLicense​

Лицензия организации.

public init(
    type: String,
    license: String,
    legalForm: String,
    endDate: String
)
Parameters

type

license

legalForm

endDate

Properties

var type​

Тип.

var license​

Номер.

Форма собственности компании.

var endDate​

Дата, до которой действует лицензия.

TrafficControlState​

Состояние элемента управления видимостью пробок.

public init(
    status: TrafficControlStatus = TrafficControlStatus.hidden,
    score: UInt32?
)
Parameters

status

score

Properties

var status​

Статус, в зависимости от которого меняется внешний вид элемента управления.

var score​

Балл пробок. Отображается в виде надписи на контроле. Если отсутствует, отображается иконка-заглушка.

TrafficScore​

Оценка пробок.

public init(
    state: TrafficScoreState = TrafficScoreState.pending,
    value: UInt32?
)
Parameters

state

value

Properties

var state​

Актуальность значения.

var value​

Значение в баллах. Как правило, значения находятся в диапазоне от 1 до 10. Пустое значение, если информация ещё не получена, либо уже устарела, либо недоступна для заданного местоположения.

TrafficSpeedColorRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: TrafficSpeedColor
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

TrafficView​

Контрол пробок на SwiftUI.

Properties

var body​

some View

The content and behavior of the view.
This documentation comment was inherited from .

TrafficViewColors​

public init(
	titleColor: SwiftUI.Color,
	enabledTitleColor: 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.

emptyStateLoadingColor

ColorSwiftUI.

disabledInnerBackgroundColor

ColorSwiftUI.

lowScoreColor

ColorSwiftUI.

mediumScoreColor

ColorSwiftUI.

highScoreColor

ColorSwiftUI.

lowScoreDisabledColor

ColorSwiftUI.

mediumScoreDisabledColor

ColorSwiftUI.

highScoreDisabledColor

ColorSwiftUI.
Properties

static let `default`​

TransportTypeRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: TransportType
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

TruckPassZoneId​

Идентификатор пропускной зоны для грузовиков. Значение 0 соответствует отсутствию пропускной зоны.

public init(
    value: UInt32 = 0
)
Parameters

value

Properties

var value​

TruckPassZoneIdRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: TruckPassZoneId
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

TruckPassZonePass​

Пропуск, разрешающий движение грузового транспорта в пропускных зонах.

public init(
    id: TruckPassZonePassId,
    name: String,
    passZoneIds: Set<TruckPassZoneId>
)
Parameters

id

name

Properties

var id​

Идентификатор пропуска.

var name​

Название пропуска.

var passZoneIds​

Set<TruckPassZoneId>

Идентификаторы пропускных зон, по которым разрешает движение данный пропуск

TruckPassZonePassId​

Идентификатор пропуска, разрешающего движение грузового транспорта в пропускных зонах.

public init(
    value: UInt32 = 0
)
Parameters

value

Properties

var value​

TruckRouteSearchOptions​

Параметры поиска маршрута на грузовом транспорте. При поиске маршрута учитываются только заполненные параметры.

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​

Параметры поиска маршрута, общие с прочими автомобильными.

var truckLength​

Длина грузового транспортного средства в миллиметрах.

var truckHeight​

Высота грузового транспортного средства в миллиметрах.

var truckWidth​

Ширина грузового транспортного средства в миллиметрах.

var actualMass​

Фактическая масса грузового транспортного средства в килограммах.

var maxPermittedMass​

Разрешённая максимальная масса грузового транспортного средства в килограммах.

var axleLoad​

Нагрузка на ось в килограммах.

var dangerousCargo​

Признак наличия опасного груза.

var explosiveCargo​

Признак наличия взрывчатых веществ в грузе.

var passIds​

Set<TruckPassZonePassId>

Идентификаторы имеющихся у пользователя пропусков, требующихся для движения в пределах пропускных зон.

var fallbackOnCar​

Использование автоматического фоллбека с поиска грузового маршрута на поиск автомобильного маршрута при невозможности найти грузовой маршрут, удовлетворяющий параметрам поиска.

UIMarkerInfo​

Идентификатор объекта с подписью.

public init(
    objectId: DgisObjectId,
    label: String?
)
Parameters

objectId

label

Properties

var objectId​

var label​

UIntRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

public init(
    point: RoutePoint,
    length: RouteDistance,
    value: UInt32
)
Parameters

point

length

value

Properties

var point​

var length​

var value​

UnavailablePositioningServicesFactory​

Реализация сервисов геопозиционирования, отключающая доступ к этим функциям.

Implements: IPositioningServicesFactory
public init()
Properties

let locationProvider​

Интерфейс источника геопозиционирования. Если nil, то функции геопозиционирования SDK оказываются недоступны.
This documentation comment was inherited from .

let magneticHeadingProvider​

Интерфейс источника магнитного ориентирования. Если nil, то функции магнитного ориентирования SDK оказываются недоступны.
This documentation comment was inherited from .

VendorConfigOptions​

Настройки SDK 2ГИС для работы в автономных конфигурациях.

public init(vendorConfigFile: File)
Parameters

vendorConfigFile

Properties

let vendorConfigFile​

Файл с переопределениями настроек.

WeekTime​

Момент времени внутри недели.

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.
This documentation comment was inherited from .

Properties

var weekDay​

День недели.

var time​

Время.

WeekTimeInterval​

Интервал времени в течение недели.

public init(
    startTime: WeekTime,
    finishTime: WeekTime
)
Parameters

startTime

finishTime

Properties

var startTime​

Время начала.

var finishTime​

Время окончания.

WorkStatus​

Статус работы.

public init(
    isOpen: Bool,
    description: String
)
Parameters

isOpen

description

Properties

var isOpen​

Открыто ли сейчас.

var description​

Текстовое описание. Например, “Открыто до 21:00”, “Круглосуточно”, “Закроется через 5 минут”.

ZIndex​

Индекс, задающий порядок отрисовки объектов в рамках слоя.

public init(
    value: UInt32 = 0
)
Parameters

value

Properties

var value​

Zoom​

Уровень масштабирования.
Zoom не может быть отрицательным.

public init(
    value: Float = 0
)
Parameters

value

Float
public init(floatLiteral value: Float)

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

Parameters

value

Float

The value to create.

Properties

var value​

Float

ZoomView​

Контрол зума на SwiftUI.

Properties

var body​

some View

The content and behavior of the view.
This documentation comment was inherited from .