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

interface

CameraMoveController​

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

Methods
func position(
    time: TimeInterval
) -> CameraPosition
Parameters

time

TimeInterval
Returns
CameraPosition
func animationTime() -> TimeInterval
Returns
TimeInterval

CustomFollowController​

Интерфейс, который можно реализовать на платформе для создания собственного контроллера слежения за параметрами Для добавления контроллера в камеру, нужно реализовать этот интерфейс и создать объект FollowController’а передав в качестве аргумента объект, реализующий данные интерфейс.

Methods
func availableValues() -> FollowValueOptionSet
Returns
FollowValueOptionSet
func requestValues(
    values: FollowValueOptionSet
)
Parameters

values

func setNewValuesNotifier(
    notifier: NewValuesNotifier?
)
Parameters

notifier

func coordinates() -> GeoPoint?
Returns
GeoPoint?
func bearing() -> Bearing?
Returns
Bearing?
func tilt() -> Tilt?
Returns
Tilt?
func styleZoom() -> StyleZoom?
Returns
StyleZoom?

HttpClient​

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

Methods
func sendRequest(
    request: HttpRequest,
    callback: HttpResponseCallback
)
Parameters

request

callback

IAudioSettings​

Интерфейс для изменения настроек звука.

Properties

var muteOtherSounds​

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

var audioVolume​

Уровень громкости звука.

IBatteryManagerDelegate​

Методы управления слежением за батареей. Реализация может включать и выключать слежение за батареей с помощью изменения UIDevice.isBatteryMonitoringEnabled.

Methods
func startBatteryMonitoring()

Запрос на запуск слежения за состоянием батареи с помощью установки UIDevice.current.isBatteryMonitoringEnabled в true. Если UIDevice.current.isBatteryMonitoringEnabled уже true, то менять состояние необязательно. Если включение слежения нежелательно, реализация может быть пустой.

func stopBatteryMonitoring()

Запрос на выключение слежения за состоянием батареи с помощью установки UIDevice.current.isBatteryMonitoringEnabled в true. Если UIDevice.current.isBatteryMonitoringEnabled уже false, то менять состояние необязательно. Если необходимо продолжать слежение за батареей, значение isBatteryMonitoringEnabled может быть оставлено прежним.

ICancellable​

Жетон для отмены операции, при запуске которой он был получен.

Methods
func cancel()

ICreateRoadEventView​

Протокол интерфейса создания дорожного события.

Properties

var visibleAreaEdgeInsets​

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

var visibleAreaEdgeInsetsChangedCallback​

((UIEdgeInsets) -> ())?

Замыкание обратного вызова при изменении видимой области.

var cancelButtonCallback​

(() -> ())?

Замыкание обратного вызова при нажатии кнопки отмены.

var createRoadEventRequestCallback​

((Result<AddEventResult, Error>) -> ())?

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

IDoubleTapAndPanGestureRecognizer​

Properties

var scaleDoublingTranslation​

Число точек вертикального сдвига, приводящее к изменению масштаба в два раза.
Для обработчика жеста по умолчанию используется значение -100. Сдвиг вниз (увеличение y) увеличивает масштаб. Сдвиг вверх (уменьшение y) уменьшает масштаб. Для увеличения масштаба в 2 раза, при таком значении скорости масштабирования, нужно провести пальцем вниз на 100 pt.

IEnergyConsumption​

Протокол для настройки энергосбережения устройства.

Methods
func setFpsCallback(_ fpsCallback: FpsCallback?)

Установить функцию обратного вызова на изменение fps.

Parameters

fpsCallback

FpsCallback?
Properties

var maxFps​

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

var powerSavingMaxFps​

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

IHTTPClient​

Интерфейс сетевого клиента для отправки HTTP-запросов.

Methods
func send(
	request: URLRequest,
	callback: @escaping RequestDataCompletionCallback
)

Функция для отправки запроса и получения результата выполнения через callback. Обработка результатов будет выполнена в callback.

Parameters

request

URLRequest

HTTP-запрос.

callback

RequestDataCompletionCallback

Функция обратного вызова при получении результата запроса.

IImageFactory​

Methods
func make(pngData: Data, size: CGSize) -> Image

