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

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?

IBriefInfoProvider​

Methods
func provide(
	transportMode: TransportMode
) async throws -> BriefInfo?
Parameters

transportMode

Returns
BriefInfo?

ICancellable​

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

Methods
func cancel()

IDirectoryObjectViewsFactory​

Methods
func makeTitleView() -> AnyView
Returns
AnyView
func makeSubtitleView() -> AnyView
Returns
AnyView
func makeRatingView() -> AnyView
Returns
AnyView
func makeDistanceView() -> AnyView
Returns
AnyView
func makeShortAddressView() -> AnyView
Returns
AnyView
func makeAlertView() -> AnyView
Returns
AnyView
func makeFullAddressView(minimizeCard: @escaping MinimizeCardAction) -> AnyView
Parameters

minimizeCard

MinimizeCardAction
Returns
AnyView
func makeAdditionalInformationView() -> AnyView
Returns
AnyView
func makeWorkingHoursView() -> AnyView
Returns
AnyView
func makePorchesView() -> AnyView
Returns
AnyView
func makeCloseButton(action: @escaping (() -> Void)) -> AnyView
Returns
AnyView
func makeContactsView() -> AnyView
Returns
AnyView
func makeSitesAndSocialNetworksView() -> AnyView
Returns
AnyView
func makeChargingStationView() -> AnyView
Returns
AnyView

IDirectoryViewsFactory​

Фабрика SwiftUI-элементов справочника.

Methods
func makeVoiceAssistantView(speechService: (any IVoiceAssistantService)?) -> VoiceAssistantView

SwiftUI-элемент для голосового ввода.

Returns
VoiceAssistantView
func makeSearchResultItemView(
	object: DirectoryObject,
	onTap: @escaping (DirectoryObject) -> Void,
	lastLocation: GeoPoint?
) -> SearchResultItemView

SwiftUI-элемент карточки объекта в поисковой выдаче.

Parameters

object

lastLocation

Returns
SearchResultItemView
func makeDirectoryObjectView(
	onDismiss: @escaping () -> Void,
	onShowEntrances: (([EntranceInfo]) -> Void)?,
	visibleAreaEdgeInsets: Binding<EdgeInsets>
) -> DirectoryObjectView

SwiftUI-элемент подробной информации об объекте справочника.

Returns
DirectoryObjectView
func makeDirectoryObjectView(
	onDismiss: @escaping () -> Void,
	onShowEntrances: (([EntranceInfo]) -> Void)?,
	visibleAreaEdgeInsets: Binding<EdgeInsets>,
	viewsFactory: IDirectoryObjectViewsFactory
) -> DirectoryObjectView

SwiftUI-элемент подробной информации об объекте справочника.

Parameters

viewsFactory

Returns
DirectoryObjectView
func makeDefaultDirectoryObjectViewsFactory(
	edgeInsets: Binding<EdgeInsets>,
	onDismiss: @escaping () -> Void,
	onShowEntrances: (([EntranceInfo]) -> Void)?
) -> IDirectoryObjectViewsFactory

Фабрика SwiftUI-элемент для наполнения view с подробной информации об объекте.

Returns
IDirectoryObjectViewsFactory

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

IMagneticHeadingProvider​

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

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

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

Parameters

headingCallback

HeadingCallback?

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

availabilityCallback

AvailabilityCallback?

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

IMapCoordinateSpace​

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

Implements: INativeScaleProvider

IMapEventProcessor​

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

Methods
func process(event: Event)

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

Parameters

event

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

IMapFactory​

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

Methods
func makeModernMapViewsFactory(
	theme: MapControlsTheme
) -> IModernMapViewsFactory

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

Parameters

theme

Returns
IModernMapViewsFactory
func makeModernMapUIControlsFactory(
	theme: MapControlsTheme
) -> IModernMapUIControlsFactory

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

Parameters

theme

Returns
IModernMapUIControlsFactory
Properties

