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

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​

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​

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

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, r