Создать изображение на основе PNG-данных.

Parameters

pngData

Data

size

Returns
Image
func make(svgData: Data, size: CGSize) -> Image

Создать изображение на основе SVG-данных.

Parameters

svgData

Data

size

Returns
Image
func make(lottieData: Data, size: CGSize) -> Image

Создать анимированное изображение на основе Lottie-данных.

Parameters

lottieData

Data

size

Returns
Image
func make(image: UIImage) -> Image

Создать изображение на основе объекта UIImage. При наличии готовых PNG-данных метод make(pngData:size:) работает эффективнее.

Parameters

image

Returns
Image
func make(imageFactory: @escaping () -> UIImage) -> Image

Создать изображение на основе отложенного объекта UIImage. Переданное замыкание вызывается отложенно в тот момент, когда нужны данные. При наличии готовых PNG-данных метод make(pngData:size:) работает эффективнее.

Returns
Image

ILocationProvider​

Интерфейс источника геопозиции, который реализуется на платформе.

Methods
func setCallbacks(
	locationCallback: LocationCallback?,
	availabilityCallback: AvailabilityCallback?
)

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

Parameters

locationCallback

LocationCallback?

Функция обратного вызова на обновление текущей гепозиции. Если провайдер доступен (вызов availabilityCallback со значением true), то данный источник всегда доставляет достоверную геопозицию. Достоверная геопозиция - это геопозиция, в которой все поля имеют актуальное значение на момент ее отправки в этот канал (т.е. если точность геопозиции >= половине длины экватора Земли, то геопозиция является достоверной для любых от указанных в ней корректных координат). Если значение точности <= 0, то позиция считается недостоверной даже если isAvailable == true. См. метод CLLocationManagerDelegate.locationManager(didUpdateLocations:).

availabilityCallback

AvailabilityCallback?

Функция обратного вызова на изменение доступности источника геопозиции. Если вызвана эта функция со значением true, то все последующие вызовы locationCallback будут содержать достоверную (актуальную) геопозицию. Даже если слежение за изменением геопозиции недоступно, реализация ILocationProvider может присылать новую геопозицию, но она будет считаться недостоверной. См. метод CLLocationManagerDelegate.locationManager(didFailWithError:).

func setDesiredAccuracy(_ accuracy: DesiredAccuracy)

Задает желаемую точность определения местоположения. Если устройство не может вернуть местоположение с желаемой точностью, то оно может вернуть местоположение с меньшей точностью. Если платфора не предоставляет аналогичный по функциональности метод, то данный метод должен иметь пустую реализацию.
См. метод CLLocationManager.desiredAccuracy и \ .

Parameters

accuracy

Properties

var lastLocation​

Наилучшая известная на текущий момент геопозиция. Если известная на текущий момент геопозиция отсутствует, возвращается nil. Возвращаемая данным методом геопозиция может быть недостоверной (см. setCallbacks). Этот метод должен запросить у системы наилучшую известную на текущий момент геопозиции и вернуть её даже если она является устаревшей и/или не соответствует требуемой точности. Если API платформы не предоставляет аналогичный по функциональности метод, то данный метод всегда должен возвращать nil.
См. метод CLLocationManager.location.

ILocationService​

Интерфейс источника геопозиции.

Properties

var lastLocation​

Наилучшая известная на текущий момент геопозиция. Если известная на текущий момент геопозиция отсутствует, возвращается nil. Возвращаемая данным методом геопозиция может быть недостоверной. Этот метод должен запросить у системы наилучшую известную на текущий момент геопозиции и вернуть её даже если она является устаревшей и/или не соответствует требуемой точности. Если API платформы не предоставляет аналогичный по функциональности метод, то данный метод всегда будет возвращать nil.
См. метод CLLocationManager.location.

IMagneticHeadingProvider​

Протокол, предоставляющий направление устройства относительно направления на магнитный север. Все методы данного интерфейса должны вызываться из очереди IPositioningServicesFactory.positiningQueue.

Methods
func setCallbacks(
	headingCallback: HeadingCallback?,
	availabilityCallback: AvailabilityCallback?
)

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

Parameters

headingCallback

HeadingCallback?

