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.
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 positionChannel
Получение текущей позиции камеры.
var position
Получение текущей позиции камеры.
var zoomRestrictionsChannel
Получение актуальных ограничений уровня масштабирования.
var zoomRestrictions
Получение актуальных ограничений уровня масштабирования.
var deviceDensityChannel
Получение отношения DPI к базовому DPI устройства.
var deviceDensity
Получение отношения DPI к базовому DPI устройства.
var sizeChannel
Получение размера области просмотра.
var size
Получение размера области просмотра.
var paddingChannel
Получение текущих отступов от краёв экрана.
var padding
Получение текущих отступов от краёв экрана.
var positionPointChannel
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var viewPoint
Точка взгляда относительно полного размера вьюпорта.
var visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
var visibleRectChannel
Объемлющий прямоугольник видимой области карты.
var visibleRect
Объемлющий прямоугольник видимой области карты.
var maxTiltRestrictionChannel
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
var maxTiltRestriction
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
var viewportRestrictionChannel
Получение ограничения на область видимости.
var viewportRestriction
Получение ограничения на область видимости.
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()
Удаление контроллера слежения, реализованного на платформе.
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.
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 sink(
receiveValue: @escaping (Value) -> Void
) -> Cancellable
Subscribe to a stream of values over time. The subscription never fails.
A cancellable instance. Deallocation of the result will tear down the subscription stream.
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 (Value) -> Void) -> Cancellable
Получение результата Channel на main очереди.
func sink(on queue: DispatchQueue, receiveValue: @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
Кластер объектов.
CompassControl
public override func layoutSubviews()
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()
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() -> IDirectoryViewsFactory
Создать фабрику SwiftUI элементов справочника.
public func makeMapFactory(
options: MapOptions
) throws -> IMapFactory
options
Первоначальные свойства карты. Укажите .default для быстрого создания онлайн-карты, смотрящей на Москву, с фиксированным неточным PPI (не соответствующим текущему устройству).
public func makeRouteEditorFactory() throws -> IRouteEditorFactory
Создать фабрику редактора маршрутов.
public func makeRoadEventCardViewFactory(options: RoadEventCardViewOptions = .default) throws -> IRoadEventCardViewFactory
Создать фабрику карточки дорожного события.
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
Объект для настройки звук