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

class

ActivityTracker

Extends: Hashable
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
)

Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал, когда пользователь перестал пользоваться навигатором и его можно выключить.

Parameters

platformContext

Контекст.

model

Модель навигатора, состояние которого отслеживается.

speedBound

Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается, что навигатор активен, т.е. движение продолжается.

timeThreshold

TimeInterval

Время, в течение которого в состоянии Finished навигатора отслеживается скорость движения ниже пороговой для определения состояния неактивности навигатора. Если в течение этого времени скорость движения меньше установленного порога или нет данных о локации и скорости, навигатор считается неактивным.

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var stopChannel

StatefulChannel<Bool>

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

var stop

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

AlternativeRouteSelector

Выбор альтернативного маршрута.

Extends: Hashable
public static func == (lhs: AlternativeRouteSelector, rhs: AlternativeRouteSelector) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func selectAlternativeRoute(
trafficRoute: TrafficRoute
)

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

Parameters

trafficRoute

Альтернативный маршрут, который должен быть выбран в качестве текущего активного маршрута.

AlternativeRoutesProviderSettings

Настройки поиска альтернативных маршрутов и маршрута лучше.

Extends: Hashable
public static func == (lhs: AlternativeRoutesProviderSettings, rhs: AlternativeRoutesProviderSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var alternativeRoutesEnabled

Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.

var betterRouteEnabled

Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.

var routeSearchDelay

Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.

var betterRouteTimeCostThreshold

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

var betterRouteLengthThreshold

Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.

Attributes

Интерфейс для управления свойствами объекта карты.

Extends: Hashable
public static func == (lhs: Attributes, rhs: Attributes) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func setAttributeValue(
name: String,
value: AttributeValue
)

Установка свойства.

Parameters

name

Название свойства.

value

Значение.

public func setAttributeValues(
values: [String: AttributeValue],
attributesToRemove: [String] = []
)

Установка набора свойств.

Parameters

values

String[ : ]

Набор пар “имя”:“значение” для добавляемых свойства.

attributesToRemove

Список имён свойств, которые нужно удалить.

public func removeAttribute(
name: String
)

Удаление свойства.

Parameters

name

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

public func getAttributeValue(
name: String
) -> AttributeValue

Получение свойства.

Parameters

name

Имя свойства для получения.

Returns
Properties

var attributeNames

Получение списка свойств.

var changed

Channel<[String]>

Получение канала, уведомляющего об изменении свойств.

BaseCamera

Камера.

Extends: Hashable
public static func == (lhs: BaseCamera, rhs: BaseCamera) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func clone() -> BaseCamera

Создание копии текущей камеры.

Returns
public func setPosition(
position: CameraPosition
) throws

Установка новой позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, стилевым уровнем масштабирования, наклоном и направлением.

Parameters
public func changePosition(
positionChange: CameraPositionChange
) throws

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

Parameters

positionChange

public func setZoomRestrictions(
zoomRestrictions: CameraZoomRestrictions
) throws

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

Parameters

zoomRestrictions

Новый диапазон ограничений уровня масштабирования.

public func setPositionPoint(
positionPoint: CameraPositionPoint
) throws

Функция устанавливает новую позицию относительно области экрана, ограниченной отступами.

Parameters

positionPoint

новая позиция относительно области экрана, ограниченной отступами.

Properties

var projection

Проекция.

var positionChannel

StatefulChannel<CameraPosition>

Получение текущей позиции камеры.

var position

Получение текущей позиции камеры.

var zoomRestrictionsChannel

StatefulChannel<CameraZoomRestrictions>

Получение актуальных ограничений уровня масштабирования.

var zoomRestrictions

Получение актуальных ограничений уровня масштабирования.

var deviceDensityChannel

StatefulChannel<DeviceDensity>

Получение отношения DPI к базовому DPI устройства.

var deviceDensity

Получение отношения DPI к базовому DPI устройства.

var sizeChannel

StatefulChannel<ScreenSize>

Получение размера области просмотра.

var size

Получение размера области просмотра.

var paddingChannel

StatefulChannel<Padding>

Получение текущих отступов от краёв экрана.

var padding

Получение текущих отступов от краёв экрана.

var positionPointChannel

StatefulChannel<CameraPositionPoint>

Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).

var positionPoint

Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).

var visibleArea

Область пересечения пирамиды видимости камеры и поверхности карты.

var visibleRectChannel

StatefulChannel<GeoRect>

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

var visibleRect

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

var maxTiltRestrictionChannel

StatefulChannel<StyleZoomToTiltRelation?>

Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.

var maxTiltRestriction

Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.

BearingFollowController

Контроллер слежения за направлением карты.

public convenience init(
bearingSource: BearingSource,
animationDuration: TimeInterval = 1,
valueThreshold: Bearing = Bearing(value: 1)
)

Создание контроллера слежения за направлением карты.

Parameters

bearingSource