var initialMapOptions​

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

var map​

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

var mapUIView​

any UIView & IMapUIView

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

var mapView​

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

var gestureUIView​

(any UIView & IMapGestureUIView)?

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

var gestureManager​

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

var mapEventProcessor​

any IMapEventProcessor

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

var mapCoordinateSpace​

any IMapCoordinateSpace

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

var mapUIControlsFactory​

any IMapUIControlsFactory

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

var mapViewsFactory​

any IMapViewsFactory

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

var snapshotter​

any IMapSnapshotter

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

var energyConsumption​

any IEnergyConsumption

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

var markerOverlayUIView​

any IMarkerOverlayUIView

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

var markerOverlayView​

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

IMapGestureUIView​

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

Properties

var doubleTapGestureRecognizer​

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

var panGestureRecognizer​

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

var twoFingerPanGestureRecognizer​

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

var rotationGestureRecognizer​

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

var pinchGestureRecognizer​

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

var twoFingerTapGestureRecognizer​

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

var doubleTapAndPanGestureRecognizer​

(any UIGestureRecognizer & IDoubleTapAndPanGestureRecognizer)?

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

IMapGestureUIViewFactory​

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

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

func makeGestureUIView(
	map: Map,
	coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureUIView

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

Parameters

map

coordinateSpace

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

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

Parameters

map

eventProcessor

coordinateSpace

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

func makeGestureUIView(
	map: Map,
	coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureUIView

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

Parameters

map

coordinateSpace

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

Создать слой обработки жестов.
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.

IMapUIControlsFactory​

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

Methods
func makeZoomUIControl() -> ZoomUIControl
Returns
ZoomUIControl
func makeCurrentLocationUIControl() -> CurrentLocationUIControl
Returns
CurrentLocationUIControl
func makeCompassUIControl() -> CompassUIControl
Returns
CompassUIControl
func makeTrafficUIControl() -> TrafficUIControl
Returns
TrafficUIControl
func makeRoadEventCreatorButtonUIControl() -> RoadEventCreatorButtonUIControl
Returns
RoadEventCreatorButtonUIControl
func makeIndoorUIControl(_ options: IndoorUIControlOptions) -> IndoorUIControl
Parameters

options

Returns
IndoorUIControl
func makeIndoorUIControl(_ options: IndoorUIControlOptions = .default) -> IndoorUIControl
Parameters

options

Returns
IndoorUIControl

IMapUIView​

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

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

(any UIView & IMapGestureUIView)?

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

var appearance​

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

var showsAPIVersion​

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

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

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

var urlOpener​

((URL) -> ())?

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

IMapViewsFactory​

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

Methods
func makeCurrentLocationView() -> AnyView
Returns
AnyView
func makeZoomView() -> AnyView
Returns
AnyView
func makeTrafficView(colors: TrafficViewColors) -> AnyView
Parameters

colors

Returns
AnyView
func makeIndoorView() -> AnyView
Returns
AnyView
func makeCompassView(icon: UIImage?, highlightedIcon: UIImage?) -> AnyView
Parameters

icon

highlightedIcon

Returns
AnyView
func makeMiniMapView(mapFactory: IMapFactory) throws -> AnyView
Parameters

mapFactory

Returns
AnyView
func makeRoadEventCreatorButtonView(callback: (() -> Void)?) -> AnyView
Returns
AnyView
func makeCompassView() -> AnyView
Returns
AnyView

IMarkerOverlayUIView​

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

Methods
func add(markerView: IMarkerUIView)

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

Parameters

markerView

func add(markerViews: [IMarkerUIView])
Parameters

markerViews

func remove(markerView: IMarkerUIView)

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

Parameters

markerView

func remove(markerViews: [IMarkerUIView])
Parameters

markerViews

func removeAll()

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

IMarkerUIView​

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

Properties

var id​

UUID

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

var position​

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

var tapHandler​

(() -> ())?

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

IMarkerUIViewFactory​

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

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

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

Parameters

view

position

anchor

offsetX

offsetY

Returns
IMarkerUIView

IModelFactory​

Methods
func make(modelData: Data) -> ModelData

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

Parameters

modelData

Data
Returns
ModelData

IModernMapUIControlsFactory​

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

Methods
func makeCurrentLocationUIControl(permissionCallback: @escaping () -> Void) -> UIControl
Returns
UIControl
func makeCompassUIControl() -> UIControl
Returns
UIControl
func makeZoomUIControl() -> UIControl
Returns
UIControl
func makeIndoorUIControl(showOverview: Bool) -> UIView
Parameters

showOverview

Returns
UIView
func makeTrafficAndParkingUIControl() -> UIControl
Returns
UIControl
func makeTrafficUIControl() -> UIControl
Returns
UIControl
func makeParkingUIControl() -> UIControl
Returns
UIControl
func makeCurrentLocationUIControl() -> UIControl
Returns
UIControl

IModernMapViewsFactory​

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

Methods
func makeCurrentLocationView(permissionCallback: @escaping () -> Void) -> AnyView
Returns
AnyView
func makeZoomView() -> AnyView
Returns
AnyView
func makeTrafficAndParkingView() -> AnyView
Returns
AnyView
func makeTrafficView() -> AnyView
Returns
AnyView
func makeParkingView() -> AnyView
Returns
AnyView
func makeIndoorView(showOverview: Bool) -> AnyView
Parameters

showOverview

Returns
AnyView
func makeCompassView() -> AnyView
Returns
AnyView
func makeMiniMapView(mapFactory: IMapFactory) throws -> AnyView
Parameters

mapFactory

Returns
AnyView

INativeScaleProvider​

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

Properties

var nativeScale​

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

var toPixels​

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

INavigationMapUIControlsFactory​

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

Methods
func makeZoomUIControl() -> UIControl

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

Returns
UIControl
func makeTrafficAndParkingMapUIControl() -> UIControl

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

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

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

Parameters

icon

highlightedIcon

Returns
UIControl
func makeNavigationFollowingUIControl() -> NavigationFollowingUIControl

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

Returns
NavigationFollowingUIControl
func makeTUGCUIControl() -> UIControl

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

Returns
UIControl
func makeIndoorUIControl() -> IndoorUIControl

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

Returns
IndoorUIControl
func makeTrafficUIControl() -> UIControl

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

Returns
UIControl
func makeParkingUIControl() -> UIControl

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

Returns
UIControl
func makeCompassUIControl() -> UIControl
Returns
UIControl
Properties

var followManager​

any INavigatorFollowManager

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

INavigationMapViewsFactory​

Фабрика SwiftUI Map элементов для добавления в навигатор.

Methods
func makeNavigationZoomView() -> AnyView

SwiftUI-элемент для управления зумом карты.

Returns
AnyView
func makeNavigationTrafficAndParkingView() -> AnyView

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

Returns
AnyView
func makeNavigationFollowingView() -> AnyView

SwiftUI-элемент для управления режимом слежения за местоположением в навигаторе.

Returns
AnyView
func makeNavigationCompassView(icon: UIImage?, highlightedIcon: UIImage?) -> AnyView

SwiftUI-элемент для отображения ориентации карты в навигаторе.

Parameters

icon

highlightedIcon

Returns
AnyView
func makeNavigationIndoorView() -> AnyView

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

Returns
AnyView
func makeNavigationTrafficView() -> AnyView

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

Returns
AnyView
func makeNavigationParkingView() -> AnyView

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

Returns
AnyView
func makeNavigationCompassView() -> AnyView
Returns
AnyView

INavigationUIControl​

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

Properties

var isVisible​

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

var onDidChangeVisibility​

(() -> ())?

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

INavigationUIControlsFactory​

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

Methods
func makeNextManeuverUIControl(
	uiModel: Model
) -> UIView & INextManeuverUIControl

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

Parameters

uiModel

Returns
UIView & 
func makeSpeedUIControl(
	uiModel: Model
) -> (UIView & INavigationUIControl)

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

Parameters

uiModel

func makeRemainingRouteInfoUIControl(
	navigationManager: NavigationManager
) -> UIView & INavigationUIControl

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

Parameters

navigationManager

Returns
UIView & 
func makeMessageBarUIControl(
	uiModel: Model
) -> UIView & INavigationUIControl

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

Parameters

uiModel

Returns
UIView & 
func makeBetterRouteUIControl(
	uiModel: Model
) -> UIView & INavigationUIControl

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

Parameters

uiModel

Returns
UIView & 
func makeThermometerUIControl(
	uiModel: Model
) -> UIView & IThermometerUIControl

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

Parameters

uiModel

Returns
UIView &

INavigationUIView​

Methods
func showRoadEvent(_ roadEvent: RoadEvent)

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

Parameters

roadEvent

Properties

var visibleAreaEdgeInsets​

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

var visibleAreaEdgeInsetsChangedCallback​

((UIEdgeInsets) -> ())?

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

var finishButtonCallback​

(() -> ())?

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

INavigationUIViewFactory​

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

Methods
func makeNavigationUIControlsFactory() -> INavigationUIControlsFactory

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

Returns
INavigationUIControlsFactory
func makeNavigationMapUIControlsFactory(
	map: Map,
	followManager: INavigatorFollowManager
) -> INavigationMapUIControlsFactory

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

Parameters

map

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

followManager

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

Returns
INavigationMapUIControlsFactory
func makeNavigationUIView(
	map: Map,
	navigationManager: NavigationManager
) -> (UIView & INavigationUIView)

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

Parameters

map

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

navigationManager

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

func makeNavigationUIView(
	map: Map,
	navigationManager: NavigationManager,
	navigationUIControlsFactory: INavigationUIControlsFactory?,
	navigationMapUIControlsFactory: INavigationMapUIControlsFactory?
) -> (UIView & INavigationUIView)

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

Parameters

map

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

navigationManager

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

navigationUIControlsFactory

navigationMapUIControlsFactory

func makeRouteListUIView(_ routes: [TrafficRoute]) -> IRouteListUIView

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

Parameters

routes

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

Returns
IRouteListUIView
func makeRouteUIView(_ route: TrafficRoute) -> IRouteUIView

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

Parameters

route

Маршрут.

Returns
IRouteUIView
func makeRouteDetailsUIView(
	_ route: TrafficRoute,
	startName: String?,
	finishName: String?
) -> IRouteDetailsUIView

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

Parameters

route

Маршрут.

startName

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

finishName

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

Returns
IRouteDetailsUIView

INavigationViewFactory​

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

Methods
func makeNavigationViewsFactory() -> INavigationViewsFactory

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

Returns
INavigationViewsFactory
func makeNavigationMapViewsFactory(
	map: Map,
	followManager: INavigatorFollowManager
) -> INavigationMapViewsFactory

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

Parameters

map

followManager

Returns
INavigationMapViewsFactory
func makeNavigationView(
	map: Map,
	navigationManager: NavigationManager,
	miniMapFactory: IMapFactory?,
	isMiniMapSelected: Binding<Bool>
) -> NavigationView

Создать SwiftUI-элемент навигатора.

Parameters

map

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

navigationManager

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

miniMapFactory

Фабрика контроллера для миникарты.

Returns
NavigationView
func makeNavigationView(
	map: Map,
	navigationManager: NavigationManager,
	miniMapFactory: IMapFactory?,
	navigationViewsFactory: INavigationViewsFactory?,
	navigationMapViewsFactory: INavigationMapViewsFactory?,
	isMiniMapSelected: Binding<Bool>
) -> NavigationView

Создать SwiftUI-элемент навигатора.

Parameters

map

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

navigationManager

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

miniMapFactory

Фабрика контроллера для миникарты.

navigationViewsFactory

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

navigationMapViewsFactory

Фабрика UI-элементов управления картой.

Returns
NavigationView
func makeNavigationView(
	map: Map,
	navigationManager: NavigationManager
) -> NavigationView

Создать SwiftUI-элемент навигатора.

Parameters

map

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

navigationManager

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

Returns
NavigationView
func makeNavigationView(
	map: Map,
	navigationManager: NavigationManager,
	navigationViewsFactory: INavigationViewsFactory?,
	navigationMapViewsFactory: INavigationMapViewsFactory?
) -> NavigationView

Создать SwiftUI-элемент навигатора.

Parameters

map

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

navigationManager

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

navigationViewsFactory

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

navigationMapViewsFactory

Фабрика UI-элементов управления картой.

Returns
NavigationView

INavigationViewsFactory​

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

Methods
func makeFinishRouteDashboardView(
	map: Map,
	uiModel: Model,
	isExpandedPublisher: AnyPublisher<Bool, Never>
) -> AnyView

SwiftUI-элемент с информацией о завершении маршрута.

Parameters

map

uiModel

isExpandedPublisher

Never<, >
Returns
AnyView
func makeNextManeuverView(
	uiModel: Model
) -> AnyView

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

Parameters

uiModel

Returns
AnyView
func makeRemainingRouteInfoView(
	navigationManager: NavigationManager
) -> AnyView

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

Parameters

navigationManager

Returns
AnyView
func makeSpeedView(
	uiModel: Model
) -> AnyView

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

Parameters

uiModel

Returns
AnyView
func makeThermometerView(
	uiModel: Model, isLeftSide: Bool
) -> AnyView

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

Parameters

uiModel

isLeftSide

Returns
AnyView
func makeMessageBarView(
	uiModel: Model,
	onVisibilityChanged: @escaping (Bool) -> Void
) -> AnyView

SwiftUI-элемент для отображения сообщений об ошибках при построении маршрутов.

Parameters

uiModel

Returns
AnyView
func makeBetterRouteView(
	uiModel: Model,
	onVisibilityChanged: @escaping (Bool) -> Void
) -> AnyView

SwiftUI-элемент для отображения и выбора маршрута лучше.

Parameters

uiModel

Returns
AnyView
func makeMiniMapView(
	navigationManager: NavigationManager,
	miniMapFactory: IMapFactory
) throws -> AnyView

SwiftUI-элемент для отображения маршрута в виде миникарты.

Parameters

navigationManager

miniMapFactory

Returns
AnyView
func makeFinishRouteDashboardView(
	map: Map,
	uiModel: Model
) -> AnyView
Parameters

map

uiModel

Returns
AnyView

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()

INextManeuverUIControl​

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

Implements: INavigationUIControl
Properties

var onDidRequestLayout​

(() -> ())?

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

InstallFallback​

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

Methods
func process(
    targetPackage: Package
)
Parameters

targetPackage

IRoadEventCreatorUIView​

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

Properties

var visibleAreaEdgeInsets​

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

var visibleAreaEdgeInsetsChangedCallback​

((UIEdgeInsets) -> ())?

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

var cancelButtonCallback​

(() -> ())?

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

var createRoadEventRequestCallback​

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

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

IRoadEventInfoUIView​

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

Methods
func setRoadEvent(_ roadEvent: RoadEvent)

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

Parameters

roadEvent

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

Properties

var closeButtonCallback​

(() -> ())?

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

var roadEventActionResultCallback​

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

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

var removeRoadEventActionResultCallback​

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

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

IRoadEventUIViewFactory​

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

Methods
func makeRoadEventInfoUIView(_ roadEvent: RoadEvent) -> IRoadEventInfoUIView

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

Parameters

roadEvent

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

Returns
IRoadEventInfoUIView
func makeRoadEventCreatorUIView(map: Map) -> IRoadEventCreatorUIView

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

Parameters

map

Карта.

Returns
IRoadEventCreatorUIView

IRoadEventViewFactory​

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

Methods
func makeRoadEventInfoView(_ roadEvent: RoadEvent) -> RoadEventInfoView

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

Parameters

roadEvent

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

Returns
RoadEventInfoView
func makeRoadEventCreatorView(
	map: Map,
	visibleAreaEdgeInsets: Binding<EdgeInsets>?
) -> RoadEventCreatorView

SwiftUI элемент для создания дорожного события.

Parameters

map

Карта.

Returns
RoadEventCreatorView

IRouteCardViewFactory​

Methods
func make(
	route: TrafficRoute,
	transportMode: TransportMode?,
	onStartNavigation: IRouteEditorViewFactory.StartNavigationCallback?,
	index: Int,
	theme: RouteCardViewTheme
) -> AnyView
Parameters

route

transportMode

onStartNavigation

StartNavigationCallback.?

index

theme

Returns
AnyView

IRouteDetailsUIView​

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

Properties

var isScrollEnabled​

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

var contentSize​

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

IRouteEditorErrorViewFactory​

Methods
func makeErrorView(routesInfo: RouteEditorRoutesInfo?) -> AnyView
Parameters

routesInfo

Returns
AnyView

IRouteEditorFactory​

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

Methods
func createRouteEditorSource() -> RouteEditor

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

Returns
RouteEditor

IRouteEditorViewFactory​

Фабрика SwiftUI элементов экрана выбора маршрутов.

Methods
func makeTrafficRouterBriefInfoProvider(
	trafficRouter: TrafficRouter,
	transportModeOptionsProvider: ITransportModeOptionsProvider
) -> IBriefInfoProvider
Parameters

trafficRouter

transportModeOptionsProvider

Returns
IBriefInfoProvider
func makeActiveRouteBriefInfoProvider() -> IBriefInfoProvider
Returns
IBriefInfoProvider
func makeDefaultRouteCardViewFactory() -> IRouteCardViewFactory
Returns
IRouteCardViewFactory
func makeDefaultTransportModeTabViewFactory(
	routeEditor: RouteEditor,
	briefInfoProvider: IBriefInfoProvider
) -> ITransportModeTabViewFactory
Parameters

routeEditor

briefInfoProvider

Returns
ITransportModeTabViewFactory
func makeRouteEditorView(
	routeEditor: RouteEditor,
	availableTransportModes: [TransportMode],
	transportModeOptionsProvider: ITransportModeOptionsProvider?,
	briefInfoProvider: IBriefInfoProvider?,
	routeSearchPointViewFactory: IRouteSearchPointViewFactory?,
	routeCardViewFactory: IRouteCardViewFactory?,
	transportModeTabViewFactory: ITransportModeTabViewFactory?,
	startNavigationCallback: StartNavigationCallback?,
	closeCallback: CloseCallback?,
	editRoutePointsCallBack: EditRoutePointsCallBack?,
	errorViewFactrory: IRouteEditorErrorViewFactory?
) -> RouteEditorView
Parameters

routeEditor

availableTransportModes

transportModeOptionsProvider

briefInfoProvider

routeSearchPointViewFactory

routeCardViewFactory

transportModeTabViewFactory

startNavigationCallback

StartNavigationCallback?

closeCallback

CloseCallback?

editRoutePointsCallBack

EditRoutePointsCallBack?

errorViewFactrory

Returns
RouteEditorView
func makeTrafficRouterBriefInfoProvider(
	trafficRouter: TrafficRouter
) -> IBriefInfoProvider
Parameters

trafficRouter

Returns
IBriefInfoProvider
func makeRouteEditorView(
	routeEditor: RouteEditor,
	briefInfoProvider _: IBriefInfoProvider? = nil,
	startNavigationCallback: StartNavigationCallback?,
	closeCallback: CloseCallback?,
	editRoutePointsCallBack: EditRoutePointsCallBack?
) -> RouteEditorView
Parameters

routeEditor

_

startNavigationCallback

StartNavigationCallback?

closeCallback

CloseCallback?

editRoutePointsCallBack

EditRoutePointsCallBack?
Returns
RouteEditorView

IRouteListUIView​

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

Properties

var isScrollEnabled​

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

var contentSize​

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

var trafficRouteSelectedCallback​

((TrafficRoute) -> ())?

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

IRouteSearchPointViewFactory​

Methods
func provideStartPointView(point: RoutePointUI) -> AnyView
Parameters

point

Returns
AnyView
func provideFinishPointView(point: RoutePointUI) -> AnyView
Parameters

point

Returns
AnyView
func provideIntermediatePointView(point: RoutePointUI, index: Int) -> AnyView
Parameters

point

index

Returns
AnyView

IRouteUIView​

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

Properties

var route​

Маршрут.

IRoutingViewsFactory​

Фабрика SwiftUI элементов построения маршрута.

Methods
func makeRouteEditorViewFactory() -> IRouteEditorViewFactory

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

Returns
IRouteEditorViewFactory

ISDKError​

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

ISearchManagerFactory​

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

Methods
func makeOnlineManager() throws -> SearchManager?

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

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

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

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

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

Returns
SearchManager?

ISearchResultItemViewFactory​

Methods
func makeTitleView() -> AnyView
Returns
AnyView
func makeSubtitleView() -> AnyView
Returns
AnyView
func makeRatingView() -> AnyView
Returns
AnyView
func makeDistanceView() -> AnyView
Returns
AnyView
func makeAddressView() -> AnyView
Returns
AnyView
func makeAttributesView() -> AnyView
Returns
AnyView
func makeChargingStationView() -> AnyView
Returns
AnyView
func makeAlertView() -> AnyView
Returns
AnyView

ISourceFactory​

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

Methods
func createOnlineDGISSource() -> Source

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

Returns
Source
func createGeometryMapObjectSourceBuilder() -> GeometryMapObjectSourceBuilder

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

Returns
GeometryMapObjectSourceBuilder
func createImmersiveDgisSource() -> Source

Создание источника данных с иммерсивными данными.

Returns
Source
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

IThermometerUIControl​

Implements: INavigationUIControl
Properties

var eventsPosition​

ITransportModeOptionsProvider​

Methods
func provide(_ type: TransportMode) -> RouteSearchOptions
Parameters

type

Returns
RouteSearchOptions

ITransportModeTabViewFactory​

Фабрика SwiftUI элемента переключения типа маршрута.

Methods
func make(
	transportMode: TransportMode,
	theme: RouteTabViewTheme
) -> AnyView
Parameters

transportMode

theme

Returns
AnyView

IVoiceAssistantService​

Methods
func requestPermission(completion: @escaping @Sendable (VoicePermissionState) -> Void)
func startRecognition(
	progress: @escaping ((VoiceRecognitionState) -> Void),
	completion: @escaping ((VoiceRecognitionResult) -> Void)
)
func abortRecognition()

LogSink​

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

Methods
func write(
    message: LogMessage
)
Parameters

message

RoadEventFilter​

Фильтр отображаемых дорожных событий.

Methods
func passes(
    event: RoadEventFilterData
) -> Bool
Parameters

event

Returns
Bool

SearchHistoryKeyStrategy​

Интерфейс, предоставляющий реализовать стратегию создания ключа для элемента истории поиска. Ключ используется для определения уникальности элемента истории поиска.

Methods
func create(
    item: SearchHistoryItem
) -> String
Parameters

item

Returns
String

SimpleClusterRenderer​

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

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

cluster

Returns
SimpleClusterOptions

StyleZoomToTiltRelation​

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

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

styleZoom

Returns
Tilt