Функция обратного вызова на обновление текущего направления. См. метод CLLocationManagerDelegate.locationManager(didUpdateHeading:).

availabilityCallback

AvailabilityCallback?

Функция обратного вызова на изменение доступности источника направления. Даже если слежение за изменением направления недоступно, реализация может присылать новое направление, но оно будет считаться недостоверным. См. метод CLLocationManagerDelegate.locationManager(didFailWithError).

IMapControlFactory​

Фабрика кнопок для добавления на карту.

Methods
func makeZoomControl() -> ZoomControl
Returns
ZoomControl
func makeCurrentLocationControl() -> CurrentLocationControl
Returns
CurrentLocationControl
func makeCompassControl() -> CompassControl
Returns
CompassControl
func makeTrafficControl() -> TrafficControl
Returns
TrafficControl
func makeCreateRoadEventControl() -> CreateRoadEventControl
Returns
CreateRoadEventControl
func makeIndoorControl(_ options: IndoorControlOptions) -> IndoorControl
Parameters

options

Returns
IndoorControl
func makeIndoorControl(_ options: IndoorControlOptions = .default) -> IndoorControl
Parameters

options

Returns
IndoorControl

IMapControlViewFactory​

Фабрика SwiftUI кнопок для добавления на карту.

Methods
func makeCurrentLocationView() -> CurrentLocationView
Returns
CurrentLocationView
func makeZoomView() -> ZoomView
Returns
ZoomView
func makeTrafficView(colors: TrafficViewColors) -> TrafficView
Parameters

colors

Returns
TrafficView
func makeIndoorView() -> IndoorView
Returns
IndoorView
func makeCompassView() -> CompassView
Returns
CompassView

IMapCoordinateSpace​

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

Implements: INativeScaleProvider

IMapEventProcessor​

Обработчик жестов карты. Все координаты принимаются в физических точках (пикселах).

Methods
func process(event: Event)

Обработка события управления картой.

Parameters

event

Событие управления картой.

IMapFactory​

Фабрика согласованых объектов карты.

Properties

var initialMapOptions​

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

var map​

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

var mapView​

Слой карты. Можно читать только из главной очереди.

var mapViewOverlay​

Слой карты для SwiftUI. Можно читать только из главной очереди.

var gestureView​

(UIView & IMapGestureView)?

Слой обработки жестов. За создание слоя отвечает свойство initialMapOptions.gestureViewFactory. Можно читать только из главной очереди.

var mapEventProcessor​

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

var mapCoordinateSpace​

Координатное пространство карты.

var mapControlFactory​

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

var mapControlViewFactory​

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

var snapshotter​

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

var energyConsumption​

Объект для настройки энергосбережения устройства.

var markerViewOverlay​

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

IMapGestureView​

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

Properties

var doubleTapGestureRecognizer​

Распознаватель двойного прикосновения. Используется для приближения карты (уменьшения масштаба) с фиксированным коэффициентом.

var panGestureRecognizer​

Распознаватель таскания. Используется для перемещения карты в плоскости. По умолчанию распознаётся таскание ровно одной точкой нажатия.

var twoFingerPanGestureRecognizer​

Таскание двумя пальцами. Используется для трёхмерного наклона карты относительно горизонта.

var rotationGestureRecognizer​

Жест вращения карты в плоскости.

var pinchGestureRecognizer​

Изменение масштаба щипанием.

var twoFingerTapGestureRecognizer​

Кратковременное прикосновение двумя пальцами. Используется для отдаления карты (увеличения масштаба) с фиксированным коэффициентом.

var doubleTapAndPanGestureRecognizer​

(UIGestureRecognizer & IDoubleTapAndPanGestureRecognizer)?

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

IMapGestureViewFactory​

Фабрика слоя обработки жестов. Все методы вызываются только на главной очереди.

Methods
@available(*, deprecated, message: "Please use makeGestureView(map:eventProcessor:coordinateSpace:)")