источник информации о направлении.

animationDuration

TimeInterval

неотрицательная длительность изменения реального направления.

valueThreshold

неотрицательное пороговое значение учитываемого изменения реального направления.

BoolRouteLongAttribute

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

Extends: Hashable
public static func == (lhs: BoolRouteLongAttribute, rhs: BoolRouteLongAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func entry(
point: RoutePoint
) -> BoolRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [BoolRouteLongEntry]

Элементы, частично или полностью покрываемые отрезком [begin, end].

Parameters
Properties

var size

Количество элементов.

var isEmpty

Элементы отсутствуют.

var first

Первый элемент.

var last

Последний элемент.

var entries

Все элементы.

BufferedChannel

Extends: Channel<Value>
Properties

var value

Value?

Camera

Камера для запуска перемещения карты и настроек слежения.

Extends: BaseCamera
Methods
public func move(
moveController: CameraMoveController
) -> Future<CameraAnimatedMoveResult>

Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.

Parameters

moveController

Контроллер анимированного перемещения камеры.

Returns
Future<>
public func move(
position: CameraPosition,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>

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

Parameters

position

Конечная позиция камеры.

time

TimeInterval

Время, выделенное на перемещение карты.

animationType

Тип анимации при перемещении камеры.

Returns
Future<>
public func move(
point: GeoPoint,
zoom: Zoom,
tilt: Tilt?,
bearing: Bearing,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>

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

Parameters

point

точка конечной позиции камеры

zoom

уровень масштабирования в конечной позиции камеры

tilt

наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller’а или текущее значение

bearing

поворот в конечной позиции камеры

time

TimeInterval

время, выделенное на перемещение карты

animationType

тип анимации при перемещении камеры

Returns
Future<>
public func processMovementAndStop()

Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, уровнем масштабирования и направлением.

public func setBehaviour(
behaviour: CameraBehaviour
)

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

Parameters
public func addFollowController(
followController: FollowController
)

Добавление контроллера слежения.

Parameters

followController

public func removeFollowController(
followController: FollowController
)

Удаление контроллера слежения.

Parameters

followController

public func setCustomFollowController(
followController: CustomFollowController
)

Добавление контроллера слежения, реализованного на платформе.

Parameters

followController

public func removeCustomFollowController()

Удаление контроллера слежения, реализованного на платформе.

func setPosition(point: GeoPoint, zoom: Zoom) throws
Parameters

point

zoom

func setPosition(point: GeoPoint) throws
Parameters
Properties

var stateChannel

StatefulChannel<CameraState>

Получение актуального состояния камеры.

var state

Получение актуального состояния камеры.

var behaviourChannel

StatefulChannel<CameraBehaviourChange>

Режим слежения камеры.

var behaviour

Режим слежения камеры.

CameraNotifier

Предупреждает о попадании в зону действия дорожной камеры.

Extends: Hashable
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
)

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

Parameters

model

Модель навигатора, состояние которого отслеживается.

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var cameraProgressChannel

StatefulChannel<CameraProgressInfo?>

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

var cameraProgress

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

CameraRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: Hashable
public static func == (lhs: CameraRouteAttribute, rhs: CameraRouteAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [CameraRouteEntry]

Элементы, попадающие в отрезок [begin, end).

Parameters
public func findNearBackward(
point: RoutePoint
) -> CameraRouteEntry?

Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.

Parameters
public func findNearForward(
point: RoutePoint
) -> CameraRouteEntry?

Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.

Parameters
Properties

var size

Количество элементов.

var isEmpty

Элементы отсутствуют.

var first

Первый элемент.

var last

Последний элемент.

var entries

Все элементы.

CancelEvent

Событие отмены текущего действия.

Extends: Event
public convenience init()

Cancellable

A cancellation token for a running operation.

Implements: ICancellable
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 .

Methods
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 .

Parameters

hasher

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 .

Methods
public func sink(
receiveValue: @escaping (Value) -> Void
) -> Cancellable

Subscribe to a stream of values over time. The subscription never fails.

Returns
Cancellable

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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CheckableGroupedItem

Единичный элемент из GroupCheckableItem.

Extends: Hashable
public static func == (lhs: CheckableGroupedItem, rhs: CheckableGroupedItem) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var text

Получение текстового описания элемента.

var values

Получение списка значений, по которым происходит фильтрация. Обычно одно значение.

var isChecked

Получение состояния элемента.

CheckableItem

Базовое представление отмечаемого элемента из CheckableItemsGroup.

Extends: Hashable
public static func == (lhs: CheckableItem, rhs: CheckableItem) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var type

Получение типа отмечаемого элемента.

var filterType

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

CheckableItemsGroup

Виджет для представления группы отмечаемых элементов.

Extends: Widget
Properties

var items

Получение группы элементов виджета.

Checkbox

Виджет-чекбокс.

Extends: Widget
Properties

var filterType

Получение типа фильтра, который представляет виджет.

var checkedText

Получение текста подписи для “отмеченного” чекбокса.

var uncheckedText

Получение текста подписи для “неотмеченного” чекбокса.

var values

Получение списка значений, по которым происходит фильтрация. Обычно одно значение.

var isChecked

Получение состояния виджета.

Circle

Окружность.

public convenience init(
options: CircleOptions
) throws
Parameters
Methods
public func setPosition(
position: GeoPoint
) throws

Установка местоположения центра окружности.

Parameters

position

public func setRadius(
radius: Meter
) throws

Установка радиуса окружности.

Parameters

radius

Properties

var position

Местоположение центра окружности.

var radius

Радиус окружности.

var color

Цвет заливки окружности.

var strokeWidth

Ширина линии границы окружности.

var strokeColor

Цвет границы окружности.

var dashedStrokeOptions

Получение параметров пунктирной обводки

ClusterObject

Кластер объектов.

Extends: MapObject
Properties

var position

Получение позиции кластера на карте.

var objectCount

Получение количества маркеров в кластере.

var objects

Получение списка маркеров в кластере.

var geometryObject

Получение геометрического объекта кластера.

CompassControl

Extends: UIControl
Methods
public override func layoutSubviews()
Properties

var intrinsicContentSize

CompassControlModel

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

Extends: Hashable
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 convenience init(
map: Map
)
Parameters

map

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func onClicked()
Properties

var bearingChannel

StatefulChannel<Bearing>

var bearing

CompassViewModel

ViewModel для контрола компаса

Extends: ObservableObject
Methods
public func onClicked()

ComplexGeometry

Составная геометрия, состоит из набора простых или составных геометрий.

Extends: Geometry
public convenience init(
geometries: [Geometry]
)
Parameters

geometries

Properties

var elements

Container

Центральный объект для доступа к возможностям iOS Mobile SDK.

public convenience init(
apiKeyOptions: ApiKeyOptions = .default,
logOptions: LogOptions = .default,
httpClientForRequest: IHTTPClient? = nil,
httpOptions: HTTPOptions = .default,
positioningServices: IPositioningServicesFactory = PlatformPositioningServicesFactory(),
batteryOptions: BatteryOptions = .default,
personalDataCollectionOptions: PersonalDataCollectionOptions = .default,
localizationOptions: LocalizationOptions = .default,
audioOptions: AudioOptions = .default,
vendorConfigFile: File? = nil
)

Конструктор контейнера.

Parameters

apiKeyOptions

Настройки ключа для доступа к сервисам 2ГИС.

logOptions

Настройки журналирования.

httpClientForRequest

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

httpOptions

Настройки HTTP-клиента (такие как кеширование).

positioningServices

Сервисы геопозиционирования.

batteryOptions

personalDataCollectionOptions

Настройки сервиса сбора данных.

localizationOptions

Настройки локализации приложения.

audioOptions

Настройки звука.

vendorConfigFile

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

Methods
public func makeMapFactory(
options: MapOptions
) throws -> IMapFactory
Parameters

options

Первоначальные свойства карты. Укажите .default для быстрого создания онлайн-карты, смотрящей на Москву, с фиксированным неточным PPI (не соответствующим текущему устройству).

Returns
public func makeStyleFactory() throws -> IStyleFactory

Создать конструктор стандартных и пользовательских стилей.

public func makeSearchManagerFactory() throws -> ISearchManagerFactory

Создать фабрику поисковиков по справочнику.

public func makeSourceFactory() throws -> ISourceFactory

Создать фабрику источников данных карты.

public func makeImageFactory() throws -> IImageFactory

Создать фабрику изображений для объектов карты.

public func makeLocaleManager() throws -> LocaleManager

Создать менеджер региональных настроек приложения.

public func makeRouteEditorFactory() throws -> IRouteEditorFactory

Создать фабрику редактора маршрутов.

public func makeNavigationViewFactory(options: NavigationViewOptions = .default) throws -> INavigationViewFactory

Создать фабрику слоя навигатора.

Parameters

options

Пользовательские настройки.

Returns
public func makeRoadEventCardViewFactory(options: RoadEventCardViewOptions = .default) throws -> IRoadEventCardViewFactory

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

Parameters

options

Пользовательские настройки.

Returns
Properties

var context

Корневой непрозрачный контейнер объектов SDK. Используется в качестве аргумента к API SDK.

var markerViewFactory

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

var locationService

Текущая реализация ILocationService, используемая внутри SDK и работающая через ILocationProvider.

let audioSettings

Настройки звука.

let httpOptions

Настройки HTTP-клиента.

let batteryOptions

Настройки слежения за состоянием батареи.

let localizationOptions

Настройки локализации приложения.

Context

Контекст - окружение, необходимое для работы SDK.

Extends: Hashable
public static func == (lhs: Context, rhs: Context) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
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 .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CoordinatesFollowController