class
ActivityTracker
public static func == (lhs: ActivityTracker, rhs: ActivityTracker) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: TimeInterval = 20
)
Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал, когда пользователь перестал пользоваться навигатором и его можно выключить.
platformContext
Контекст.
model
Модель навигатора, состояние которого отслеживается.
speedBound
Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается, что навигатор активен, т.е. движение продолжается.
timeThreshold
Время, в течение которого в состоянии Finished навигатора отслеживается скорость движения ниже пороговой для определения состояния неактивности навигатора. Если в течение этого времени скорость движения меньше установленного порога или нет данных о локации и скорости, навигатор считается неактивным.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var stopChannel
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
var stop
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
AlternativeRouteSelector
Выбор альтернативного маршрута.
public static func == (lhs: AlternativeRouteSelector, rhs: AlternativeRouteSelector) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func selectAlternativeRoute(
trafficRoute: TrafficRoute
)
Выбор альтернативного маршрута. Если переданный маршрут не соответствует одному из актуальных альтернативных маршрутов, ничего не происходит. В противном случае соответствующий альтернативный маршрут становится текущим активным маршрутом.
trafficRoute
Альтернативный маршрут, который должен быть выбран в качестве текущего активного маршрута.
AlternativeRoutesProviderSettings
Настройки поиска альтернативных маршрутов и маршрута лучше.
public static func == (lhs: AlternativeRoutesProviderSettings, rhs: AlternativeRoutesProviderSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var alternativeRoutesEnabled
Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.
var betterRouteEnabled
Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.
var routeSearchDelay
Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.
var betterRouteTimeCostThreshold
Минимальная разница во времени движения между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var betterRouteLengthThreshold
Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var routerType
Тип поисковика для поиска альтернативных маршрутов.
AnimationSettings
Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами “3D model” и “Directional model”. Индекс анимации должен быть обязательно указан для анимированной модели.
public static func == (lhs: AnimationSettings, rhs: AnimationSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var animationIndex
Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.
var animationName
Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.
var sceneIndex
Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.
var sceneName
Название текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано, используется сцена по умолчанию, которая определена в самой модели.
var animationRepeatCount
Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.
var animationSpeed
Скорость проигрывания анимации модели. Если null, то используется значение из стилей. Значения больше единицы ускоряют проигрывание, меньше замедляют. Если в стилях значение не задано, используется скорость по умолчанию.
Attributes
Интерфейс для управления свойствами объекта карты.
public static func == (lhs: Attributes, rhs: Attributes) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setAttributeValue(
name: String,
value: AttributeValue
)
Установка свойства.
public func setAttributeValues(
values: [String: AttributeValue],
attributesToRemove: [String] = []
)
Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.
values
Набор пар “имя”:“значение” для добавляемых свойства.
attributesToRemove
Список имён свойств, которые нужно удалить.
public func removeAttribute(
name: String
)
Удаление свойства.
name
Имя свойства для удаления.
public func getAttributeValue(
name: String
) -> AttributeValue
Получение свойства.
AudioSettings
Класс для управления звуком.
Все методы могут вызываться из любого потока.
public static func == (lhs: AudioSettings, rhs: AudioSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func `get`(
context: Context
) -> AudioSettings?
Получает объект для управления звуком приложения. Возвращает значение Null, если аудиодрайвер недоступен.
BaseCamera
Камера.
public static func == (lhs: BaseCamera, rhs: BaseCamera) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setPosition(
position: CameraPosition
) throws
Установка новой позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, стилевым уровнем масштабирования, наклоном и направлением.
position
public func changePosition(
positionChange: CameraPositionChange
) throws
Изменение только части параметров позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за изменёнными параметрами, а при изменении координат также и слежение за стилевым уровнем масштабирования и направлением.
positionChange
public func setZoomRestrictions(
zoomRestrictions: CameraZoomRestrictions
) throws
Функция устанавливает новый диапазон ограничений уровня масштабирования.
zoomRestrictions
Новый диапазон ограничений уровня масштабирования.
public func setPositionPoint(
positionPoint: CameraPositionPoint
) throws
Функция устанавливает новую позицию относительно области экрана, ограниченной отступами.
positionPoint
новая позиция относительно области экрана, ограниченной отступами.
public func setViewPoint(
viewPoint: CameraViewPoint?
) throws
Функция устанавливает новую точку взгляда относительно полного размера вьюпорта.
viewPoint
новая точка взгляда относительно полного размера вьюпорта. Будет следовать за точкой позиции, если передан nil.
var projection
Проекция.
var position
Получение текущей позиции камеры.
var zoomRestrictions
Получение актуальных ограничений уровня масштабирования.
var deviceDensity
Получение отношения DPI к базовому DPI устройства.
var size
Получение размера области просмотра.
var padding
Получение текущих отступов от краёв экрана.
var positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var viewPoint
Точка взгляда относительно полного размера вьюпорта.
var visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
var visibleRect
Объемлющий прямоугольник видимой области карты.
var maxTiltRestriction
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
var viewportRestriction
Получение ограничения на область видимости.
var changed
Причины изменения состояния камеры.
Изменённые свойства доступны в соответствующих каналах.
BearingFollowController
Контроллер слежения за направлением карты.
public convenience init(
bearingSource: BearingSource,
animationDuration: TimeInterval = 1,
valueThreshold: Bearing = Bearing(value: 1)
)
Создание контроллера слежения за направлением карты.
bearingSource
источник информации о направлении.
animationDuration
неотрицательная длительность изменения реального направления.
valueThreshold
неотрицательное пороговое значение учитываемого изменения реального направления.
BoolRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: BoolRouteLongAttribute, rhs: BoolRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> BoolRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [BoolRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
BufferedChannel
var value
Camera
Камера для запуска перемещения карты и настроек слежения.
public func move(
moveController: CameraMoveController
) -> Future<CameraAnimatedMoveResult>
Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.
public func move(
position: CameraPosition,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает слежение за позицией, уровнем масштабирования, наклоном и направлением и прерывает обработку жестов.
position
Конечная позиция камеры.
time
Время, выделенное на перемещение карты.
animationType
Тип анимации при перемещении камеры.
public func move(
point: GeoPoint,
zoom: Zoom,
tilt: Tilt?,
bearing: Bearing,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
point
точка конечной позиции камеры
zoom
уровень масштабирования в конечной позиции камеры
tilt
наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller’а или текущее значение
bearing
поворот в конечной позиции камеры
time
время, выделенное на перемещение карты
animationType
тип анимации при перемещении камеры
public func processMovementAndStop()
Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, уровнем масштабирования и направлением.
public func setBehaviour(
behaviour: CameraBehaviour
)
Смена режима слежения камеры. Если новый режим более ограниченный, чем текущий, вызов прервёт перелёт и обработку жестов.
behaviour
public func addFollowController(
followController: FollowController
)
Добавление контроллера слежения.
followController
public func removeFollowController(
followController: FollowController
)
Удаление контроллера слежения.
followController
public func setCustomFollowController(
followController: CustomFollowController
)
Добавление контроллера слежения, реализованного на платформе.
followController
public func removeCustomFollowController()
Удаление контроллера слежения, реализованного на платформе.
func sinkOnStatefulChangesOnMainThread<T: Sendable>(
reason: CameraChangeReasonOptionSet,
receiveValue: @escaping @Sendable (T) -> Void
) -> Cancellable
Подписывается на изменения Channel с указанием типа изменения в главной очереди. Возвращает текущее значение Camera для указанного типа изменений CameraChangeReasonOptionSet.
func sinkOnStatefulChanges<T: Sendable>(
on queue: DispatchQueue,
reason: CameraChangeReasonOptionSet,
receiveValue: @escaping @Sendable (T) -> Void
) -> Cancellable
Подписывается на изменения Channel с указанием типа изменения в заданной очереди. Возвращает текущее значение Camera для указанного типа изменений CameraChangeReasonOptionSet.
CameraNotifier
Предупреждает о попадании в зону действия дорожной камеры.
public static func == (lhs: CameraNotifier, rhs: CameraNotifier) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
model: Model
)
Расширение навигатора, которое предупреждает о попадании в зону действия дорожной камеры.
model
Модель навигатора, состояние которого отслеживается.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
CameraRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: CameraRouteAttribute, rhs: CameraRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [CameraRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> CameraRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> CameraRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
CameraTransactionGuard
public static func == (lhs: CameraTransactionGuard, rhs: CameraTransactionGuard) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
CancelEvent
Cancellable
A cancellation token for a running operation.
public init(
cancel: @escaping () -> Void,
release: @escaping () -> Void = {}
)
public convenience init()
Make a cancellation token that cancels nothing.
public static func ==(lhs: Cancellable, rhs: Cancellable) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func cancel()
May be called any number of times from any queue.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
Channel
public static func == (lhs: Channel<Value>, rhs: Channel<Value>) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
func sinkOnMainThread(_ receiveValue: @Sendable @escaping (Value) -> Void) -> Cancellable
Получение результата Channel на main очереди. Сам канал срабатывает на другой очереди и передает результат на main очередь.
func sink(on queue: DispatchQueue, receiveValue: @Sendable @escaping (Value) -> Void) -> Cancellable
Получение результата Channel на заданной очереди. Сам канал срабатывает на другой очереди и передает результат на заданную очередь.
CheckableGroupedItem
Единичный элемент из GroupCheckableItem.
public static func == (lhs: CheckableGroupedItem, rhs: CheckableGroupedItem) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
CheckableItem
Базовое представление отмечаемого элемента из CheckableItemsGroup.
public static func == (lhs: CheckableItem, rhs: CheckableItem) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
CheckableItemsGroup
Виджет для представления группы отмечаемых элементов.
var items
Получение группы элементов виджета.
Checkbox
Виджет-чекбокс.
var filterType
Получение типа фильтра, который представляет виджет.
var checkedText
Получение текста подписи для “отмеченного” чекбокса.
var uncheckedText
Получение текста подписи для “неотмеченного” чекбокса.
var values
Получение списка значений, по которым происходит фильтрация. Обычно одно значение.
var isChecked
Получение состояния виджета.
Circle
Окружность.
public func setPosition(
position: GeoPoint
) throws
Установка местоположения центра окружности.
position
ClusterObject
Кластер объектов.
CompassControlModel
Модель контрола компаса. Контрол состоит из кнопки компаса, при нажатии на которую камера карты меняет угол в направлении севера. Если камера карты смотрит на сервер, то контрол необходимо скрывать. Потокобезопасно.
public static func == (lhs: CompassControlModel, rhs: CompassControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func onClicked()
CompassUIControl
override public func layoutSubviews()
CompassViewModel
ViewModel для контрола компаса
public func onClicked()
ComplexGeometry
Составная геометрия, состоит из набора простых или составных геометрий.
var elements
Container
Центральный объект для доступа к возможностям iOS Mobile SDK.
public required init(
keySource: KeySource = .default,
logOptions: LogOptions = .default,
httpClientForRequest: IHTTPClient? = nil,
httpOptions: HttpOptions = HttpOptions(),
locationProvider: ILocationProvider? = nil,
magneticHeadingProvider: IMagneticHeadingProvider? = nil,
personalDataCollectionOptions: PersonalDataCollectionOptions = .default,
vendorConfig: VendorConfig = .none
)
Конструктор контейнера.
keySource
Настройки ключа для доступа к сервисам 2ГИС.
logOptions
Настройки логирования.
httpClientForRequest
Сетевой клиент для отправки HTTP-запросов.
httpOptions
Настройки HTTP-клиента (такие как кеширование).
locationProvider
Источник геопозиции. Если передать nil, то будет использоваться источник по умолчанию.
magneticHeadingProvider
Источник направления магнитной стрелки. Если передать nil, то будет использоваться источник по умолчанию.
personalDataCollectionOptions
Настройки сервиса сбора данных.
vendorConfig
Переопределения настроек для работы в автономном окружении.
public func makeDirectoryViewsFactory() throws -> IDirectoryViewsFactory
Создать фабрику SwiftUI элементов справочника.
public func makeMapFactory(
options: MapOptions
) throws -> IMapFactory
options
Первоначальные свойства карты. Укажите .default для быстрого создания онлайн-карты, смотрящей на Москву, с фиксированным неточным PPI (не соответствующим текущему устройству).
public func makeRouteEditorFactory() throws -> IRouteEditorFactory
Создать фабрику редактора маршрутов.
public func makeRoadEventUIViewFactory(options: RoadEventInfoViewOptions = .default) throws -> IRoadEventUIViewFactory
Создаёт фабрику UIKit-карточки дорожного события.
public func makeRoadEventViewFactory(options: RoadEventInfoViewOptions = .default) throws -> IRoadEventViewFactory
Создать фабрику SwiftUI карточки дорожного события.
var context
Корневой непрозрачный контейнер объектов SDK. Используется в качестве аргумента к API SDK.
var markerViewFactory
Фабрика UIView маркеров для карты.
var styleFactory
Конструктор стандартных и пользовательских стилей.
var searchManagerFactory
Фабрика поисковиков по справочнику.
var sourceFactory
Фабрика источников данных карты.
var imageFactory
Фабрика изображений для объектов карты.
var modelFactory
Фабрика моделей для объектов карты.
var localeManager
Менеджер региональных настроек приложения.
var locationService
Объект для работы с установленным при инициализации SDK источником геопозиции.
let httpOptions
Настройки HTTP-клиента.
var audioSettings
Объект для настройки звуков.
var voiceManager
Объект для взаимодействия со списком голосовых пакетов навигатора.
Context
Контекст - окружение, необходимое для работы SDK.
public static func == (lhs: Context, rhs: Context) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
CoordinatesFollowController
Контроллер слежения за координатами позиции карты.
public convenience init(
animationDuration: TimeInterval = 1,
valueThreshold: Meter = Meter(value: 0.10000000149011612)
)
Создание контроллера слежения за координатами позиции карты.
animationDuration
длительность изменения реальной позиции.
valueThreshold
неотрицательное пороговое значение учитываемого изменения реальной позиции.
CrossingTypeRouteLongAttribute
Контейнер, хранящий протяжённый атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения атрибута. Значение атрибута действует от текущей точки до точки, в которой начинается действие атрибута следующего элемента.
public static func == (lhs: CrossingTypeRouteLongAttribute, rhs: CrossingTypeRouteLongAttribute) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
public func entry(
point: RoutePoint
) -> CrossingTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [CrossingTypeRouteLongEntry]
Элементы, попадающие в промежуток [begin, end).
CurrentLocationUIControl
UI-элемент с функцией перелёта к текущему местоположению.
override public func layoutSubviews()
CurrentLocationViewModel
ViewModel для контрола текущего местоположения.
public func onClicked()
DataPrefetcher
Контроллер для предварительной загрузки данных карты для маршрута. Загружает данные из источников с поддержкой кеширования. Данные загружаются для участков маршрута с длиной segment_size вперёд на расстояние max_prefetch_distance. При прохождении участков данные о них удаляются из кеша, вместо них загружаются данные следующих участков.
public static func == (lhs: DataPrefetcher, rhs: DataPrefetcher) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
var enabled
Используется ли предварительная загрузка данных карты для маршрута. Значение по умолчанию — true.
Можно использовать, если навигатор находится в статусе Disabled.
var minZoom
Минимальный уровень масштабирования для предварительной загрузки тайлов карты. Значение по умолчанию — 8.
var maxZoom
Максимальный уровень масштабирования для предварительной загрузки тайлов карты. Значение по умолчанию — 16.
var radius
Радиус охвата на карте для предварительной загрузки тайлов карты. Значение по умолчанию — 128.
var segmentSize
Размер минимального участка маршрута для предварительной загрузки тайлов карты, в км. Значение по умолчанию — 2.
var maxPrefetchDistance
Расстояние впереди текущей позиции на маршруте для предварительной загрузки тайлов карты, в км. Значение по умолчанию — 4.
DefaultInstallFallback
Фабрика для создания предустановленных стратегий при ошибке установки или обновления пакета (InstallFallback).
public static func == (lhs: DefaultInstallFallback, rhs: DefaultInstallFallback) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
public static func noOperation() -> InstallFallback
Создаёт fallback, не выполняющий операции (no-op).
public static func retryOnError(
retryCount: UInt64
) -> InstallFallback
Создаёт fallback, который повторно вызывает метод install() при ошибке загрузки пакета.
retryCount
Лимит повторных вызовов метода install(), после которого выполнение останавливается.
DgisMapObject
Объект карты 2GIS.
информацию об объекте можно получить через справочник (directory)
var id
Стабильный числовой идентификатор объекта.
DgisSource
Основной интерфейс источников данных 2ГИС.
public static func createDgisSource(
context: Context,
workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.hybridOnlineFirst
) -> Source
Создание источника, получающего данные с серверов 2ГИС или использующего в работе предварительно загруженные данные.
public static func createImmersiveDgisSource(
context: Context
) -> Source
Создаёт источник, получающий реалистичные данные с серверов 2ГИС.
public func setHighlighted(
directoryObjectIds: [DgisObjectId],
highlighted: Bool
)
Установка или снятие выделения объектов.
добавляет объекту атрибут “selected”, который можно использовать в стилях.
directoryObjectIds
Идентификаторы изменяемых объектов.
highlighted
Установка или снятие выделения.
DirectMapControlBeginEvent
Событие начала прямого управления картой. Сообщает карте, что необходимо обрабатывать события прямого управления картой. События прямого управления работают только от DirectMapControlBeginEvent до DirectMapControlEndEvent. После завершения последовательности событий прямого управления может запуститься кинематика. Кинематика использует время возникновения события, поэтому лучше использовать время, полученное от системы, а не заполнять значение при обработке. Пока кинематика работает только для перемещения карты, но не для вращения и масштабирования.
public convenience init()
DirectMapControlEndEvent
Событие окончания прямого управления картой. Завершает прямое управление картой, начатое после получения события DirectMapControlBeginEvent. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
public convenience init(
timestamp: TimeInterval
)
timestamp
DirectMapRotationEvent
Событие прямого вращения карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
public convenience init(
bearingDelta: Bearing,
timestamp: TimeInterval,
rotationCenter: ScreenPoint? = nil
)
bearingDelta
изменение угла поворота карты, в градусах. Положительные значения соответствуют направлению вращения против часовой стрелки
timestamp
Время генерации системного события.
rotationCenter
Точка на экране, вокруг которой вращается карта. Если точка не задана, то вращение происходит относительно точки позиции карты.
DirectMapScalingEvent
Событие прямого масштабирования карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
public convenience init(
zoomDelta: Float,
timestamp: TimeInterval,
scalingCenter: ScreenPoint? = nil
)
zoomDelta
Величина, на которую изменится текущее значение масштаба.
timestamp
Время генерации системного события.
scalingCenter
Точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.
DirectMapShiftEvent
Событие прямого сдвига карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
public convenience init(
screenShift: ScreenShift,
shiftedPoint: ScreenPoint,
timestamp: TimeInterval
)
screenShift
Изменение экранной позиции карты относительно предыдущей, в пикселях.
shiftedPoint
Центральная точка, от которой производится смещение карты.
timestamp
Время генерации системного события.
DirectMapTiltEvent
Событие прямого наклона камеры. События прямого управления картой описаны в DirectMapControlBeginEvent.
public convenience init(
delta: Float,
timestamp: TimeInterval
)
delta
Изменение угла наклона в градусах.
timestamp
Время генерации системного события.
var delta
Изменение угла наклона в градусах.
DirectoryObject
Объект справочника.
public static func == (lhs: DirectoryObject, rhs: DirectoryObject) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func formattedAddress(
type: FormattingType
) -> FormattedAddress?
Cтроковое представление адреса, отформатированное в соответствии с указанным требованием к длине.
public func publicTransportScheduleInfo(
departureTimeUtc: UInt64
) -> Future<PublicTransportDirectoryScheduleInfo?>
Информация о расписаниях платформ и направлений.
departureTimeUtc
Время в системе UNIX по UTC, на которое необходимо получить расписание.
var types
Тип объекта. Может быть несколько, например, ТЦ Сан Сити - филиал организации и здание одновременно. Первый тип в этом списке - основной.
var title
Заголовок объекта.
var titleAddition
Дополнительная информация заголовка Пример: “(кв. 1-12)”
Для получения данной информации запросите дополнительную настройку ключа.
var subtitle
Подзаголовок объекта.
при отсутствии может быть пустой строкой
var description
Описание объекта.
var id
Стабильный числовой идентификатор объекта.
var markerPosition
Точка объекта, где следует разместить маркер.
var address
Адрес объекта в виде набора компонент.
var attributes
Дополнительные атрибуты объекта.
var contextAttributes
Контекстные дополнительные атрибуты объекта.
var timeZoneOffset
Сдвиг локального времени объекта относительно UTC в секундах в текущий момент.
var openingHours
Время работы объекта.
var contactInfos
Контакты объекта.
var reviews
Отзывы.
var parkingInfo
Дополнительная информация о парковке.
var workStatus
Статус работы.
var levelId
Идентификатор этажа, на котором расположен объект.
Для получения данной информации запросите дополнительную настройку ключа.
var entrances
Информация о входах.
Для получения данной информации запросите дополнительную настройку ключа.
var tradeLicense
Данные о лицензии организации.
Для получения данной информации запросите дополнительную настройку ключа.
var buildingInfo
Информация о здании.
var branchesInfo
Информация о связанных организациях.
var chargingStation
Атрибуты для электрозаправки.
var rubricIds
Идентификаторы рубрик.
var orgInfo
Информация об организации.
var group
Связанные в объединённую карточку объекты.
Для получения данной информации запросите дополнительную настройку ключа.
var routeInfos
Справочная информация о маршрутах общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.
var platformIds
Справочная информация о идентификаторах платформ общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.
DoubleRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: DoubleRouteAttribute, rhs: DoubleRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [DoubleRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> DoubleRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> DoubleRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
DoubleRouteLongAttribute
Контейнер, хранящий протяжённый атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения атрибута. Значение атрибута действует от текущей точки до точки, в которой начинается действие атрибута следующего элемента.
public static func == (lhs: DoubleRouteLongAttribute, rhs: DoubleRouteLongAttribute) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
public func entry(
point: RoutePoint
) -> DoubleRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [DoubleRouteLongEntry]
Элементы, попадающие в промежуток [begin, end).
DynamicRouteInfoSettings
Настройки получения динамических данных о маршруте.
public static func == (lhs: DynamicRouteInfoSettings, rhs: DynamicRouteInfoSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
Event
Базовый класс для всех обрабатываемых событий.
public static func == (lhs: Event, rhs: Event) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
ExceedSpeedLimitSettings
Настройки обнаружения превышения максимальной разрешённой скорости.
public static func == (lhs: ExceedSpeedLimitSettings, rhs: ExceedSpeedLimitSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
File
Идентификатор файла.
public static func == (lhs: File, rhs: File) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
FinishDetector
public static func == (lhs: FinishDetector, rhs: FinishDetector) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
FloatRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: FloatRouteLongAttribute, rhs: FloatRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> FloatRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [FloatRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
FollowController
Класс, позволяющий управлять положением камеры. Реализации всех его методов должны быть потокобезопасны. У большинства методов есть тривиальные реализации по умолчанию (таким образом FollowController, отвечающий за масштаб, не обязан переопределять методы coordinates() и т.п.). Один контроллер может быть единомоментно добавлен только в одну карту.
public static func == (lhs: FollowController, rhs: FollowController) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
FreeRoamSelector
Контроллер перевода навигатора в режим FreeRoam при слишком долгом перестроении маршрута.
public static func == (lhs: FreeRoamSelector, rhs: FreeRoamSelector) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
FreeRoamSettings
public static func == (lhs: FreeRoamSettings, rhs: FreeRoamSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var onRoutePrefetchLength
Тайлы дорожного графа загружаются в http-кэш во время ведения по маршруту, если они соответствуют участку маршрута от текущей позиции до указанного расстояния. Значение по умолчанию - 5 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
var onRoutePrefetchRadiusMeters
При кэшировании тайлов дорожного графа во время ведения по маршруту тайлы загружаются в http-кэш, если оказываются ближе заданного расстояния в метрах от линии маршрута. Значение по умолчанию - 1 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
var prefetchRadiusMeters
Тайлы дорожного графа загружаются в http-кэш если оказываются ближе заданного расстояния в метрах от текущей позиции. Значение по умолчанию - 2 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
Future
public init(
subscriber: @escaping Subscriber,
canceller: @escaping Canceller = {}
)
subscriber
A function to create a new subscription.
canceller
A function to release all associated resources. It must be called at some point after the subscription has fired (e.g. in deinit).
public static func == (lhs: Future<Value>, rhs: Future<Value>) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
static func makeReadyValue(_ value: Value) -> Future<Value>
Make an immediately ready future value.
static func makeReadyError(message: String) -> Future<Value>
Make an immediately ready future error.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
func sinkOnMainThread(
receiveValue: @escaping @Sendable (Value) -> Void,
failure: @escaping @Sendable (Error) -> Void
) -> DGis.Cancellable
func sink(
on queue: DispatchQueue,
receiveValue: @escaping @Sendable (Value) -> Void,
failure: @escaping @Sendable (Error) -> Void
) -> Cancellable
Geometry
Объект геометрии.
public static func == (lhs: Geometry, rhs: Geometry) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func intersects(
geometry: Geometry
) -> Bool
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
GeometryMapObject
Геометрический объект карты.
var geometryChannel
Геометрия объекта.
var geometry
Геометрия объекта.
var objectAttributes
Получение свойств объекта карты для чтения и изменения.
var isVisibleChannel
Текущий флаг видимости объекта.
var isVisible
Текущий флаг видимости объекта.
var isDraggableChannel
Текущий флаг перемещаемости объекта.
var isDraggable
Текущий флаг перемещаемости объекта.
var animationSettings
Получение настроек анимации. Применяется для объектов с типом “3D model” или “Directional model”.
var bounds
Прямоугольник минимального размера, содержащий геометрию.
GeometryMapObjectBuilder
Класс для установки свойств и последующего создания геометрических объектов.
public static func == (lhs: GeometryMapObjectBuilder, rhs: GeometryMapObjectBuilder) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init()
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setObjectAttribute(
name: String,
value: AttributeValue
) -> GeometryMapObjectBuilder
Установка свойства объекта карты.
name
Имя свойства объекта карты.
value
Значение свойства объекта карты.
public func setObjectAttributes(
values: [String: AttributeValue]
) -> GeometryMapObjectBuilder
Установка свойств объекта карты.
метод не заменяет весь набор свойств объекта, т.е. если свойство в values отсутствует, но уже добавлено в объект ранее, оно не будет изменено.
values
набор пар “имя”:“значение” для добавляемых свойства объекта карты
public func setGeometry(
geometry: Geometry
) -> GeometryMapObjectBuilder
Установка геометрии объекта карты.
public func setVisible(
visible: Bool
) -> GeometryMapObjectBuilder
Установка видимости объекта карты.
public func setDraggable(
draggable: Bool
) -> GeometryMapObjectBuilder
Установка возможности перетаскивания объекта карты.
public func setUserData(
userData: Any
) -> GeometryMapObjectBuilder
Установка пользовательских данных.
пользовательские данные никак не используются в SDK и нужны только чтобы возвращать их пользователю.
public func createObject() -> GeometryMapObject
Конструирование объекта карты.
GeometryMapObjectSource
Источник геометрических объектов карты.
public func clusteringObjects(
position: CameraPosition
) -> [MapObject]
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и геометрические объекты.
public func addObject(
item: GeometryMapObject
)
Добавление объекта в источник.
public func addObjects(
objects: [GeometryMapObject]
)
Добавление нескольких объектов в источник.
objects
public func removeObject(
item: GeometryMapObject
)
Удаление объекта из источника.
Удаление асинхронное, потокобезопасное, метод можно использовать из любого потока.
public func removeObjects(
objects: [GeometryMapObject]
)
Удаление объектов из источника.
objects
public func removeAndAddObjects(
objectsToRemove: [GeometryMapObject],
objectsToAdd: [GeometryMapObject]
)
Удаление и добавление объектов в источник.
public func clear()
Удаление всех объектов из источника.
GeometryMapObjectSourceBuilder
public static func == (lhs: GeometryMapObjectSourceBuilder, rhs: GeometryMapObjectSourceBuilder) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setSourceAttribute(
name: String,
value: AttributeValue
) -> GeometryMapObjectSourceBuilder
Установка свойства объектов карты, общего для всего источника (см. ISource).
public func setSourceAttributes(
values: [String: AttributeValue]
) -> GeometryMapObjectSourceBuilder
Установка свойств объектов карты, общих для всего источника.
public func addObject(
item: GeometryMapObject
) -> GeometryMapObjectSourceBuilder
Добавление геометрического объекта карты в источник.
public func addObjects(
objects: [GeometryMapObject]
) -> GeometryMapObjectSourceBuilder
Добавление нескольких геометрических объектов карты в источник.
public func createSource() -> GeometryMapObjectSource
Создание источника геометрических объектов.
после вызова этой функции использовать GeometryMapObjectSourceBuilder для создания источника данных или для задания параметров источника данных нельзя
GeoPointRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: GeoPointRouteAttribute, rhs: GeoPointRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [GeoPointRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> GeoPointRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> GeoPointRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
public func calculateGeoPoint(
routePoint: RoutePoint
) -> SegmentGeoPoint?
Вычисляет GeoPoint по известной RoutePoint.
Сложность операции O(log2(N)), где N = route_geometry.size()
routePoint
Вычисленные географические координаты и направление сегмента, на который указывает параметр route_point. Если маршрут пустой или route_point выходит за пределы маршрута, то возвращается nil.
public func calculateClosestPoint(
point: GeoPoint
) -> RoutePoint?
Вычисляет ближайшую точку на маршруте к заданной в географических координатах точке.
Сложность операции O(N), где N = route_geometry.size()
point
Проецируемая на маршрут точка.
Ближайшая точка на маршруте. Если маршрут пустой, либо точки range.first и range.second одновременно лежат либо до маршрута, либо после, то возвращается nil.
GroupCheckableItem
Набор отмечаемых элементов, работающих как радио-группа.
var items
Получение набора элементов группы.
HttpCacheManager
Интерфейс управления HTTP-кешем.
public static func == (lhs: HttpCacheManager, rhs: HttpCacheManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func `get`(
context: Context
) -> HttpCacheManager?
Получает объект для управления HTTP-кешем.
public func clear()
Очистка содержимого HTTP-кеша.
Image
Изображение.
public static func == (lhs: Image, rhs: Image) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
IncompleteTextHandler
Предложено автодополнение для введенного пользователем текста.
public static func == (lhs: IncompleteTextHandler, rhs: IncompleteTextHandler) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
IndoorBuilding
Здание с этажными планами.
public static func == (lhs: IndoorBuilding, rhs: IndoorBuilding) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func linkedWith(
other: IndoorBuilding
) -> Bool
Указывает, что текущее здание и другие здания с этажными планами (параметр other) связаны между собой.
Группа связанных зданий работает как единый объект:
- метод
levels()возвращает общий список этажей во всех зданиях группы; - активный режим отображения изменяется одновременно у зданий всей группы.
var id
Идентификатор здания с этажными планами.
var defaultLevelIndex
Индекс этажа по умолчанию.
var levels
Информация обо всех этажах.
var activeLevelIndexChannel
Порядковый индекс активного этажа в levels.
var activeLevelIndex
Порядковый индекс активного этажа в levels.
var modeChannel
Активный режим отображения здания. Если указано значение ActiveLevelMode, то index указывает на индекс активного этажа в векторе levels. Если указано значение OverviewMode, активен режим обзорного вида на здание.
var mode
Активный режим отображения здания. Если указано значение ActiveLevelMode, то index указывает на индекс активного этажа в векторе levels. Если указано значение OverviewMode, активен режим обзорного вида на здание.
IndoorControlModel
Модель элемента управления этажами.
public static func == (lhs: IndoorControlModel, rhs: IndoorControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var activeLevelIndexChannel
Индекс активного этажа.
var activeLevelIndex
Индекс активного этажа.
var markedLevels
Этажи, на которых отображаются пометки.
var levelNamesChannel
Названия этажей. Пусто, если на карте не отображается здание с этажными планами, или у здания всего один этаж.
var levelNames
Названия этажей. Пусто, если на карте не отображается здание с этажными планами, или у здания всего один этаж.
IndoorDetector
Детектор, который определяет находится ли пользователь в помещении.
public static func == (lhs: IndoorDetector, rhs: IndoorDetector) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
IndoorManager
Класс для получения текущего здания с этажными планами.
public static func == (lhs: IndoorManager, rhs: IndoorManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setIndoorState(
newState: IndoorManagerState
)
Переключение включенности/выключенности менеджера этажных планов
newState
IndoorRouteLevelsGetter
Позволяет получать множество этажей, через которые проходят маршруты, отображаемые на карте.
public static func == (lhs: IndoorRouteLevelsGetter, rhs: IndoorRouteLevelsGetter) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
IndoorUIControl
UI-элемент для управления этажами в здании.
override public func layoutSubviews()
IndoorViewModel
ViewModel для контрола этажей.
InputEvent
Событие пользовательского ввода.
InstructionRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: InstructionRouteAttribute, rhs: InstructionRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [InstructionRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> InstructionRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> InstructionRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
IntRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: IntRouteAttribute, rhs: IntRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [IntRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> IntRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> IntRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
ItemMarkerInfo
Идентификатор объекта и его координаты.
public static func == (lhs: ItemMarkerInfo, rhs: ItemMarkerInfo) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
LaneSignRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: LaneSignRouteLongAttribute, rhs: LaneSignRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> LaneSignRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [LaneSignRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
LocaleManager
Менеджер региональных настроек приложения.
public static func == (lhs: LocaleManager, rhs: LocaleManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> LocaleManager
Получает объект для управления локалями приложения.
public func overrideLocales(
locales: [Locale]
)
Установка списка локалей приложения
locales
var localesChannel
Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.
var locales
Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.
var systemLocalesChannel
Получение локалей, предоставляемых ОС.
var systemLocales
Получение локалей, предоставляемых ОС.
LocationService
Класс для работы с установленным при инициализации SDK источником геопозиции.
public static func == (lhs: LocationService, rhs: LocationService) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
Map
Карта.
public static func == (lhs: Map, rhs: Map) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setFontIconSizeMultiplier(
multiplier: Float
) throws
Установка множителя размера для иконок и шрифтов, полученный из приложения.
через set_font_icon_size_multiplier можно задавать множитель размера иконок и шрифтов, без необходимости менять системный множитель и, соответственно, без влияния на размер иконок и шрифтов в других приложениях.
multiplier
public func resetFontIconSizeMultiplier()
Сбросить множитель размера для иконок.
public func addSource(
source: Source
)
Добавление источника данных на карту.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
source
public func removeSource(
source: Source
)
Удаление источника данных из карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
source
public func getRenderedObjects(
centerPoint: ScreenPoint,
radius: ScreenDistance = ScreenDistance(value: 1)
) -> Future<[RenderedObjectInfo]>
Получение отображаемых объектов карты, проецирующихся на окружность на экране.
Список объектов формируется в порядке отрисовки от поздних к ранним.
centerPoint
центр окружности.
radius
радиус окружности.
public func sublayerAttributes(
sublayerName: String
) -> Attributes
Получение атрибутов подслоя.
Полученные атрибуты содержат только добавленные туда ранее (явно).
var id
Идентификатор экземпляра карты, уникальный в рамках процесса.
var camera
Получение камеры.
var indoorManager
Получение менеджера этажных планов.
var dataLoadingStateChannel
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
var dataLoadingState
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
var styleChannel
Получение текущих стилей карты.
var style
Получение текущих стилей карты.
var fontIconSizeMultiplierChannel
Множитель размера иконок и шрифтов, полученный из приложения.
var fontIconSizeMultiplier
Множитель размера иконок и шрифтов, полученный из приложения.
var sources
Получение источников данных карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
var mapVisibilityStateChannel
var mapVisibilityState
var attributes
Получение атрибутов.
должны быть указаны свойства: “theme”=“day|night” “navigatorOn”=“true|false”
var interactiveChannel
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
var interactive
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
var graphicsPresetHintChannel
Получение рекомендуемого режима графики для данного устройства.
var graphicsPresetHint
Получение рекомендуемого режима графики для данного устройства.
var graphicsPresetChannel
Получение режима графики. В случае nil используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.
var graphicsPreset
Получение режима графики. В случае nil используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.
MapLocationController
Контроллер для управления позиционированием карты в навигаторе.
public static func == (lhs: MapLocationController, rhs: MapLocationController) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
MapManager
Интерфейс, позволяющий добавлять карты в навигатор и убирать их из него.
public static func == (lhs: MapManager, rhs: MapManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
MapObject
Объект на карте.
public static func == (lhs: MapObject, rhs: MapObject) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var userData
Произвольные пользовательские данные, прикрепленные к объекту.
MapObjectManager
public static func == (lhs: MapObjectManager, rhs: MapObjectManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
map: Map,
layerId: String? = nil
)
Создать IMapObjectManager.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func withClustering(
map: Map,
logicalPixel: LogicalPixel,
maxZoom: Zoom,
clusterRenderer: SimpleClusterRenderer,
minZoom: Zoom = Zoom(value: 0),
layerId: String? = nil
) -> MapObjectManager
Создать IMapObjectManager с кластеризацией данных. Кластеризуются только IMarker объекты.
map
logicalPixel
Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает кластеризация.
maxZoom
Уровень, начиная с которого видны все маркеры.
clusterRenderer
Интерфейс для задания параметров отображения кластера.
minZoom
Уровень, начиная с которого формируются кластеры.
layerId
ID слоя в стиле типа “Динамический объект”. Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
public static func withGeneralization(
map: Map,
logicalPixel: LogicalPixel,
maxZoom: Zoom,
minZoom: Zoom = Zoom(value: 0),
layerId: String? = nil
) -> MapObjectManager
Создать IMapObjectManager с генерализацией данных. Генерализуются только IMarker объекты.
map
logicalPixel
Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает генерализация.
maxZoom
Уровень, начиная с которого видны все маркеры.
minZoom
Уровень, начиная с которого работает генерализация.
layerId
ID слоя в стиле типа “Динамический объект”. Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
public func addObjects(
objects: [SimpleMapObject]
)
Добавить объекты.
objects
public func removeObjects(
objects: [SimpleMapObject]
)
Удалить объекты.
objects
public func removeAndAddObjects(
objectsToRemove: [SimpleMapObject],
objectsToAdd: [SimpleMapObject]
)
Удалить и добавить объекты.
public func removeAll()
public func clusteringObjects(
position: CameraPosition
) -> [MapObject]
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и маркеры.
MapObjectTappedCallback
Класс для хранения функции обратного вызова, которая вызывается при клике на карту.
public init(callback: @Sendable @escaping (_ objectInfo: RenderedObjectInfo) -> Void)
public static func == (lhs: MapObjectTappedCallback, rhs: MapObjectTappedCallback) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
MapRotationBeginEvent
Событие начала вращения карты вокруг точки.
var direction
Направление вращения карты.
MapRotationEndEvent
MapScalingBeginEvent
Событие начала изменения масштаба.
var direction
Направление изменения уровня масштабирования карты.
MapScalingEndEvent
MapShiftBeginEvent
MapShiftEndEvent
Marker
Точечная отметка на карте, представляющая интерес для пользователя.
var position
Получение местоположения маркера.
var icon
Получение иконки маркера.
var anchor
Получение точки привязки иконки маркера.
var iconOpacity
Получение прозрачности иконки маркера.
var text
Получение подписи маркера.
var textStyle
Получение стиля подписи маркера.
var isDraggable
Получение флага перемещаемости маркера.
var iconWidth
Получение целевой ширины маркера, используемой для масштабирования.
var iconMapDirection
Угол поворота маркера на карте относительно направления на север, по часовой стрелке.
var animatedAppearance
Анимировать ли появление.
var iconAnimationMode
Получение режима анимации анимированного маркера.
MarkerViewModel
public init(
id: UUID,
position: GeoPointWithElevation,
anchor: Anchor,
offsetX: CGFloat,
offsetY: CGFloat
)
MillisecondsRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: MillisecondsRouteAttribute, rhs: MillisecondsRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [MillisecondsRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> MillisecondsRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> MillisecondsRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
public func calculateDuration(
routePoint: RoutePoint
) -> TimeInterval
public func calculateDuration(
fromRoutePoint: RoutePoint,
toRoutePoint: RoutePoint
) -> TimeInterval
MiniMapViewModel
Model
Модель навигатора, предназначенная для отображения в UI.
public static func == (lhs: Model, rhs: Model) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func betterRouteResponse(
response: BetterRouteResponse
)
Ответ пользователя о применении предложенного маршрута лучше.
response
var stateChannel
Состояние навигатора.
var state
Состояние навигатора.
var locationChannel
Текущая геопозиция, с которой работает навигатор.
var location
Текущая геопозиция, с которой работает навигатор.
var locationAvailableChannel
Флаг, который указывает используется ли текущая геопозия для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.
Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.
var locationAvailable
Флаг, который указывает используется ли текущая геопозия для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.
Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.
var routeChannel
Маршрут с манёврами.
В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.
var route
Маршрут с манёврами.
В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.
var dynamicRouteInfoChannel
Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.
var dynamicRouteInfo
Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.
var routePositionChannel
Текущая позиция пользователя на маршруте.
var routePosition
Текущая позиция пользователя на маршруте.
var exceedingMaxSpeedLimitChannel
Флаг превышения максимальной разрешенной скорости.
var exceedingMaxSpeedLimit
Флаг превышения максимальной разрешенной скорости.
var betterRouteChannel
Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно nil, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.
var betterRoute
Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно nil, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.
var distance
Расстояние от текущей позиции до конца маршрута.
var duration
Время движения от текущей позиции до конца маршрута.
var isFreeRoam
ModelData
Данные модели.
public static func == (lhs: ModelData, rhs: ModelData) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
ModelMapObject
Модель на карте.
public convenience init(
options: ModelMapObjectOptions
) throws
options
MyLocationControlModel
Модель контрола перелета к местоположению пользователя. Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя. Если местоположение не определено, ничего не происходит. Методы объекта необходимо вызывать на одном потоке.
public static func == (lhs: MyLocationControlModel, rhs: MyLocationControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func onClicked()
MyLocationMapObject
Маркер геопозиции.
MyLocationMapObjectSource
Источник, содержащий маркер геопозиции.
public convenience init(
context: Context,
controllerSettings: MyLocationControllerSettings = MyLocationControllerSettings(),
markerType: MyLocationMapObjectMarkerType = MyLocationMapObjectMarkerType.model
)
Создать источник маркера геопозиции.
var item
Получить маркер геопозиции.
MyLocationMapObjectSourceProvider
Провайдер, предоставляющий источник маркера геопозиции.
public static func == (lhs: MyLocationMapObjectSourceProvider, rhs: MyLocationMapObjectSourceProvider) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var myLocationMapObjectSource
Источник, содержащий маркер геопозиции.
NavigationFollowController
Интерфейс для управления слежением карты за маркером геопозиции в навигаторе.
var followReturnDelay
Таймаут, через который карта автоматически вернется в режим слежения за маркером геопозиции после того, как пользователь подвигал её. 0 - автоматический возврат в режим слежения за маркером геопозиции отключен.
var cameraBehaviour
Режим слежения камеры за маркером геопозиции в навигаторе.
NavigationFollowingUIControl
NavigationManager
Корневой публичный интерфейс навигатора.
var uiModel
Модель навигатора, предназначенная для отображения в UI.
var indoorDetector
Навигация внутри помещений.
var mapFollowController
Управление автоматическим возвратом карты к слежению за маркером геопозиции.
var mapLocationController
Контроллер для управления позиционированием карты в навигаторе.
var mapManager
Менеджер карт навигатора.
var zoomFollowSettings
Настройки масштабирования карты во время режима ведения.
var routeMapSettings
Настройки отображения маршрута на карте.
var routeSourceSettings
Настройки источника, используемого для отображения маршрута на карте.
var routeMapObjectsProvider
Провайдер объектов маршрутов на карте.
var simulationSettings
Настройки симуляции ведения по маршруту.
var voiceSelector
Управление голосовыми пакетами в текущей сессии навигатора.
var exceedSpeedLimitSettings
Настройки детектирования превышения скорости.
var dynamicRouteInfoSettings
Настройки получения и обновления динамических данных о маршруте.
var soundNotificationSettings
Настройки звуковых оповещений в текущей сессии навигатора.
var freeRoamSettings
Настройки ведения без маршрута в режиме free roam.
var alternativeRoutesProviderSettings
Настройки поиска альтернативных маршрутов в режиме ведения.
var alternativeRouteSelector
Выбор альтернативного маршрута.
var trafficJamDetector
Информация о пробках на маршруте.
var myLocationMapObjectSourceProvider
Провайдер, предоставляющий источник маркера геопозиции.
var routeRebuilder
Контроллер поиска нового маршрута при сходе с текущего маршрута.
var freeRoamSelector
Контроллер перевода навигатора в режим FreeRoam при слишком долгом перестроении маршрута.
var dataPrefetcher
Контроллер для предварительной загрузки данных карты для маршрута.
var finishDetector
Контроллер завершения маршрута.
NavigationMiniMapViewModel
ViewModel для SwiftUI-элемента отображения миникарты в навигаторе.
NavigationVoice
Голос для использования в навигаторе.
NavigationZoomViewModel
ViewModel SwiftUI-элемента для управления зумом в навигаторе.
NavigatorFollowManager
NewValuesNotifier
Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.
public static func == (lhs: NewValuesNotifier, rhs: NewValuesNotifier) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func sendNotification()
Необходимо вызывать, чтобы сообщить об обновлении параметров.
ObstacleInfoRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: ObstacleInfoRouteAttribute, rhs: ObstacleInfoRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [ObstacleInfoRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> ObstacleInfoRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> ObstacleInfoRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
ObstacleInfoRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: ObstacleInfoRouteLongAttribute, rhs: ObstacleInfoRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> ObstacleInfoRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [ObstacleInfoRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
Package
Пакет. Для удобства работы с данными (установки, обновления, удаления), данные в 2ГИС SDK группируются в наборы по функционально-логическому назначению. Набор сгруппированных данных называется пакетом. В пределах одного пакета функциональное назначение данных уникально. Однако, множества данных пакетов с единым функциональным назначением могут пересекаться, то есть, возможна ситуация, когда данные нескольких пакетов имеют общие файлы. При операциях с группой таких пакетов общие данные будут обрабатываться (скачиваться, распаковываться, удаляться) только один раз.
public static func == (lhs: Package, rhs: Package) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func install()
Запуск операции установки либо обновления пакета.
public func install(
fallback: InstallFallback
)
Запуск операции установки либо обновления пакета.
fallback
Поведение при ошибке.
public func uninstall()
Запуск операции удаления пакета.
public func pause()
Приостанавливает установку или обновление пакета.
var id
Стабильный технический идентификатор пакета.
var infoChannel
Информация о пакете.
var info
Информация о пакете.
var progressChannel
Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне [0, 100].
var progress
Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне [0, 100].
PackageManager
Интерфейс для централизованной работы с пакетами:
public static func == (lhs: PackageManager, rhs: PackageManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> PackageManager
Получает объект для работы с пакетами из контекста.
public func checkForUpdates()
Принудительная проверка на наличие обновлений.
var autoupdateEnabled
Статус (включено/выключено) автообновления.
var packagesChannel
Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.
var packages
Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.
PackedMapState
Сериализованное состояние карты.
public static func == (lhs: PackedMapState, rhs: PackedMapState) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func of(
position: CameraPosition,
showTraffic: Bool,
behaviour: CameraBehaviour
) -> PackedMapState
Получение состояния карты.
position
Позиция камеры.
showTraffic
Состояние отображения пробок на карте.
behaviour
Режим слежения камеры.
Сериализованное состояние карты.
public static func fromBytes(
data: Data
) throws -> PackedMapState
Получение состояния карты.
data
Состояние карты в виде последовательности байтов.
Сериализованное состояние карты.
public static func fromMap(
map: Map
) -> PackedMapState
Получение состояния карты.
map
Карта, состояние которой необходимо получить.
Сериализованное состояние карты.
public func toBytes() -> Data
Представление состояния карты в виде последовательности байтов.
PackedNavigationState
Вспомогательный объект для сериализации и десериализации состояния навигации.
PackedSearchQuery
Вспомогательный объект для сериализации и десериализации поискового запроса.
public static func == (lhs: PackedSearchQuery, rhs: PackedSearchQuery) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func fromBytes(
data: Data
) throws -> PackedSearchQuery
Десериализация запроса поиска.
public static func fromSearchQuery(
searchQuery: SearchQuery
) -> PackedSearchQuery
public func toBytes() -> Data
public func toSearchQuery() -> SearchQuery
var queryText
Текст запроса. Для некоторых запросов (например, раскрытие рубрики из suggest’а) текст отсутствует, т.к. в запросе хранятся идентификаторы, и поведение отличается от поиска по тексту элемента suggest’а.
var orgId
Идентификатор организации.
var rubricIds
Идентификаторы рубрик.
var objectIds
Идентификаторы объектов.
var buildingId
Идентификатор здания.
var spatialRestriction
Геометрия, ограничивающая область поиска.
var areaOfInterest
Прямоугольная область интереса.
var allowedResultTypes
Ограничение по возвращаемым поиском типам объектов.
var pageSize
Размер страницы выдачи.
var directoryFilter
Информация об активных фильтрах.
var sortingType
Тип сортировки результатов.
var geoPoint
Центр для поискового запроса.
var radius
Радиус поиска в метрах.
var locale
Локаль поискового запроса.
var searchNearby
Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
Page
Страница результатов поиска.
public static func == (lhs: Page, rhs: Page) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func fetchPrevPage() -> Future<Page?>
Получить предыдущую страницу результатов.
public func fetchNextPage() -> Future<Page?>
Получить следующую страницу результатов.
var items
Непустой набор объектов справочника этой страницы.
ParkingControlModel
Модель контрола парковок.
Этот интерфейс является потокобезопасным.
public static func == (lhs: ParkingControlModel, rhs: ParkingControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
map: Map
)
Функция создания модели элемента управления парковками.
map
карта.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func toggleParkingsVisibility()
Действие при нажатии на контрол. Переключает видимость парковок на карте.
PerformSearchHandler
Предложено поискать определенный набор объектов.
public static func == (lhs: PerformSearchHandler, rhs: PerformSearchHandler) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var searchQuery
Запрос для прогона через поисковик.
PointGeometry
Polygon
Полигон на карте.
public convenience init(
options: PolygonOptions
) throws
Cоздание полигона на основе параметров.
options
PolygonGeometry
Polyline
Ломаная линия на карте.
PolylineGeometry
Projection
Проекция.
public static func == (lhs: Projection, rhs: Projection) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func screenToMap(
point: ScreenPoint
) -> GeoPoint?
Вычисление точки карты в указанной точке экрана.
Функция возвращает пустое значение, если указанная точка экрана за пределами проекции карты.
public func mapToScreen(
point: GeoPoint
) -> ScreenPoint?
Вычисление точки экрана, соответствующей указанной точке карты.
Функция возвращает пустое значение:
public func mapToScreen(
point: GeoPointWithElevation
) -> ScreenPoint?
Вычисление точки экрана, соответствующей указанной точке карты с высотой.
Функция возвращает пустое значение:
public func screenToMapClipped(
point: ScreenPoint
) -> GeoPoint
Вычисление ближайшей точки карты к проекции указанной точки экрана.
public func distanceOnMap(
fromPoint: ScreenPoint,
toPoint: ScreenPoint
) -> Meter?
Вычисление расстояния между точками на карте, соответствующими указанным точкам на экране, в метрах.
Функция возвращает пустое значение, если одна или обе указанных точки экрана находятся за пределами проекции карты.
public func distanceOnScreen(
fromGeoPoint: GeoPoint,
toGeoPoint: GeoPoint
) -> LogicalPixel?
Вычисление расстояния между точками на экране, соответствующими указанным точкам на карте, в пикселях.
Функция возвращает пустое значение если одна или обе точки на карте:
PublicTransportTransferRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: PublicTransportTransferRouteLongAttribute, rhs: PublicTransportTransferRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> PublicTransportTransferRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [PublicTransportTransferRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
RangeWidget
Виджет для представления непрерывного или дискретного набора упорядоченных значений.
RasterTileSource
Источник, получающий растровые тайлы.
public convenience init(
context: Context,
sublayerName: String,
sourceTemplate: RasterUrlTemplate
)
Создание источника, получающего растровые тайлы.
context
контекст.
sublayerName
имя, которое будет использовано при генерации объектов. Это имя должно быть указано в стилях в условии filter слоя типа raster для атрибута db_sublayer. Пример: [“match”, [“get”, “db_sublayer”], [“NAME”], true, false] Подробнее см. спецификацию: https://docs.2gis.com/ru/mapgl/stylespecification
sourceTemplate
Шаблон для запроса тайлов.
public func setOpacity(
opacity: Opacity
)
Установка значения прозрачности растрового тайла.
opacity
Remover
Объект для удаления пользовательского контента.
public static func == (lhs: Remover, rhs: Remover) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func remove() -> Future<ActionResult>
Удаление контента.
действие доступно для контента, автором которого является пользователь.
RoadEvent
Дорожное событие.
public static func == (lhs: RoadEvent, rhs: RoadEvent) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func photos() -> Future<[RoadEventPhoto]>
Фотографии события.
var type
Тип события.
var id
Идентификатор события.
var name
Локализованное название события.
var author
Информация о пользователе, добавившем событие.
var timestamp
Временная метка создания события.
var location
Координаты события.
var elevation
Высота дорожного события.
var description
Пользовательское описание дорожного события.
var cameraInfo
Информация о камере.
Доступна только для событий типа “Camera”.
var schedule
Расписание.
На текущий момент доступно только для перекрытий, и даже для них может отсутствовать.
var lanes
Затронутые событием полосы.
На текущий момент могут быть проставлены только у пользовательских событий.
var availableActions
Список доступных действий с событием.
var remover
Получение объекта для удаления события.
RoadEventAction
Действие события.
public static func == (lhs: RoadEventAction, rhs: RoadEventAction) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func `set`() -> Future<ActionResult>
Применение действия (например, добавление отметки “нравится”, подтверждение события).
Есть действия, противоположные друг другу, например, “нравится” и “не нравится”. Если для события доступны оба действия, вызов метода сбрасывает применение противоположного - невозможно одновременно поставить “нравится” и “не нравится”.
public func reset() -> Future<ActionResult>
Отмена действия (например, сброс отметки “нравится”, сброс подтверждения события).
Есть действия, противоположные друг другу, например, “нравится” и “не нравится”. Если для события доступны оба действия, вызов метода не вызывает применение противоположного действия.
RoadEventCreatorButtonUIControl
UI-элемент для создания дорожных событий.
override public func layoutSubviews()
RoadEventManager
Объект для создания транспортных событий.
public static func == (lhs: RoadEventManager, rhs: RoadEventManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> RoadEventManager
Получает объект для работы с дорожными событиями.
public func createAccident(
location: GeoPoint,
lanes: LaneOptionSet,
description: String
) -> Future<AddEventResult>
Создание события “ДТП”.
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
public func createCamera(
location: GeoPoint,
description: String
) -> Future<AddEventResult>
Создание события “Камера”.
public func createRoadRestriction(
location: GeoPoint,
description: String
) -> Future<AddEventResult>
Создание события “Перекрытие дорожного движения”.
public func createComment(
location: GeoPoint,
description: String
) -> Future<AddEventResult>
Создание события “Комментарий”.
public func createOther(
location: GeoPoint,
lanes: LaneOptionSet,
description: String
) -> Future<AddEventResult>
Создание события “Другое”.
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
public func createRoadWorks(
location: GeoPoint,
lanes: LaneOptionSet,
description: String
) -> Future<AddEventResult>
Создание события “Дорожные работы”.
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
RoadEventMapObject
Объект карты “Дорожное событие”.
RoadEventMapObjectRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: RoadEventMapObjectRouteAttribute, rhs: RoadEventMapObjectRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoadEventMapObjectRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> RoadEventMapObjectRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> RoadEventMapObjectRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RoadEventPhoto
Фотография дорожного события.
public static func == (lhs: RoadEventPhoto, rhs: RoadEventPhoto) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func previewUrl(
desiredSize: ScreenSize
) -> String
URL превью фотографии.
public func report() -> Future<ActionResult>
Отправка жалобы на фотографию.
жалоба на свою фотографию ни к чему не приведёт.
RoadEventRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: RoadEventRouteAttribute, rhs: RoadEventRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoadEventRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> RoadEventRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> RoadEventRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RoadEventSource
Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.
public convenience init(
context: Context
)
Создание источника, отображающего дорожные события на карте.
context
public func setHighlighted(
directoryObjectIds: [DgisObjectId],
highlighted: Bool
)
Установка или снятие выделения дорожных событий.
добавляет событию атрибут “selected”, который можно использовать в стилях.
directoryObjectIds
Идентификаторы изменяемых событий. Можно получить из RoadEventMapObject.
highlighted
Установка или снятие выделения.
RoadRuleRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: RoadRuleRouteLongAttribute, rhs: RoadRuleRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> RoadRuleRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoadRuleRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
RoadSubtypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: RoadSubtypeRouteLongAttribute, rhs: RoadSubtypeRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> RoadSubtypeRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoadSubtypeRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
RoadSurfaceRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: RoadSurfaceRouteLongAttribute, rhs: RoadSurfaceRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> RoadSurfaceRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoadSurfaceRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
RoadTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: RoadTypeRouteLongAttribute, rhs: RoadTypeRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> RoadTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoadTypeRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
RotateMapToNorthEvent
Route
Класс, описывающий маршрут. Маршрут представляет собой набор атрибутов, каждый из которых представляет собой контейнер типа RouteAttribute или RouteLongAttribute, в котором хранятся элементы атрибутов маршрута. Атрибуты маршрута делятся на точечные и протяженные. Точечные атрибуты (например, точки геометрии или лежачие полицейские) задаются в виде пары из RoutePoint и значения атрибута. Протяженные атрибуты (например, ширина проезжей части или ограничение скорости) задаются в виде пары из RoutePoint, которая указывает на начало действия атрибута и значения атрибута. В конце маршрута ставится терминатор. Например, пусть ширина проезжей части задана в виде набора пар {{0m, 3m}, {10m, 7m}, {20m, 5m}, {30m, 0m}}, тогда первые 10 метров маршрута проезжая часть имеет ширину 3 метра, на интервале [10м., 20м.) - 7м., с 20м. до конца маршрута - 5м.
public static func == (lhs: Route, rhs: Route) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var geometry
Геометрия маршрута.
Не гарантируется, что RoutePoint у точек геометрии будет совпадать с RoutePoint у элементов других атрибутов, поэтому для того, чтобы вычислить географическую координату у элемента атрибута, не нужно искать в геометрии элемент, RoutePoint которого совпадает с RoutePoint элемента атрибута, вместо этого нужно воспользоваться функцией calculate_geo_point.
var instructions
Инструкции, которые необходимо выполнить для движения по маршруту.
var intermediatePoints
Промежуточные точки, через которые проходит маршрут. Маршрут может проходить не прямо через промежуточную точку, а рядом с ней. В значении атрибута хранится координата, в которую была установлена промежуточная точка, в ключе - координата проекции промежуточной точки на маршрут.
var altitudes
Высоты на маршруте.
var badRoads
Плохая дорога (на дороге присутствуют кочки и ямы, которые препятствуют проезду).
var obstacles
Препятствия на маршруте.
var roadNames
Названия дорог/улиц.
var settlements
Признак того, что участок маршрута проходит по населённому пункту.
var transportTypes
Вид транспорта, для которого построен участок маршрута.
var crossingTypes
var tollPaymentPointInfos
var cameras
Дорожные камеры.
var carriagewaysWidth
Ширина проезжей части в метрах. 0 - ширина неизвестна.
var exitSigns
Знаки съездов.
var humps
Искусственные неровности.
var lanes
Полосы движения.
var levels
Этажи зданий.
var maxSpeedLimits
Ограничения максимальной допустимой скорости.
0 - ограничение скорости неизвестно.
var roadRules
Сторона движения.
var roadSubtypes
Дополнительное описание типа дороги, по которой пролегает маршрут.
var roadSurfaces
Покрытие дороги.
var roadTypes
Тип дороги, по которой пролегает маршрут.
var tolls
Участки маршрута, пролегающие по платным дорогам.
var truckData
Признак наличия или отсутствия данных для грузовой навигации.
var truckPassZoneIds
Пропускные зоны для грузового транспорта.
var truckRestrictedAreas
Признак действия знака запрета проезда грузового транспорта.
var vehicleRestrictedAreas
Признак действия знака запрета проезда любого автотранспорта (перекрытия).
var bicycleLanes
Признак наличия выделенной велополосы.
var trafficLights
Признак наличия светофоров.
var immersiveData
var publicTransportTransfers
Описание способов перемещения на общественном транспорте между точками пересадок.
RouteEditor
Интерфейс для редактора маршрута. Редактор маршрута получает точки начала и конца маршрута, строит маршруты и через каналы оповещает об их обновлениях и перестроениях.
Все методы этого интерфейса вызываются из одного потока.
public static func == (lhs: RouteEditor, rhs: RouteEditor) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
context: Context,
trafficRouter: TrafficRouter? = nil
)
Функция создания редактора маршрута.
context
Контекст.
trafficRouter
Поисковик маршрута для использования внутри редактора маршрута. Если не задан, по умолчанию используется гибридный поисковик.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func setRouteParams(
routeParams: RouteEditorRouteParams
)
Установка параметров редактора маршрута. Запускает поиск нового маршрута согласно переданным параметрам.
routeParams
public func setActiveRouteIndex(
index: RouteIndex
)
Установка индекса активного маршрута.
index
var routesInfoChannel
Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.
var routesInfo
Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.
var activeRouteIndexChannel
Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается nil.
var activeRouteIndex
Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается nil.
RouteEditorSource
Интерфейс класса, управляющего отображением маршрутов на карте.
public convenience init(
context: Context,
routeEditor: RouteEditor,
activeDisplayFlags: RouteMapObjectDisplayFlagOptionSet? = nil,
inactiveDisplayFlags: RouteMapObjectDisplayFlagOptionSet? = nil,
activeCalloutLabelFlags: RouteMapObjectCalloutLabelFlagOptionSet? = nil,
inactiveCalloutLabelFlags: RouteMapObjectCalloutLabelFlagOptionSet? = nil,
calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.absoluteValues,
activePermanentDisplayFlags: RouteMapObjectPermanentDisplayFlagOptionSet? = nil,
inactivePermanentDisplayFlags: RouteMapObjectPermanentDisplayFlagOptionSet? = nil
)
Функция создания IRouteEditorSource.
context
routeEditor
activeDisplayFlags
inactiveDisplayFlags
activeCalloutLabelFlags
inactiveCalloutLabelFlags
calloutLabelDisplayMode
activePermanentDisplayFlags
inactivePermanentDisplayFlags
public func setRoutesVisible(
visible: Bool
)
Включить или выключить отображение маршрутов на карте.
visible
public func setShowOnlyActiveRoute(
showOnlyActiveRoute: Bool
)
Отображать на карте все маршруты (false) или только текущий активный маршрут (true).
showOnlyActiveRoute
public func setPassedDistanceVisualization(
passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization
)
Изменить способ визуализации расстояния, пройденного вдоль маршрута.
passedDistanceVisualization
var objects
Объекты маршрута на карте.
var routeSourceSettings
Настройки отображения маневров на маршруте.
var activeDisplayFlags
Флаги отображения активного маршрута. См. IRouteMapObject::display_flags.
var inactiveDisplayFlags
Флаги отображения неактивных маршрутов. См. IRouteMapObject::display_flags.
var activeCalloutLabelFlags
Флаги, включающие отображение содержимого в баблах активного маршрута. См. IRouteMapObject::callout_label_flags.
var inactiveCalloutLabelFlags
Флаги, включающие отображение содержимого в баблах неактивных маршрутов. См. IRouteMapObject::callout_label_flags.
var calloutLabelDisplayMode
Режим отображения значений в баблах маршрутов. См. IRouteMapObject::callout_label_display_mode.
var activePermanentDisplayFlags
Флаги, исключающие скрытие компонентов активного маршрута с карты. См. IRouteMapObject::permanent_display_flags.
var inactivePermanentDisplayFlags
Флаги, исключающие скрытие компонентов неактивных маршрутов с карты. См. IRouteMapObject::permanent_display_flags.
RouteExitSignRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: RouteExitSignRouteAttribute, rhs: RouteExitSignRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RouteExitSignRouteEntry]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> RouteExitSignRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> RouteExitSignRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RouteInfoCalloutMapObject
Объект бабла с информацией о длине и/или длительности маршрута на карте.
RouteLevelInfoRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: RouteLevelInfoRouteLongAttribute, rhs: RouteLevelInfoRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> RouteLevelInfoRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RouteLevelInfoRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
RouteMapObject
Объект маршрута на карте.
public convenience init(
trafficRoute: TrafficRoute,
isActive: Bool,
index: RouteIndex,
displayFlags: RouteMapObjectDisplayFlagOptionSet? = nil,
calloutLabelFlags: RouteMapObjectCalloutLabelFlagOptionSet? = nil,
calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.absoluteValues,
permanentDisplayFlags: RouteMapObjectPermanentDisplayFlagOptionSet? = nil
)
trafficRoute
isActive
index
displayFlags
calloutLabelFlags
calloutLabelDisplayMode
permanentDisplayFlags
var displayFlagsChannel
Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.
var displayFlags
Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.
var permanentDisplayFlagsChannel
Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.
var permanentDisplayFlags
Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.
var isActiveChannel
Статус активности маршрута.
var isActive
Статус активности маршрута.
var route
Маршрут.
var routeIndex
Индекс маршрута в редакторе маршрута.
var passedDistanceChannel
Пройденное расстояние вдоль маршрута.
var passedDistance
Пройденное расстояние вдоль маршрута.
var passedDistanceVisualizationChannel
var passedDistanceVisualization
var calloutPositionChannel
Положение бабла маршрута.
var calloutPosition
Положение бабла маршрута.
var calloutLabelFlagsChannel
Набор флагов для отображения содержимого баблов маршрута. Набор флагов для отображения содержимого баблов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.
var calloutLabelFlags
Набор флагов для отображения содержимого баблов маршрута. Набор флагов для отображения содержимого баблов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.
var calloutLabelDisplayModeChannel
Режим отображения значений в баблах маршрута. По умолчанию значения отображаются в виде абсолютных величин.
var calloutLabelDisplayMode
Режим отображения значений в баблах маршрута. По умолчанию значения отображаются в виде абсолютных величин.
var roadEventObjectsChannel
Отображаемые на карте объекты дорожных событий вдоль маршрута.
var roadEventObjects
Отображаемые на карте объекты дорожных событий вдоль маршрута.
RouteMapObjectSource
Источник объектов маршрута на карте.
public convenience init(
context: Context,
routeVisualizationType: RouteVisualizationType = RouteVisualizationType.normal
)
Функция создания IRouteMapObjectSource.
public func addObject(
item: RouteMapObject
)
Добавление объекта маршрута в источник.
item
public func removeObject(
item: RouteMapObject
)
Удаление объекта маршрута из источника.
item
public func replaceObject(
oldObject: RouteMapObject,
newObject: RouteMapObject
)
Замена одного объекта маршрута в источнике на другой. В отличие от удаления и добавления объектов маршрута через последовательные вызовы remove_object и add_object замена одного маршрута на другой выполняется атомарно - старый маршрут удаляется, а новый появляется на карте одновременно.
Если старый маршрут не найден в источнике, то вызов эквивалентен вызову add_object.
public func clear()
Удаление всех объектов маршрута из источника.
public func replaceAllObjects(
objects: [RouteMapObject]
)
Замена всех ранее добавленных в источник объектов на передаваемый список объектов. В отличие от удаления и добавления объектов по одному замена выполняется атомарно - старые маршруты удаляются, а новые маршруты появляются на карте одновременно.
objects
RouteMapObjectsProvider
Интерфейс для получения объектов маршрута на карте.
public static func == (lhs: RouteMapObjectsProvider, rhs: RouteMapObjectsProvider) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
RouteMapSettings
Настройки отображения маршрута на карте.
public static func == (lhs: RouteMapSettings, rhs: RouteMapSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var onRouteDisplayFlags
Флаги отображения маршрута на карте для режима ведения по маршруту. По умолчанию включены все флаги, за исключением флага InactiveFloors.
var freeRoamDisplayFlags
Флаги отображения маршрута на карте для режима free roam. По умолчанию включены флаги Cameras, Humps, Accidents, RoadWorks, Comments, RoadRestrictions, OtherEvents.
var onRoutePermanentDisplayFlags
Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима ведения по маршруту. По умолчанию скрываются все элементы маршрута.
var freeRoamPermanentDisplayFlags
Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима free roam. По умолчанию скрываются все элементы маршрута.
RoutePointMapObject
Точечный объект, являющийся частью маршрута на карте (например, точка начала или конца маршрута).
var route
Маршрут, часть которого представляет данный точечный объект.
var routeIndex
Индекс маршрута.
var kind
Тип точечного объекта маршрута.
var routePoint
Позиция на маршруте, соответствующая данному точечному объекту.
var pointChannel
Географические координаты, в которых находится данный точечный объект.
var point
Географические координаты, в которых находится данный точечный объект.
RouteRebuilder
Контроллер поиска нового маршрута при сходе с текущего маршрута.
public static func == (lhs: RouteRebuilder, rhs: RouteRebuilder) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
RouteSourceSettings
Настройки источника маршрута.
public static func == (lhs: RouteSourceSettings, rhs: RouteSourceSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func getLargeScaleMergeDistanceMeters(
transportType: TransportType
) -> Float
Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба. Если расстояние меньше заданного, то стрелки объединяются.
public func setLargeScaleMergeDistanceMeters(
distance: Float,
transportType: TransportType
)
Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба.
distance
Расстояние в метрах.
transportType
Тип транспорта, для которого устанавливается расстояние.
public func getSmallScaleMergeDistanceMeters(
transportType: TransportType
) -> Float
Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба. Если расстояние меньше заданного, то стрелки объединяются.
public func setSmallScaleMergeDistanceMeters(
distance: Float,
transportType: TransportType
)
Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба.
distance
Расстояние в метрах.
transportType
Тип транспорта, для которого устанавливается расстояние.
public func getLargeScaleCrossroadsOffsetMeters(
transportType: TransportType
) -> Float
Смещение в метрах от точки перекрестка до начала и конца стрелки манёвра для крупного масштаба.
public func setLargeScaleCrossroadsOffsetMeters(
offset: Float,
transportType: TransportType
)
Установить смещение в метрах от точки перекрестка до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.
offset
Смещение в метрах.
transportType
Тип транспорта, для которого устанавливается смещение.
public func getSmallScaleCrossroadsOffsetMeters(
transportType: TransportType
) -> Float
Смещение от точки перекрестка до начала и конца стрелки манёвра для мелкого масштаба.
public func setSmallScaleCrossroadsOffsetMeters(
offset: Float,
transportType: TransportType
)
Установить смещение от точки перекрестка до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.
offset
Смещение в метрах.
transportType
Тип транспорта, для которого устанавливается смещение.
var largeScaleRingroadOffsetMeters
Смещение от точки съезда с кольца до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.
var smallScaleRingroadOffsetMeters
Смещение от точки съезда с кольца до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.
var calloutVisualizationMode
Режим отображения баблов со временем и длиной маршрута.
RouteTollPaymentPointInfoRouteAttribute
Контейнер, описывающий точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой расположен элемент, и значения атрибута.
public static func == (lhs: RouteTollPaymentPointInfoRouteAttribute, rhs: RouteTollPaymentPointInfoRouteAttribute) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RouteTollPaymentPointInfoRouteEntry]
Элементы, попадающие в промежуток [begin, end).
public func findNearBackward(
point: RoutePoint
) -> RouteTollPaymentPointInfoRouteEntry?
Поиск ближайшего элемента с позицией <= point.
Сложность операции: log2(N), где N = size (количество элементов).
public func findNearForward(
point: RoutePoint
) -> RouteTollPaymentPointInfoRouteEntry?
Поиск ближайшего элемента с позицией <= point.
Сложность операции: log2(N), где N = size (количество элементов).
ScaleMapEvent
Событие изменения масштаба карты.
public convenience init(
zoomDelta: Float,
scalingCenter: ScreenPoint? = nil
)
Конструктор события изменения масштаба.
zoomDelta
Величина, на которую изменится текущее значение масштаба.
scalingCenter
Точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.
SearchHistory
public static func == (lhs: SearchHistory, rhs: SearchHistory) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> SearchHistory
public func items(
page: SearchHistoryPage
) -> Future<SearchHistoryResult>
Возвращает страницу истории поиска. Элементы возвращаются в упорядоченном виде по времени добавления (от самых свежих до самых поздних).
public func addItem(
item: SearchHistoryItem
)
Добавляет элемент в историю поиска. В случае, если уже существовал такой же элемент, ранний дубликат удаляется.
public func addItems(
items: [SearchHistoryItem]
)
Добавляет список элементов в историю поиска. Считается, что порядок в списке хронологический. Все дубликаты будут убраны.
items
public func removeItem(
item: SearchHistoryItem
)
Удаляет элемент из истории поиска.
public func removeItems(
items: [SearchHistoryItem]
)
Удаляет список элементов из истории поиска.
items
public func clear()
Очищает историю поиска.
public func setKeyStrategy(
keyStrategy: SearchHistoryKeyStrategy?
)
Устанавливает политику формирования ключей для истории поиска. Миграцию уже существующих записей, созданных с использованием другой политики key_strategy, необходимо выполнять вручную. Если параметр не задан — используется алгоритм по умолчанию.
keyStrategy
SearchHistoryResult
Результат работы истории поиска при запросе истории.
public static func == (lhs: SearchHistoryResult, rhs: SearchHistoryResult) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var items
Набор элементов истории поиска.
SearchManager
Поисковик. Основная точка входа для справочного API.
public static func == (lhs: SearchManager, rhs: SearchManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func createOnlineManager(
context: Context
) throws -> SearchManager
Создать поисковик, работающий онлайн.
public static func createOfflineManager(
context: Context
) throws -> SearchManager
Создать поисковик, работающий с предзагруженными данными.
public static func createSmartManager(
context: Context
) throws -> SearchManager
Создать поисковик, работающий онлайн или с предзагруженными данными в зависимости от наличия подключения к сети интернет.
public func suggest(
query: SuggestQuery
) -> Future<SuggestResult>
Получить подсказки, соответствующие данному запросу.
query
public func search(
query: SearchQuery
) -> Future<SearchResult>
Получить объекты справочника, соответствующие данному запросу.
query
public func search(
suggest: Suggest,
searchSettings: SearchSettings
) -> Future<SearchResult>
Получить объекты справочника, соответствующие данному саджесту.
public func searchById(
id: String
) -> Future<DirectoryObject?>
Получить объект справочника по строковому идентификатору.
id
public func searchByDirectoryObjectId(
objectId: DgisObjectId
) -> Future<DirectoryObject?>
Получить объект справочника по идентификатору.
objectId
public func searchByIdWithLocale(
id: String,
locale: Locale?
) -> Future<DirectoryObject?>
Получить объект справочника по строковому идентификатору с указанной локалью.
public func searchByDirectoryObjectIdWithLocale(
objectId: DgisObjectId,
locale: Locale?
) -> Future<DirectoryObject?>
Получить объект справочника по идентификатору с указанной локалью.
SearchQuery
Поисковый запрос.
public static func == (lhs: SearchQuery, rhs: SearchQuery) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
SearchQueryBuilder
Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):
public static func == (lhs: SearchQueryBuilder, rhs: SearchQueryBuilder) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func fromQueryText(
queryText: String
) -> SearchQueryBuilder
Начать построение текстового поискового запроса c указанным текстом.
public static func fromRubricIds(
rubricIds: [RubricId]
) -> SearchQueryBuilder
Начать построение поискового запроса на основе идентификаторов рубрик.
public static func fromQueryTextAndRubricIds(
queryText: String,
rubricIds: [RubricId]
) -> SearchQueryBuilder
Начать построение текстового поискового запроса с фильтрацией по идентификаторам рубрик.
public static func fromQuery(
query: SearchQuery
) -> SearchQueryBuilder
Начать построение запроса на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
public static func fromOrgId(
orgId: OrgId
) -> SearchQueryBuilder
Начать построение поискового запроса c указанным идентификатором организации.
public static func fromBuildingId(
buildingId: BuildingId
) -> SearchQueryBuilder
Начать построение поискового запроса c указанным идентификатором здания.
public static func fromGeoPoint(
geoPoint: GeoPoint
) -> SearchQueryBuilder
Начать построение поискового запроса c указанным центром области поиска. Радиус по умолчанию равен 250. Конфликтует с методом set_spatial_restriction. Работает только с онлайн поиском.
public func setSpatialRestriction(
spatialRestriction: [GeoPoint]?
) -> SearchQueryBuilder
Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать. Конфликтует с методоми set_geo_point и from_geo_point.
по умолчанию ограничение отсутствует.
public func setAreaOfInterest(
rect: GeoRect?
) -> SearchQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
public func setAllowedResultTypes(
allowedResultTypes: [ObjectType]
) -> SearchQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
public func setPageSize(
pageSize: Int32
) -> SearchQueryBuilder
Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона [1; 50]
по умолчанию 10
public func setDirectoryFilter(
filter: DirectoryFilter
) -> SearchQueryBuilder
Задать фильтрацию для поискового запроса.
public func setSortingType(
sortingType: SortingType
) -> SearchQueryBuilder
Задать сортировку для поискового запроса.
public func setGeoPoint(
geoPoint: GeoPoint?
) -> SearchQueryBuilder
Задать центр для поискового запроса. Радиус по умолчанию равен 250 метров. Конфликтует с методом set_spatial_restriction.
public func setRadius(
radius: Meter?
) -> SearchQueryBuilder
Задать радиус поиска в метрах. Работает в сочетании с установленным geo_point. Для поискового запроса в точке ограничение от 0 до 2000. Для остальных запросов ограничение от 0 до 50000.
public func setLocale(
locale: Locale?
) -> SearchQueryBuilder
Задать локаль для поискового запроса.
public func setSearchNearby(
searchNearby: Bool
) -> SearchQueryBuilder
Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
SearchQueryWithInfo
Класс с дополнительной информацией о поисковом запросе для вывода в UI-элементах.
public static func == (lhs: SearchQueryWithInfo, rhs: SearchQueryWithInfo) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
searchQuery: SearchQuery,
title: String,
subtitle: String
)
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var searchQuery
Возвращает объект поискового запроса.
var title
Возвращает текст заголовка, который описывает объекты поискового запроса. Например, это может быть текст из поля title объекта ISuggest.
var subtitle
Возвращает текст подзаголовка. Например, это может быть текст из поля subtitle объекта ISuggest.
var rubrics
Возвращает список рубрик, по которым производится запрос.
SearchResult
Результат работы поисковика.
public static func == (lhs: SearchResult, rhs: SearchResult) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func markerTitles(
objectIds: [DgisObjectId]
) -> [Future<[UIMarkerInfo]>]
Получение текстов маркеров по их идентификаторам. Возвращается vector <future
var firstPage
Первая страница результатов поиска.
var representativeArea
Прямоугольная область, подходящая для отображения результатов поиска.
var itemMarkerInfos
Асинхронное получение маркеров.
var searchResultType
Тип поискового запроса.
var dynamicFilters
Динамические фильтры для этого запроса.
var actionWidgets
Виджеты быстрых фильтров.
Это так называемые “быстрые фильтры” - фильтры, наиболее интересные пользователю. Их не больше 5.
var mainWidgets
Виджеты фильтров.
var autoUseFirstResult
Признак того, что первый результат пригоден для непосредственного использования.
var nearbyRequested
Признак того, что запрошены объекты поблизости.
SearchResultItemViewFactory
public init(
viewModel: SearchResultItemViewModel,
theme: DirectoryViewTheme.SearchResultItemViewTheme
)
viewModel
public func makeTitleView() -> AnyView
public func makeSubtitleView() -> AnyView
public func makeRatingView() -> AnyView
public func makeDistanceView() -> AnyView
public func makeAddressView() -> AnyView
public func makeAttributesView() -> AnyView
public func makeChargingStationView() -> AnyView
public func makeAlertView() -> AnyView
SettlementRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: SettlementRouteLongAttribute, rhs: SettlementRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> SettlementRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [SettlementRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
SimpleCheckableItem
Простой отмечаемый элемент из CheckableItemsGroup.
SimpleClusterObject
Кластер простых (simple) объектов-маркеров.
var position
Получение позиции кластера на карте.
var objectCount
Получение количества маркеров в кластере.
var objects
Получение списка маркеров в кластере.
var anchor
Получение и установка точки привязки иконки кластера.
var iconOpacity
Получение и установка прозрачности иконки кластера.
var text
Получение и установка подписи кластера.
var textStyle
Получение и установка стиля подписи кластера.
var iconWidth
Получение и установка целевой ширины кластера, используемой для масштабирования.
var iconMapDirection
Получение и установка угла поворота кластера на карте относительно направления на север, по часовой стрелке.
var animatedAppearance
Получение и установка флага анимируемости появления кластера.
var zIndex
Получение и установка уровня отрисовки объекта.
SimpleMapObject
Объект на карте, для которого можно задавать видимость.
SimulationSettings
Настройки симуляции ведения по маршруту.
public static func == (lhs: SimulationSettings, rhs: SimulationSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var speedMode
Режим работы симулятора.
SoundNotificationSettings
Настройки звуковых оповещений в навигаторе По умолчанию все значения категорий звуков оповещений включены. Пользователь может менять значения во время работы с навигатором.
public static func == (lhs: SoundNotificationSettings, rhs: SoundNotificationSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var enabledSoundCategories
Набор флагов для звуковых оповещений.
Source
Источник данных на карте.
public static func == (lhs: Source, rhs: Source) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
StatefulChannel
var value
StringRouteAttribute
Контейнер, описывающий точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой расположен элемент, и значения атрибута.
public static func == (lhs: StringRouteAttribute, rhs: StringRouteAttribute) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [StringRouteEntry]
Элементы, попадающие в промежуток [begin, end).
public func findNearBackward(
point: RoutePoint
) -> StringRouteEntry?
Поиск ближайшего элемента с позицией <= point.
Сложность операции: log2(N), где N = size (количество элементов).
public func findNearForward(
point: RoutePoint
) -> StringRouteEntry?
Поиск ближайшего элемента с позицией <= point.
Сложность операции: log2(N), где N = size (количество элементов).
StringRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: StringRouteLongAttribute, rhs: StringRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> StringRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [StringRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
Style
Стиль с набором свойств объектов карты (cм. ISource).
public static func == (lhs: Style, rhs: Style) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var styleAttributes
Получение свойств по умолчанию для объектов, к которым применён указанный слой.
StyleZoomFollowController
Контроллер слежения за стилевым уровнем масштабирования карты.
public convenience init(
animationDuration: TimeInterval = 0.3
)
Создание контроллера слежения за стилевым уровнем масштабирования карты.
animationDuration
public func setStyleZoom(
styleZoom: StyleZoom
)
Установка нового значения стилевого уровня масштабирования.
styleZoom
Suggest
Поисковая подсказка.
public static func == (lhs: Suggest, rhs: Suggest) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
SuggestObjectHandler
Предложен конкретный объект справочника.
public static func == (lhs: SuggestObjectHandler, rhs: SuggestObjectHandler) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var item
Подсказанный объект.
SuggestQuery
Запрос поисковой подсказки.
public static func == (lhs: SuggestQuery, rhs: SuggestQuery) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
SuggestQueryBuilder
Построитель запросов к подсказчику.
public static func == (lhs: SuggestQueryBuilder, rhs: SuggestQueryBuilder) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func fromQueryText(
queryText: String
) -> SuggestQueryBuilder
Начать построение запроса подсказки для заданного текста и области интереса.
public static func fromQuery(
query: SuggestQuery
) -> SuggestQueryBuilder
Начать построение запроса подсказки на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
public func setSpatialRestriction(
spatialRestriction: [GeoPoint]?
) -> SuggestQueryBuilder
Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.
по умолчанию ограничение отсутствует
public func setAreaOfInterest(
rect: GeoRect?
) -> SuggestQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
public func setAllowedResultTypes(
allowedResultTypes: [SuggestedType]
) -> SuggestQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
public func setSuggestorType(
suggestorType: SuggestorType
) -> SuggestQueryBuilder
Задать тип подсказчика.
по умолчанию #SuggestorType::Object
public func setLimit(
limit: Int32
) -> SuggestQueryBuilder
Задать желаемое количество подсказок. Допустимы значения из диапазона [1; 50]
по умолчанию 10
public func setLocale(
locale: Locale?
) -> SuggestQueryBuilder
Локаль, с которой производится запрос подсказки и отдаются результаты.
public func setSearchNearby(
searchNearby: Bool
) -> SuggestQueryBuilder
Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
SuggestResult
Результат работы подсказчика.
public static func == (lhs: SuggestResult, rhs: SuggestResult) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
SystemMemoryManager
Интерфейс управления использованием системной памяти.
public static func == (lhs: SystemMemoryManager, rhs: SystemMemoryManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> SystemMemoryManager
Получает объект для управления использованием системной памяти.
public func reduceMemoryUsage()
Уменьшение использования памяти путём очистки всевозможных кешей и буферов.
TerritoriesAlongRouteProvider
Интерфейс для поиска маршрута с учетом пробочных данных.
public static func == (lhs: TerritoriesAlongRouteProvider, rhs: TerritoriesAlongRouteProvider) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
context: Context
)
Создание объекта для получения списка территорий вдоль маршрута из контекста.
context
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func getTerritories(
route: Route
) -> Future<[Territory]>
Возвращает минимально необходимый список офлайн-территорий в порядке следования маршрута.
route
Territory
Территория. Данные в 2ГИС нарезаны на некоторые неделимые единицы, называемые сегментами. Но для более удобной и гибкой работы с данными для обновления используются не сами сегменты, а их наборы, называемые территориями. Наборы сегментов в двух территориях могут пересекаться, в том числе одна территория может быть целиком вложена в другую.
TerritoryManager
Интерфейс для взаимодействия со списком территорий: Подписки на изменения информации о территориях; Поиска территорий по координатам и геометриям; Подписки на изменения информации о всеобщем прогрессе установки/обновления территорий; Приостановки и возобновления процесса установки/обновления территорий.
public static func == (lhs: TerritoryManager, rhs: TerritoryManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> TerritoryManager
Получает объект для работы с территориями из контекста.
public func findByPoint(
geoPoint: GeoPoint
) -> [Territory]
Поиск территорий, которым принадлежит заданная точка. Бросает исключение в случае передачи некорректных координат точки. Возвращает пустой список в случае ошибки, а именно:
public func findByRect(
rect: GeoRect
) -> [Territory]
Поиск территорий, которым принадлежит заданная геометрия. Бросает исключение в случае попытки использования неподдерживаемой геометрии. Возвращает пустой список, если геометрия находится за пределами проекции. Возвращает пустой список в случае внутренней ошибки при обработке списка территорий.
public func pause()
Приостановка всех запущенных операций установки либо обновления территорий.
public func resume()
Возобновление всех приостановленных операций установки либо обновления территорий.
var territoriesChannel
Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
var territories
Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
TiltFollowController
Контроллер слежения за углом наклона карты.
public convenience init(
styleZoomToTilt: StyleZoomToTiltRelation
)
Создание контроллера слежения за углом наклона карты.
styleZoomToTilt
зависимость угла наклона камеры от стилевого уровня масштабирования.
Traffic
Описание пробочных данных.
public static func == (lhs: Traffic, rhs: Traffic) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
TrafficCollector
Интерфейс для управления сервисом сбора информации о транспортном трафике.
Этот интерфейс является потокобезопасным.
public static func == (lhs: TrafficCollector, rhs: TrafficCollector) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> TrafficCollector
Получает объект для управления сервисом сбора информации о дорожном движении. Сервис анализирует состояние трафика на дороге, по которой движется пользователь, и отправляет результаты анализа на сервер в анонимизированном виде.
context
Контекст: окружение, необходимое для работы SDK.
Сервис сбора информации о дорожном движении.
TrafficControlModel
Модель контрола пробок.
Этот интерфейс является потокобезопасным.
public static func == (lhs: TrafficControlModel, rhs: TrafficControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
map: Map
)
Функция создания модели элемента управления пробками.
map
карта.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func onClicked()
Действие при нажатии на контрол. Переключает видимость пробок на карте.
TrafficJamDetector
Определение близости пользователя к пробке на маршруте.
public static func == (lhs: TrafficJamDetector, rhs: TrafficJamDetector) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
TrafficRoute
public static func == (lhs: TrafficRoute, rhs: TrafficRoute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
TrafficRouter
Интерфейс для поиска маршрута с учетом пробочных данных.
public static func == (lhs: TrafficRouter, rhs: TrafficRouter) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
context: Context,
routerType: RouterType = RouterType.hybrid
)
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func findRoute(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: [RouteSearchPoint] = []
) -> Future<[TrafficRoute]>
Ищет маршрут по заданным параметрам.
startPoint
Начальная точка маршрута.
finishPoint
Конечная точка маршрута.
routeSearchOptions
Параметры поиска маршрута.
intermediatePoints
Промежуточные точки для проезда в том же порядке, в котором точки заданы в векторе.
public func requestRoute(
request: Data,
serverEndpoint: String
) -> Future<[TrafficRoute]>
Ищет маршрут по ранее сериализованным параметрам.
request
Сериализованные параметры запроса.
serverEndpoint
Тип искомого маршрута, выступает частью урла, по которому отсылается запрос: bicycle, carrouting, pedestrian, truck.
public func findBriefRouteInfos(
searchPoints: [BriefRouteInfoSearchPoints],
routeSearchOptions: RouteSearchOptions
) -> Future<[BriefRouteInfo?]>
Ищет базовую информацию о маршрутах для соответствующего набора поисковых точек.
Если базовая информация для каких-либо из пар точек не будет найдена, элемент с соответствующим индексом в возвращённом результате будет иметь значение nil.
searchPoints
Набор точек для поиска базовой информации о маршруте.
routeSearchOptions
Параметры поиска маршрута.
Future с базовой информацией о наборе маршрутов, соответствующему набору точек поиска, либо исключением SimpleError в случае ошибки.
var truckPassZonePasses
Возвращает список всех поддерживаемых пропусков, разрешающих движение грузового транспорта в пределах пропускных зон.
TrafficScoreProvider
Подписка на обновления информации о величине пробок.
Этот интерфейс является потокобезопасным.
public static func == (lhs: TrafficScoreProvider, rhs: TrafficScoreProvider) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
map: Map
)
Функция создания объекта для слежения за баллом пробок в области видимости карты.
Получаемый объект нужно хранить всё время, пока требуется обновление данных.
map
Карта, для которой будет отслеживаться область видимости.
public convenience init(
context: Context,
point: GeoPoint
)
Функция создания объекта для слежения за баллом пробок для заданного местоположения.
получаемый объект нужно хранить всё время, пока требуется обновление данных.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
TrafficSource
TrafficSpeedColorRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: TrafficSpeedColorRouteLongAttribute, rhs: TrafficSpeedColorRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> TrafficSpeedColorRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [TrafficSpeedColorRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
TrafficUIControl
public override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?)
previousTraitCollection
public override func layoutSubviews()
public func switchTrafficVisibility()
TrafficViewModel
ViewModel для SwiftUI-элемента управления отображением пробок.
TransportTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: TransportTypeRouteLongAttribute, rhs: TransportTypeRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> TransportTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [TransportTypeRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
TraversalTypeRouteLongAttribute
Контейнер, хранящий протяжённый атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения атрибута. Значение атрибута действует от текущей точки до точки, в которой начинается действие атрибута следующего элемента.
public static func == (lhs: TraversalTypeRouteLongAttribute, rhs: TraversalTypeRouteLongAttribute) -> Bool
Возвращает булево значение, которое показывает, равны ли два значения.
public func hash(into hasher: inout Hasher)
Хэширует основные компоненты этого значения, передавая их в указанный хэшер.
hasher
Хэшер, который используется при объединении компонентов этого экземпляра.
public func entry(
point: RoutePoint
) -> TraversalTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [TraversalTypeRouteLongEntry]
Элементы, попадающие в промежуток [begin, end).
TruckPassZoneIdRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
public static func == (lhs: TruckPassZoneIdRouteLongAttribute, rhs: TruckPassZoneIdRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> TruckPassZoneIdRouteLongEntry?
Элемент, в который попадает заданная точка.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [TruckPassZoneIdRouteLongEntry]
Элементы, частично или полностью покрываемые отрезком [begin, end].
Voice
Голосовой пакет с озвучкой навигатора.
public func playWelcome() -> Future<Void>
Воспроизвести образец голоса.
future, который становится готовым, когда проигрывание сэмпла завершается.
VoiceManager
Интерфейс для взаимодействия со списком голосовых пакетов навигатора.
public static func == (lhs: VoiceManager, rhs: VoiceManager) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public static func instance(
context: Context
) -> VoiceManager
Получает объект для управления голосовыми пакетами из контекста.
var voicesChannel
Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
var voices
Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
var defaultVoice
Голосовой пакет на основании списка поддерживаемых локалей.
VoiceSelector
Управляет голосовыми пакетами в текущей сессии навигатора.
public static func == (lhs: VoiceSelector, rhs: VoiceSelector) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var voice
Голосовой пакет, с помощью которого воспроизводятся голосовые оповещения в текущей сессии навигатора.
VoidRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
public static func == (lhs: VoidRouteAttribute, rhs: VoidRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [RoutePoint]
Элементы, попадающие в отрезок [begin, end).
public func findNearBackward(
point: RoutePoint
) -> RoutePoint?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
public func findNearForward(
point: RoutePoint
) -> RoutePoint?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Widget
Базовый класс, представляющий виджет для фильтрации поисковой выдачи.
public static func == (lhs: Widget, rhs: Widget) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
ZoomControlModel
Модель контрола зумирования. Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты. При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной. Методы объекта необходимо вызывать на одном потоке.
public static func == (lhs: ZoomControlModel, rhs: ZoomControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
public func isEnabled(
button: ZoomControlButton
) -> StatefulChannel<Bool>
public func setPressed(
button: ZoomControlButton,
value: Bool
)
ZoomFollowSettings
Интерфейс, позволяющий управлять настройками масштабирования карты во время ведения.
public static func == (lhs: ZoomFollowSettings, rhs: ZoomFollowSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .
hasher
The hasher to use when combining the components of this instance.
var speedRangeToStyleZoomSequence
Последовательность интервалов скоростей и соответствующих им масштабов. Используется для автоматического изменения масштаба в навигаторе в зависимости от скорости.
var speedRangeToStyleZoomFreeRoamSequence
Последовательность интервалов скоростей и соответствующих им масштабов при ведении в режиме FreeRoam. Используется для автоматического изменения масштаба в навигаторе в зависимости от скорости.
var styleZoomSpeedRangesAnimationDuration
Длительность плавного изменения масштаба в режиме ведения при изменении скорости при отсутствии манёвров впереди/позади на достаточно близком расстоянии, либо на дорогах низкого значения.
var zoomInBeforeManeuverAnimationDuration
Длительность плавного увеличения уровня зума при приближении к манёвру. Используется только если скорость ниже, чем в get_min_speed_to_consider_in_zoom_in_before_maneuver_animation.
var zoomOutAfterManeuverAnimationDuration
Длительность плавного уменьшения уровня масштабирования после проезда манёвра.
var minSpeedToConsiderInZoomInBeforeManeuverAnimation
Минимальная скорость движения в м/с, при которой длительность плавного изменения уровня зума будет рассчитываться с учётом не только близости к манёвру, но и с учётом текущей скорости. Должна быть не меньше 0.1 м/с, значения меньше будут игнорироваться.
var zoomInBeforeManeuverAnimationAcceleration
Коэффициент ускорения анимации увеличения уровня зума при приближении к манёвру. Должен быть не меньше 1, значения меньше будут игнорироваться.
var distanceGapToManeuver
Расстояние до манёвра, при достижении которого анимация плавного увеличения уровня зума должна быть завершена, чтобы во время манёвра зум не менялся. Например, если до маневра 300 м, то анимация с плавным увеличением уровня зума должна быть завершена за 50 м до начала маневра. Должно быть не меньше 1 м, значения меньше будут игнорироваться.
var minAnimationDuration
Минимальное время анимации. Используется для предотвращения резких изменений уровня зума при анимации. Должно быть не меньше 200, значения меньше будут игнорироваться.
ZoomUIControl
UI-элемент для управления масштабом карты.
override public func layoutSubviews()
ZoomViewModel
ViewModel для контрола зума