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.
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
Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
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] = []
)
Установка набора свойств.
values
набор пар “имя”:“значение” для добавляемых свойства
attributesToRemove
список имён свойств, которые нужно удалить
public func removeAttribute(
name: String
)
Удаление свойства.
name
имя свойства для удаления
public func getAttributeValue(
name: String
) -> AttributeValue
Получение свойства.
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 setZoomRestrictions(
zoomRestrictions: CameraZoomRestrictions
) throws
Функция устанавливает новый диапазон ограничений zoom-уровня.
zoomRestrictions
новый диапазон ограничений zoom-level.
public func setPositionPoint(
positionPoint: CameraPositionPoint
) throws
Функция устанавливает новую позицию относительно области экрана, ограниченной отступами.
positionPoint
новая позиция относительно области экрана, ограниченной отступами.
var projection
Проекция.
var positionChannel
Получение текущей позиции камеры.
var position
Получение текущей позиции камеры.
var zoomRestrictionsChannel
Получение актуальных ограничений zoom-уровня.
var zoomRestrictions
Получение актуальных ограничений zoom-уровня.
var deviceDensityChannel
Получение отношения DPI к базовому DPI устройства.
var deviceDensity
Получение отношения DPI к базовому DPI устройства.
var sizeChannel
Получение размера области просмотра.
var size
Получение размера области просмотра.
var paddingChannel
Получение текущих отступов от краёв экрана.
var padding
Получение текущих отступов от краёв экрана.
var positionPointChannel
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
var visibleRectChannel
Объемлющий прямоугольник видимой области карты.
var visibleRect
Объемлющий прямоугольник видимой области карты.
var styleZoomToTiltRelationChannel
Получение текущей функции зависимости угла наклона камеры от стилевого zoom-уровня.
var styleZoomToTiltRelation
Получение текущей функции зависимости угла наклона камеры от стилевого zoom-уровня.
var maxTiltRestrictionChannel
Получение текущей функции зависимости максимального угла наклона камеры от стилевого zoom-уровня.
var maxTiltRestriction
Получение текущей функции зависимости максимального угла наклона камеры от стилевого zoom-уровня.
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 processMovementAndStop()
Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает режим слежения.
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.
Circle
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()
ComplexGeometry
Составная геометрия, состоит из набора простых или составных геометрий.
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
)
Конструктор контейнера.
apiKeyOptions
Настройки ключа для доступа к сервисам 2ГИС.
logOptions
Настройки журналирования.
httpClientForRequest
Сетевой клиент для отправки HTTP-запросов.
httpOptions
Настройки HTTP-клиента (такие как кеширование).
positioningServices
Сервисы геопозиционирования.
batteryOptions
personalDataCollectionOptions
Настройки сервиса сбора данных.
localizationOptions
Настройки локализации приложения.
audioOptions
Настройки звука.
vendorConfigFile
Переопределения настроек для работы в автономном окружении.
public func makeMapFactory(
options: MapOptions
) throws -> IMapFactory
options
Первоначальные свойства карты. Укажите .default для быстрого создания онлайн-карты, смотрящей на Москву, с фиксированным неточным PPI (не соответствующим текущему устройству).
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 makeRoadEventCardViewFactory(options: RoadEventCardViewOptions = .default) throws -> IRoadEventCardViewFactory
Создать фабрику карточки дорожного события.
var context
Корневой непрозрачный контейнер объектов SDK. Используется в качестве аргумента к API SDK.
var markerViewFactory
Фабрика UIView маркеров для карты.
var locationService
Текущая реализация ILocationService, используемая внутри SDK и работающая через ILocationProvider.
let audioSettings
Настройки звука.
let httpOptions
Настройки HTTP-клиента.
let batteryOptions
Настройки слежения за состоянием батареи.
let localizationOptions
Настройки локализации приложения.
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.
CreateRoadEventControl
CurrentLocationControl
Блок с функцией перелёта к текущему местоположению.
public override func layoutSubviews()
DgisMapObject
Объект карты 2GIS.
информацию об объекте можно получить через справочник (directory)
var id
Стабильный числовой идентификатор объекта.
DgisSource
Основной интерфейс источников данных 2GIS
public static func createDgisSource(
context: Context,
workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.online
) -> 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?
Отформатированное в соответствии с указанным требованием к длине строковое представление адреса.
var types
Тип объекта. Может быть несколько, например, ТЦ Сан Сити - филиал организации и здание одновременно. Первый тип в этом списке - основной.
var title
Заголовок объекта.
var titleAddition
Дополнительная информация заголовка Пример: “(кв. 1-12)”
var subtitle
Подзаголовок объекта.
при отсутствии может быть пустой строкой
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 buildingLevels
Информация об этажных планах здания.
var entrances
Информация о входах.
var tradeLicense
Данные о лицензии организации.
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.