func makeGestureView(
	map: Map,
	coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureView

Создать слой обработки жестов.
Устаревший метод. Необходимо использовать makeGestureView(map:eventProcessor:coordinateSpace:).

Parameters

map

coordinateSpace

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

Создать слой обработки жестов.

Parameters

map

eventProcessor

coordinateSpace

Returns
UIView & 
@available(*, deprecated, message: "Please use makeGestureView(map:eventProcessor:coordinateSpace:)")

func makeGestureView(
	map: Map,
	coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureView

Создать слой обработки жестов.

Parameters

map

coordinateSpace

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

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

Parameters

map

eventProcessor

coordinateSpace

Returns
UIView &

IMapSnapshotter​

Инструмент по захвату изображения карты.

Methods
func makeImage(
	scale: CGFloat,
	orientation: UIImage.Orientation
) -> Future<UIImage>

Получить изображение карты на основе её текущего состояния. Можно вызывать из любой очереди. Значение возвращается во Future на неопределённой очереди.
Перед вызовом метода необходимо убедиться, что сцена, отображающая карту, находится в состоянии UIScene.ActivationState.foregroundActive. Под iOS 12 приложение должно находиться в состоянии UIApplication.State.active.

Parameters

scale

Множитель полученного изображения (см. UIImage.scale).

orientation

Ориентация изображения (см. UIImage.orientation).

func makeImage(
	scale: CGFloat = 1,
	orientation: UIImage.Orientation = .up
) -> Future<UIImage>

Получить изображение карты на основе её текущего состояния. Можно вызывать из любой очереди. Значение возвращается во Future на неопределённой очереди.
Перед вызовом метода необходимо убедиться, что сцена, отображающая карту, находится в состоянии UIScene.ActivationState.foregroundActive. Под iOS 12 приложение должно находиться в состоянии UIApplication.State.active.

Parameters

scale

Множитель полученного изображения (см. UIImage.scale). По умолчанию 1.

orientation

Ориентация изображения (см. UIImage.orientation). По умолчанию .up.

IMapView​

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

Methods
func addObjectTappedCallback(callback: MapObjectTappedCallback)

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

Parameters

callback

func addObjectLongPressCallback(callback: MapObjectTappedCallback)
Parameters

callback

func removeObjectTappedCallback(callback: MapObjectTappedCallback)

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

Parameters

callback

func removeLongPressCallback(callback: MapObjectTappedCallback)
Parameters

callback

Properties

var gestureView​

(UIView & IMapGestureView)?

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

var appearance​

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

var showsAPIVersion​

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

По умолчанию bottomRight.

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

var urlOpener​

((URL) -> ())?

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

IMarkerView​

Протокол UIView маркера.

Properties

var id​

UUID

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

var position​

Точка на карте, к которой осуществляется привязка.

var tapHandler​

(() -> ())?

Пользовательский обработчик при тапе в UIView маркер.

IMarkerViewFactory​

Фабрика для создания UIView маркеров.

Methods
func make(
	/// Отображение маркера.
	view: UIView,
	/// Точка на карте, к которой осуществляется привязка.
	position: GeoPointWithElevation,
	/// Относительная точка на View, к которой осуществяется привязка.
	anchor: Anchor,
	/// Дополнительное смещение в пикселях по оси X.
	offsetX: CGFloat,
	/// Дополнительное смещение в пикселях по оси Y.
	offsetY: CGFloat
) -> IMarkerView

Создать маркер.

Parameters

view

position

anchor

offsetX

offsetY

Returns
IMarkerView

IMarkerViewOverlay​

Протокол для работы с UIView маркерами на карте.

Methods
func add(markerView: IMarkerView)

Добавить UIView маркер.

Parameters

markerView

func add(markerViews: [IMarkerView])
Parameters

markerViews

func remove(markerView: IMarkerView)

Удалить UIView маркер.

Parameters

markerView

func remove(markerViews: [IMarkerView])
Parameters

markerViews

func removeAll()

Удалить все маркеры.

INativeScaleProvider​

Протокол, описывающие преобразование точек в пикселы.

Properties

var nativeScale​

Множитель для преобразования в пикселы. Если карта не существует, то значение равно 1. Можно обращаться только из главной очереди.

var toPixels​

Матрица преобразования из точек в пикселы. Множитель по x и y равен nativeScale.

INavigationControlView​

UI-элемент навигатора.

Properties

var isVisible​

Видимость элемента.

var onDidChangeVisibility​

(() -> ())?

Сигнал изменения видимости элемента.

INavigationMapControlsFactory​

Фабрика UI-элементов карты в навигаторе.

Methods
func makeZoomControl() -> UIControl

UI-элемент для изменения масштаба карты.

Returns
UIControl
func makeTrafficAndParkingMapControl() -> UIControl

UI-элемент для включения/выключения отображения пробок и парковочных мест.

Returns
UIControl
func makeCompassControl() -> UIControl

UI-элемент для отображения компаса.

Returns
UIControl
func makeCompassControl(icon: UIImage?, highlightedIcon: UIImage?) -> UIControl

UI-элемент для отображения компаса.

Parameters

icon

highlightedIcon

Returns
UIControl
func makeNavigationFollowingControl() -> NavigationFollowingControl

UI-элемент включения режима слежения.

Returns
NavigationFollowingControl
func makeTUGCControl() -> UIControl

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

Returns
UIControl
func makeIndoorControl() -> IndoorControl

UI-элемент для переключения этажей в этажном плане.

Returns
IndoorControl
func makeTrafficControl() -> UIControl

UI-элемент для отдельного контрола включения/выключения отображения пробок.

Returns
UIControl
func makeParkingControl() -> UIControl

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

Returns
UIControl
func makeCompassControl(icon: UIImage?, highlightedIcon: UIImage?) -> UIControl

UI-элемент для отображения компаса.
This documentation comment was inherited from .

Parameters

icon

highlightedIcon

Returns
UIControl
func makeTrafficControl() -> UIControl

UI-элемент для отдельного контрола включения/выключения отображения пробок.
This documentation comment was inherited from .

Returns
UIControl
func makeParkingControl() -> UIControl

UI-элемент для отдельного контрола включения/выключения отображения парковочных мест.
This documentation comment was inherited from .

Returns
UIControl
Properties

var followManager​

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

INavigationView​

Methods
func showRoadEvent(_ roadEvent: RoadEvent)

Показать карточку дорожного события.

Parameters

roadEvent

Properties

var visibleAreaEdgeInsets​

Видимая область карты с учетом интерфейса навигатора.

var visibleAreaEdgeInsetsChangedCallback​

((UIEdgeInsets) -> ())?

Замыкание обратного вызова при изменении видимой области карты.

var finishButtonCallback​

(() -> ())?

Замыкание обратного вызова при нажатии кнопки завершения маршрута.

INavigationViewControlsFactory​

Фабрика UI-элементов навигатора.

Methods
func makeNextManeuverControl(
	uiModel: Model
) -> UIView & INextManeuverControlView

UI-элемент с информацией о следующем манёвре и дополнительном манёвре. См. , , .

Parameters

uiModel

Returns
UIView & 
func makeSpeedControl(
	uiModel: Model
) -> (UIView & INavigationControlView)

UI-элемент с информацией о текущей скорости движения, ограничении скорости на текущем участке маршрута и предупреждении о прохождении зоны действия камеры. См. , и .

Parameters

uiModel

func makeRemainingRouteInfoControl(
	navigationManager: NavigationManager
) -> UIView & INavigationControlView

UI-элемент с информацией об оставшемся расстоянии и ориентировочном времени прибытия/оставшемся времени в пути. См. , и .

Parameters

navigationManager

Returns
UIView & 
func makeMessageBarControl(
	uiModel: Model
) -> UIView & INavigationControlView

UI-элемент для отображения сообщений о статусе навигации, например, о поиске маршрута и потере сигнала GPS. См. и .

Parameters

uiModel

Returns
UIView & 
func makeBetterRouteControl(
	uiModel: Model
) -> UIView & INavigationControlView

UI-элемент перехода на маршрут с меньшим ожидаемым временем прибытия. См. .

Parameters

uiModel

Returns
UIView & 
func makeThermometerControl(
	uiModel: Model
) -> UIView & IThermometerControlView

UI-элемент для отображения скоростей движения ТС и дорожных событий на маршруте. См. .

Parameters

uiModel

Returns
UIView &

INavigationViewFactory​

Фабрика UI-элементов навигатора.

Methods
func makeNavigationViewControlsFactory() -> INavigationViewControlsFactory

Создать фабрику UI-элементов навигатора.

Returns
INavigationViewControlsFactory
func makeNavigationMapControlsFactory(
	map: Map,
	followManager: INavigatorFollowManager
) -> INavigationMapControlsFactory

Создать фабрику UI-элементов навигатора.

Parameters

map

Контроллер карты.

followManager

Переключатель режимов слежения в навигаторе.

Returns
INavigationMapControlsFactory
func makeNavigationView(
	map: Map,
	navigationManager: NavigationManager
) -> (UIView & INavigationView)

Создать UI навигатора.

Parameters

map

Контроллер карты.

navigationManager

Сервис навигации.

func makeNavigationView(
	map: Map,
	navigationManager: NavigationManager,
	navigationViewControlsFactory: INavigationViewControlsFactory?,
	navigationMapControlsFactory: INavigationMapControlsFactory?
) -> (UIView & INavigationView)

Создать UI навигатора.

Parameters

map

Контроллер карты.

navigationManager

Сервис навигации.

navigationViewControlsFactory

Пользовательская фабрика UI-элементов навигатора. Если nil, то будет использоваться реализация по умолчанию.

navigationMapControlsFactory

Пользовательская фабрика UI-элементов карты в навигаторе. Если nil, то будет использоваться реализация по умолчанию.

func makeRouteListView(_ routes: [TrafficRoute]) -> IRouteListView

Создать UI списка превью маршрутов.

Parameters

routes

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

Returns
IRouteListView
func makeRouteView(_ route: TrafficRoute) -> IRouteView

Создать UI превью маршрута.

Parameters

route

Маршрут.

Returns
IRouteView
func makeRouteDetailsView(
	_ route: TrafficRoute,
	startName: String?,
	finishName: String?
) -> IRouteDetailsView

Создать UI деталей маршрута.

Parameters

route

Маршрут.

startName

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

finishName

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

Returns
IRouteDetailsView

INavigatorFollowManager​

Обертка для переключения режимов слежения в навигаторе.

Methods
func toggleFollowMode()

Переключает режим слежения на следующий доступный.

func setFollowMode(_ mode: NavigatorFollowMode)
Parameters

mode

func addFollowModeObserver(_ observer: @escaping FollowModeObserver) -> INavigatorFollowManagerObservation
Parameters

observer

FollowModeObserver
Returns
INavigatorFollowManagerObservation
Properties

var followMode​

var driverType​

INavigatorFollowManagerObservation​

Methods
func invalidate()

INextManeuverControlView​

UI-элемент с информацией о следующем манёвре и дополнительном манёвре.

Implements: INavigationControlView
Properties

var onDidRequestLayout​

(() -> ())?

Сигнал о необходимости обновления макета.

IPositioningServicesFactory​

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

Properties

var locationProvider​

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

var magneticHeadingProvider​

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

IRoadEventCardView​

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

Methods
func setRoadEvent(_ roadEvent: RoadEvent)

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

Parameters

roadEvent

Дорожное событие.

Properties

var closeButtonCallback​

(() -> ())?

Замыкание обратного вызова при нажатии кнопки закрытия.

var roadEventActionResultCallback​

((Result<(type: RoadEventActionType, result: ActionResult), Error>) -> ())?

Замыкание обратного вызова при завершении обработки действия дорожного события.

var removeRoadEventActionResultCallback​

((Result<ActionResult, Error>) -> ())?

Замыкание обратного вызова при завершении обработки действия дорожного события.

IRoadEventCardViewFactory​

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

Methods
func makeRoadEventCardView(_ roadEvent: RoadEvent) -> IRoadEventCardView

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

Parameters

roadEvent

Дорожное событие.

Returns
IRoadEventCardView
func makeCreateRoadEventView(map: Map) -> ICreateRoadEventView

Интерфейс создания дорожного события.

Parameters

map

Карта.

Returns
ICreateRoadEventView

IRouteDetailsView​

Протокол карточки деталей маршрута.

Properties

var isScrollEnabled​

Значение, определяющее включена ли прокрутка контента карточки маршрута.

var contentSize​

Размер контента карточки маршрута.

IRouteEditorFactory​

Конструктор источников данных карты.

Methods
func createRouteEditorSource() -> RouteEditor

Создать редактор маршрута.

Returns
RouteEditor

IRouteListView​

Протокол списка превью маршрутов.

Properties

var isScrollEnabled​

Значение, определяющее включена ли прокрутка списка маршрутов.

var contentSize​

Размер контента списка маршрутов.

var trafficRouteSelectedCallback​

((TrafficRoute) -> ())?

Замыкание обратного вызова при изменении видимой области карты.

IRouteView​

Протокол превью карточки маршрута.

Properties

var route​

Маршрут.

ISDKError​

Протокол для всех исключений MobileSDK.

ISearchManager​

Поисковик. Основная точка входа для справочного API.

Methods
func suggest(
	query: SuggestQuery
) -> Future<SuggestResult>

Получить подсказки, соответствующие данному запросу.

Parameters

query

Запрос на подсказку по поиску в справочнике.

func search(
	query: SearchQuery
) -> Future<SearchResult>

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

Parameters

query

Запрос на поиск по справочнику.

func searchById(
	id: String
) -> Future<DirectoryObject?>

Получить объект справочника по строковому идентификатору.

Parameters

id

Строковый идентификатор справочника. Возможен сложный идентификатор, который получен в результате запроса к WebAPI.

func searchByDirectoryObjectId(
	objectId: DgisObjectId
) -> Future<DirectoryObject?>

Получить объект справочника по идентификатору.

Parameters

objectId

Идентификатор объекта в справочнике.

ISearchManagerFactory​

Фабрика поисковиков с разными источниками данных.

Methods
func makeOnlineManager() throws -> ISearchManager?

Создать поисковик, работающий онлайн.

Returns
ISearchManager?
func makeOfflineManager() throws -> ISearchManager?

Создать поисковик, работающий с предзагруженными данными.

Returns
ISearchManager?
func makeSmartManager() throws -> ISearchManager?

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

Returns
ISearchManager?

ISourceFactory​

Конструктор источников данных карты.

Methods
func createOnlineDGISSource() -> Source

Создание источника, получающего данные с серверов 2ГИС.

Returns
Source
func createGeometryMapObjectSourceBuilder() -> GeometryMapObjectSourceBuilder

Создание источника данных с наложенными объектами (например, маркерами).

Returns
GeometryMapObjectSourceBuilder
func createOfflineDGISSource() -> Source

Создание источника, использующего в работе предварительно загруженные данные 2ГИС.

Returns
Source
func createHybridDGISSource() -> Source

Создание источника, использующего в работе данные с серверов 2ГИС и предварительно загруженные данные 2ГИС.

Returns
Source
func createRouteEditorSource(routeEditor: RouteEditor) -> RouteEditorSource

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

Parameters

routeEditor

Returns
RouteEditorSource

IStyleFactory​

Интерфейс инструмента загрузки стилей.

Methods
func setAttribute(name: String, value: AttributeValue) -> Self
Parameters

name

value

func loadDefault() -> Future<Style>

Получение предустановленного стиля.

func loadFile(path: String) -> Future<Style>

Загрузка пользовательского стиля из указанного файла по абсолютному пути.

Parameters

path

func loadFile(url: URL) -> Future<Style>

Загрузка пользовательского стиля из указанного файла по URL. URL должен быть по схеме “file:”, иначе будет возвращена ошибка.

Parameters

url

URL
func loadResource(name: String, bundle: Bundle) -> Future<Style>

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

Parameters

name

bundle

Bundle

IThermometerControlView​

Implements: INavigationControlView
Properties

var eventsPosition​

LogSink​

Приемник логирования.

Methods
func write(
    message: LogMessage
)
Parameters

message

SimpleClusterRenderer​

Класс для кастомизации внешнего вида кластера в IMapObjectManager.

Methods
func renderCluster(
    cluster: SimpleClusterObject
) -> SimpleClusterOptions
Parameters

cluster

Returns
SimpleClusterOptions

StyleZoomToTiltRelation​

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

Methods
func styleZoomToTilt(
    styleZoom: StyleZoom
) -> Tilt
Parameters

styleZoom

Returns
Tilt