class
ActiveLevelMode
Режим отображения этажного плана.
ActiveLevelMode(index: Long)
Режим отображения этажного плана.
index
val index
Индекс этажа в векторе IIndoorBuilding::levels().
ActivityTracker
val stopChannel
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
val stop
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
AddEventResult
Результат добавления события (объект события или ошибка).
fun match(event: Function1, error: Function1): T
event
error
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
Address
Адрес в виде набора отдельных компонентов.
Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
buildingId: BuildingId?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)
Адрес в виде набора отдельных компонентов.
drillDown
components
buildingName
buildingId
postCode
buildingCode
fiasCode
addressComment
val drillDown
Набор объектов административного деления, в которых находится описываемый объект.
val components
Полный адрес объекта может содержать несколько отдельных адресных компонент.
val buildingName
Название здания.
val buildingId
Уникальный идентификатор здания.
val postCode
Почтовый индекс.
val buildingCode
Уникальный почтовый код здания.
val fiasCode
Код ФИАС объекта.
Для получения данной информации запросите дополнительную настройку ключа.
val addressComment
Комментарий к адресу. Пример: "301 офис; 9 этаж"
AddressAdmDiv
Объект административного деления.
AddressAdmDiv(type: String, name: String)
Объект административного деления.
type
name
AddressComponent
Компонент адреса: улица, номер дома или словесное описание местоположения.
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
streetAddress
number
location
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
AddressLocation
Применяется для компонентов, которые тяжело описать конкретным адресом.
AddressLocation(comment: String)
Применяется для компонентов, которые тяжело описать конкретным адресом.
comment
val comment
Словесное описание местоположения строения.
AddressNumber
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
AddressNumber(number: String, fiasCode: String?)
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
number
fiasCode
AddressStreet
Обычный адрес, есть улица и номер дома.
AddressStreet(
street: String,
number: String,
fiasCode: String?
)
Обычный адрес, есть улица и номер дома.
street
number
fiasCode
AddRoadEventButton
Кнопка добавления дорожного события.
AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Кнопка добавления дорожного события.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCard
Карточка добавления дорожного события.
AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка добавления дорожного события.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
const MAX_DESCRIPTION_LENGTH
AddRoadEventCardModel
Модель карточки добавления дорожного события.
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)
Модель карточки добавления дорожного события.
fun onEventTypeClicked(type: RoadEventType): Unit
Действие при нажатии UI-элемента управления выбором типа события.
fun onLaneClicked(lane: Lane): Unit
Действие при нажатии UI-элемента управления выбором полосы.
fun onDescriptionEntered(description: String): Unit
Действие при вводе описания.
description
fun onSendClicked(): Unit
Действие при нажатии кнопки отправки.
fun close(): Unit
val eventTypeChannel
Выбранный тип события.
val lanesChannel
Выбранные полосы.
val canSelectLanesChannel
Есть ли возможность задать полосы.
val descriptionChannel
Введенное описание.
val markerPositionChannel
Позиция маркера на экране.
val canSendChannel
Есть ли возможность отправить событие.
val resultChannel
Результат отправки события.
AddRoadEventControl
Базовый класс для UI-элементов добавления дорожных событий.
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для UI-элементов добавления дорожных событий.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
@CallSuper
fun detachFromModel(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
AddRoadEventControls
Набор UI-элементов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.
val cardHeightChannel
Высота в пикселях, на которую раскрыта карточка.
AddRoadEventMarker
Маркер добавления дорожного события.
AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Маркер добавления дорожного события.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
fun detachFromModel(): Unit
Aggregate
Обобщенное описание станции зарядки автомобилей.
Aggregate(
connectorsFree: Short,
connectorsTotal: Short,
isActive: Boolean,
isBusy: Boolean,
power: Short
)
Обобщенное описание станции зарядки автомобилей.
connectorsFree
connectorsTotal
isActive
isBusy
power
val connectorsFree
Количество доступных коннекторов.
val connectorsTotal
Общее количество коннекторов (кроме недоступных).
val isActive
Статус активности. true, если есть хотя бы один доступный, зарезервированный или на зарядке коннектор.
val isBusy
Статус занятости. true, если половина или более коннекторов заняты.
val power
Максимальная мощность из всех коннекторов.
AlternativeRouteSelector
AlternativeRoutesProviderSettings
Настройки поиска альтернативных маршрутов и маршрута лучше.
var alternativeRoutesEnabled
Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.
var betterRouteEnabled
Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.
var routeSearchDelay
Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.
var onAlternativeRoutesSuggestedRouteSearchDelay
Задержка перед следующим поиском маршрутов сразу после предложения пользователю альтернативных маршрутов. Сбрасывается в случае, если после предложения альтернативных маршрутов пользователь переходит на любой другой маршрут помимо одного из предложенных альтернативных.
var betterRouteTimeCostThreshold
Минимальная разница во времени движения между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var betterRouteLengthThreshold
Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var routerType
Тип поисковика для поиска альтернативных маршрутов.
Anchor
Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний
Anchor(x: Float = 0.5f, y: Float = 0.5f)
Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний
x
y
AndroidAutoMapSession
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
Important: ensure that SDK context has been initialized before creating instance of this class.
AndroidAutoMapSession(options: MapControllerOptions)
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
Important: ensure that SDK context has been initialized before creating instance of this class.
options
The configuration of the map controller.
fun onSurfaceAvailable(
surface: Surface,
width: Int,
height: Int
): Unit
Provides a surface for rendering additional content on top of the map. This surface can be created and provided before the onMapReady callback is triggered.
surface
The Surface object that will be used for rendering content on top of the map.
width
The width of the surface.
height
The height of the surface.
fun onSurfaceDestroyed(surface: Surface): Unit
Indicates that the surface has been destroyed.
surface
fun onSurfaceClicked(x: Float, y: Float): Unit
Forwards the SurfaceCallback.onClick event.
x
y
fun onSurfaceStableAreaChanged(stableArea: Rect): Unit
Forwards the SurfaceCallback.onStableAreaChanged event.
stableArea
fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit
Forwards the SurfaceCallback.onVisibleAreaChanged event.
visibleArea
fun onMapReady(map: Map): Unit
Provides a map when it is successfully initialized.
fun onMapReadyException(exception: Exception): Unit
Provides an exception in case of an error during initialization.
exception
fun setTheme(theme: MapTheme): Unit
Applies the theme to the map.
This takes effect only after the map has been initialized (i.e., after onMapReady has been called). To set a theme before the map is initialized, use MapControllerOptions.attributes.
fun setCopyrightPosition(position: CopyrightPosition): Unit
Sets the position of the copyright icon on the screen.
Important: This method must be called only after the onCreate state of Lifecycle.
AnimationSettings
Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами "3D model" и "Directional model". Индекс анимации должен быть обязательно указан для анимированной модели.
var animationIndex
Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.
var animationName
Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.
var sceneIndex
Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.
var sceneName
Название текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано, используется сцена по умолчанию, которая определена в самой модели.
var animationRepeatCount
Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.
var animationSpeed
Скорость проигрывания анимации модели. Если null, то используется значение из стилей. Значения больше единицы ускоряют проигрывание, меньше замедляют. Если в стилях значение не задано, используется скорость по умолчанию.
ApartmentRange
Диапазон квартир.
ApartmentRange(start: String, end: String? = null)
Диапазон квартир.
start
end
val start
Начало диапазона/хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.
val end
Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1.
Attribute
Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }
Attribute(tag: String, value: String)
Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }
tag
value
Attributes
Интерфейс для управления свойствами объекта карты.
Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты, для стиля и для источника (подробнее см. ISource).
fun setAttributeValue(name: String, value: AttributeValue): Unit
Установка свойства.
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit
Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.
values
Набор пар "имя":"значение" для добавляемых свойства.
attributesToRemove
Список имён свойств, которые нужно удалить.
fun removeAttribute(name: String): Unit
Удаление свойства.
name
Имя свойства для удаления.
fun getAttributeValue(name: String): AttributeValue
Получение свойства.
AttributeValue
Свойства объектов карты.
AttributeValue()
AttributeValue(boolean: Boolean)
boolean
AttributeValue(number: Double)
number
AttributeValue(integer: Long)
integer
AttributeValue(string: String)
string
AttributeValue(data: ByteArray)
data
AttributeValue(array: List<AttributeValue>)
array
AttributeValue(item: Map)
item
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
empty
boolean
number
integer
string
data
array
item
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
val isEmpty
val isBoolean
val asBoolean
val isNumber
val asNumber
val isInteger
val asInteger
val isString
val asString
val isData
val asData
val isArray
val asArray
val isObject
val asObject
val value
AudioSettings
Класс для управления звуком.
Все методы могут вызываться из любого потока.
@JvmStatic
fun get(context: Context): AudioSettings?
Настройки аудио. Null, если аудио драйвер недоступен.
AudioStreamReader
fun read(): List<Short>
Описание типа функции обратного вызова, которую вызывает аудиодрайвер для чтения потока аудиоданных.
буфер, в который записывается аудиопоток.
Описание формата данных аудиопотока: Кодировка: LPCM (https://en.wikipedia.org/wiki/Pulse-code_modulation). Количество фреймов в пакете: 1. Количество семплов в фрейме: 1. Формат сэмпла: знаковое целое. Размер сэмпла: 16 бит. Количество каналов: 1. Частота дискретизации (Sample rate): 22050 семплов в секунду.
AuthorInfo
Информация об авторе события или фотографии.
AuthorInfo(type: AuthorType, name: String)
Информация об авторе события или фотографии.
val type
Категория автора контента.
val name
Строка, содержащая имя пользователя, добавившего событие или фотографию.
- Имя пользователя в случае, если автор является авторизированным пользователем и согласился на отображение своего имени.
- Пустая строка для анонимного пользователя или пользователя, отказавшегося от отображения своего имени.
AvailableCallback
fun setAvailable(available: Boolean): Unit
Доступность аудиоустройства приложению.
available
Признак доступности аудиоустройства приложению.
BaseCamera
Камера.
Задаёт параметры проецирования карты на экран.
fun changePosition(positionChange: CameraPositionChange): Unit
Изменение только части параметров позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за изменёнными параметрами, а при изменении координат также и слежение за стилевым уровнем масштабирования и направлением.
val projection
Проекция.
Используется для получения точки экрана по точке карты и точки карты по точке экрана. Параметры камеры фиксируются в момент вызова.
var position
Получение текущей позиции камеры.
var zoomRestrictions
Получение актуальных ограничений уровня масштабирования.
val deviceDensity
Получение отношения DPI к базовому DPI устройства.
var size
Получение размера области просмотра.
var padding
Получение текущих отступов от краёв экрана.
var positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var viewPoint
Точка взгляда относительно полного размера вьюпорта.
val visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
val visibleRect
Объемлющий прямоугольник видимой области карты.
var maxTiltRestriction
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
var viewportRestriction
Получение ограничения на область видимости.
val changed
Получение причин изменения состояния камеры.
Измененные свойства доступны в соответствующих каналах.
Bearing
Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений 0°,360°.
Bearing(value: Double = 0.0)
Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений 0°,360°.
value
val value
BearingFollowController
Контроллер слежения за направлением карты.
BearingFollowController(
bearingSource: BearingSource,
animationDuration: Duration = Duration.ofMilliseconds(1000),
valueThreshold: Bearing = Bearing(value = 1.0)
)
Создание контроллера слежения за направлением карты.
bearingSource
источник информации о направлении.
animationDuration
неотрицательная длительность изменения реального направления.
valueThreshold
неотрицательное пороговое значение учитываемого изменения реального направления.
BetterRouteInfo
Информация о доступном альтернативном маршруте.
BetterRoutePromptControl
Диалог, предлагающий перейти на ведение по маршруту с меньшим ожидаемым временем прибытия.
val visibilityChannel
BicycleBriefRouteInfo
Базовая информация о велосипедном маршруте.
BicycleBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о велосипедном маршруте.
BicycleInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
BicycleInstructionCrossroad(landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.NONE, maneuvers: List<BicycleInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
BicycleInstructionCrossroadManeuver
BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
BicycleInstructionFinish
Конец велосипедной части маршрута.
BicycleInstructionFinish()
Конец велосипедной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
BicycleInstructionStart
Начало велосипедной части маршрута.
BicycleInstructionStart()
Начало велосипедной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
BicycleRouteSearchOptions
Параметры поиска маршрута на велосипеде.
BicycleRouteSearchOptions(
avoidCarRoads: Boolean = false,
avoidStairways: Boolean = false,
avoidUnderpassesAndOverpasses: Boolean = false,
avoidUnpavedRoads: Boolean = false,
avoidLockedRoads: Boolean = true,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на велосипеде.
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
avoidUnpavedRoads
avoidLockedRoads
excludedAreas
val avoidCarRoads
Избегать автомобильных дорог.
val avoidStairways
Избегать лестниц.
val avoidUnderpassesAndOverpasses
Избегать подземных и надземных переходов.
val avoidUnpavedRoads
Избегать грунтовых дорог.
val avoidLockedRoads
Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.
val excludedAreas
Исключаемые области (не больше 25).
BicycleRouteSummary
Саммари информация для велосипедного маршрута.
BicycleRouteSummary(
routeType: BicycleSummaryRouteType = BicycleSummaryRouteType.UNKNOWN,
stairways: Int = 0,
gates: Int = 0,
barriers: Int = 0,
calories: Int = 0,
carRoadsLength: Int = 0,
groundRoadsLength: Int = 0,
gravelRoadsLength: Int = 0,
bicycleRoadsLength: Int = 0,
bicycleLanesLength: Int = 0,
badRoadsLength: Int = 0,
roadBlocks: Int = 0
)
Саммари информация для велосипедного маршрута.
routeType
stairways
gates
barriers
calories
carRoadsLength
groundRoadsLength
gravelRoadsLength
bicycleRoadsLength
bicycleLanesLength
badRoadsLength
roadBlocks
val routeType
Тип велосипедного маршрута.
val stairways
Количество лестниц на маршруте.
val gates
Количество калиток на маршруте.
val barriers
Количество шлагбаумов на маршруте.
val calories
Количество калорий, которые будут потрачены на проезд по маршруту.
val carRoadsLength
Суммарная протяжённость автомобильной дороги на маршруте в метрах.
val groundRoadsLength
Суммарная протяжённость грунтовых дорог на маршруте в метрах.
val gravelRoadsLength
Суммарная протяжённость гравийных дорог на маршруте в метрах.
val bicycleRoadsLength
Суммарная протяжённость велодорожек на маршруте в метрах.
val bicycleLanesLength
Суммарная протяжённость велосипедных полос на маршруте в метрах.
val badRoadsLength
Суммарная протяжённость участков плохой дороги на маршруте в метрах.
val roadBlocks
Суммарное количество пешеходных перекрытий на маршруте.
BoolRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): BoolRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<BoolRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
BoolRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
BoolRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Boolean
)
Протяженный элемент маршрута - отрезок и значение на нем.
Borders
Описывает набор непрерывного упорядоченных значений.
Borders(
snapping: Double?,
isLg: Boolean,
value: String,
min: Double,
max: Double,
currentMin: Double? = null,
currentMax: Double? = null
)
Описывает набор непрерывного упорядоченных значений.
snapping
isLg
value
min
max
currentMin
currentMax
val snapping
Задаёт притяжку до значения, кратного этому числу.
val isLg
Признак использования логарифмической шкалы.
val value
Значение, по которым происходит фильтрация.
val min
Нижняя граница набора значений.
val max
Верхняя граница набора значений.
val currentMin
Текущее установленное минимальное значение.
val currentMax
Текущее установленное максимальное значение.
BranchesInfo
Информация о связанных организациях.
BranchesInfo(count: Short = 0)
Информация о связанных организациях.
count
val count
Количество связанных объектов.
BriefExtraRouteInfo
Дополнительная информация о маршруте для конкретного типа транспорта.
BriefExtraRouteInfo(motorcycle: MotorcycleBriefRouteInfo)
motorcycle
BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)
pedestrian
BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)
publicTransport
fun match(
bicycle: Function1,
car: Function1,
motorcycle: Function1,
pedestrian: Function1,
publicTransport: Function1,
scooter: Function1
): T
bicycle
car
motorcycle
pedestrian
publicTransport
scooter
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
BriefPublicTransportCard
Краткая карточка, отображающая информацию о маршруте на общественном транспорте. В отличии от PublicTransportCard не содержит информацию о пересадках.
BriefPublicTransportCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Краткая карточка, отображающая информацию о маршруте на общественном транспорте. В отличии от PublicTransportCard не содержит информацию о пересадках.
context
attrs
defStyle
fun onAttachedToWindow(): Unit
var model
BriefPublicTransportCardModel
Модель для BriefPublicTransportCard.
BriefPublicTransportCardModel(route: TrafficRoute, context: Context)
Модель для BriefPublicTransportCard.
val title
Заголовок. Предполагаемое время проезда, например, "1 ч 42 мин."
val transports
Информация о транспорте.
val description
Описание. Количество пересадок и время пешком, например, 1пересадка,Пешком15мин.
BriefRoadEvent
Дорожное событие.
BriefRouteInfo
Базовая информация о маршруте.
BriefRouteInfo(duration: Duration, extraInfo: BriefExtraRouteInfo)
Базовая информация о маршруте.
BriefRouteInfoSearchPoints
Точки для запроса поиска базовой информации о маршруте.
BriefRouteInfoSearchPoints(startPoint: RouteSearchPoint, finishPoint: RouteSearchPoint)
Точки для запроса поиска базовой информации о маршруте.
BuildingId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
BuildingId(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
BuildingInfo
Информация о здании.
BuildingInfo(
buildingName: String?,
purposeName: String?,
purposeCode: PurposeCode?,
buildingLevels: BuildingLevels?,
floorsInfo: FloorsInfo?,
buildingId: BuildingId
)
Информация о здании.
buildingName
purposeName
purposeCode
buildingLevels
floorsInfo
buildingId
val buildingName
Собственное имя здания.
val purposeName
Описание назначения здания.
val purposeCode
Код назначения здания.
val buildingLevels
Информация об этажных планах здания.
val floorsInfo
Информация о количестве этажей в здании.
Для получения данной информации запросите дополнительную настройку ключа.
val buildingId
Уникальный идентификатор здания.
BuildingLevels
Информация об этажных планах здания.
BuildingLevels(defaultLevelId: LevelId, levels: List<LevelInfo>)
Информация об этажных планах здания.
CalloutMapPosition
Положение бабла маршрута.
CalloutMapPosition(
mapId: MapId,
calloutPosition: GeoPoint?,
routePoint: RoutePoint?
)
Положение бабла маршрута.
Camera
Камера для запуска перемещения карты и настроек слежения.
fun move(moveController: CameraMoveController): Future<CameraAnimatedMoveResult>
Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.
moveController
Контроллер анимированного перемещения камеры.
fun move(
position: CameraPosition,
time: Duration = Duration.ofMilliseconds(300),
animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает слежение за позицией, уровнем масштабирования, наклоном и направлением и прерывает обработку жестов.
position
Конечная позиция камеры.
time
Время, выделенное на перемещение карты.
animationType
Тип анимации при перемещении камеры.
fun move(
point: GeoPoint,
zoom: Zoom,
tilt: Tilt?,
bearing: Bearing,
time: Duration = Duration.ofMilliseconds(300),
animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает слежение за позицией, уровнем масштабирования и направлением и прерывает обработку жестов.
Если tilt задан, то сбрасывается слежение за наклоном.
Если tilt не задан и слежения за наклоном нет, то используется текущее значение наклона.
point
точка конечной позиции камеры
zoom
уровень масштабирования в конечной позиции камеры
tilt
наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller'а или текущее значение
bearing
поворот в конечной позиции камеры
time
время, выделенное на перемещение карты
animationType
тип анимации при перемещении камеры
fun processMovementAndStop(): Unit
Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, уровнем масштабирования и направлением.
fun setBehaviour(behaviour: CameraBehaviour): Unit
Смена режима слежения камеры. Если новый режим более ограниченный, чем текущий, вызов прервёт перелёт и обработку жестов.
fun addFollowController(followController: FollowController): Unit
Добавление контроллера слежения.
Их может быть несколько разных, например контроллер слежения за масштабом, за углом наклона карты, за геолокацией и т.д.
fun removeFollowController(followController: FollowController): Unit
Удаление контроллера слежения.
fun setCustomFollowController(followController: CustomFollowController): Unit
Добавление контроллера слежения, реализованного на платформе.
Можно установить только один такой контроллер. Если установить несколько контроллеров, то будет использоваться только последний установленный.
fun removeCustomFollowController(): Unit
Удаление контроллера слежения, реализованного на платформе.
fun statefulChanges(byReason: CameraChangeReason, valueGetter: Function0<T>): Channel<T>
Фильтрует изменения камеры по byReason причине, фактические значения получает с помощью valueGetter. При подписке получает начальное значение с помощью valueGetter.
CameraBehaviour
Режим слежения камеры.
Режимы камеры деградируются по следующим правилам:
- смещение карты сбрасывает слежение за позицией (включая слежение за направлением и стилевым уровнем масштабирования) события: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent с указанием центра события, DirectMapScalingEvent с указанием центра события, ScaleMapEvent с указанием центра события
- поворот карты относительно точки позиции отбрасывает Bearing события: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent без центра события
- изменение масштаба относительно точки позиции отбрасывает StyleZoom события: MapScalingBeginEvent, DirectMapScalingEvent без центра события, ScaleMapEvent без центра события
- наклон отбрасывает Tilt события: DirectMapTiltEvent
CameraBehaviour(position: FollowPosition?, tilt: FollowTilt = FollowTilt.OFF)
Режим слежения камеры.
Режимы камеры деградируются по следующим правилам:
- смещение карты сбрасывает слежение за позицией (включая слежение за направлением и стилевым уровнем масштабирования) события: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent с указанием центра события, DirectMapScalingEvent с указанием центра события, ScaleMapEvent с указанием центра события
- поворот карты относительно точки позиции отбрасывает Bearing события: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent без центра события
- изменение масштаба относительно точки позиции отбрасывает StyleZoom события: MapScalingBeginEvent, DirectMapScalingEvent без центра события, ScaleMapEvent без центра события
- наклон отбрасывает Tilt события: DirectMapTiltEvent
CameraBehaviourChange
Изменение режима слежения.
CameraBehaviourChange(newBehaviour: CameraBehaviour, changeReason: CameraBehaviourChangeReason = CameraBehaviourChangeReason.APPLICATION)
Изменение режима слежения.
CameraChange
Изменение состояние камеры.
CameraChange(changeReasons: EnumSet<CameraChangeReason>)
Изменение состояние камеры.
changeReasons
val changeReasons
Причины (набор флагов) изменения состояния камеры.
CameraNotifier
Предупреждает о попадании в зону действия дорожной камеры.
CameraPosition
Позиция камеры.
val point
Точка местности, которая находится в точке позиции камеры (см. ICamera::position_point()).
val zoom
Уровень масштабирования. 0 - это весь мир, вписанный в квадрат 256x256 логических пикселей (см. LogicalPixel)
val tilt
Угол наклона направления взгляда по вертикали.
0 - надир (смотрим вертикально вниз), максимальное значение - 60 градусов.
val bearing
Угол поворота направления взгляда по горизонтали относительно направления на север. Отсчитывается по часовой стрелке, в градусах.
CameraPositionChange
Описание изменения части параметров позиции камеры.
CameraPositionPoint
Относительная экранная позиция точки, к которой привязана камера.
Область экрана задаётся padding'ами. x - отступ от левого края области экрана, y - отступ от верхнего края Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол области экрана, 1,1 - правый нижний
CameraPositionPoint(x: Float = 0.5f, y: Float = 0.5f)
Относительная экранная позиция точки, к которой привязана камера.
Область экрана задаётся padding'ами. x - отступ от левого края области экрана, y - отступ от верхнего края Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол области экрана, 1,1 - правый нижний
x
y
CameraProgressInfo
Информация о прогрессе прохождения зоны камеры.
CameraRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<CameraRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): CameraRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): CameraRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
CameraRouteEntry
Элемент маршрута - точка и значение в ней.
CameraRouteEntry(point: RoutePoint, value: RouteCamera)
Элемент маршрута - точка и значение в ней.
CameraTransactionGuard
CameraViewPoint
Относительная экранная позиция точки, в которую направлен взгляд камеры.
Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол вьюпорта, 1,1 - правый нижний
CameraViewPoint(x: Float = 0.5f, y: Float = 0.5f)
Относительная экранная позиция точки, в которую направлен взгляд камеры.
Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол вьюпорта, 1,1 - правый нижний
x
y
CameraZoomRestrictions
Допустимый диапазон изменения уровня масштабирования.
CancelEvent
Событие отмены текущего действия.
Вызывается, например, при отмене жеста, потере фокуса окна или при потере захвата мыши. Также может быть вызван изнутри карты при смене ограничений уровня масштабирования, некоторых изменениях режима слежения и установке интерактивного режима карты.
CancelEvent()
CarBriefRouteInfo
Базовая информация об автомобильном маршруте.
CarBriefRouteInfo(
length: RouteDistance,
landmark: String,
trafficSpeed: CarBriefRouteInfoTrafficSpeed
)
Базовая информация об автомобильном маршруте.
CarInstructionCrossroad
Описание манёвров на перекрёстке.
CarInstructionCrossroad(
direction: CarInstructionCrossroadDirection = CarInstructionCrossroadDirection.STRAIGHT,
turnAngle: Int = 0,
landmark: CarInstructionCrossroadLandmark = CarInstructionCrossroadLandmark.NONE,
exitName: String
)
Описание манёвров на перекрёстке.
direction
turnAngle
landmark
exitName
CarInstructionFinish
Конец автомобильной части маршрута.
CarInstructionFinish()
Конец автомобильной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
CarInstructionRoundabout
Описание манёвров на перекрёстке с круговым движением.
CarInstructionRoundabout(
type: CarInstructionRoundaboutType = CarInstructionRoundaboutType.ENTRY,
turnAngle: Int = 0,
exitNumber: Int = 0,
exitName: String
)
Описание манёвров на перекрёстке с круговым движением.
CarInstructionStart
Начало автомобильной части маршрута.
CarInstructionStart()
Начало автомобильной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
CarInstructionUTurn
Разворот на дороге (не на перекрёстке).
Разворот на перекрестке описывается инструкцией Crossroad.
CarInstructionUTurn(exitName: String)
Разворот на дороге (не на перекрёстке).
Разворот на перекрестке описывается инструкцией Crossroad.
exitName
val exitName
Название съезда.
CarRouteSearchOptions
Параметры поиска маршрута на легковом автомобиле.
CarRouteSearchOptions(
avoidTollRoads: Boolean = false,
avoidUnpavedRoads: Boolean = false,
avoidFerries: Boolean = false,
avoidLockedRoads: Boolean = true,
routeSearchType: RouteSearchType = RouteSearchType.JAM,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на легковом автомобиле.
avoidTollRoads
avoidUnpavedRoads
avoidFerries
avoidLockedRoads
routeSearchType
excludedAreas
val avoidTollRoads
Избегать платных дорог.
val avoidUnpavedRoads
Избегать грунтовых дорог.
val avoidFerries
Избегать паромных переправ.
val avoidLockedRoads
Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.
val routeSearchType
Тип поиска маршрута.
val excludedAreas
Исключаемые области (не больше 25).
CarRouteSummary
Саммари информация для автомобильного маршрута.
CarRouteSummary(
roadBlocks: Int = 0,
accidents: Int = 0,
roadWorks: Int = 0,
tollRoads: Int = 0,
ferryCrossings: Int = 0,
iceCrossings: Int = 0,
trafficLights: Int = 0,
carRoadsLength: Int = 0,
groundRoadsLength: Int = 0,
gravelRoadsLength: Int = 0,
badRoadsLength: Int = 0
)
Саммари информация для автомобильного маршрута.
roadBlocks
accidents
roadWorks
tollRoads
ferryCrossings
iceCrossings
trafficLights
carRoadsLength
groundRoadsLength
gravelRoadsLength
badRoadsLength
val roadBlocks
Суммарное количество перекрытий на маршруте.
val accidents
Суммарное количество аварий на маршруте.
val roadWorks
Суммарное количество дорожных работ на маршруте.
val tollRoads
Суммарное количество платных дорог на маршруте.
val ferryCrossings
Суммарное количество паромных переправ на маршруте.
val iceCrossings
Суммарное количество ледовых переправ на маршруте.
val trafficLights
Суммарное количество светофоров на маршруте.
val carRoadsLength
Суммарная протяжённость автомобильной дороги на маршруте в метрах.
val groundRoadsLength
Суммарная протяжённость грунтовых дорог на маршруте в метрах.
val gravelRoadsLength
Суммарная протяжённость гравийных дорог на маршруте в метрах.
val badRoadsLength
Суммарная протяжённость участков плохой дороги на маршруте в метрах.
CategoriesPage
Страница результатов запроса категорий.
fun fetchPrevPage(): Future<CategoriesPage?>
Получить предыдущую страницу результатов.
future, резолвящаяся в ненулевой указатель на предыдущую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если предыдущая страница отсутствует exceptional future, если произошла ошибка при получении страницы
fun fetchNextPage(): Future<CategoriesPage?>
Получить следующую страницу результатов.
future, резолвящаяся в ненулевой указатель на следующую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если следующая страница отсутствует exceptional future, если произошла ошибка при получении страницы
val items
Категории этой страницы.
Category
Категория справочника.
val id
Идентификатор категории.
val type
Тип категории.
val name
Название категории.
val title
Заголовок для отображения в UI.
при отсутствии может быть пустой строкой.
val caption
Короткая подпись к иконке для отображения в UI.
при отсутствии может быть пустой строкой.
val seoName
SEO-синоним.
при отсутствии может быть пустой строкой.
val keyword
Ключевое слово, по которому была найдена категория.
при отсутствии может быть пустой строкой.
val tag
Уникальное имя, которое можно использовать как часть имени файла-иконки.
при отсутствии может быть пустой строкой.
val iconUrl
Ссылка на изображение.
при отсутствии может быть пустой строкой.
val suggestIcon
Иконка категории для выдачи suggest.
при отсутствии может быть пустой строкой.
val parentId
Идентификатор родительской категории.
при отсутствии может быть пустой строкой.
val branchCount
Количество филиалов организаций в данной категории.
val orgCount
Количество организаций в данной категории.
val geoCount
Количество геообъектов в данной категории.
val isReviewableOnFlamp
Разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.
val children
Дочерние категории.
CategoryGeoContext
Географический контекст, по которому SDK уточнит регион при запросе категорий.
fun match(geoRect: Function1, geoPoint: Function1): T
geoRect
geoPoint
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
CategoryGetByIdsQueryBuilder
Построитель запроса получения категорий по идентификаторам.
CategoryGetByIdsQueryBuilder(ids: List<RubricId>)
Начать построение запроса получения категорий по идентификаторам.
ids
fun setGeoContext(geoContext: CategoryGeoContext?): CategoryGetByIdsQueryBuilder
Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.
fun setLocale(locale: Locale?): CategoryGetByIdsQueryBuilder
Задать локаль для запроса категорий.
CategoryListQueryBuilder
Построитель запроса списка категорий.
CategoryListQueryBuilder()
Начать построение запроса списка категорий.
fun setParentId(parentId: RubricId?): CategoryListQueryBuilder
Задать родителя для запроса списка категорий.
fun setSortType(sortType: CategorySortType): CategoryListQueryBuilder
Задать сортировку для запроса списка категорий.
fun setGeoContext(geoContext: CategoryGeoContext?): CategoryListQueryBuilder
Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.
fun setPageSize(pageSize: Int): CategoryListQueryBuilder
Задать размер страницы.
fun setLocale(locale: Locale?): CategoryListQueryBuilder
Задать локаль для запроса категорий.
CategoryQuery
Запрос категорий.
CategorySearchQueryBuilder
Построитель запроса поиска категорий по тексту.
CategorySearchQueryBuilder(queryText: String)
Начать построение запроса поиска категорий по тексту.
queryText
fun setGeoContext(geoContext: CategoryGeoContext?): CategorySearchQueryBuilder
Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.
fun setPageSize(pageSize: Int): CategorySearchQueryBuilder
Задать размер страницы.
fun setLocale(locale: Locale?): CategorySearchQueryBuilder
Задать локаль для запроса категорий.
Certificate
SSL-сертификат.
fun match(
system: Function1,
fromFile: Function1,
fromAsset: Function1
): T
system
fromFile
fromAsset
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
CertificateFromAsset
SSL-сертификат из asset-а.
CertificateFromAsset(path: String)
SSL-сертификат из asset-а.
path
val path
Путь относительно корневой директории asset-ов.
CertificateFromFile
SSL-сертификат из файла.
CertificateFromFile(path: String)
SSL-сертификат из файла.
path
val path
Путь к файлу.
ChargingStation
Атрибуты для электрозаправок.
ChargingStation(aggregate: Aggregate, connectors: List<Connector>)
Атрибуты для электрозаправок.
CheckableGroupedItem
Единичный элемент из GroupCheckableItem.
CheckableItem
Базовое представление отмечаемого элемента из CheckableItemsGroup.
CheckableItemsGroup
Виджет для представления группы отмечаемых элементов.
val items
Получение группы элементов виджета.
Checkbox
Виджет-чекбокс.
val filterType
Получение типа фильтра, который представляет виджет.
val checkedText
Получение текста подписи для "отмеченного" чекбокса.
val uncheckedText
Получение текста подписи для "неотмеченного" чекбокса.
val values
Получение списка значений, по которым происходит фильтрация. Обычно одно значение.
var isChecked
Получение состояния виджета.
Circle
Окружность.
CircleOptions
Параметры для создания геометрического объекта карты типа "Окружность".
CircleOptions(
position: GeoPoint,
radius: Meter,
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value = 0.0f),
strokeColor: Color = Color(),
dashedStrokeOptions: DashedStrokeCircleOptions? = null,
visible: Boolean = true,
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
levelId: LevelId? = null
)
Параметры для создания геометрического объекта карты типа "Окружность".
position
radius
color
strokeWidth
strokeColor
dashedStrokeOptions
visible
userData
zIndex
levelId
val position
Географическая позиция.
val radius
Радиус в метрах.
val color
Цвет заливки.
val strokeWidth
Ширина линии границы окружности.
val strokeColor
Цвет линии границы окружности.
val dashedStrokeOptions
Параметры пунктирной границы.
val visible
Флаг видимости.
val userData
Пользовательские данные (не используются внутри SDK, нужны только для пользователя API).
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
val zIndex
Уровень отрисовки объекта.
val levelId
Привязка к поэтажному плану здания.
Closed
Закрыто.
Closed(timeUntilOpen: Duration?, reason: ClosedReason)
Закрыто.
ClosingHours
Интервал, когда заведение закрыто.
ClosingHours(interval: WeekTimeInterval, reason: ClosedReason)
Интервал, когда заведение закрыто.
ClosingSoon
Скоро закроется.
ClosingSoon(timeUntilClose: Duration, reason: ClosedReason)
Скоро закроется.
ClusterObject
Кластер объектов.
ClusterOptions
Параметры маркера кластера.
ClusterOptions(attributes: Map, userData: Any? = null)
Параметры маркера кластера.
attributes
userData
val attributes
Атрибуты кластера.
val userData
Пользовательские данные. Возвращаются в IClusterObject.
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
Color
Цвет
Color(argb: Int = 4278190080.toInt())
Цвет
argb
CommonGestureSettings
var recognizeSettings
Общие настройки распознавания жестов.
CommonRecognizeSettings
Общие настройки распознавания жестов.
CommonRecognizeSettings(interGestureTimeout: Duration = Duration.ofMilliseconds(50))
Общие настройки распознавания жестов.
interGestureTimeout
CompassControl
CompassControl
UI-элемент управления компасом.
CompassControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0,
layout: Int = R.layout.dgis_compass_control
)
UI-элемент управления компасом.
context
attrs
defStyle
layout
CompassControlModel
Модель контрола компаса. Контрол состоит из кнопки компаса, при нажатии на которую камера карты меняет угол в направлении севера. Если камера карты смотрит на сервер, то контрол необходимо скрывать. Потокобезопасно.
fun onClicked(): Unit
ComplexGeometry
Составная геометрия, состоит из набора простых или составных геометрий.
Поддерживается произвольный уровень вложенности составных геометрий в наборе.
ComplexGeometry(geometries: List<Geometry>)
geometries
val elements
Connector
Connector(
power: Short,
price: Short,
status: StatusType,
type: String
)
ContactInfo
Способ связаться с организацией.
ContactInfo(
type: String,
displayText: String,
value: String,
comment: String?
)
Способ связаться с организацией.
type
displayText
value
comment
val type
Тип контакта. Один из следующих:
- email — электронная почта
- website — сайт
- phone — телефон
- fax — факс
- pobox — абонентский ящик
- icq
- jabber
- skype
- vkontakte
- odnoklassniki
- youtube
- googleplus
- viber
- telegram
val displayText
Значение контакта для вывода на экран.
val value
Техническое значение контакта. В зависимости от типа контакта имеет следующую семантику:
- email — адрес почты
- website — полный url
- phone — номер телефона в международном формате, например: "+73831234567"
- fax — номер телефона в международном формате, например: "+73831234567"
- pobox — адрес почтового ящика
- icq — идентификатор пользователя
- jabber — идентификатор пользователя
- skype — идентификатор пользователя
- vkontakte — полный url
- twitter — полный url
- odnoklassniki — полный url
- youtube — полный url
- linkedin — полный url
- googleplus — полный url
- pinterest — полный url
- whatsapp — полный url
- viber — полный url
- telegram — полный url
val comment
Уточняющая информация о контакте.
Context
Контекст - окружение, необходимое для работы SDK.
CoordinatesFollowController
Контроллер слежения за координатами позиции карты.
CoordinatesFollowController(animationDuration: Duration = Duration.ofMilliseconds(1000), valueThreshold: Meter = Meter(value = 0.1f))
Создание контроллера слежения за координатами позиции карты.
CopyrightMargins
Margins between the screen and a copyright icon, specifying the distance from each edge of the screen.
CopyrightMargins(
left: Int = 0,
top: Int = 0,
right: Int = 0,
bottom: Int = 0
)
Margins between the screen and a copyright icon, specifying the distance from each edge of the screen.
left
top
right
bottom
CopyrightPosition
Position of the copyright icon on the screen.
CopyrightPosition(gravity: Int, margins: CopyrightMargins)
Position of the copyright icon on the screen.
gravity
The gravity value (e.g., Gravity.START, Gravity.BOTTOM) that determines the alignment of the copyright icon within the screen.
margins
The margins between the screen and a copyright icon.
CrossingTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): CrossingTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<CrossingTypeRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
CrossingTypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
CrossingTypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: CrossingType
)
Протяженный элемент маршрута - отрезок и значение на нем.
CustomDashboardButton
Класс содержит поля необходимые для замены стандартной кнопки добавления дорожных событий в дашборде навигатора.
CustomizableDashboardButton
DashboardButtonAbsent
Используется в DefaultNavigationControls.setCustomDashboardButton для обозначения того, что кнопку действия необходимо скрыть.
DashboardControl
DashedPolygonOptions
Параметры пунктирного контура полигона.
DashedPolygonOptions(dashLength: LogicalPixel = LogicalPixel(value = 5.0f), dashSpaceLength: LogicalPixel = LogicalPixel(value = 2.0f))
Параметры пунктирного контура полигона.
DashedPolylineOptions
Параметры пунктирной полилинии.
DashedPolylineOptions(dashLength: LogicalPixel = LogicalPixel(value = 5.0f), dashSpaceLength: LogicalPixel = LogicalPixel(value = 2.0f))
Параметры пунктирной полилинии.
DashedStrokeCircleOptions
DashedStrokeCircleOptions(dashLength: LogicalPixel = LogicalPixel(value = 5.0f), dashSpaceLength: LogicalPixel = LogicalPixel(value = 2.0f))
DataPrefetcher
Контроллер предварительной загрузки данных карты вдоль маршрута. Данные карты загружаются для источников, которые поддерживают предварительное кэширование. Данные загружаются для отрезков маршрута, определяемых длиной segment_size на расстояние до max_prefetch_distance вперёд. По мере проезда отрезков маршрута соответствующие им предварительно загруженные данные перестают удерживаться в кэше, вместо них загружаются данные дальше по маршруту.
var enabled
Включение/выключение предварительной загрузки тайлов карты вдоль маршрута. По умолчанию предварительная загрузка включена.
Вызывать этот метод можно только когда навигатор находится в состоянии Disabled, в противном случае поведение программы не определено.
var minZoom
Минимальный уровень зума, для которого предварительно загружаются тайлы карты. По умолчанию 8.
var maxZoom
Максимальный уровень зума, для которого предварительно загружаются тайлы карты. По умолчанию 16.
var radius
Радиус охвата для предварительной загрузки тайлов карты. По умолчанию 128.
var segmentSize
Размер минимального участка геометрии маршрута, для которого выполняется предварительная загрузка тайлов карты. По умолчанию 2 км.
var maxPrefetchDistance
Расстояние впереди текущей позиции на маршруте, для которого нужно выполнить предварительную загрузку тайлов карты. По умолчанию 4 км.
DayTime
Момент времени внутри дня.
DayTime(hours: Byte, minutes: Byte)
Момент времени внутри дня.
hours
minutes
DefaultHttpClient
Стандартная реализация HTTP-клиента (транспортной части) для запросов к сервису Radar. Не логирует тела и заголовки запросов и ответов сервера на всех уровнях логирования из-за соображений приватности. При необходимости логирования запросов – подготовьте свою реализацию и передайте при инициализации DefaultLocationSource как параметр для настроек RadarSettings.
DefaultHttpClient()
Стандартная реализация HTTP-клиента (транспортной части) для запросов к сервису Radar. Не логирует тела и заголовки запросов и ответов сервера на всех уровнях логирования из-за соображений приватности. При необходимости логирования запросов – подготовьте свою реализацию и передайте при инициализации DefaultLocationSource как параметр для настроек RadarSettings.
fun post(
url: String,
body: String,
headers: Map
): RadarHttpResponse
Выполняет POST-запрос к указанному URL
url
URL для запроса
body
Тело запроса в формате JSON
headers
Ответ от сервера в виде RadarHttpResponse
DefaultInstallFallback
Фабрика, производящая предустановленные стратегии поведения при ошибке установки или обновления пакета.
see IInstallFallback
@JvmStatic
fun noOperation(): InstallFallback
Создание fallback, который не выполняет никаких операций (no-op).
@JvmStatic
fun retryOnError(retryCount: Long): InstallFallback
Создание fallback, вызывающего повторный install при возникновении ошибки загрузки пакета.
retryCount
количество повторных вызовов install, по достижении которого перестает выполнять операции.
DefaultLocationSource
Реализация источника геопозиции, которую рекомендуется использовать по умолчанию. При наличии GMS использует их, иначе - LocationManager.
DefaultLocationSource(context: Context, radarApiSettings: RadarApiSettings = RadarApiSettings.OFF)
Реализация источника геопозиции, которую рекомендуется использовать по умолчанию. При наличии GMS использует их, иначе - LocationManager.
@Synchronized
fun activate(listener: LocationChangeListener): Unit
@Synchronized
fun deactivate(): Unit
@Synchronized
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit
fun onPermissionGranted(): Unit
Метод необходимо вызвать после получения разрешений на использование геопозиции.
@Synchronized
fun onLocationServicesChanged(): Unit
Метод обрабатывает изменения доступности источников
val lastLocation
Наилучшая известная на текущий момент геопозиция. Если известная на текущий момент геопозиция отсутствует, возвращается null. Возвращаемая геопозиция может быть недостоверной, например являться устаревшей и/или не соответствовать требуемой точности
var isGMSAllowed
Использовать ли GMS.
DefaultNavigationControls
UI контролы навигатора, предлагаемые к использованию по умолчанию: полосность, ограничение скорости, обозначение следующего манёвра и т.д. Пользователи SDK также могут создать свои собственные UI контролы и использовать UI модель навигатора для получения оповещений о событиях при ведении по маршруту.
DefaultRasterUrlTemplate
DefaultRasterUrlTemplate(urlTemplate: String)
urlTemplate
val urlTemplate
DefaultRoadEventFilter
Фабрика для создания стандартных временных фильтров дорожных событий.
see IDefaultRoadEventFilter.
@JvmStatic
fun create(
context: Context,
displayCategories: EnumSet?<RoadEventDisplayCategory>,
startTimeCutoff: Duration?
): RoadEventFilter
Создает фильтр отображаемых дорожных событий на карте.
context
Контекст.
displayCategories
Категории событий, которые нужно отображать на карте. Если не задано — фильтрация по категориям не применяется.
startTimeCutoff
Максимально допустимое время начала события относительно текущего момента. События с start_time позже этого порога будут скрыты. Например, +1d — скрыть события, которые начнутся позже чем через сутки. События без start_time не фильтруются. Если не задано — фильтрация по времени начала не применяется.
DefaultSpeechRecognizer
Стандартная реализация SpeechRecognizer, использующая системный механизм распознавания речи Android через RecognizerIntent.
DefaultSpeechRecognizer(activity: <ERROR CLASS>, prompt: String? = "Speak Now")
Стандартная реализация SpeechRecognizer, использующая системный механизм распознавания речи Android через RecognizerIntent.
activity
prompt
fun recognize(onResult: Function1, onError: Function1): Unit
Реализация метода SpeechRecognizer.recognize. Запускает системный интерфейс распознавания речи и обрабатывает результаты.
onResult
Функция обратного вызова для получения распознанного текста.
onError
Функция обратного вызова для обработки возможных ошибок.
DeviceDensity
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
DeviceDensity(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
DevicePpi
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
DevicePpi(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
DGis
Точка входа в 2GIS SDK. На старте работы необходимо вызвать initialize.
@JvmStatic
fun initialize(
appContext: Context,
httpOptions: HttpOptions = HttpOptions(),
logOptions: LogOptions = LogOptions(LogLevel.WARNING),
vendorConfig: VendorConfig = VendorConfig(),
keySource: KeySource = KeySource(KeyFromAsset("dgissdk.key")),
dataCollectConsent: PersonalDataCollectionConsent = PersonalDataCollectionConsent.GRANTED,
platformHttpClient: HttpClient? = null,
platformAudioDriver: AudioDriver? = null,
mapOptions: GlobalMapOptions = GlobalMapOptions(),
storageOptions: StorageOptions = StorageOptions()
): Context
Необходимо вызвать этот метод до начала работы с SDK.
appContext
контекст android приложения.
httpOptions
настройки сетевого клиента.
logOptions
параметры логирования. Игнорируются при повторном вызове после deinitialize().
vendorConfig
переопределение конфигурации SDK.
keySource
источник ключа.
dataCollectConsent
согласие на сбор данных и обработку данных
platformHttpClient
сетевой клиент, который будет использоваться вместо стандартного.
platformAudioDriver
платформенный аудиодрайвер.
mapOptions
настройки, применяемые ко всем картам.
storageOptions
настройки, применяемые к файловому хранилищу.
sdkContext необходимый для работы сервисов SDK.
@JvmStatic
fun deinitialize(): Unit
Деинициализация SDK. Освобождает ресурсы контекста.
Перед вызовом убедитесь, что все объекты SDK (карты, маркеры, источники данных и т.д.) освобождены. Если деинициализация завершилась с ошибкой, контекст останется активным.
После успешного вызова ранее созданный контекст становится невалидным. Для создания нового контекста необходимо вызвать initialize.
@JvmStatic
fun context(): Context
DgisMapObject
Объект карты 2GIS.
информацию об объекте можно получить через справочник (directory)
val id
Стабильный числовой идентификатор объекта.
DgisObjectId
DgisObjectId(objectId: Long = 0, entranceId: Long = 0)
objectId
entranceId
DgisSource
Основной интерфейс источников данных 2ГИС.
fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit
Установка или снятие выделения объектов.
добавляет объекту атрибут "selected", который можно использовать в стилях.
directoryObjectIds
Идентификаторы изменяемых объектов.
highlighted
Установка или снятие выделения.
@JvmStatic
fun createDgisSource(context: Context, workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.HYBRID_ONLINE_FIRST): Source
Создание источника, получающего данные с серверов 2ГИС или использующего в работе предварительно загруженные данные.
DirectMapControlBeginEvent
Событие начала прямого управления картой. Сообщает карте, что необходимо обрабатывать события прямого управления картой. События прямого управления работают только от DirectMapControlBeginEvent до DirectMapControlEndEvent. После завершения последовательности событий прямого управления может запуститься кинематика. Кинематика использует время возникновения события, поэтому лучше использовать время, полученное от системы, а не заполнять значение при обработке. Пока кинематика работает только для перемещения карты, но не для вращения и масштабирования.
DirectMapControlBeginEvent()
DirectMapControlEndEvent
Событие окончания прямого управления картой. Завершает прямое управление картой, начатое после получения события DirectMapControlBeginEvent. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapRotationEvent
Событие прямого вращения карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapRotationEvent(
bearingDelta: Bearing,
timestamp: Duration,
rotationCenter: ScreenPoint? = null
)
bearingDelta
изменение угла поворота карты, в градусах. Положительные значения соответствуют направлению вращения против часовой стрелки
timestamp
Время генерации системного события.
rotationCenter
Точка на экране, вокруг которой вращается карта. Если точка не задана, то вращение происходит относительно точки позиции карты.
DirectMapScalingEvent
Событие прямого масштабирования карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
DirectMapScalingEvent(
zoomDelta: Float,
timestamp: Duration,
scalingCenter: ScreenPoint? = null
)
zoomDelta
Величина, на которую изменится текущее значение масштаба.
timestamp
Время генерации системного события.
scalingCenter
Точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.
DirectMapShiftEvent
Событие прямого сдвига карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
DirectMapShiftEvent(
screenShift: ScreenShift,
shiftedPoint: ScreenPoint,
timestamp: Duration
)
screenShift
Изменение экранной позиции карты относительно предыдущей, в пикселях.
shiftedPoint
Центральная точка, от которой производится смещение карты.
timestamp
Время генерации системного события.
DirectMapTiltEvent
Событие прямого наклона камеры. События прямого управления картой описаны в DirectMapControlBeginEvent.
DirectMapTiltEvent(delta: Float, timestamp: Duration)
val delta
Изменение угла наклона в градусах.
DirectoryFilter
Фильтры для справочника.
DirectoryFilter(workTime: WorkTimeFilter?, dynamic: List<DynamicFilter>)
Фильтры для справочника.
DirectoryObject
Объект справочника.
fun formattedAddress(type: FormattingType): FormattedAddress?
Cтроковое представление адреса, отформатированное в соответствии с указанным требованием к длине.
fun publicTransportScheduleInfo(departureTimeUtc: Long): Future<PublicTransportDirectoryScheduleInfo?>
Информация о расписаниях платформ и направлений.
departureTimeUtc
Время в системе UNIX по UTC, на которое необходимо получить расписание.
val types
Тип объекта. Может быть несколько, например, ТЦ Сан Сити - филиал организации и здание одновременно. Первый тип в этом списке - основной.
val title
Заголовок объекта.
val titleAddition
Дополнительная информация заголовка Пример: "(кв. 1-12)"
Для получения данной информации запросите дополнительную настройку ключа.
val subtitle
Подзаголовок объекта.
при отсутствии может быть пустой строкой
val description
Описание объекта.
val id
Стабильный числовой идентификатор объекта.
val markerPosition
Точка объекта, где следует разместить маркер.
val address
Адрес объекта в виде набора компонент.
val attributes
Дополнительные атрибуты объекта.
val contextAttributes
Контекстные дополнительные атрибуты объекта.
val timeZoneOffset
Сдвиг локального времени объекта относительно UTC в секундах в текущий момент.
val openingHours
Время работы объекта.
val contactInfos
Контакты объекта.
val reviews
Отзывы.
val parkingInfo
Дополнительная информация о парковке.
val workStatus
Статус работы.
val levelId
Идентификатор этажа, на котором расположен объект.
Для получения данной информации запросите дополнительную настройку ключа.
val entrances
Информация о входах.
Для получения данной информации запросите дополнительную настройку ключа.
val tradeLicense
Данные о лицензии организации.
Для получения данной информации запросите дополнительную настройку ключа.
val buildingInfo
Информация о здании.
val branchesInfo
Информация о связанных организациях.
val chargingStation
Атрибуты для электрозаправки.
val rubricIds
Идентификаторы рубрик.
val orgInfo
Информация об организации.
val group
Связанные в объединённую карточку объекты.
Для получения данной информации запросите дополнительную настройку ключа.
val routeInfos
Справочная информация о маршрутах общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.
Для маршрута (тип ObjectType.Route) содержит информацию только об одном маршруте. Для остановочной платформы (тип ObjectType.StationPlatform), станции метро (тип ObjectType.StationMetro) и входа на станцию (тип ObjectType.StationEntrance) содержит информацию обо всех маршрутах, которые проходят через объект.
val platformIds
Справочная информация о идентификаторах платформ общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.
Для входа на станцию (тип ObjectType.StationEntrance) и станции метро (тип ObjectType.StationMetro) содержит информацию обо всех идентификаторах платформ.
val nearestParkingIds
Ближайшие парковки.
val nearestStations
Ближайшие остановки.
val nearestPlatforms
Ближайшие остановочные платформы.
DoubleRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<DoubleRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): DoubleRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): DoubleRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
DoubleRouteEntry
Элемент маршрута - точка и значение в ней.
DoubleRouteEntry(point: RoutePoint, value: Double)
Элемент маршрута - точка и значение в ней.
DoubleRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): DoubleRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<DoubleRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
DoubleRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
DoubleRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Double
)
Протяженный элемент маршрута - отрезок и значение на нем.
DragBeginData
Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.
DragBeginData(point: ScreenPoint, item: RenderedObject)
Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.
Duration
Класс, представляющий период времени.
operator fun unaryMinus(): Duration
fun toString(): String
fun toFormattedMeasure(context: Context): FormattedMeasure
Преобразование Duration в FormattedMeasure для показа в UI-элементах навигатора.
fun toArrivalTimeString(): String
Преобразование Duration в строку для показа в UI-элементах навигатора.
DynamicFilter
Динамические фильтры поисковой выдачи.
fun match(
flagFilter: Function1,
rangeFilter: Function1,
sortingFilter: Function1
): T
flagFilter
rangeFilter
sortingFilter
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
DynamicRouteInfo
DynamicRouteInfoSettings
Настройки получения динамических данных о маршруте.
Elevation
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
Elevation(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
EmptyFollowController
Базовый класс для пользовательских контроллеров. Можно использовать как основу для реализации контроллера на платформе.
EmptyFollowController()
Базовый класс для пользовательских контроллеров. Можно использовать как основу для реализации контроллера на платформе.
fun availableValues(): EnumSet<FollowValue>
Набор видов значений, которыми умеет управлять данный контроллер.
fun requestValues(values: EnumSet<FollowValue>): Unit
С помощью этого метода в контроллер сообщается, какие из предоставляемых им значений используются. Это позволяет освободить ресурсы, связанные с вычислением неиспользуемых значений. Метод может вызываться многократно с разными значениями, в этом случае актуальным является последнее из них.
values
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit
Установка нотифаера, который оповещает о новых значениях. Нотифаер нужно сохранить в реализуемом контроллере
fun coordinates(): GeoPoint?
Географические координаты. Метод вызывается только после вызова request_values с соответствующими параметрами.
fun bearing(): Bearing?
Направление. Метод вызывается только после вызова request_values с соответствующими параметрами.
fun tilt(): Tilt?
Наклон карты. Метод вызывается только после вызова request_values с соответствующими параметрами.
fun styleZoom(): StyleZoom?
Стилевой уровень масштабирования карты. Метод вызывается только после вызова request_values с соответствующими параметрами.
EntranceGeometry
Геометрии для отображения входа на карте.
EntranceGeometry(entrancePoints: List<GeoPoint>, entrancePolylines: List<List<GeoPoint>>)
Геометрии для отображения входа на карте.
entrancePoints
entrancePolylines
EntranceInfo
Информация о входе в здание.
EntranceInfo(
id: DgisObjectId,
buildingNumber: String?,
porchName: String?,
porchNumber: String?,
apartmentRanges: List<ApartmentRange>,
geometry: EntranceGeometry?,
entranceNumber: String?
)
Информация о входе в здание.
id
buildingNumber
porchName
porchNumber
apartmentRanges
geometry
entranceNumber
val id
Идентификатор объекта входа.
val buildingNumber
Номер дома, к которому относится вход.
val porchName
Непустое имя подъезда. Заполняется только для подъездов. Может принимать значения имени подъезда (например "Подъезд 1") или номера здания, если подъезд имеет собственный адрес.
val porchNumber
Непустой номер подъезда. Заполняется только для подъездов. Может принимать значения номера подъезда (например "1") или номера здания, если подъезд имеет собственный адрес.
val apartmentRanges
Номера квартир, относящихся к подъезду.
val geometry
Геометрии для отображения входа на карте.
val entranceNumber
Номер входа на станцию. Будет содержать информацию для объекта с типом ObjectType.StationEntrance.
Event
Базовый класс для всех обрабатываемых событий.
ExceedSpeedLimitSettings
Настройки обнаружения превышения максимальной разрешённой скорости.
ExcludedArea
Исключаемая область, которую следует избегать при построении маршрута.
ExcludedArea(
type: ExcludedAreaType = ExcludedAreaType.POINT,
severity: ExcludedAreaSeverity = ExcludedAreaSeverity.SOFT,
extent: RouteDistance,
points: List<GeoPoint>
)
Исключаемая область, которую следует избегать при построении маршрута.
ExtraInstructionInfo
ExtraInstructionInfo(bicycleStart: BicycleInstructionStart)
bicycleStart
ExtraInstructionInfo(bicycleFinish: BicycleInstructionFinish)
bicycleFinish
ExtraInstructionInfo(bicycleCrossroad: BicycleInstructionCrossroad)
bicycleCrossroad
ExtraInstructionInfo(carCrossroad: CarInstructionCrossroad)
carCrossroad
ExtraInstructionInfo(carRoundabout: CarInstructionRoundabout)
carRoundabout
ExtraInstructionInfo(pedestrianStart: PedestrianInstructionStart)
pedestrianStart
ExtraInstructionInfo(pedestrianFinish: PedestrianInstructionFinish)
pedestrianFinish
ExtraInstructionInfo(pedestrianCrossroad: PedestrianInstructionCrossroad)
pedestrianCrossroad
ExtraInstructionInfo(pedestrianIndoorFloorChange: PedestrianInstructionIndoorFloorChange)
pedestrianIndoorFloorChange
ExtraInstructionInfo(pedestrianIndoorEnter: PedestrianInstructionIndoorEnter)
pedestrianIndoorEnter
ExtraInstructionInfo(pedestrianIndoorExit: PedestrianInstructionIndoorExit)
pedestrianIndoorExit
ExtraInstructionInfo(scooterStart: ScooterInstructionStart)
scooterStart
ExtraInstructionInfo(scooterFinish: ScooterInstructionFinish)
scooterFinish
ExtraInstructionInfo(scooterCrossroad: ScooterInstructionCrossroad)
scooterCrossroad
fun match(
bicycleStart: Function1,
bicycleFinish: Function1,
bicycleCrossroad: Function1,
carStart: Function1,
carFinish: Function1,
carCrossroad: Function1,
carRoundabout: Function1,
carUturn: Function1,
pedestrianStart: Function1,
pedestrianFinish: Function1,
pedestrianCrossroad: Function1,
pedestrianIndoorFloorChange: Function1,
pedestrianIndoorEnter: Function1,
pedestrianIndoorExit: Function1,
scooterStart: Function1,
scooterFinish: Function1,
scooterCrossroad: Function1
): T
bicycleStart
bicycleFinish
bicycleCrossroad
carStart
carFinish
carCrossroad
carRoundabout
carUturn
pedestrianStart
pedestrianFinish
pedestrianCrossroad
pedestrianIndoorFloorChange
pedestrianIndoorEnter
pedestrianIndoorExit
scooterStart
scooterFinish
scooterCrossroad
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
val isBicycleStart
val asBicycleStart
val isBicycleFinish
val asBicycleFinish
val isBicycleCrossroad
val asBicycleCrossroad
val isCarStart
val asCarStart
val isCarFinish
val asCarFinish
val isCarCrossroad
val asCarCrossroad
val isCarRoundabout
val asCarRoundabout
val isCarUturn
val asCarUturn
val isPedestrianStart
val asPedestrianStart
val isPedestrianFinish
val asPedestrianFinish
val isPedestrianCrossroad
val asPedestrianCrossroad
val isPedestrianIndoorFloorChange
val asPedestrianIndoorFloorChange
val isPedestrianIndoorEnter
val asPedestrianIndoorEnter
val isPedestrianIndoorExit
val asPedestrianIndoorExit
val isScooterStart
val asScooterStart
val isScooterFinish
val asScooterFinish
val isScooterCrossroad
val asScooterCrossroad
val value
File
Идентификатор файла.
Может являться не только файлом на файловой системе, но и произвольным источником данных.
File(path: String)
Файл в файловой системе.
path
Путь к файлу.
@JvmStatic
fun fromString(contents: String): File
Файл с содержимым из заданной строки.
FinishDetector
FinishRouteControl
FlagFilter
Фильтр - флаг.
FlagFilter(
tagName: String,
displayName: String,
flagValue: Boolean?
)
Фильтр - флаг.
tagName
displayName
flagValue
FloatRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): FloatRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<FloatRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
FloatRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
FloatRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Float
)
Протяженный элемент маршрута - отрезок и значение на нем.
FloorInfo
Информация об этажном плане для маркера - элемента поисковой выдачи.
FloorInfo(levelId: LevelId, buildingId: BuildingId)
Информация об этажном плане для маркера - элемента поисковой выдачи.
FloorsInfo
Информация об этажности объекта.
Для получения данной информации запросите дополнительную настройку ключа.
FloorsInfo(
groundCount: Short = 0,
groundMinCount: Short?,
undergroundCount: Short?
)
Информация об этажности объекта.
Для получения данной информации запросите дополнительную настройку ключа.
groundCount
groundMinCount
undergroundCount
FollowControl
UI-элемент управления слежением за маркером местоположения.
FollowController
Класс, позволяющий управлять положением камеры. Реализации всех его методов должны быть потокобезопасны. У большинства методов есть тривиальные реализации по умолчанию (таким образом FollowController, отвечающий за масштаб, не обязан переопределять методы coordinates() и т.п.). Один контроллер может быть единомоментно добавлен только в одну карту.
FollowPosition
Настройки слежения за позицией.
FollowPosition(bearing: FollowBearing = FollowBearing.OFF, styleZoom: FollowStyleZoom = FollowStyleZoom.OFF)
Настройки слежения за позицией.
FormattedAddress
Человекочитаемое представление адреса.
FormattedAddress(
drilldownAddress: String?,
streetAddress: String?,
addressComment: String?,
postCode: String?
)
Человекочитаемое представление адреса.
drilldownAddress
streetAddress
addressComment
postCode
val drilldownAddress
Адрес из дриллдауна. Пример: "Новосибирск, Кировский район".
val streetAddress
Адрес внутри населённого пункта. Пример: "Николаева, 11".
val addressComment
Комментарий к адресу. Пример: "301 офис; 9 этаж".
val postCode
Почтовый индекс объекта с кодом здания, если есть. Пример: "630088", "630007/XBVJF8".
FormattedMeasure
Значение с единицами измерения, например ("1.5", "км")
FormattedMeasure(value: String, unit: String)
Значение с единицами измерения, например ("1.5", "км")
value
unit
Fps
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
Fps(value: Int = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
FreeRoamSelector
Контроллер перевода навигатора в режим FreeRoam при слишком долгом перестроении маршрута.
var enabled
FreeRoamSettings
var onRoutePrefetchLength
Тайлы дорожного графа загружаются в http-кэш во время ведения по маршруту, если они соответствуют участку маршрута от текущей позиции до указанного расстояния. Значение по умолчанию - 5 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
var onRoutePrefetchRadiusMeters
При кэшировании тайлов дорожного графа во время ведения по маршруту тайлы загружаются в http-кэш, если оказываются ближе заданного расстояния в метрах от линии маршрута. Значение по умолчанию - 1 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
var prefetchRadiusMeters
Тайлы дорожного графа загружаются в http-кэш если оказываются ближе заданного расстояния в метрах от текущей позиции. Значение по умолчанию - 2 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
Geometry
Объект геометрии.
fun intersects(geometry: Geometry): Boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
geometry
объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется
GeometryMapObject
Геометрический объект карты.
методы потокобезопасны
объект будет отображаться на карте при выполнении следующих условий:
- объект видимый;
- объект добавлен в источник данных;
- источник данных, содержащий объект, добавлен в карту;
- в стилях, установленных в карту, есть параметры отображения, применимые к этому объекту. Подробнее про отображение на карте - см. ISource.
val geometryChannel
Геометрия объекта.
var geometry
Геометрия объекта.
val objectAttributes
Получение свойств объекта карты для чтения и изменения.
val isVisibleChannel
Текущий флаг видимости объекта.
var isVisible
Текущий флаг видимости объекта.
val isDraggableChannel
Текущий флаг перемещаемости объекта.
var isDraggable
Текущий флаг перемещаемости объекта.
val animationSettings
Получение настроек анимации. Применяется для объектов с типом "3D model" или "Directional model".
val bounds
Прямоугольник минимального размера, содержащий геометрию.
GeometryMapObjectBuilder
Класс для установки свойств и последующего создания геометрических объектов.
GeometryMapObjectBuilder()
fun setObjectAttribute(name: String, value: AttributeValue): GeometryMapObjectBuilder
Установка свойства объекта карты.
name
Имя свойства объекта карты.
value
Значение свойства объекта карты.
fun setObjectAttributes(values: Map): GeometryMapObjectBuilder
Установка свойств объекта карты.
values
набор пар "имя":"значение" для добавляемых свойства объекта карты
метод не заменяет весь набор свойств объекта, т.е. если свойство в values отсутствует, но уже добавлено в объект ранее, оно не будет изменено.
fun setGeometry(geometry: Geometry): GeometryMapObjectBuilder
Установка геометрии объекта карты.
fun setVisible(visible: Boolean): GeometryMapObjectBuilder
Установка видимости объекта карты.
fun setDraggable(draggable: Boolean): GeometryMapObjectBuilder
Установка возможности перетаскивания объекта карты.
fun setUserData(userData: Any?): GeometryMapObjectBuilder
Установка пользовательских данных.
пользовательские данные никак не используются в SDK и нужны только чтобы возвращать их пользователю.
fun createObject(): GeometryMapObject
Конструирование объекта карты.
у объекта обязательно должна быть установлена геометрия
после вызова этой функции GeometryMapObjectBuilder непригоден для задания параметров объекта карты или для его создания
fun setObjectAttribute(name: String, value: Boolean): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Long): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Int): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Double): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Float): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: String): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: ByteArray): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Color): GeometryMapObjectBuilder
GeometryMapObjectSource
Источник геометрических объектов карты.
fun clusteringObjects(position: CameraPosition): List<MapObject>
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и геометрические объекты.
fun addObject(item: GeometryMapObject): Unit
Добавление объекта в источник.
Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.
Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.
Для источника с кластеризацией добавление пока не реализовано, будет выброшено исключение.
fun addObjects(objects: List<GeometryMapObject>): Unit
Добавление нескольких объектов в источник.
Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.
Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.
Для источника с кластеризацией добавление пока не реализовано, будет выброшено исключение.
objects
fun removeObject(item: GeometryMapObject): Unit
Удаление объекта из источника.
Удаление асинхронное, потокобезопасное, метод можно использовать из любого потока.
fun removeObjects(objects: List<GeometryMapObject>): Unit
Удаление объектов из источника.
objects
fun removeAndAddObjects(objectsToRemove: List<GeometryMapObject>, objectsToAdd: List<GeometryMapObject>): Unit
Удаление и добавление объектов в источник.
objectsToRemove
objectsToAdd
fun clear(): Unit
Удаление всех объектов из источника.
GeometryMapObjectSourceBuilder
fun setSourceAttribute(name: String, value: AttributeValue): GeometryMapObjectSourceBuilder
Установка свойства объектов карты, общего для всего источника (см. ISource).
fun setSourceAttributes(values: Map): GeometryMapObjectSourceBuilder
Установка свойств объектов карты, общих для всего источника.
fun addObject(item: GeometryMapObject): GeometryMapObjectSourceBuilder
Добавление геометрического объекта карты в источник.
fun addObjects(objects: List<GeometryMapObject>): GeometryMapObjectSourceBuilder
Добавление нескольких геометрических объектов карты в источник.
fun createSource(): GeometryMapObjectSource
Создание источника геометрических объектов.
после вызова этой функции использовать GeometryMapObjectSourceBuilder для создания источника данных или для задания параметров источника данных нельзя
GeoPoint
Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).
GeoPoint(latitude: Latitude, longitude: Longitude)
Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).
fun move(bearing: Bearing, meter: Meter): GeoPoint
Вычисляет точку, полученную перемещением исходной точки в указанном направлении на указанное расстояние.
fun withElevation(elevation: Elevation = Elevation(0.0f)): GeoPointWithElevation
fun bearing(point: GeoPoint): Bearing
Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) между двумя точками.
GeoPointRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<GeoPointRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): GeoPointRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): GeoPointRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
fun calculateGeoPoint(routePoint: RoutePoint): SegmentGeoPoint?
Вычисляет GeoPoint по известной RoutePoint.
routePoint
Вычисленные географические координаты и направление сегмента, на который указывает параметр route_point. Если маршрут пустой или route_point выходит за пределы маршрута, то возвращается null.
Сложность операции O(log2(N)), где N = route_geometry.size()
fun calculateClosestPoint(point: GeoPoint): RoutePoint?
Вычисляет ближайшую точку на маршруте к заданной в географических координатах точке.
point
Проецируемая на маршрут точка.
Ближайшая точка на маршруте. Если маршрут пустой, либо точки range.first и range.second одновременно лежат либо до маршрута, либо после, то возвращается null.
Сложность операции O(N), где N = route_geometry.size()
GeoPointRouteEntry
Элемент маршрута - точка и значение в ней.
GeoPointRouteEntry(point: RoutePoint, value: GeoPoint)
Элемент маршрута - точка и значение в ней.
GeoPointWithElevation
Точка в географической системе координат (широта, долгота, возвышение).
возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.
GeoPointWithElevation(
latitude: Latitude,
longitude: Longitude,
elevation: Elevation = Elevation(value = 0.0f)
)
Точка в географической системе координат (широта, долгота, возвышение).
возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.
fun bearing(point: GeoPoint): Bearing
Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) для проекции точки на карту и заданной точкой.
fun distance(point: GeoPoint): Meter
Вычисляет минимальное (по ортодромии) расстояние между проекцией точки на карту и заданной точкой.
fun move(bearing: Bearing, meter: Meter): GeoPointWithElevation
Вычисляет точку, полученную перемещением проекции исходной точки в указанном направлении на указанное расстояние.
GeoRect
Прямоугольная область в сферической системе координат (например, WGS84). Данная структура не привязана к конкретной геодезической системе координат.
fun contains(rect2: GeoRect): Boolean
Содержится ли rect2 внутри rect1, т.е. все его точки находятся внутри.
fun contains(point: GeoPoint): Boolean
Содержит ли прямоугольник точку. Точки, расположенные на границе, так же считаются принадлежащими прямоугольнику.
fun expand(rect2: GeoRect): GeoRect
Расширить прямоугольник. Вернуть прямоугольник минимального размера, содержащий оба переданных прямоугольника.
fun expand(point: GeoPoint): GeoRect
Расширить прямоугольник. Вернуть прямоугольник минимального размера, содержащий исходный прямоугольник и точку.
fun intersects(rect2: GeoRect): Boolean
Пересекаются ли прямоугольники, т.е. имеют общие точки. Прямогольники, с общими точками лишь на границе, так же считаются пересекающимися.
val isValid
val isDegenerate
Проверяет прямоугольник на вырожденность. Если точки в прямоугольнике равны, то он вырождается в точку. Вырожденный прямоугольник является корректным прямоугольником. Некорректный прямоугольник не является вырожденным.
val southWestPoint
Юго-западная точка, левая нижняя граница прямоугольника.
val northEastPoint
Северо-восточная точка, правая верхняя граница прямоугольника.
GestureActionEventCenter
Выполнить жест относительно геометрического центра множества точек постановки пальцев.
GestureActionEventCenter()
Выполнить жест относительно геометрического центра множества точек постановки пальцев.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
GestureActionMapPosition
Выполнить жест относительно точки позиции карты.
GestureActionMapPosition()
Выполнить жест относительно точки позиции карты.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
GestureActionPoint
Задает правило обработки событий карты.
GestureActionPoint(eventCenter: GestureActionEventCenter)
eventCenter
GestureActionPoint(mapPosition: GestureActionMapPosition)
mapPosition
GestureActionPoint(targetGeoPoint: GestureActionTargetGeoPoint)
targetGeoPoint
fun match(
eventCenter: Function1,
mapPosition: Function1,
targetGeoPoint: Function1
): T
eventCenter
mapPosition
targetGeoPoint
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
GestureActionTargetGeoPoint
Выполнить жест относительно геопозиции target_geo_point.
GestureActionTargetGeoPoint(targetGeoPoint: GeoPoint)
Выполнить жест относительно геопозиции target_geo_point.
targetGeoPoint
GestureManager
Класс для управления обработкой жестов.
fun gestureEnabled(gesture: TransformGesture): Boolean
fun setMutuallyExclusiveGestures(rules: List<EnumSet<TransformGesture>>): Unit
Установка списка правил исключения одновременного срабатывания нескольких жестов.
К переданному списку правил добавляются правила по умолчанию, которые не позволяют жесту управления наклоном срабатывать одновременно с другими жестами. Каждое правило представляет собой перечень жестов, которые не могут срабатывать одновременно Например, если в правиле указать жесты Scaling и Rotation то эти жесты не будут работать одновременно В случае одновременного выполнения жестов из правила, сработает жест с большим приоритетом Порядок приоритета жестов (по убыванию): (Shift ->) Tilt -> Scaling -> Rotation -> MultiTouchShift
rules
GLESRenderer
Creates input surfaces and renders their content to the provided output surface. The input surfaces are created with the same size as the output surface. When the input surfaces are ready, the provided callback is triggered with the corresponding event.
GLESRenderer(
numberOfInputSurfaces: Int,
outputSurface: Surface,
outputSurfaceSize: Size,
rendererCallback: Callback,
rendererCallbackHandler: Handler
)
Creates input surfaces and renders their content to the provided output surface. The input surfaces are created with the same size as the output surface. When the input surfaces are ready, the provided callback is triggered with the corresponding event.
numberOfInputSurfaces
The number of input surfaces to create for rendering.
outputSurface
The Surface object representing the output surface where the final rendered content will be displayed.
outputSurfaceSize
The size of the output surface, which also determines the size of all input surfaces.
rendererCallback
rendererCallbackHandler
The Handler on which the renderer callback will be invoked.
fun setCopyright(bitmap: Bitmap?, position: Point): Unit
Sets the copyright icon's bitmap and its position on the screen in a Cartesian coordinate system where (0, 0) is the bottom-left corner.
Important: not thread safe.
bitmap
The bitmap representing the copyright icon. Can be null to clear the current icon.
position
The position of the bottom-left corner of the copyright icon in the Cartesian coordinate system.
fun releaseAndJoinRenderThread(): Unit
Stops the rendering thread, releases all OpenGL resources, and ensures no further callbacks will be executed.
GlobalMapOptions
Глобальные настройки карты. Задаются при инициализации SDK и используются для всех карт.
GlobalMapOptions(graphicsApi: GraphicsApi = GraphicsApi.VULKAN, vulkanEmulatorSupportEnabled: Boolean = false)
Глобальные настройки карты. Задаются при инициализации SDK и используются для всех карт.
GradientPolylineOptions
Параметры градиентной полилинии.
GradientPolylineOptions(
borderWidth: LogicalPixel = LogicalPixel(value = 0.0f),
secondBorderWidth: LogicalPixel = LogicalPixel(value = 0.0f),
gradientLength: LogicalPixel = LogicalPixel(value = 1.0f),
borderColor: Color = Color(),
secondBorderColor: Color = Color(),
colors: List<Color>,
colorIndices: ByteArray
)
Параметры градиентной полилинии.
borderWidth
secondBorderWidth
gradientLength
borderColor
secondBorderColor
colors
colorIndices
val borderWidth
Ширина границы линии.
val secondBorderWidth
Ширина второй границы линии.
val gradientLength
Длина градиентной линии.
val borderColor
Цвет окантовки.
val secondBorderColor
Цвет второй окантовки.
val colors
Палитра цветов градиентной полилинии.
val colorIndices
Индексы цветов градиентной полилинии. Количество индексов должно быть на 1 меньше количества точек полилинии.
GroupCheckableItem
Набор отмечаемых элементов, работающих как радио-группа.
val items
Получение набора элементов группы.
GroupItem
Элемент объединенной карточки, содержащий информацию об объекте.
GroupItem(id: DgisObjectId, type: ObjectType)
Элемент объединенной карточки, содержащий информацию об объекте.
HttpCacheManager
Интерфейс управления HTTP-кешем.
fun clear(): Unit
Очистка содержимого HTTP-кеша.
@JvmStatic
fun get(context: Context): HttpCacheManager?
Интерфейс управления HTTP-кешем. Null, если HTTP кэш не используется.
HttpHeader
HttpHeader(name: String, value: String)
name
value
HttpOptions
Опции Http-клиента.
HttpOptions(
timeout: Duration = Duration.ofMilliseconds(15000),
useCache: Boolean = true,
cacheStoragePath: String? = null,
cacheMaxSize: Long? = null,
certificates: List?<Certificate> = null,
proxy: HttpProxyOptions? = null
)
Опции Http-клиента.
timeout
useCache
cacheStoragePath
cacheMaxSize
certificates
proxy
val timeout
Таймаут для HTTP-запросов.
val useCache
Использовать HTTP кэш.
val cacheStoragePath
Путь к каталогу верхнего уровня для основного файлового хранилища HTTP кэша. Файловое хранилище будет находиться в подкаталоге http_cache в данном каталоге. Если путь не указан, будет использоваться директория по умолчанию.
val cacheMaxSize
Максимальный размер HTTP-кеша в байтах. Если не указан, по умолчанию максимальный размер HTTP кэша составляет 300 Мб.
val certificates
Сертификаты в PEM-формате. Если не заданы, используются системные + поставляемые вместе с SDK.
val proxy
Настройки proxy.
HttpProxyOptions
Настройки proxy.
HttpProxyOptions(host: String, port: Int = 0)
Настройки proxy.
host
port
HttpRequest
Структура для представления HTTP запроса.
HttpRequest(
url: String,
method: HttpMethod = HttpMethod.GET,
headers: List<HttpHeader> = listOf(),
body: ByteArray? = null
)
Структура для представления HTTP запроса.
HttpResponse
Структура для представления ответа на HTTP запрос.
тело ответа хранится и обрабатывается отдельно.
HttpResponse(statusCode: HttpStatusCode, headers: List<HttpHeader>)
Структура для представления ответа на HTTP запрос.
тело ответа хранится и обрабатывается отдельно.
HttpResponseCallback
Объект с обратными вызовами для обработки отправки и получения данных.
fun onResponse(response: HttpResponse): Boolean
Метод, обрабатывающий получение ответа от сервера.
response
ответ от сервера.
возвращает false если SDK отменил отправку/обработку запроса.
fun onReceive(body: ByteArray, size: Int): Boolean
Метод, обрабатывающий получение тела ответа. Обработка может вестись по частям.
body
тело (или его часть) ответа от сервера.
size
размер данных в байтах.
возвращает false если SDK отменил отправку/обработку запроса.
При обработке присутствует копирование данных для передачи из Java в с++. Рекомендуется передавать данные небольшими кусками.
fun onFinished(): Unit
Метод, оповещающий об окончании обработки запроса. Необходимо вызывать в конце процесса обработки. Даже если запрос был отменен на стороне SDK.
Отсутствие вызова метода может привести к отказу работы сети в SDK.
HttpStatusCode
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
HttpStatusCode(value: Int = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
Image
Изображение.
ImageData
Данные изображения: размер, формат и бинарные данные.
ImageData(
size: ScreenSize,
format: ImageFormat,
data: ByteArray
)
Данные изображения: размер, формат и бинарные данные.
fun toBitmap(): Bitmap
IncompleteTextHandler
Предложено автодополнение для введенного пользователем текста.
IndoorBuilding
Здание с этажными планами.
fun linkedWith(other: IndoorBuilding): Boolean
Признак того, что текущее здание и other связаны.
Несколько зданий с этажными планами могут быть связаны между собой. Группа связанных зданий ведёт себя как единое целое:
- метод levels() выдаёт объединённый список этажей по всей группе;
- активный режим отображения меняется согласованно у всей группы.
val id
Идентификатор здания с этажными планами.
val defaultLevelIndex
Индекс этажа по умолчанию.
val levels
Информация обо всех этажах.
val activeLevelIndexChannel
Порядковый индекс активного этажа в levels.
var activeLevelIndex
Порядковый индекс активного этажа в levels.
val modeChannel
Активный режим. Если ActiveLevelMode, то index указывает порядковый индекс активного этажа в levels. Если OverviewMode, значит, активен обзорный вид на здание.
var mode
Активный режим. Если ActiveLevelMode, то index указывает порядковый индекс активного этажа в levels. Если OverviewMode, значит, активен обзорный вид на здание.
IndoorBuildingMode
Режим отображения здания.
fun match(activeLevel: Function1, overview: Function1): T
activeLevel
overview
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
IndoorControl
Контрол этажей.
Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.
IndoorControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол этажей.
Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.
context
attrs
defStyle
var markedLevels
Этажи, на которых отображаются пометки.
IndoorControlModel
Модель элемента управления этажами.
fun isLevelMarked(index: Long): Boolean
Нужно ли отображать пометку у этажа с указанным индексом.
index
val activeLevelIndexChannel
Индекс активного этажа.
var activeLevelIndex
Индекс активного этажа.
var markedLevels
Этажи, на которых отображаются пометки.
val levelNamesChannel
Названия этажей. Пусто, если на карте не отображается здание с этажными планами.
val levelNames
Названия этажей. Пусто, если на карте не отображается здание с этажными планами.
IndoorDetector
Детектор, который определяет находится ли пользователь в помещении.
IndoorManager
Класс для получения текущего здания с этажными планами.
fun setIndoorState(newState: IndoorManagerState): Unit
Переключение включенности/выключенности менеджера этажных планов
IndoorRouteLevelsGetter
Позволяет получать множество этажей, через которые проходят маршруты, отображаемые на карте.
InputEvent
Событие пользовательского ввода.
InstructionRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<InstructionRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): InstructionRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): InstructionRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
InstructionRouteEntry
Элемент маршрута - точка и значение в ней.
InstructionRouteEntry(point: RoutePoint, value: RouteInstruction)
Элемент маршрута - точка и значение в ней.
IntRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<IntRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): IntRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): IntRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
IntRouteEntry
Элемент маршрута - точка и значение в ней.
IntRouteEntry(point: RoutePoint, value: Int)
Элемент маршрута - точка и значение в ней.
IsOpenNow
Открыто сейчас.
IsOpenNow()
Открыто сейчас.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
ItemMarkerInfo
Идентификатор объекта и его координаты.
KeyFromAsset
Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.
KeyFromAsset(path: String)
Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.
path
val path
Путь относительно корневой директории asset-ов.
KeyFromFile
Ключ из файла.
KeyFromFile(path: String)
Ключ из файла.
path
val path
Путь к файлу.
KeyFromString
Ключ из строки.
KeyFromString(contents: String)
Ключ из строки.
contents
val contents
Содержимое.
KeySource
Источник ключа.
fun match(
fromAsset: Function1,
fromFile: Function1,
fromString: Function1
): T
fromAsset
fromFile
fromString
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
LabelingPriority
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
LabelingPriority(value: Byte = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
LaneSignRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): LaneSignRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<LaneSignRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
LaneSignRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
LaneSignRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RouteLaneSign
)
Протяженный элемент маршрута - отрезок и значение на нем.
Latitude
Географическая широта.
Latitude(value: Double = 0.0)
Географическая широта.
value
val value
LevelId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
LevelId(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
LevelInfo
Информация об этаже здания.
LevelInfo(
id: LevelId?,
name: String,
linkedLevelIds: List<LevelId>
)
Информация об этаже здания.
Locale
Локаль.
Locale(language: String, region: String)
Локаль.
language
region
fun toLocalePosix(): String
@JvmStatic
fun makeLocale(localeStr: String): Locale?
Создать локаль по строковому представлению в виде LanguageTag или POSIX.
LocaleManager
Менеджер региональных настроек приложения.
fun overrideLocales(locales: List<Locale>): Unit
Установка списка локалей приложения
locales
@JvmStatic
fun instance(context: Context): LocaleManager
Интерфейс управления локалями приложения.
val localesChannel
Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.
val locales
Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.
val systemLocalesChannel
Получение локалей, предоставляемых ОС.
Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).
val systemLocales
Получение локалей, предоставляемых ОС.
Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).
Location
Location(
coordinates: LocationCoordinates,
altitude: LocationFuzzyDouble?,
course: LocationCourse?,
groundSpeed: LocationFuzzyDouble?,
source: String,
timestamp: Duration = Duration.ofMilliseconds(0)
)
coordinates
altitude
course
groundSpeed
source
timestamp
LocationCoordinates
LocationCourse
LocationFuzzyDouble
LocationFuzzyDouble(value: Double, accuracy: Double?)
value
accuracy
LogicalPixel
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
LogicalPixel(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
LogMessage
Сообщение, записываемое в лог.
LogMessage(
level: LogLevel,
text: String,
file: String,
line: Int
)
Сообщение, записываемое в лог.
LogOptions
Настройки логирования.
Longitude
Географическая долгота.
Longitude(value: Double = 0.0)
Географическая долгота.
value
val value
MagneticChangeListener
Класс, отслеживающий изменения направления компаса и его доступность.
fun onValueChanged(
yaw: Float,
accuracy: Float?,
timestamp: Long
): Unit
yaw
accuracy
timestamp
fun onAvailabilityChanged(availability: Boolean): Unit
availability
ManeuverControl
Map
Карта.
fun resetFontIconSizeMultiplier(): Unit
Сбросить множитель размера для иконок.
fun addSource(source: Source): Unit
Добавление источника данных на карту.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
fun removeSource(source: Source): Unit
Удаление источника данных из карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
fun getRenderedObjects(centerPoint: ScreenPoint, radius: ScreenDistance = ScreenDistance(value = 1.0f)): Future<List<RenderedObjectInfo>>
Получение отображаемых объектов карты, проецирующихся на окружность на экране.
centerPoint
центр окружности.
radius
радиус окружности.
Список объектов формируется в порядке отрисовки от поздних к ранним.
fun sublayerAttributes(sublayerName: String): Attributes
Получение атрибутов подслоя.
sublayerName
Название подслоя.
Полученные атрибуты содержат только добавленные туда ранее (явно).
fun setAttribute(name: String, value: AttributeValue): Unit
fun removeAttribute(name: String): Unit
name
val id
Идентификатор экземпляра карты, уникальный в рамках процесса.
val camera
Получение камеры.
val indoorManager
Получение менеджера этажных планов.
val dataLoadingStateChannel
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
val dataLoadingState
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
val styleChannel
Получение текущих стилей карты.
var style
Получение текущих стилей карты.
val fontIconSizeMultiplierChannel
Множитель размера иконок и шрифтов, полученный из приложения.
Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.
var fontIconSizeMultiplier
Множитель размера иконок и шрифтов, полученный из приложения.
Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.
val sources
Получение источников данных карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
val mapVisibilityStateChannel
var mapVisibilityState
val attributes
Получение атрибутов.
должны быть указаны свойства: "theme"="day|night" "navigatorOn"="true|false"
TODO: стилевые свойства для пробок
val interactiveChannel
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
var interactive
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
val graphicsPresetHintChannel
Получение рекомендуемого режима графики для данного устройства.
val graphicsPresetHint
Получение рекомендуемого режима графики для данного устройства.
val graphicsPresetChannel
Получение режима графики. В случае null используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.
var graphicsPreset
Получение режима графики. В случае null используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.
val universeDrawingModeChannel
Режим отображения Universe.
var universeDrawingMode
Режим отображения Universe.
MapControl
Базовый класс для UI-элементов карты.
MapControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для UI-элементов карты.
context
attrs
defStyle
fun bindToMap(controller: MapController, mapView: View): Unit
fun unbindFromMap(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
var mapView
MapController
Готовая к показу карта вместе с рендерером и распознавателем жестов.
@JvmStatic
fun create(context: Context, options: MapControllerOptions): Future<MapController>
Создаёт карту с параметрами из options.
context
контекст SDK. Должен быть валиден на время создания карты.
options
параметры начального состояния карты.
future с готовым MapController либо с ошибкой создания.
MapControllerOptions
MapControllerOptions(
position: CameraPosition? = null,
zoomRestrictions: CameraZoomRestrictions? = null,
sources: List<Source> = listOf(),
attributes: Map = mapOf(),
styleFile: File? = null,
fontIconSizeMultiplier: Float? = null,
graphicsPreset: GraphicsPreset? = null,
maxFps: Fps? = null,
powerSavingMaxFps: Fps? = null
)
position
zoomRestrictions
sources
attributes
styleFile
fontIconSizeMultiplier
graphicsPreset
maxFps
powerSavingMaxFps
val position
Начальная позиция камеры. Не задано: позиция по умолчанию.
val zoomRestrictions
Начальный допустимый диапазон изменения уровня масштабирования. Не задано: диапазон по умолчанию.
val sources
Источники данных, добавляемые на карту при создании.
val attributes
Атрибуты карты, применяемые при создании.
val styleFile
Файл стиля карты. Не задано: используется стиль по умолчанию.
val fontIconSizeMultiplier
Множитель размера иконок и шрифтов. Не задано: множитель не применяется.
val graphicsPreset
Графический пресет качества. Не задано: пресет по умолчанию.
val maxFps
Ограничение частоты кадров. Не задано: ограничения нет.
val powerSavingMaxFps
Ограничение частоты кадров в режиме энергосбережения. Не задано: ограничения нет.
MapControls
Элементы управления картой во время навигации.
MapDirection
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
MapDirection(value: Double = 0.0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
MapGestureRecognizer
Принимает информацию о нажатиях и преобразует их в жесты карты. Обработка происходит в два этапа:
- Добавляется несколько точек - add_touch_point
- Точки обрабатываются - process_touch_event
MapId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
MapId(value: Int = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
MapLocationController
Контроллер для управления позиционированием карты в навигаторе.
MapManager
Интерфейс, позволяющий добавлять карты в навигатор и убирать их из него.
MapObject
Объект на карте.
var userData
Произвольные пользовательские данные, прикрепленные к объекту.
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
MapObjectManager
MapObjectManager(map: Map, layerId: String? = null)
Создать IMapObjectManager.
map
layerId
ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
fun removeObject(item: SimpleMapObject): Unit
Удалить объект.
fun addObjects(objects: List<SimpleMapObject>): Unit
Добавить объекты.
objects
fun removeObjects(objects: List<SimpleMapObject>): Unit
Удалить объекты.
objects
fun removeAndAddObjects(objectsToRemove: List<SimpleMapObject>, objectsToAdd: List<SimpleMapObject>): Unit
Удалить и добавить объекты.
objectsToRemove
objectsToAdd
fun removeAll(): Unit
fun clusteringObjects(position: CameraPosition): List<MapObject>
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и маркеры.
@JvmStatic
fun withClustering(
map: Map,
logicalPixel: LogicalPixel,
maxZoom: Zoom,
clusterRenderer: SimpleClusterRenderer,
minZoom: Zoom = Zoom(value = 0.0f),
layerId: String? = null
): MapObjectManager
Создать IMapObjectManager с кластеризацией данных. Кластеризуются только IMarker объекты.
map
logicalPixel
Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает кластеризация.
maxZoom
Уровень, начиная с которого видны все маркеры.
clusterRenderer
Интерфейс для задания параметров отображения кластера.
minZoom
Уровень, начиная с которого формируются кластеры.
layerId
ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
@JvmStatic
fun withGeneralization(
map: Map,
logicalPixel: LogicalPixel,
maxZoom: Zoom,
minZoom: Zoom = Zoom(value = 0.0f),
layerId: String? = null
): MapObjectManager
Создать IMapObjectManager с генерализацией данных. Генерализуются только IMarker объекты.
map
logicalPixel
Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает генерализация.
maxZoom
Уровень, начиная с которого видны все маркеры.
minZoom
Уровень, начиная с которого работает генерализация.
layerId
ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
var isVisible
Переопределение видимости всех объектов, добавленных в экземпляр менеджера. Значение false здесь имеет приоритет над видимостью отдельного объекта.
MapPaddingControl
UI-элемент, задающий внутренние отступы (padding) карты.
MapPaddingControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
UI-элемент, задающий внутренние отступы (padding) карты.
context
attrs
defStyle
MapRenderer
Создание этого объекта приводит к началу рисования карты.
fun setMaxFps(maxFps: Fps?, powerSavingMaxFps: Fps?): Unit
fun takeSnapshot(copyrightAlign: Alignment): Future<ImageData>
MapRotationBeginEvent
Событие начала вращения карты вокруг точки.
val direction
Направление вращения карты.
MapRotationEndEvent
MapScalingBeginEvent
Событие начала изменения масштаба.
val direction
Направление изменения масштаба карты.
MapScalingEndEvent
MapShiftBeginEvent
Событие начала сдвига карты.
val direction
Направление смещения карты.
MapShiftEndEvent
MapTheme
Тема для использования в карте.
MapTheme(name: String, loadingBackground: Color)
Тема для использования в карте.
val name
Код стиля из редактора стилей.
val loadingBackground
Цвет подложки, используемый до загрузки стилей и отображения подложки карты. В темах по умолчанию соответствует цвету подложки карты по умолчанию.
val defaultTheme
Стандартная светлая тема для базовых стилей
val defaultDarkTheme
Стандартная темная тема для базовых стилей
MapView
MapView(context: Context, options: MapViewOptions = MapViewOptions())
fun setCopyrightMargins(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
left
top
right
bottom
fun setCopyrightGravity(gravity: Int): Unit
gravity
fun setUriOpener(uriOpener: Function1): Unit
uriOpener
fun useCustomGestureRecognitionEngine(engine: MapGestureRecognitionEngine): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
fun onWindowVisibilityChanged(visibility: Int): Unit
visibility
fun onConfigurationChanged(newConfig: Configuration): Unit
newConfig
var showApiVersionInCopyrightView
MapViewOptions
Параметры отображения карты (view-layer). Не содержит параметров самой карты — они задаются через MapControllerOptions.
MapViewOptions(
renderMode: MapRenderMode = MapRenderMode.SURFACE,
theme: MapTheme? = null,
backgroundColor: Color? = null,
devicePpi: DevicePpi? = null,
deviceDensity: DeviceDensity? = null,
copyrightInsetsSides: Int? = null
)
Параметры отображения карты (view-layer). Не содержит параметров самой карты — они задаются через MapControllerOptions.
renderMode
theme
backgroundColor
devicePpi
deviceDensity
copyrightInsetsSides
val renderMode
Режим рендеринга: SurfaceView (лучшая производительность) или TextureView (поддержка анимаций view-иерархии, RecyclerView, Compose).
val theme
Тема карты, используемая для определения цвета cover view (фон-заглушка). Если null — определяется автоматически из системного night mode.
val backgroundColor
Цвет cover view (фон-заглушка до первого отрисованного кадра карты). Если задан — используется вместо цвета из theme.
val devicePpi
PPI устройства для корректного масштабирования карты. Если null — определяется автоматически из DisplayMetrics.
val deviceDensity
Плотность экрана (density multiplier). Если null — определяется автоматически из DisplayMetrics.
val copyrightInsetsSides
Стороны, с которых применяются системные insets к копирайту. Битовая маска значений CopyrightInsetsSide. Если null — применяются все стороны.
MarkedByRouteIndoorControl
UI-элемент, где отмечены этажи, через которые на карте проходят маршруты.
MarkedByRouteIndoorControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
UI-элемент, где отмечены этажи, через которые на карте проходят маршруты.
context
attrs
defStyle
MarkedUpText
Размеченный текст.
MarkedUpText(text: String, matchedParts: List<MarkedUpTextSpan>)
Размеченный текст.
text
matchedParts
MarkedUpTextSpan
Описывает поднабор байтов строки text.
MarkedUpTextSpan(offset: Long, length: Long)
Описывает поднабор байтов строки text.
offset
length
Marker
Точечная отметка на карте, представляющая интерес для пользователя.
var position
Получение местоположения маркера.
var icon
Получение иконки маркера.
var anchor
Получение точки привязки иконки маркера.
var iconOpacity
Получение прозрачности иконки маркера.
var text
Получение подписи маркера.
var textStyle
Получение стиля подписи маркера.
var isDraggable
Получение флага перемещаемости маркера.
var iconWidth
Получение целевой ширины маркера, используемой для масштабирования.
var iconMapDirection
Угол поворота маркера на карте относительно направления на север, по часовой стрелке.
var animatedAppearance
Анимировать ли появление.
var iconAnimationMode
Получение режима анимации анимированного маркера.
var labelingPriority
Получение приоритета лейблинга маркера.
var suppressOnOverlap
Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).
MarkerOptions
Параметры маркера.
MarkerOptions(
position: GeoPointWithElevation,
icon: Image?,
iconMapDirection: MapDirection? = null,
anchor: Anchor = Anchor(x = 0.5f, y = 0.5f),
text: String? = null,
textStyle: TextStyle? = null,
iconOpacity: Opacity = Opacity(value = 1.0f),
visible: Boolean = true,
draggable: Boolean = false,
iconWidth: LogicalPixel = LogicalPixel(value = 0.0f),
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
labelingPriority: LabelingPriority = LabelingPriority(value = 0),
animatedAppearance: Boolean = true,
levelId: LevelId? = null,
iconAnimationMode: AnimationMode = AnimationMode.NORMAL,
suppressOnOverlap: Boolean = false
)
Параметры маркера.
position
icon
iconMapDirection
anchor
text
textStyle
iconOpacity
visible
draggable
iconWidth
userData
zIndex
labelingPriority
animatedAppearance
levelId
iconAnimationMode
suppressOnOverlap
val position
val icon
val iconMapDirection
val anchor
val text
val textStyle
val iconOpacity
val visible
val draggable
val iconWidth
Целевая ширина, используемая для масштабирования.
val userData
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
val zIndex
Уровень отрисовки объекта.
val labelingPriority
Приоритет лейблинга иконки маркера.
val animatedAppearance
Анимировать ли появление.
val levelId
Привязка к поэтажному плану здания.
val iconAnimationMode
Режим анимации.
val suppressOnOverlap
Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).
MessageControl
Meter
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
Meter(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
MillisecondsRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<MillisecondsRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): MillisecondsRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): MillisecondsRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
fun calculateDuration(routePoint: RoutePoint): Duration
fun calculateDuration(fromRoutePoint: RoutePoint, toRoutePoint: RoutePoint): Duration
MillisecondsRouteEntry
Элемент маршрута - точка и значение в ней.
MillisecondsRouteEntry(point: RoutePoint, value: Duration)
Элемент маршрута - точка и значение в ней.
MiniMapControlModel
Интерфейс модели контрола миникарты. Предназначен для управления позицией маркера на экране, зумом и прочим положением камеры так, чтобы маршрут было лучше видно на миникарте.
Model
Модель навигатора, предназначенная для отображения в UI.
val stateChannel
Состояние навигатора.
val state
Состояние навигатора.
val locationChannel
Текущая геопозиция, с которой работает навигатор.
see location_available_channel
val location
Текущая геопозиция, с которой работает навигатор.
see location_available_channel
val locationAvailableChannel
Флаг, который указывает используется ли текущая геопозиция для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.
Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.
see location_channel
val locationAvailable
Флаг, который указывает используется ли текущая геопозиция для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.
Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.
see location_channel
val routeChannel
Маршрут с манёврами.
В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.
val route
Маршрут с манёврами.
В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.
val dynamicRouteInfoChannel
Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.
val dynamicRouteInfo
Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.
val routePositionChannel
Текущая позиция пользователя на маршруте.
val routePosition
Текущая позиция пользователя на маршруте.
val exceedingMaxSpeedLimitChannel
Флаг превышения максимальной разрешенной скорости.
val exceedingMaxSpeedLimit
Флаг превышения максимальной разрешенной скорости.
val betterRouteChannel
Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно null, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.
val betterRoute
Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно null, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.
val duration
val isFreeRoam
ModelData
Данные модели.
ModelMapObject
Модель на карте.
ModelMapObjectOptions
Параметры модели.
ModelMapObjectOptions(
position: GeoPointWithElevation,
data: ModelData?,
size: ModelSize,
mapDirection: MapDirection? = null,
opacity: Opacity = Opacity(value = 1.0f),
visible: Boolean = true,
userData: Any? = null,
levelId: LevelId? = null
)
Параметры модели.
position
data
size
mapDirection
opacity
visible
userData
levelId
val position
Местоположение.
val data
Данные.
val size
Целевая ширина, используемая для масштабирования.
val mapDirection
Угол поворота модели на карте относительно направления на север, по часовой стрелке.
val opacity
Прозрачность.
val visible
Видимость.
val userData
Пользовательские данные.
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
val levelId
Привязка к поэтажному плану здания.
ModelScale
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
ModelScale(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
ModelSize
Размер модели. Если LogicalPixel, то размер модели не будет привязан к масштабу карты и останется неизменным относительно экрана. Если ModelScale, то размер модели умножится на коэффициент и привяжется к масштабу карты.
fun match(logicalPixel: Function1, scale: Function1): T
logicalPixel
scale
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
MotorcycleBriefRouteInfo
Базовая информация об маршруте на мотоцикле.
MotorcycleBriefRouteInfo(
length: RouteDistance,
landmark: String,
trafficSpeed: MotorcycleBriefRouteInfoTrafficSpeed
)
Базовая информация об маршруте на мотоцикле.
MotorcycleRouteSearchOptions
Параметры поиска маршрута на мотоцикле.
MotorcycleRouteSearchOptions(
avoidTollRoads: Boolean = false,
avoidUnpavedRoads: Boolean = false,
avoidFerries: Boolean = false,
avoidLockedRoads: Boolean = true,
routeSearchType: RouteSearchType = RouteSearchType.JAM,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на мотоцикле.
avoidTollRoads
avoidUnpavedRoads
avoidFerries
avoidLockedRoads
routeSearchType
excludedAreas
val avoidTollRoads
Избегать платных дорог.
val avoidUnpavedRoads
Избегать грунтовых дорог.
val avoidFerries
Избегать паромных переправ.
val avoidLockedRoads
Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.
val routeSearchType
Тип поиска маршрута.
val excludedAreas
Исключаемые области (не больше 25).
MotorcycleRouteSummary
Саммари информация для мотоциклетного маршрута.
MotorcycleRouteSummary(
roadBlocks: Int = 0,
accidents: Int = 0,
roadWorks: Int = 0,
tollRoads: Int = 0,
ferryCrossings: Int = 0,
iceCrossings: Int = 0,
trafficLights: Int = 0,
carRoadsLength: Int = 0,
groundRoadsLength: Int = 0,
gravelRoadsLength: Int = 0,
badRoadsLength: Int = 0
)
Саммари информация для мотоциклетного маршрута.
roadBlocks
accidents
roadWorks
tollRoads
ferryCrossings
iceCrossings
trafficLights
carRoadsLength
groundRoadsLength
gravelRoadsLength
badRoadsLength
val roadBlocks
Суммарное количество перекрытий на маршруте.
val accidents
Суммарное количество аварий на маршруте.
val roadWorks
Суммарное количество дорожных работ на маршруте.
val tollRoads
Суммарное количество платных дорог на маршруте.
val ferryCrossings
Суммарное количество паромных переправ на маршруте.
val iceCrossings
Суммарное количество ледовых переправ на маршруте.
val trafficLights
Суммарное количество светофоров на маршруте.
val carRoadsLength
Суммарная протяжённость автомобильной дороги на маршруте в метрах.
val groundRoadsLength
Суммарная протяжённость грунтовых дорог на маршруте в метрах.
val gravelRoadsLength
Суммарная протяжённость гравийных дорог на маршруте в метрах.
val badRoadsLength
Суммарная протяжённость участков плохой дороги на маршруте в метрах.
MultiTouchGestureSettings
Настройки жеста касания несколькими пальцами.
var recognizeSettings
Настройки распознавания касания несколькими пальцами.
MultiTouchRecognizeSettings
Настройки распознавания касания несколькими пальцами.
MultiTouchRecognizeSettings(multiTouchShiftThresholdMm: Float = 7.0f)
Настройки распознавания касания несколькими пальцами.
multiTouchShiftThresholdMm
val multiTouchShiftThresholdMm
Порог сдвига взвешенного среднего точек, в миллиметрах, преодоление которого говорит о начале сдвига несколькими пальцами.
MyLocationControl
Контрол перелёта к текущему местоположению пользователя.
MyLocationControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол перелёта к текущему местоположению пользователя.
context
attrs
defStyle
MyLocationControllerSettings
Настройки контроллера перемещения маркера геопозиции.
MyLocationControllerSettings(
bearingSource: BearingSource? = BearingSource.AUTO,
animationDuration: Duration = Duration.ofMilliseconds(1000),
coordinatesThreshold: Meter = Meter(value = 0.1f),
bearingThreshold: Bearing = Bearing(value = 1.0)
)
Настройки контроллера перемещения маркера геопозиции.
bearingSource
animationDuration
coordinatesThreshold
bearingThreshold
val bearingSource
Источник направления. Если отсутствует, будет отображаться маркер без направления.
val animationDuration
Неотрицательная длительность изменения реального направления.
val coordinatesThreshold
Неотрицательное пороговое значение учитываемого изменения реальной позиции и её точности.
val bearingThreshold
Неотрицательное пороговое значение учитываемого изменения реального направления.
MyLocationControlModel
Модель контрола перелета к местоположению пользователя. Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя. Если местоположение не определено, ничего не происходит. Методы объекта необходимо вызывать на одном потоке.
fun onClicked(): Unit
val isEnabledChannel
Состояние элемента перелета к местоположению пользователя.
val isEnabled
Состояние элемента перелета к местоположению пользователя.
val followStateChannel
Состояние слежения камеры за текущим местоположением пользователя.
val followState
Состояние слежения камеры за текущим местоположением пользователя.
val locationQualityChannel
Качество определения текущего местоположения.
val locationQuality
Качество определения текущего местоположения.
MyLocationMapObject
Маркер геопозиции.
fun setModelData(data: ModelData?): Unit
Установить данные модели.
MyLocationMapObjectSource
Источник, содержащий маркер геопозиции.
MyLocationMapObjectSource(
context: Context,
controllerSettings: MyLocationControllerSettings = MyLocationControllerSettings(),
markerType: MyLocationMapObjectMarkerType = MyLocationMapObjectMarkerType.MODEL
)
Создать источник маркера геопозиции.
val item
Получить маркер геопозиции.
MyLocationMapObjectSourceProvider
Провайдер, предоставляющий источник маркера геопозиции.
val myLocationMapObjectSource
Источник, содержащий маркер геопозиции.
NativeException
Исключение, преобразованное из исключения, брошенного в нативном коде.
NativeObject
Базовый класс для объектов, представляющих собой обёртки над объектами в нативном коде.
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
fun close(): Unit
fun isValid(): Boolean
NativeProxy
Технический класс, инкапсулирующий в себе слабый указатель на объект в нативном коде.
fun finalize(): Unit
NativeReference
Indicates that the native layer holds a strong reference to an object of this type.
If the implementation is an inner/anonymous class or a lambda that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while the native reference is alive, causing a memory leak.
Implement such interfaces in a standalone class without capturing this, passing required dependencies via the constructor wrapped in WeakReference.
NativeReference()
Indicates that the native layer holds a strong reference to an object of this type.
If the implementation is an inner/anonymous class or a lambda that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while the native reference is alive, causing a memory leak.
Implement such interfaces in a standalone class without capturing this, passing required dependencies via the constructor wrapped in WeakReference.
NavigationControl
Базовый класс для UI-элементов навигатора.
NavigationControl
Контейнер с UI-элементами управления уровнем масштабирования и перелётом к текущему местоположению пользователя.
NavigationFollowController
Интерфейс для управления слежением карты за маркером геопозиции в навигаторе.
var followReturnDelay
Таймаут, через который карта автоматически вернется в режим слежения за маркером геопозиции после того, как пользователь подвигал её. 0 - автоматический возврат в режим слежения за маркером геопозиции отключен.
var cameraBehaviour
Режим слежения камеры за маркером геопозиции в навигаторе.
NavigationManager
Корневой публичный интерфейс навигатора.
val uiModel
Модель навигатора, предназначенная для отображения в UI.
val indoorDetector
Навигация внутри помещений.
val mapFollowController
Управление автоматическим возвратом карты к слежению за маркером геопозиции.
val mapLocationController
Контроллер для управления позиционированием карты в навигаторе.
val mapManager
Менеджер карт навигатора.
val zoomFollowSettings
Настройки масштабирования карты во время режима ведения.
val routeMapSettings
Настройки отображения маршрута на карте.
val routeSourceSettings
Настройки источника, используемого для отображения маршрута на карте.
val routeMapObjectsProvider
Провайдер объектов маршрутов на карте.
val simulationSettings
Настройки симуляции ведения по маршруту.
val voiceSelector
Управление голосовыми пакетами в текущей сессии навигатора.
val exceedSpeedLimitSettings
Настройки детектирования превышения скорости.
val dynamicRouteInfoSettings
Настройки получения и обновления динамических данных о маршруте.
val soundNotificationSettings
Настройки звуковых оповещений в текущей сессии навигатора.
val freeRoamSettings
Настройки ведения без маршрута в режиме free roam.
val alternativeRoutesProviderSettings
Настройки поиска альтернативных маршрутов в режиме ведения.
val alternativeRouteSelector
Выбор альтернативного маршрута.
val trafficJamDetector
Информация о пробках на маршруте.
val myLocationMapObjectSourceProvider
Провайдер, предоставляющий источник маркера геопозиции.
val routeRebuilder
Контроллер поиска нового маршрута при сходе с текущего маршрута.
val freeRoamSelector
Контроллер перевода навигатора в режим FreeRoam при слишком долгом перестроении маршрута.
val dataPrefetcher
Контроллер предварительной загрузки тайлов карты вдоль маршрута.
val finishDetector
Контроллер завершения маршрута
val tripHighlightsCollector
Коллектор сводки о завершенном маршруте
NavigationView
UI-элемент, отображающий состояние навигации на карте.
Добавление его в MapView приводит к отображению на ней маршрута, маркера геопозиции, транспортных событий, слежению за камерой. Внутри NavigationView можно размещать навигационные контролы - наследники NavigationControl, в частности готовый к использованию набор контролов DefaultNavigationControls.
var navigationManager
NavigationVoice
Голос для использования в навигаторе.
NearestPlatform
Информация о платформе.
NearestPlatform(
id: DgisObjectId,
name: String,
headingTo: String?,
color: Color?,
transitionType: NearestPlatformTransitionType?
)
Информация о платформе.
NearestStation
Информация о станции.
NearestStation(
id: DgisObjectId,
name: String,
distance: Int = 0,
routeTypes: List<PublicTransportRouteType>,
internalTransition: Boolean = false,
color: Color?
)
Информация о станции.
id
name
distance
routeTypes
internalTransition
color
val id
Уникальный идентификатор остановки.
val name
Название остановки.
val distance
Расстояние от описываемого объекта до ближайшей остановочной платформы данной остановки в метрах.
val routeTypes
Типы транспорта, проходящие через эту остановку.
val internalTransition
Существует ли внутренний переход на эту станцию из описываемого объекта.
val color
Цветовое кодирование маршрута.
NewValuesNotifier
Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.
fun sendNotification(): Unit
Необходимо вызывать, чтобы сообщить об обновлении параметров.
ObstacleInfo
Информация о препятствии на маршруте.
ObstacleInfo(
type: Obstacle = Obstacle.OTHER,
limitation: ObstaclePassLimitation = ObstaclePassLimitation.UNLIMITED,
objectId: Long = 0
)
Информация о препятствии на маршруте.
ObstacleInfoRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): ObstacleInfoRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): ObstacleInfoRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
ObstacleInfoRouteEntry
Элемент маршрута - точка и значение в ней.
ObstacleInfoRouteEntry(point: RoutePoint, value: ObstacleInfo)
Элемент маршрута - точка и значение в ней.
ObstacleInfoRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): ObstacleInfoRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
ObstacleInfoRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
ObstacleInfoRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: ObstacleInfo
)
Протяженный элемент маршрута - отрезок и значение на нем.
Opacity
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
Opacity(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
Opened
Открыто.
OpeningHours
Часы работы организации.
OpeningHours(
weekOpeningHours: List<List<WeekTimeInterval>>,
weekClosingHours: List<List<ClosingHours>>,
isOpen24x7: Boolean
)
Часы работы организации.
weekOpeningHours
weekClosingHours
isOpen24x7
OpeningSoon
Скоро откроется.
OpenStatus
fun match(
opened: Function1,
openingSoon: Function1,
closingSoon: Function1,
closed: Function1
): T
opened
openingSoon
closingSoon
closed
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
OrderedValue
Описывает одно значение из набора.
OrderedValue(value: String, text: String?)
Описывает одно значение из набора.
value
text
OrderedValues
Описывает набор дискретных упорядоченных значений.
OrderedValues(
values: List<OrderedValue>,
currentMinIndex: Long? = null,
currentMaxIndex: Long? = null
)
Описывает набор дискретных упорядоченных значений.
values
currentMinIndex
currentMaxIndex
OrgId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
OrgId(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
OrgInfo
Информация об организации.
OrgInfo(
branchCount: Int,
id: OrgId,
name: String?
)
Информация об организации.
OverviewMode
Режим обзорного вида здания (модель или мастер-план).
OverviewMode()
Режим обзорного вида здания (модель или мастер-план).
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
Package
Пакет. Для удобства работы с данными (установки, обновления, удаления), данные в 2ГИС SDK группируются в наборы по функционально-логическому назначению. Набор сгруппированных данных называется пакетом. В пределах одного пакета функциональное назначение данных уникально. Однако, множества данных пакетов с единым функциональным назначением могут пересекаться, то есть, возможна ситуация, когда данные нескольких пакетов имеют общие файлы. При операциях с группой таких пакетов общие данные будут обрабатываться (скачиваться, распаковываться, удаляться) только один раз.
fun install(): Unit
Запуск операции установки либо обновления пакета.
fun install(fallback: InstallFallback): Unit
Запуск операции установки либо обновления пакета.
fun uninstall(): Unit
Запуск операции удаления пакета.
fun pause(): Unit
Постановка операции установки либо обновления пакета на паузу.
val id
Стабильный технический идентификатор пакета.
val infoChannel
Информация о пакете.
val info
Информация о пакете.
val progressChannel
Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне 0,100.
val progress
Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне 0,100.
PackageInfo
Информация о пакете. См. IPackage.
PackageInfo(
name: String,
installed: Boolean = false,
incomplete: Boolean = true,
preinstalled: Boolean = false,
compatible: Boolean = false,
hasUpdate: Boolean = false,
error: PackageInfoError?,
updateStatus: PackageUpdateStatus = PackageUpdateStatus.NOT_AVAILABLE,
finalSizeOnDisk: Long? = null,
currentSizeOnDisk: Long = 0
)
Информация о пакете. См. IPackage.
name
installed
incomplete
preinstalled
compatible
hasUpdate
error
updateStatus
finalSizeOnDisk
currentSizeOnDisk
val name
Локализованное название пакета.
val installed
Признак установки - true в случае, если пакет был выбран для установки.
val incomplete
Признак незавершенности установки - true, если нет полностью загруженной версии пакета (возможно, несовместимой с текущей версией SDK).
val preinstalled
Признак предустановленных пакетов. Предустановленные пакеты всегда установлены и полностью загружены, и их нельзя удалить.
val compatible
Признак совместимости - true в случае, если загруженный пакет совместим с текущей версией SDK.
val hasUpdate
Признак наличия обновления - true в случае наличия обновления для загруженного пакета. Возможна ситуация, когда во время процесса обновления до новой версии на сервере стала доступна ещё более новая версия пакета. В этом случае значение будет true как во время обновления, так и по его окончании.
val error
Ошибка, произошедшая при попытке загрузки и/или установки пакета, или null, если ошибки нет.
val updateStatus
Статус обновления пакета.
val finalSizeOnDisk
Размер территории в байтах, который она занимает на диске после установки. Неинициализированное значение означает, что территория не содержит файлов (информация получена на основе предустановленного файла состояния, в котором нет списка файлов для территории).
val currentSizeOnDisk
Размер в байтах, который занимают на данный момент уже установленные файлы территории.
PackageManager
Интерфейс для централизованной работы с пакетами:
- Управления автообновлением и получением его статуса;
- Принудительной проверкой обновлений;
- Запуском и остановкой установки/обновления всех доступных пакетов.
- Подпиской на изменения информации о пакетах;
- Подпиской на изменения информации о всеобщем прогрессе установки пакетов.
fun checkForUpdates(): Unit
Принудительная проверка на наличие обновлений.
@JvmStatic
fun instance(context: Context): PackageManager
Получение объекта для работы с пакетами из контекста.
var autoupdateEnabled
Статус (включено/выключено) автообновления.
val packagesChannel
Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.
val packages
Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.
PackedMapState
Сериализованное состояние карты.
fun toBytes(): ByteArray
Представление состояния карты в виде последовательности байтов.
@JvmStatic
fun of(
position: CameraPosition,
showTraffic: Boolean,
behaviour: CameraBehaviour
): PackedMapState
Получение состояния карты.
position
Позиция камеры.
showTraffic
Состояние отображения пробок на карте.
behaviour
Режим слежения камеры.
Сериализованное состояние карты.
@JvmStatic
fun fromBytes(data: ByteArray): PackedMapState
Получение состояния карты.
data
Состояние карты в виде последовательности байтов.
Сериализованное состояние карты.
@JvmStatic
fun fromMap(map: Map): PackedMapState
Получение состояния карты.
map
Карта, состояние которой необходимо получить.
Сериализованное состояние карты.
PackedNavigationState
Вспомогательный объект для сериализации и десериализации состояния навигации.
PackedSearchQuery
Вспомогательный объект для сериализации и десериализации поискового запроса.
fun toBytes(): ByteArray
fun toSearchQuery(): SearchQuery
@JvmStatic
fun fromBytes(data: ByteArray): PackedSearchQuery
Десериализация запроса поиска.
@JvmStatic
fun fromSearchQuery(searchQuery: SearchQuery): PackedSearchQuery
val queryText
Текст запроса. Для некоторых запросов (например, раскрытие рубрики из suggest'а) текст отсутствует, т.к. в запросе хранятся идентификаторы, и поведение отличается от поиска по тексту элемента suggest'а.
val orgIds
Идентификаторы организаций.
val rubricIds
Идентификаторы рубрик.
val objectIds
Идентификаторы объектов.
val buildingIds
Идентификаторы зданий.
val geometryRestriction
Геометрия, ограничивающая область поиска.
val areaOfInterest
Прямоугольная область интереса.
val territoryOfInterest
Слабое ограничение области поиска объектов: штраф за непопадание вместо строгого отбрасывания.
val allowedResultTypes
Ограничение по возвращаемым поиском типам объектов.
val pageSize
Размер страницы выдачи.
val directoryFilter
Информация об активных фильтрах.
val sortingType
Тип сортировки результатов.
val radius
Радиус поиска в метрах.
val locale
Локаль поискового запроса.
val searchNearby
Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
Padding
Отступы от краёв камеры.
Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:
- точку позиции;
- анимированное перемещение карты;
- расположение динамических объектов карты (например баблы маршрутов).
Padding(
left: Int = 0,
top: Int = 0,
right: Int = 0,
bottom: Int = 0
)
Отступы от краёв камеры.
Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:
- точку позиции;
- анимированное перемещение карты;
- расположение динамических объектов карты (например баблы маршрутов).
left
top
right
bottom
Page
Страница результатов поиска.
fun fetchPrevPage(): Future<Page?>
Получить предыдущую страницу результатов.
future, резолвящаяся в ненулевой указатель на предыдущую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если предыдущая страница отсутствует exceptional future, если произошла ошибка при получении страницы
fun fetchNextPage(): Future<Page?>
Получить следующую страницу результатов.
future, резолвящаяся в ненулевой указатель на следующую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если следующая страница отсутствует exceptional future, если произошла ошибка при получении страницы
val items
Непустой набор объектов справочника этой страницы.
ParkingCapacity
Вместимость парковки.
ParkingCapacity(total: String?, specialSpaces: List<SpecialSpace>)
Вместимость парковки.
total
specialSpaces
ParkingControl
ParkingControlModel
Модель контрола парковок.
Этот интерфейс является потокобезопасным.
ParkingControlModel(map: Map)
Функция создания модели элемента управления парковками.
map
карта.
fun toggleParkingsVisibility(): Unit
Действие при нажатии на контрол. Переключает видимость парковок на карте.
ParkingInfo
Общая информация о парковке.
ParkingInfo(
type: ParkingType?,
purpose: ParkingPurpose,
access: ParkingAccess,
pavingType: ParkingPavingType?,
isPaid: Boolean,
isIncentive: Boolean,
forTrucks: Boolean,
levelCount: Short?,
capacity: ParkingCapacity?
)
Общая информация о парковке.
type
purpose
access
pavingType
isPaid
isIncentive
forTrucks
levelCount
capacity
val type
Тип.
val purpose
Назначение.
val access
Тип доступа.
val pavingType
Тип покрытия.
val isPaid
Является ли парковка платной.
val isIncentive
Является ли парковка перехватывающей.
val forTrucks
Есть места для грузовиков.
val levelCount
Количество уровней.
val capacity
Вместимость.
PedestrianBriefRouteInfo
Базовая информация о пешеходном маршруте.
PedestrianBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о пешеходном маршруте.
PedestrianInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
PedestrianInstructionCrossroad(landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.NONE, maneuvers: List<PedestrianInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
PedestrianInstructionCrossroadManeuver
PedestrianInstructionCrossroadManeuver(direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
PedestrianInstructionFinish
Конец пешеходной части маршрута.
PedestrianInstructionFinish()
Конец пешеходной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
PedestrianInstructionIndoorEnter
Вход в здание.
PedestrianInstructionIndoorEnter(levelId: LevelId = LevelId())
Вход в здание.
levelId
PedestrianInstructionIndoorExit
Выход из здания.
PedestrianInstructionIndoorExit()
Выход из здания.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
PedestrianInstructionIndoorFloorChange
Смена этажа в здании.
PedestrianInstructionIndoorFloorChange(
type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.UNDEFINED,
beginId: LevelId = LevelId(),
endId: LevelId = LevelId()
)
Смена этажа в здании.
PedestrianInstructionStart
Начало пешеходной части маршрута.
PedestrianInstructionStart()
Начало пешеходной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
PedestrianRouteSearchOptions
Параметры поиска пешеходного маршрута.
PedestrianRouteSearchOptions(
avoidStairways: Boolean = false,
avoidUnderpassesAndOverpasses: Boolean = false,
useIndoor: Boolean = true,
avoidUnpavedRoads: Boolean = false,
avoidLockedRoads: Boolean = true,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска пешеходного маршрута.
avoidStairways
avoidUnderpassesAndOverpasses
useIndoor
avoidUnpavedRoads
avoidLockedRoads
excludedAreas
val avoidStairways
Избегать лестниц.
val avoidUnderpassesAndOverpasses
Избегать подземных и надземных переходов.
val useIndoor
Строить маршруты внутри зданий.
val avoidUnpavedRoads
Избегать грунтовых дорог.
val avoidLockedRoads
Избегать закрытых для прохода дорог. При значении true поиск маршрута не будет учитывать перекрытые для прохода участки дорог. При значении false маршрут может быть проложен через перекрытые для прохода участки дорог, если невозможно построить маршрут без прохода через перекрытые участки.
val excludedAreas
Исключаемые области (не больше 25).
PedestrianRouteSummary
Саммари информация для пешеходного маршрута.
PedestrianRouteSummary(
routeType: PedestrianSummaryRouteType = PedestrianSummaryRouteType.UNKNOWN,
stairways: Int = 0,
gates: Int = 0,
barriers: Int = 0,
calories: Int = 0,
groundRoadsLength: Int = 0,
gravelRoadsLength: Int = 0,
badRoadsLength: Int = 0,
elevationGainLength: Int = 0,
elevationLossLength: Int = 0,
steps: Int = 0,
roadBlocks: Int = 0,
defaultUserAverageSpeed: Float = 0.0f,
personalizedUserAverageSpeed: Float? = null
)
Саммари информация для пешеходного маршрута.
routeType
stairways
gates
barriers
calories
groundRoadsLength
gravelRoadsLength
badRoadsLength
elevationGainLength
elevationLossLength
steps
roadBlocks
defaultUserAverageSpeed
personalizedUserAverageSpeed
val routeType
Тип пешеходного маршрута.
val stairways
Количество лестниц на маршруте.
val gates
Количество калиток на маршруте.
val barriers
Количество шлагбаумов на маршруте.
val calories
Количество калорий, которые будут потрачены на проход по маршруту.
val groundRoadsLength
Суммарная протяжённость грунтовых дорог на маршруте в метрах.
val gravelRoadsLength
Суммарная протяжённость гравийных дорог на маршруте в метрах.
val badRoadsLength
Суммарная протяжённость участков плохой дороги на маршруте в метрах.
val elevationGainLength
Суммарная высота подъёма на участках с подъёмами на маршруте в метрах.
val elevationLossLength
Суммарная высота спуска на участках со спусками на маршруте в метрах.
val steps
Количество шагов для прохода по маршруту.
val roadBlocks
Суммарное количество пешеходных перекрытий на маршруте.
val defaultUserAverageSpeed
Определяемая бэкендом средняя скорость пользователя в км/ч по умолчанию.
val personalizedUserAverageSpeed
Определяемая бэкендом персонализированная средняя скорость пользователя в км/ч.
PerformSearchHandler
Предложено поискать определенный набор объектов.
val searchQuery
Запрос для прогона через поисковик.
PointGeometry
PointGeometryData
Данные геометрии точечного объекта.
PointGeometryData(geoPointWithElevation: GeoPointWithElevation)
geoPointWithElevation
fun match(geoPoint: Function1, geoPointWithElevation: Function1): T
geoPoint
geoPointWithElevation
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
Polygon
Полигон на карте.
Polygon(options: PolygonOptions)
Создание полигона на основе параметров.
options
PolygonGeometry
Полигон.
PolygonGeometry(contours: List<List<GeoPoint>>)
contours
PolygonOptions
Параметры полигона.
PolygonOptions(
contours: List<List<GeoPoint>>,
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value = 0.0f),
strokeColor: Color = Color(),
dashedPolygonOptions: DashedPolygonOptions? = null,
visible: Boolean = true,
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
levelId: LevelId? = null,
elevation: Elevation? = null
)
Параметры полигона.
contours
color
strokeWidth
strokeColor
dashedPolygonOptions
visible
userData
zIndex
levelId
elevation
val contours
val color
val strokeWidth
val strokeColor
val dashedPolygonOptions
Параметры пунктирного контура полигона.
val visible
val userData
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
val zIndex
Уровень отрисовки объекта.
val levelId
Привязка к поэтажному плану здания.
val elevation
Высота полигона над поверхностью в метрах.
Polyline
Ломаная линия на карте.
PolylineGeometry
Ломаная линия.
PolylineGeometry(points: List<GeoPoint>)
points
PolylineOptions
Параметры полилинии.
PolylineOptions(
points: List<GeoPoint>,
width: LogicalPixel = LogicalPixel(value = 1.0f),
color: Color = Color(),
erasedPart: Double = 0.0,
dashedPolylineOptions: DashedPolylineOptions? = null,
gradientPolylineOptions: GradientPolylineOptions? = null,
visible: Boolean = true,
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
levelId: LevelId? = null,
elevation: Elevation? = null
)
Параметры полилинии.
points
width
color
erasedPart
dashedPolylineOptions
gradientPolylineOptions
visible
userData
zIndex
levelId
elevation
val points
Точки полилинии.
val width
Ширина полилинии.
val color
Основной цвет полилинии.
val erasedPart
Доля стёртой части полилинии, должна быть в диапазоне 0;1
val dashedPolylineOptions
Параметры пунктирной полилинии.
Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.
val gradientPolylineOptions
Параметры градиентной полилинии.
Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.
val visible
Видимость полилинии.
val userData
Пользовательские данные.
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
val zIndex
Уровень отрисовки объекта.
val levelId
Привязка к поэтажному плану здания.
val elevation
Высота полилинии над поверхностью в метрах.
Projection
Проекция.
Используется сферическая проекция Меркатора (EPSG:3857), зацикленная по долготе. Отображаемые данные ограничены по широте от -85.06° до 85.06°.
fun screenToMap(point: ScreenPoint): GeoPoint?
Вычисление точки карты в указанной точке экрана.
Функция возвращает пустое значение, если указанная точка экрана за пределами проекции карты.
fun mapToScreen(point: GeoPoint): ScreenPoint?
Вычисление точки экрана, соответствующей указанной точке карты.
Функция возвращает пустое значение:
fun mapToScreen(point: GeoPointWithElevation): ScreenPoint?
Вычисление точки экрана, соответствующей указанной точке карты с высотой.
Функция возвращает пустое значение:
- point имеет невалидное значение (latitude лежит вне диапазона -90;90, longitude лежит вне диапазона -180;180 или elevation отрицателен).
- если указанная точка карты находится выше плоскости проекции карты на экран.
- если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.
fun screenToMapClipped(point: ScreenPoint): GeoPoint
Вычисление ближайшей точки карты к проекции указанной точки экрана.
fun distanceOnMap(fromPoint: ScreenPoint, toPoint: ScreenPoint): Meter?
Вычисление расстояния между точками на карте, соответствующими указанным точкам на экране, в метрах.
Функция возвращает пустое значение, если одна или обе указанных точки экрана находятся за пределами проекции карты.
fun distanceOnScreen(fromGeoPoint: GeoPoint, toGeoPoint: GeoPoint): LogicalPixel?
Вычисление расстояния между точками на экране, соответствующими указанным точкам на карте, в пикселях.
Функция возвращает пустое значение если одна или обе точки на карте:
PublicBriefRouteInfo
Базовая информация о маршруте на общественном транспорте.
PublicBriefRouteInfo(publicTransportInfos: List<PublicBriefRouteTransportInfo>)
Базовая информация о маршруте на общественном транспорте.
publicTransportInfos
val publicTransportInfos
Описание способов проезда на общественном транспорте.
PublicBriefRouteTransportInfo
Описание общественного транспортного средства.
PublicBriefRouteTransportInfo(
type: PublicTransportType = PublicTransportType.BUS,
names: List<String>,
color: Int?,
routeLogo: String
)
Описание общественного транспортного средства.
val type
Тип общественного транспортного средства.
val names
Названия маршрутов общественного транспорта, на которых происходит проезд.
val color
Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.
val routeLogo
Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.
PublicRoutePart
Описание участка маршрута на общественном транспорте.
PublicRoutePart(transports: List<PublicTransportInfo>, intermediateStops: List<PublicTransportStop>)
Описание участка маршрута на общественном транспорте.
transports
intermediateStops
val transports
Виды общественного транспорта, на котором можно проехать данный участок маршрута.
Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.
val intermediateStops
Промежуточные остановки, которые транспорт проедет прежде, чем доберется до точки пересадки.
Остановки отсортированы в порядке следования по маршруту.
На этих остановках не нужно выходить.
Начальная и конечная остановки не входят в этот список.
PublicTransportCard
Карточка, отображающая информацию о маршруте на общественном транспорте.
PublicTransportCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка, отображающая информацию о маршруте на общественном транспорте.
context
attrs
defStyle
fun onAttachedToWindow(): Unit
var model
PublicTransportCardModel
Модель для PublicTransportCard.
PublicTransportCardModel(
route: TrafficRoute,
context: Context,
startName: String? = null,
finishName: String? = null
)
Модель для PublicTransportCard.
PublicTransportCostInfo
Информация о стоимости проезда на общественном транспорте.
PublicTransportCostInfo(
value: Int = 0,
fraction: Int = 0,
exponent: Int = 0,
currencyCode: String
)
Информация о стоимости проезда на общественном транспорте.
value
fraction
exponent
currencyCode
val value
Стоимость проезда на общественном транспорте в основных единицах валюты, (например, в рублях для РФ).
val fraction
Добавочная стоимость проезда на общественном транспорте в наименьших единицах валюты (например, стоимость в копейках, добавляющаяся к стоимости в рублях для РФ).
val exponent
Степень десятки, обозначающая, сколько наименьших единиц валюты содержится в одной основной единице валюты. Например, в 1 рубле 100 копеек, значит, для рублей значение exponent будет равно 2.
val currencyCode
Трёхбуквенный код валюты по ISO 4217.
PublicTransportDirectoryPlatformDepartureInfo
Справочная информация об отправлении с платформы.
PublicTransportDirectoryPlatformDepartureInfo(platformId: DgisObjectId, departureTime: DayTime = DayTime(hours = 0, minutes = 0))
Справочная информация об отправлении с платформы.
PublicTransportDirectoryRouteDirectionNamesInfo
Информация о наименованиях начальной и конечной остановках маршрута.
PublicTransportDirectoryRouteDirectionNamesInfo(fromName: String, toName: String)
Информация о наименованиях начальной и конечной остановках маршрута.
fromName
toName
PublicTransportDirectoryRouteInfo
Справочная информация о маршруте общественного транспорта.
PublicTransportDirectoryRouteInfo(
id: DgisObjectId,
name: String,
routeType: PublicTransportRouteType,
color: Color?,
fromToStationNames: PublicTransportDirectoryRouteDirectionNamesInfo?,
directions: List<PublicTransportRouteDirection>
)
Справочная информация о маршруте общественного транспорта.
id
name
routeType
color
fromToStationNames
directions
val id
Идентификатор маршрута.
val name
Название маршрута.
val routeType
Тип маршрута.
val color
Цветовое кодирование маршрута.
val fromToStationNames
Информация о наименованиях начальной и конечной остановках маршрута.
val directions
Направления маршрута. Для остановочной платформы (тип ObjectType.StationPlatform) может не содержать информацию о направлениях, которые проходят через платформу. Для получения направлений необходимо сделать поисковой запрос с идентификатором маршрута.
PublicTransportDirectoryRouteScheduleInfo
Справочная информация о расписаниях платформ и направлений на маршруте.
PublicTransportDirectoryRouteScheduleInfo(
fullDayPlatforms: Map,
nearTrips: Map,
intervalTrips: Map
)
Справочная информация о расписаниях платформ и направлений на маршруте.
fullDayPlatforms
nearTrips
intervalTrips
PublicTransportDirectoryScheduleInfo
Справочная информация о расписаниях платформ и направлений.
PublicTransportDirectoryScheduleInfo(
routeSchedules: Map,
fullDayPlatforms: Map,
nearTrips: Map
)
Справочная информация о расписаниях платформ и направлений.
routeSchedules
fullDayPlatforms
nearTrips
val routeSchedules
Справочная информация о расписаниях платформ и направлений для маршрутов.
val fullDayPlatforms
Расписания для платформы по маршутам до конца дня. Поле будет заполнено для объекта типа ObjectType.StationPlatform.
Массив с объектами PublicTransportPlatformSchedule представляет последовательность расписаний, следующих друг за другом. Например:
val nearTrips
Ближайшие рейсы для направлений по маршрутам до конечной платформы. Поле будет заполнено для объекта типа ObjectType.StationPlatform.
PublicTransportInfo
Описание общественного транспортного средства.
PublicTransportInfo(
type: PublicTransportType = PublicTransportType.BUS,
suggestedCarNumbers: List<Int>,
boardingSuggest: String,
color: Int?,
routeLogo: String,
routeInfos: List<PublicTransportRouteInfo>
)
Описание общественного транспортного средства.
type
suggestedCarNumbers
boardingSuggest
color
routeLogo
routeInfos
val type
Тип общественного транспортного средства.
val suggestedCarNumbers
Номера вагонов, в которые рекомендуется посадка.
Если транспортное средство состоит из одного вагона или можно садиться в любой вагон, то этот список будет пустым.
val boardingSuggest
Текстовое описание вагонов, в которые рекомендуется посадка.
val color
Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.
val routeLogo
Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.
val routeInfos
Описания маршрутов общественного транспорта, на которых происходит проезд.
PublicTransportIntervalSchedule
Интервальное расписание.
PublicTransportIntervalSchedule(period: Byte = 0, workHours: PublicTransportIntervalWorkingHours?)
Интервальное расписание.
PublicTransportIntervalWorkingHours
Время действия интервального расписания.
PublicTransportIntervalWorkingHours(
startTime: Long = 0,
startTimeUtc: Long = 0,
finishTime: Long = 0,
finishTimeUtc: Long = 0
)
Время действия интервального расписания.
startTime
startTimeUtc
finishTime
finishTimeUtc
val startTime
Время начала действия интервального расписания (в локальном для объекта часовом поясе) в системе UNIX.
val startTimeUtc
Время начала действия интервального расписания в системе UNIX по UTC.
val finishTime
Время окончания действия интервального расписания (в локальном для объекта часовом поясе) в системе UNIX.
val finishTimeUtc
Время окончания действия интервального расписания в системе UNIX по UTC.
PublicTransportNearTripSchedule
Интервальное расписание.
PublicTransportNearTripSchedule(period: Byte?, platformTimes: List<PublicTransportDirectoryPlatformDepartureInfo>)
Интервальное расписание.
period
platformTimes
PublicTransportPlatform
Справочная информация об остановочной платформе.
PublicTransportPlatform(
id: DgisObjectId,
stationId: DgisObjectId,
name: String,
description: String?,
transitions: List<PublicTransportPlatformTransition>,
position: GeoPoint?
)
Справочная информация об остановочной платформе.
id
stationId
name
description
transitions
position
val id
Идентификатор остановочной платформы.
val stationId
Идентификатор остановки. Например, автобусная остановка или станция метро, на которой находится платформа, или любая другая остановка.
val name
Название остановки.
val description
Краткое описание места расположения остановочной платформы.
val transitions
Справочная информация о других маршрутах общественного транспорта, на которые можно пересесть на данной остановочной платформе.
val position
Позиция.
PublicTransportPlatformSchedule
Расписание платформы.
PublicTransportPlatformSchedule(
schedule: PublicTransportSchedule,
startTime: Long = 0,
startTimeUtc: Long = 0
)
Расписание платформы.
PublicTransportPlatformTransition
Справочная информация о маршруте общественного транспорта, на который можно пересесть на остановочной платформе.
PublicTransportPlatformTransition(
routeId: DgisObjectId,
routeName: String,
routeType: PublicTransportRouteType,
color: Color?,
stationId: DgisObjectId,
stationName: String
)
Справочная информация о маршруте общественного транспорта, на который можно пересесть на остановочной платформе.
routeId
routeName
routeType
color
stationId
stationName
PublicTransportPreciseSchedule
Точное расписание проезда общественного транспорта через платформу.
PublicTransportPreciseSchedule(
preciseTime: DayTime,
nextTrips: List<Long>,
nextTripsUtc: List<Long>
)
Точное расписание проезда общественного транспорта через платформу.
PublicTransportRouteDirection
Направление маршрута общественного транспорта.
PublicTransportRouteDirection(
id: PublicTransportRouteDirectionId,
type: PublicTransportRouteDirectionType,
geometry: PublicTransportRouteGeometry?,
platforms: List<PublicTransportPlatform>
)
Направление маршрута общественного транспорта.
id
type
geometry
platforms
PublicTransportRouteDirectionId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
PublicTransportRouteDirectionId(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
PublicTransportRouteGeometry
Геометрия направления маршрута общественного транспорта.
PublicTransportRouteGeometry(line: PolylineGeometry, centroid: GeoPoint?)
Геометрия направления маршрута общественного транспорта.
PublicTransportRouteInfo
Описание маршрута общественного транспорта.
PublicTransportRouteInfo(
name: String,
directionName: String,
lastPlatformName: String,
costInfo: PublicTransportCostInfo?,
traversalType: TraversalType?
)
Описание маршрута общественного транспорта.
name
directionName
lastPlatformName
costInfo
traversalType
PublicTransportRouteSearchOptions
Параметры поиска маршрута на общественном транспорте.
PublicTransportRouteSearchOptions(
startTime: TimePoint? = null,
useSchedule: Boolean = false,
transportTypes: EnumSet<PublicTransportType> = EnumSet.noneOf(PublicTransportType::class.java),
quickFilter: PublicTransportQuickFilter? = null
)
Параметры поиска маршрута на общественном транспорте.
startTime
useSchedule
transportTypes
quickFilter
val startTime
Время в UTC, на которое нужно построить маршрут. Если не задано, используется текущее время.
val useSchedule
Учёт расписания движения общественного транспорта при построении маршрута.
val transportTypes
Типы общественного транспорта. Если не заполнены, маршруты будут строиться для всех поддерживаемых типов общественного транспорта.
val quickFilter
Быстрый фильтр для общественного транспорта. Если заполнен, то при поиске маршрута имеет приоритет над другими параметрами поиска.
PublicTransportSchedule
Расписание следования транспорта.
PublicTransportSchedule(intervalSchedule: PublicTransportIntervalSchedule)
intervalSchedule
PublicTransportSchedule(preciseSchedule: PublicTransportPreciseSchedule)
preciseSchedule
fun match(intervalSchedule: Function1, preciseSchedule: Function1): T
intervalSchedule
preciseSchedule
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
PublicTransportStop
Описание остановки общественного транспорта.
PublicTransportStop(name: String, coordinates: GeoPoint)
Описание остановки общественного транспорта.
PublicTransportTransfer
Описание способа добраться на общественном транспорте до следующей точки пересадки.
PublicTransportTransfer(
startPointName: String,
finishPointName: String,
routeParts: List<PublicRoutePart>
)
Описание способа добраться на общественном транспорте до следующей точки пересадки.
startPointName
finishPointName
routeParts
val startPointName
Название точки, из которой начинается движение для данного участка маршрута.
val finishPointName
Название точки назначения для данного участка маршрута.
val routeParts
Описание участка маршрута на общественном транспорте, по которому можно добраться до следующей точки пересадки.
Все участки маршрута из этого списка проходят по одной и той же линии геометрии.
Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.
PublicTransportTransferRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): PublicTransportTransferRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<PublicTransportTransferRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
PublicTransportTransferRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
PublicTransportTransferRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: PublicTransportTransfer
)
Протяженный элемент маршрута - отрезок и значение на нем.
PurposeCode
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
PurposeCode(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
RadarApiSettings
Настройки для работы с Radar API
Sealed класс, представляющий два возможных состояния:
RadarHttpResponse
Модель ответа от HTTP-запроса к Radar API
RadarHttpResponse(code: Int, body: String)
Модель ответа от HTTP-запроса к Radar API
code
body
Range
Описывает набор непрерывных или дискретных упорядоченных значений.
fun match(borders: Function1, orderedValues: Function1): T
borders
orderedValues
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
RangeFilter
Фильтр диапазонов значений.
RangeFilter(
tagName: String,
displayName: String,
minValue: Double,
maxValue: Double
)
Фильтр диапазонов значений.
tagName
displayName
minValue
maxValue
RangeWidget
Виджет для представления непрерывного или дискретного набора упорядоченных значений.
fun setValues(min: Double, max: Double): Unit
Установка текущих выбранных значений.
min
текущее минимальное значение.
max
текущее максимальное значение.
RasterTileSource
Источник, получающий растровые тайлы.
RasterTileSource(
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
Шаблон для запроса тайлов.
fun setOpacity(opacity: Opacity): Unit
Установка значения прозрачности растрового тайла.
RasterUrlTemplate
RasterUrlTemplate(defaultSource: DefaultRasterUrlTemplate)
defaultSource
fun match(defaultSource: Function1, wmsSource: Function1): T
defaultSource
wmsSource
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
RemainingRouteInfoControl
Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.
Remover
Объект для удаления пользовательского контента.
fun remove(): Future<ActionResult>
Удаление контента.
действие доступно для контента, автором которого является пользователь.
RenderedObject
Отображаемый объект карты.
RenderedObjectInfo
Подробная информация об отображаемом объекте карты.
RenderedObjectInfo(
closestViewportPoint: ScreenPoint,
closestMapPoint: GeoPointWithElevation,
item: RenderedObject
)
Подробная информация об отображаемом объекте карты.
Reviews
Отзывы.
Reviews(
rating: Float = 0.0f,
count: Int = 0,
countWithStars: Int = 0
)
Отзывы.
rating
count
countWithStars
RoadCameraInfo
Информация о камере.
RoadCameraInfo(purposes: EnumSet<CameraPurpose>, speedLimit: Short?)
Информация о камере.
purposes
speedLimit
val purposes
Назначения камеры.
Могут отсутствовать, если нет информации, или если камеру добавил пользователь.
val speedLimit
Ограничение скорости в км/ч.
На текущий момент доступно только для камер, контролирующих скорость и среднюю скорость на участке.
Может отсутствовать и для камер контроля скорости, если значение неизвестно.
RoadEvent
Дорожное событие.
val type
Тип события.
val id
Идентификатор события.
val name
Локализованное название события.
val author
Информация о пользователе, добавившем событие.
val timestamp
Временная метка создания события.
val location
Координаты события.
val elevation
Высота дорожного события.
val description
Пользовательское описание дорожного события.
val cameraInfo
Информация о камере.
Доступна только для событий типа "Camera".
val schedule
Расписание.
На текущий момент доступно только для перекрытий, и даже для них может отсутствовать.
val lanes
Затронутые событием полосы.
На текущий момент могут быть проставлены только у пользовательских событий.
val availableActions
Список доступных действий с событием.
val remover
Получение объекта для удаления события.
RoadEventAction
Действие события.
fun set(): Future<ActionResult>
Применение действия (например, добавление отметки "нравится", подтверждение события).
Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода сбрасывает применение противоположного - невозможно одновременно поставить "нравится" и "не нравится".
fun reset(): Future<ActionResult>
Отмена действия (например, сброс отметки "нравится", сброс подтверждения события).
Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода не вызывает применение противоположного действия.
RoadEventActionButton
Кнопка действия над дорожным событием (подтвердить, поставить "нравится" и т.д.).
RoadEventActionButton(model: RoadEventActionButtonModel, context: Context)
Кнопка действия над дорожным событием (подтвердить, поставить "нравится" и т.д.).
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
val model
RoadEventActionInfo
Информация о действии.
RoadEventActionInfo(state: RoadEventActionState, count: Int?)
Информация о действии.
RoadEventCard
Карточка, отображающая информацию о дорожном событии.
RoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка, отображающая информацию о дорожном событии.
context
attrs
defStyle
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
RoadEventCardModel
Модель карточки дорожного события.
RoadEventCardModel(
event: RoadEvent,
photoSize: StatefulChannel<ScreenSize>,
context: Context
)
Модель карточки дорожного события.
fun close(): Unit
val name
Название, например, "Перекрытие".
val description
Описание, например, "Ремонтные работы".
val lanes
Затронутые событием полосы, например, "Левый ряд, средний ряд".
val schedule
Расписание, например, "10 октября 08:00 – 15 октября 23:30".
val creationTime
Время создания, например, "5 часов назад", "5 августа", "10 декабря 2020 г".
val author
Автор, например, "2ГИС".
val photoChannel
Фотография.
val actionCompletedChannel
Уведомление о завершении действия.
val removeCompletedChannel
Уведомление о завершении удаления события.
val actions
Действия.
RoadEventFilterData
Данные о дорожном событии, используемые для фильтрации.
RoadEventFilterData(
startTime: TimePoint?,
finishTime: TimePoint?,
type: RoadEventType
)
Данные о дорожном событии, используемые для фильтрации.
RoadEventManager
Объект для создания транспортных событий.
fun createAccident(
location: GeoPoint,
lanes: EnumSet<Lane>,
description: String
): Future<AddEventResult>
Создание события "ДТП".
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
fun createCamera(location: GeoPoint, description: String): Future<AddEventResult>
Создание события "Камера".
location
Местоположение события.
description
Пользовательское описание события.
fun createRoadRestriction(location: GeoPoint, description: String): Future<AddEventResult>
Создание события "Перекрытие дорожного движения".
location
Местоположение события.
description
Пользовательское описание события.
fun createComment(location: GeoPoint, description: String): Future<AddEventResult>
Создание события "Комментарий".
location
Местоположение события.
description
Пользовательское описание события.
fun createOther(
location: GeoPoint,
lanes: EnumSet<Lane>,
description: String
): Future<AddEventResult>
Создание события "Другое".
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
fun createRoadWorks(
location: GeoPoint,
lanes: EnumSet<Lane>,
description: String
): Future<AddEventResult>
Создание события "Дорожные работы".
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
@JvmStatic
fun instance(context: Context): RoadEventManager
Получение объекта для создания дорожных событий.
RoadEventMapObject
Объект карты "Дорожное событие".
RoadEventMapObjectRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventMapObjectRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RoadEventMapObjectRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RoadEventMapObjectRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RoadEventMapObjectRouteEntry
Элемент маршрута - точка и значение в ней.
RoadEventMapObjectRouteEntry(point: RoutePoint, value: RoadEventMapObject)
Элемент маршрута - точка и значение в ней.
RoadEventPhoto
Фотография дорожного события.
fun previewUrl(desiredSize: ScreenSize): String
URL превью фотографии.
fun report(): Future<ActionResult>
Отправка жалобы на фотографию.
жалоба на свою фотографию ни к чему не приведёт.
RoadEventRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RoadEventRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RoadEventRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RoadEventRouteEntry
Элемент маршрута - точка и значение в ней.
RoadEventRouteEntry(point: RoutePoint, value: BriefRoadEvent)
Элемент маршрута - точка и значение в ней.
RoadEventSource
Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.
RoadEventSource(context: Context)
Создание источника, отображающего дорожные события на карте.
context
fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit
Установка или снятие выделения дорожных событий.
добавляет событию атрибут "selected", который можно использовать в стилях.
directoryObjectIds
Идентификаторы изменяемых событий. Можно получить из RoadEventMapObject.
highlighted
Установка или снятие выделения.
RoadRuleRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadRuleRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadRuleRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
RoadRuleRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadRuleRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadRule
)
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSubtypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadSubtypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSubtypeRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
RoadSubtypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSubtypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadSubtype
)
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSurfaceRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadSurfaceRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSurfaceRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
RoadSurfaceRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSurfaceRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadSurface
)
Протяженный элемент маршрута - отрезок и значение на нем.
RoadTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadTypeRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
RoadTypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadTypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadType
)
Протяженный элемент маршрута - отрезок и значение на нем.
RotateMapToNorthEvent
RotationGestureSettings
Настройки жеста вращения.
RotationKinematicSettings
RotationKinematicSettings(
enabled: Boolean = true,
decelerationCoefficient: Float = 10.0f,
maxInitialForwardAngularSpeed: Float = 5.0f,
initialBackwardAngularSpeed: Float = 0.40000001f,
angleThreshold: Float = 0.050000001f
)
enabled
decelerationCoefficient
maxInitialForwardAngularSpeed
initialBackwardAngularSpeed
angleThreshold
val enabled
Включает или отключает кинематику вращения. Если установлено в false, вращение мгновенно останавливается после окончания жеста, все остальные параметры игнорируются.
val decelerationCoefficient
Коэффициент затухания вращения после окончания жеста. Чем выше значение, тем быстрее замедляется вращение.
val maxInitialForwardAngularSpeed
Максимальная начальная угловая скорость после окончания жеста (в радианах в секунду).
val initialBackwardAngularSpeed
Начальная угловая скорость возврата карты в исходное положение (в радианах в секунду).
val angleThreshold
Порог углового отклонения (в радианах), при превышении которого карта продолжает вращение в направлении жеста. Если меньше — движется в сторону исходного положения.
RotationRecognizeSettings
Настройки распознавания вращения.
RotationRecognizeSettings(rotationThreshold: RotationRecognizeThresholds, rotationThresholdInScaling: RotationRecognizeThresholds)
Настройки распознавания вращения.
RotationRecognizeThresholds
RotationRecognizeThresholds(angleDiffDeg: Float = 5.0f, distanceDiffMm: Float = 5.0f)
angleDiffDeg
distanceDiffMm
Route
Класс, описывающий маршрут. Маршрут представляет собой набор атрибутов, каждый из которых представляет собой контейнер типа RouteAttribute или RouteLongAttribute, в котором хранятся элементы атрибутов маршрута. Атрибуты маршрута делятся на точечные и протяженные. Точечные атрибуты (например, точки геометрии или лежачие полицейские) задаются в виде пары из RoutePoint и значения атрибута. Протяженные атрибуты (например, ширина проезжей части или ограничение скорости) задаются в виде пары из RoutePoint, которая указывает на начало действия атрибута и значения атрибута. В конце маршрута ставится терминатор. Например, пусть ширина проезжей части задана в виде набора пар {{0m, 3m}, {10m, 7m}, {20m, 5m}, {30m, 0m}}, тогда первые 10 метров маршрута проезжая часть имеет ширину 3 метра, на интервале [10м., 20м.) - 7м., с 20м. до конца маршрута - 5м.
val geometry
Геометрия маршрута.
Не гарантируется, что RoutePoint у точек геометрии будет совпадать с RoutePoint у элементов других атрибутов, поэтому для того, чтобы вычислить географическую координату у элемента атрибута, не нужно искать в геометрии элемент, RoutePoint которого совпадает с RoutePoint элемента атрибута, вместо этого нужно воспользоваться функцией calculate_geo_point.
val instructions
Инструкции, которые необходимо выполнить для движения по маршруту.
val intermediatePoints
Промежуточные точки, через которые проходит маршрут. Маршрут может проходить не прямо через промежуточную точку, а рядом с ней. В значении атрибута хранится координата, в которую была установлена промежуточная точка, в ключе - координата проекции промежуточной точки на маршрут.
val altitudes
Высоты на маршруте.
val badRoads
Плохая дорога (на дороге присутствуют кочки и ямы, которые препятствуют проезду).
val obstacles
Препятствия на маршруте.
val roadNames
Названия дорог/улиц.
val settlements
Признак того, что участок маршрута проходит по населённому пункту.
val transportTypes
Вид транспорта, для которого построен участок маршрута.
val crossingTypes
val tollPaymentPointInfos
val cameras
Дорожные камеры.
val carriagewaysWidth
Ширина проезжей части в метрах. 0 - ширина неизвестна.
val exitSigns
Знаки съездов.
val humps
Искусственные неровности.
val lanes
Полосы движения.
val levels
Этажи зданий.
val maxSpeedLimits
Ограничения максимальной допустимой скорости.
0 - ограничение скорости неизвестно.
val roadRules
Сторона движения.
val roadSubtypes
Дополнительное описание типа дороги, по которой пролегает маршрут.
val roadSurfaces
Покрытие дороги.
val roadTypes
Тип дороги, по которой пролегает маршрут.
val tolls
Участки маршрута, пролегающие по платным дорогам.
val truckData
Признак наличия или отсутствия данных для грузовой навигации.
val truckPassZoneIds
Пропускные зоны для грузового транспорта.
val truckRestrictedAreas
Признак действия знака запрета проезда грузового транспорта.
val vehicleRestrictedAreas
Признак действия знака запрета проезда любого автотранспорта (перекрытия).
val bicycleLanes
Признак наличия выделенной велополосы.
val trafficLights
Признак наличия светофоров.
val immersiveData
Признак наличия данных для иммерсивных дорог (т.е. дорог, которые на карте могут быть отрисованы с широким дорожным полотном и разметкой).
val immersiveHeights
Иммерсивные высоты и уровни. Ожидается, что заполены и учитываются там, где есть иммерсивные дороги, см. immersive_data().
val publicTransportTransfers
Описание способов перемещения на общественном транспорте между точками пересадок.
RouteAltitudeItem
Элемент высоты на маршруте для графика высот.
RouteAltitudeItem(altitude: Double = 0.0, altitudeChange: AltitudeChange = AltitudeChange.UNDEFINED)
Элемент высоты на маршруте для графика высот.
RouteBuildOptions
Структура, которая описывает параметры построения маршрута в навигаторе.
RouteCamera
Структура, описывающая дорожную камеру.
RouteCamera(
purposes: EnumSet<RouteCameraPurpose>,
rangeAgainst: RouteDistance,
rangeAlong: RouteDistance,
direction: RouteCameraDirection = RouteCameraDirection.AGAINST,
maxSpeedLimit: Float?,
mobility: Boolean = false
)
Структура, описывающая дорожную камеру.
purposes
rangeAgainst
rangeAlong
direction
maxSpeedLimit
mobility
val purposes
Назначения камеры.
val rangeAgainst
Дальность действия камеры против хода движения.
val rangeAlong
Дальность действия камеры по ходу движения.
val direction
Направление действия камеры.
val maxSpeedLimit
Скорость, превышение которое фиксируется камерой, в м/с. Отсутствует, если камера не фиксирует превышение скорости.
val mobility
Флаг, указывающий на мобильность камеры.
RouteDistance
Расстояние вдоль маршрута.
RouteDistance(millimeters: Long = 0)
Расстояние вдоль маршрута.
millimeters
fun absoluteValue(): RouteDistance
operator fun plus(other: RouteDistance): RouteDistance
operator fun minus(other: RouteDistance): RouteDistance
RouteEditor
Интерфейс для редактора маршрута. Редактор маршрута получает точки начала и конца маршрута, строит маршруты и через каналы оповещает об их обновлениях и перестроениях.
Все методы этого интерфейса вызываются из одного потока.
RouteEditor(context: Context, trafficRouter: TrafficRouter? = null)
Функция создания редактора маршрута.
context
Контекст.
trafficRouter
Поисковик маршрута для использования внутри редактора маршрута. Если не задан, по умолчанию используется гибридный поисковик.
fun setRouteParams(routeParams: RouteEditorRouteParams): Unit
Установка параметров редактора маршрута. Запускает поиск нового маршрута согласно переданным параметрам.
fun setActiveRouteIndex(index: RouteIndex): Unit
Установка индекса активного маршрута.
val routesInfoChannel
Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.
val routesInfo
Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.
val activeRouteIndexChannel
Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается null.
val activeRouteIndex
Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается null.
RouteEditorRouteParams
Информация о параметрах маршрута.
RouteEditorRouteParams(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: List<RouteSearchPoint> = listOf()
)
Информация о параметрах маршрута.
startPoint
finishPoint
routeSearchOptions
intermediatePoints
RouteEditorRoutesInfo
Информация о маршрутах, которыми оперирует редактор.
RouteEditorRoutesInfo(
routes: List<TrafficRoute>,
error: RouterErrorInfo?,
routeParams: RouteEditorRouteParams,
availablePublicTransportQuickFilters: EnumSet<PublicTransportQuickFilter>
)
Информация о маршрутах, которыми оперирует редактор.
routes
error
routeParams
availablePublicTransportQuickFilters
val routes
При обновлении списка маршрутов активным будет первый маршрут, если список маршрутов непустой.
val error
Информация об ошибке поиска, если поиск маршрута завершается с ошибкой.
val routeParams
Параметры маршрута, для которых выполнялся поиск. Могут отличаться от параметров, переданных редактору, если маршруты были найдены уже после изменения параметров в редакторе.
val availablePublicTransportQuickFilters
Для маршрутов на общественном транспорте: список быстрых фильтров, применимых к текущему набору маршрутов.
RouteEditorSource
Интерфейс класса, управляющего отображением маршрутов на карте.
RouteEditorSource(
context: Context,
routeEditor: RouteEditor,
activeDisplayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
inactiveDisplayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
activeCalloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
inactiveCalloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.ABSOLUTE_VALUES,
activePermanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null,
inactivePermanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null
)
Функция создания IRouteEditorSource.
context
routeEditor
activeDisplayFlags
inactiveDisplayFlags
activeCalloutLabelFlags
inactiveCalloutLabelFlags
calloutLabelDisplayMode
activePermanentDisplayFlags
inactivePermanentDisplayFlags
fun setRoutesVisible(visible: Boolean): Unit
Включить или выключить отображение маршрутов на карте.
visible
fun setShowOnlyActiveRoute(showOnlyActiveRoute: Boolean): Unit
Отображать на карте все маршруты (false) или только текущий активный маршрут (true).
showOnlyActiveRoute
fun setPassedDistanceVisualization(passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization): Unit
Изменить способ визуализации расстояния, пройденного вдоль маршрута.
val objects
Объекты маршрута на карте.
val 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.
RouteEnclosingRectsOptions
Параметры для получения набора прямоугольников, описанных вокруг упрощённой геометрии маршрута.
RouteEnclosingRectsOptions(
offset: Double = 0.0,
segmentSize: RouteDistance,
maxSliceSize: Long? = null,
maxArea: Double? = null
)
Параметры для получения набора прямоугольников, описанных вокруг упрощённой геометрии маршрута.
val offset
Отступ влево/вправо от линии, аппроксимирующей геометрию маршрута, в метрах. Должен быть ненулевой положительной величиной.
val segmentSize
Размер одного сегмента ломаной линии, аппроксимирующей геометрию маршрута. Должен быть положительным.
val maxSliceSize
Максимальное количество прямоугольников входящих в одну геометрию.
val maxArea
Максимальная сумма площадей прямоугольников в квадратных километрах входящих в одну геометрию.
RouteExitSign
Информация о знаке съезда.
RouteExitSign(
type: RouteExitSignType = RouteExitSignType.UNDEFINED,
roadNameTable: RouteExitSignTable,
roadNumberTable: RouteExitSignTable?
)
Информация о знаке съезда.
RouteExitSignRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteExitSignRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RouteExitSignRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RouteExitSignRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RouteExitSignRouteEntry
Элемент маршрута - точка и значение в ней.
RouteExitSignRouteEntry(point: RoutePoint, value: RouteExitSign)
Элемент маршрута - точка и значение в ней.
RouteExitSignTable
Информация о табличке съезда.
RouteExitSignTable(backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.UNDEFINED, text: String)
Информация о табличке съезда.
RouteImmersiveHeights
Значения высот и уровней для иммерсивных участков дорожного графа.
RouteImmersiveHeights(
zLevelBegin: Int = 0,
zLevelEnd: Int = 0,
relativeHeightBegin: Double? = null,
relativeHeightEnd: Double? = null
)
Значения высот и уровней для иммерсивных участков дорожного графа.
zLevelBegin
zLevelEnd
relativeHeightBegin
relativeHeightEnd
RouteImmersiveHeightsRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RouteImmersiveHeightsRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteImmersiveHeightsRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
RouteImmersiveHeightsRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RouteImmersiveHeightsRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RouteImmersiveHeights
)
Протяженный элемент маршрута - отрезок и значение на нем.
RouteIndex
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
RouteIndex(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
RouteInfo
Описание маршрута с манёврами.
val route
Маршрут.
val routeBuildOptions
Параметры построения маршрута в навигаторе. Значение равное null означает, что у маршрута отсутствует конечная точка. В этом случае, на основании дорожного графа и параметров движения пользователя, вычисляется участок дороги, по которому предположительно движется пользователь и возвращается в виде маршрута в поле route. Следовательно, такой "маршрут" не может содержать инструкции и последняя точка в этом "маршруте" не является точкой назначения, в которую движется пользователь, а просто является точкой, до которой удалось предугадать движение пользователя. Куда он поедет дальше - неизвестно. Такой режим работы навигатора называется режим ведения без маршрута или free roam.
val external
Источник маршрута. True - маршрут передан навигатору снаружи в методе start. False - маршрут сгенерирован самим навигатором.
RouteInfoCalloutMapObject
Объект бабла с информацией о длине и/или длительности маршрута на карте.
RouteInstruction
Инструкция, которую необходимо выполнить для движения по маршруту.
RouteInstruction(
roadName: String,
range: RouteDistance,
extraInstructionInfo: ExtraInstructionInfo
)
Инструкция, которую необходимо выполнить для движения по маршруту.
val roadName
Название дороги, на которой окажется пользователь после совершения манёвра.
val range
Расстояние после точки инструкции, на протяжении которого считается, что пользователь находится в зоне действия инструкции.
val extraInstructionInfo
Специфичная для конкретного типа инструкции информация.
RouteLane
Структура, описывающая одну полосу движения.
RouteLane(
routeManeuver: RouteLaneManeuver = RouteLaneManeuver.UNDEFINED,
maneuvers: EnumSet<RouteLaneManeuver>,
speedLimit: Float = 0.0f,
prohibited: Boolean = false,
onlyPublicTransport: Boolean = false
)
Структура, описывающая одну полосу движения.
routeManeuver
maneuvers
speedLimit
prohibited
onlyPublicTransport
val routeManeuver
Манёвр, который необходимо совершить для движения по маршруту.
val maneuvers
Допустимые манёвры на полосе.
val speedLimit
Максимальная разрешенная скорость на полосе, м/с. 0 - ограничение скорости неизвестно.
val prohibited
Проезд по полосе запрещён.
val onlyPublicTransport
Полоса для общественного транспорта.
RouteLaneSign
Описание полос движения.
RouteLaneSign(
lanes: List<RouteLane>,
signStartPoint: RoutePoint?,
signPoint: RoutePoint?,
signEndPoint: RoutePoint?
)
Описание полос движения.
val lanes
Полосы движения для автомобилей на участке дороги. Перечислены в порядке следования от середины проезжей части к обочине.
Если количество полос неизвестно либо в направлении маршрута на дороге находится одна полоса движения, то этот массив будет пустым.
val signStartPoint
Точка на маршруте, в которой начинается действие знака, регулирующего движение по полосам. null, если положение начала действия знака неизвестно.
val signPoint
Точка на маршруте, в которой установлен знак, регулирующий движение по полосам. null, если положение знака неизвестно.
val signEndPoint
Точка на маршруте, в которой заканчивается действие знака, регулирующего движение по полосам. null, если положение окончания действия знака неизвестно.
RouteLevelInfo
Информация об этаже здания, соответствующая участку маршрута.
val beginId
Идентификатор этажного плана в начальной точке участка маршрута. Отсутствует, если точка не находится в здании.
val endId
Идентификатор этажного плана в конечной точке участка маршрута. Отсутствует, если точка не находится в здании.
val name
Название этажа. Пусто, если участок маршрута соединяет разные этажи.
RouteLevelInfoRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RouteLevelInfoRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteLevelInfoRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
RouteLevelInfoRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RouteLevelInfoRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RouteLevelInfo
)
Протяженный элемент маршрута - отрезок и значение на нем.
RouteMapObject
Объект маршрута на карте.
RouteMapObject(
trafficRoute: TrafficRoute,
isActive: Boolean,
index: RouteIndex,
displayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
calloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.ABSOLUTE_VALUES,
permanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null
)
trafficRoute
isActive
index
displayFlags
calloutLabelFlags
calloutLabelDisplayMode
permanentDisplayFlags
val displayFlagsChannel
Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.
var displayFlags
Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.
val permanentDisplayFlagsChannel
Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.
var permanentDisplayFlags
Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.
val isActiveChannel
Статус активности маршрута.
var isActive
Статус активности маршрута.
val route
Маршрут.
val routeIndex
Индекс маршрута в редакторе маршрута.
val passedDistanceChannel
Пройденное расстояние вдоль маршрута.
var passedDistance
Пройденное расстояние вдоль маршрута.
val passedDistanceVisualizationChannel
var passedDistanceVisualization
val calloutPositionChannel
Положение бабла маршрута.
val calloutPosition
Положение бабла маршрута.
val calloutLabelFlagsChannel
Набор флагов для отображения содержимого баблов маршрута. Набор флагов для отображения содержимого баблов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.
var calloutLabelFlags
Набор флагов для отображения содержимого баблов маршрута. Набор флагов для отображения содержимого баблов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.
val calloutLabelDisplayModeChannel
Режим отображения значений в баблах маршрута. По умолчанию значения отображаются в виде абсолютных величин.
var calloutLabelDisplayMode
Режим отображения значений в баблах маршрута. По умолчанию значения отображаются в виде абсолютных величин.
val roadEventObjectsChannel
Отображаемые на карте объекты дорожных событий вдоль маршрута.
val roadEventObjects
Отображаемые на карте объекты дорожных событий вдоль маршрута.
RouteMapObjectSource
Источник объектов маршрута на карте.
RouteMapObjectSource(context: Context, routeVisualizationType: RouteVisualizationType = RouteVisualizationType.NORMAL)
Функция создания IRouteMapObjectSource.
fun addObject(item: RouteMapObject): Unit
Добавление объекта маршрута в источник.
fun removeObject(item: RouteMapObject): Unit
Удаление объекта маршрута из источника.
fun replaceObject(oldObject: RouteMapObject, newObject: RouteMapObject): Unit
Замена одного объекта маршрута в источнике на другой. В отличие от удаления и добавления объектов маршрута через последовательные вызовы remove_object и add_object замена одного маршрута на другой выполняется атомарно - старый маршрут удаляется, а новый появляется на карте одновременно.
Если старый маршрут не найден в источнике, то вызов эквивалентен вызову add_object.
fun clear(): Unit
Удаление всех объектов маршрута из источника.
fun replaceAllObjects(objects: List<RouteMapObject>): Unit
Замена всех ранее добавленных в источник объектов на передаваемый список объектов. В отличие от удаления и добавления объектов по одному замена выполняется атомарно - старые маршруты удаляются, а новые маршруты появляются на карте одновременно.
objects
RouteMapObjectsProvider
Интерфейс для получения объектов маршрута на карте.
RouteMapSettings
Настройки отображения маршрута на карте.
var onRouteDisplayFlags
Флаги отображения маршрута на карте для режима ведения по маршруту. По умолчанию включены все флаги, за исключением флага InactiveFloors.
var freeRoamDisplayFlags
Флаги отображения маршрута на карте для режима free roam. По умолчанию включены флаги Cameras, Humps, Accidents, RoadWorks, Comments, RoadRestrictions, OtherEvents.
var onRoutePermanentDisplayFlags
Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима ведения по маршруту. По умолчанию скрываются все элементы маршрута.
var freeRoamPermanentDisplayFlags
Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима free roam. По умолчанию скрываются все элементы маршрута.
RouteOverviewControl
UI-элемент, отображаемый в режиме просмотра маршрута.
RoutePoint
Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.
RoutePoint(distance: RouteDistance)
Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.
distance
operator fun plus(distance: RouteDistance): RoutePoint
operator fun minus(distance: RouteDistance): RoutePoint
val distance
RoutePointMapObject
Точечный объект, являющийся частью маршрута на карте (например, точка начала или конца маршрута).
val route
Маршрут, часть которого представляет данный точечный объект.
val routeIndex
Индекс маршрута.
val kind
Тип точечного объекта маршрута.
val routePoint
Позиция на маршруте, соответствующая данному точечному объекту.
val pointChannel
Географические координаты, в которых находится данный точечный объект.
var point
Географические координаты, в которых находится данный точечный объект.
RouteRebuilder
Контроллер поиска нового маршрута при сходе с текущего маршрута.
var enabled
RouterErrorInfo
Информация об ошибке поисковика маршрута.
RouterErrorInfo(source: RouterErrorSource = RouterErrorSource.HYBRID_ROUTER, code: RouterErrorCode = RouterErrorCode.INTERNAL_ERROR)
Информация об ошибке поисковика маршрута.
RouteSearchOptions
Параметры поиска маршрута.
RouteSearchOptions(motorcycle: MotorcycleRouteSearchOptions)
motorcycle
RouteSearchOptions(pedestrian: PedestrianRouteSearchOptions)
pedestrian
RouteSearchOptions(publicTransport: PublicTransportRouteSearchOptions)
publicTransport
fun match(
bicycle: Function1,
car: Function1,
motorcycle: Function1,
pedestrian: Function1,
publicTransport: Function1,
scooter: Function1,
taxi: Function1,
truck: Function1
): T
bicycle
car
motorcycle
pedestrian
publicTransport
scooter
taxi
truck
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
val isBicycle
val asBicycle
val isCar
val asCar
val isMotorcycle
val asMotorcycle
val isPedestrian
val asPedestrian
val isPublicTransport
val asPublicTransport
val isScooter
val asScooter
val isTaxi
val asTaxi
val isTruck
val asTruck
val value
RouteSearchPoint
Описание точек, по которым строится маршрут.
RouteSearchPoint(
coordinates: GeoPoint,
course: Bearing? = null,
objectId: DgisObjectId = DgisObjectId(objectId = 0, entranceId = 0),
levelId: LevelId? = null
)
Описание точек, по которым строится маршрут.
RouteSourceSettings
Настройки источника маршрута.
fun getLargeScaleMergeDistanceMeters(transportType: TransportType): Float
Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба. Если расстояние меньше заданного, то стрелки объединяются.
fun setLargeScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit
Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба.
distance
Расстояние в метрах.
transportType
Тип транспорта, для которого устанавливается расстояние.
fun getSmallScaleMergeDistanceMeters(transportType: TransportType): Float
Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба. Если расстояние меньше заданного, то стрелки объединяются.
fun setSmallScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit
Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба.
distance
Расстояние в метрах.
transportType
Тип транспорта, для которого устанавливается расстояние.
fun getLargeScaleCrossroadsOffsetMeters(transportType: TransportType): Float
Смещение в метрах от точки перекрестка до начала и конца стрелки манёвра для крупного масштаба.
fun setLargeScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit
Установить смещение в метрах от точки перекрестка до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.
offset
Смещение в метрах.
transportType
Тип транспорта, для которого устанавливается смещение.
fun getSmallScaleCrossroadsOffsetMeters(transportType: TransportType): Float
Смещение от точки перекрестка до начала и конца стрелки манёвра для мелкого масштаба.
fun setSmallScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit
Установить смещение от точки перекрестка до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.
offset
Смещение в метрах.
transportType
Тип транспорта, для которого устанавливается смещение.
var largeScaleRingroadOffsetMeters
Смещение от точки съезда с кольца до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.
var smallScaleRingroadOffsetMeters
Смещение от точки съезда с кольца до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.
var calloutVisualizationMode
Режим отображения баблов со временем и длиной маршрута.
RouteSummary
fun match(
bicycle: Function1,
car: Function1,
motorcycle: Function1,
pedestrian: Function1,
scooter: Function1
): T
bicycle
car
motorcycle
pedestrian
scooter
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
RouteSummaryProvider
Провайдер сводной информации по маршруту.
RouteSummaryProvider()
Создание объекта для получения сводной информации по маршруту.
fun routeSummary(trafficRoute: TrafficRoute): RouteSummary?
Получить сводную информацию по маршруту.
trafficRoute
Маршрут, для которого требуется получить сводную информацию.
RouteTollPaymentInfo
Информация о стоимости проезда по платному участку маршрута.
RouteTollPaymentInfo(currencyCode: String, cost: Float = 0.0f)
Информация о стоимости проезда по платному участку маршрута.
currencyCode
cost
RouteTollPaymentPointInfo
Информация о пункте оплаты проезда платной дороги.
RouteTollPaymentPointInfo(
type: RouteTollPaymentPointType,
payment: RouteTollPaymentInfo,
untilTime: TimePoint?,
name: String,
description: String
)
Информация о пункте оплаты проезда платной дороги.
type
payment
untilTime
name
description
val type
Тип оплаты проезда по платной дороге.
val payment
Информация о стоимости проезда по платной дороге.
val untilTime
Время, до которого действует указанная стоимость проезда по платной дороге, указывается только в случае, если это время достаточно близко ко времени получения маршрута.
val name
Название платной дороги, если известно.
val description
Текстовое описание платной дороги, если известно.
RouteTollPaymentPointInfoRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteTollPaymentPointInfoRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RouteTollPaymentPointInfoRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RouteTollPaymentPointInfoRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
RouteTollPaymentPointInfoRouteEntry
Элемент маршрута - точка и значение в ней.
RouteTollPaymentPointInfoRouteEntry(point: RoutePoint, value: RouteTollPaymentPointInfo)
Элемент маршрута - точка и значение в ней.
RubricId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
RubricId(value: Long = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
ScaleMapEvent
Событие изменения масштаба карты.
ScaleMapEvent(zoomDelta: Float, scalingCenter: ScreenPoint? = null)
Конструктор события изменения масштаба.
zoomDelta
Величина, на которую изменится текущее значение масштаба.
scalingCenter
Точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.
ScalingGestureSettings
Настройки жеста масштабирования.
ScalingKinematicSettings
ScalingKinematicSettings(
enabled: Boolean = true,
decelerationCoefficient: Float = 14.0f,
maxInitialForwardZoomSpeed: Float = 14.0f,
zoomThreshold: Float = 0.050000001f
)
enabled
decelerationCoefficient
maxInitialForwardZoomSpeed
zoomThreshold
val enabled
Включает или отключает кинематику масштабирования. Если установлено в false, масштабирование мгновенно останавливается после окончания жеста, и все остальные параметры игнорируются.
val decelerationCoefficient
Коэффициент затухания масштабирования после окончания жеста. Чем выше значение, тем быстрее замедляется масштабирование.
val maxInitialForwardZoomSpeed
Максимальная начальная скорость после окончания жеста (dgis::map::Zoom в секунду).
val zoomThreshold
Порог отклонения dgis::map::Zoom, при превышении которого карта продолжает масштабирование в направлении жеста. Если меньше — движется в сторону исходного положения.
ScalingRecognizeSettings
Настройки распознавания масштабирования. Коэффициент масштабирования рассчитывается как отношения расстояния между точками после перемещения и исходным расстоянием.
ScalingRecognizeSettings(
scaleRatioThreshold: Float = 1.1f,
scaleRatioThresholdInRotation: Float = 1.2f,
zoomScaleRatio: Float = 2.0f,
scaleLogDiffPerMm: Float = 0.050000001f,
disableZoom: Boolean = false
)
Настройки распознавания масштабирования. Коэффициент масштабирования рассчитывается как отношения расстояния между точками после перемещения и исходным расстоянием.
scaleRatioThreshold
scaleRatioThresholdInRotation
zoomScaleRatio
scaleLogDiffPerMm
disableZoom
val scaleRatioThreshold
Порог коэффициента масштабирования, преодоление которого говорит о начале масштабирования. Используется, если вращение неактивно. Множитель должен выйти за пределы (1 / scale_ratio_threshold, scale_ratio_threshold).
val scaleRatioThresholdInRotation
Порог коэффициента масштабирования, преодоление которого говорит о начале масштабирования. Используется, если вращение активно. Множитель должен выйти за пределы (1 / scale_ratio_threshold_in_rotation, scale_ratio_threshold_in_rotation).
val zoomScaleRatio
Отношение логарифмов старого и нового масштабов при обработке мгновенного события изменения масштаба.
val scaleLogDiffPerMm
Разница логарифмов масштабов при смещении на 1 мм. на экране.
val disableZoom
Отключение жестов ZoomEvent и DirectMapScaleEvent.
Schedule
Расписание действия дорожного события.
Schedule(
startTime: TimePoint?,
finishTime: TimePoint?,
weekTimeIntervals: List<WeekTimeInterval>
)
Расписание действия дорожного события.
ScooterBriefRouteInfo
Базовая информация о маршруте на самокате.
ScooterBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о маршруте на самокате.
ScooterInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
ScooterInstructionCrossroad(landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.NONE, maneuvers: List<ScooterInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
ScooterInstructionCrossroadManeuver
ScooterInstructionCrossroadManeuver(direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
ScooterInstructionFinish
Конец самокатной части маршрута.
ScooterInstructionFinish()
Конец самокатной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
ScooterInstructionStart
Начало самокатной части маршрута.
ScooterInstructionStart()
Начало самокатной части маршрута.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
ScooterRouteSearchOptions
Параметры поиска маршрута на самокате.
ScooterRouteSearchOptions(
avoidCarRoads: Boolean = true,
avoidStairways: Boolean = true,
avoidUnderpassesAndOverpasses: Boolean = true,
avoidUnpavedRoads: Boolean = true,
avoidLockedRoads: Boolean = true,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на самокате.
avoidCarRoads
avoidStairways
avoidUnderpassesAndOverpasses
avoidUnpavedRoads
avoidLockedRoads
excludedAreas
val avoidCarRoads
Избегать автомобильных дорог.
val avoidStairways
Избегать лестниц.
val avoidUnderpassesAndOverpasses
Избегать подземных и надземных переходов.
val avoidUnpavedRoads
Избегать грунтовых дорог.
val avoidLockedRoads
Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.
val excludedAreas
Исключаемые области (не больше 25).
ScooterRouteSummary
Саммари информация для самокатного маршрута.
ScooterRouteSummary(
routeType: ScooterSummaryRouteType = ScooterSummaryRouteType.UNKNOWN,
stairways: Int = 0,
gates: Int = 0,
barriers: Int = 0,
calories: Int = 0,
carRoadsLength: Int = 0,
groundRoadsLength: Int = 0,
gravelRoadsLength: Int = 0,
bicycleRoadsLength: Int = 0,
bicycleLanesLength: Int = 0,
badRoadsLength: Int = 0,
roadBlocks: Int = 0
)
Саммари информация для самокатного маршрута.
routeType
stairways
gates
barriers
calories
carRoadsLength
groundRoadsLength
gravelRoadsLength
bicycleRoadsLength
bicycleLanesLength
badRoadsLength
roadBlocks
val routeType
Тип самокатного маршрута.
val stairways
Количество лестниц на маршруте.
val gates
Количество калиток на маршруте.
val barriers
Количество шлагбаумов на маршруте.
val calories
Количество калорий, которые будут потрачены на проезд по маршруту.
val carRoadsLength
Суммарная протяжённость автомобильной дороги на маршруте в метрах.
val groundRoadsLength
Суммарная протяжённость грунтовых дорог на маршруте в метрах.
val gravelRoadsLength
Суммарная протяжённость гравийных дорог на маршруте в метрах.
val bicycleRoadsLength
Суммарная протяжённость велодорожек на маршруте в метрах.
val bicycleLanesLength
Суммарная протяжённость велосипедных полос на маршруте в метрах.
val badRoadsLength
Суммарная протяжённость участков плохой дороги на маршруте в метрах.
val roadBlocks
Суммарное количество пешеходных перекрытий на маршруте.
ScreenDistance
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
ScreenDistance(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
ScreenPoint
Точка в экранных координатах.
Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.
ScreenPoint(x: Float = 0.0f, y: Float = 0.0f)
Точка в экранных координатах.
Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.
x
y
ScreenShift
Смещение карты по горизонтали и вертикали в координатном пространстве экрана.
Положительное направление смещения: dx - вправо, dy - вниз.
ScreenShift(dx: Float = 0.0f, dy: Float = 0.0f)
Смещение карты по горизонтали и вертикали в координатном пространстве экрана.
Положительное направление смещения: dx - вправо, dy - вниз.
dx
dy
ScreenSize
Размер в пикселях.
ScreenSize(width: Int = 0, height: Int = 0)
Размер в пикселях.
width
height
SearchCategoriesResult
Результат запроса категорий.
SearchHistory
fun items(page: SearchHistoryPage): Future<SearchHistoryResult>
Возвращает страницу истории поиска. Элементы возвращаются в упорядоченном виде по времени добавления (от самых свежих до самых поздних).
fun addItem(item: SearchHistoryItem): Unit
Добавляет элемент в историю поиска. В случае, если уже существовал такой же элемент, ранний дубликат удаляется.
fun addItems(items: List<SearchHistoryItem>): Unit
Добавляет список элементов в историю поиска. Считается, что порядок в списке хронологический. Все дубликаты будут убраны.
items
fun removeItem(item: SearchHistoryItem): Unit
Удаляет элемент из истории поиска.
fun removeItems(items: List<SearchHistoryItem>): Unit
Удаляет список элементов из истории поиска.
items
fun clear(): Unit
Очищает историю поиска.
fun setKeyStrategy(keyStrategy: SearchHistoryKeyStrategy?): Unit
Устанавливает политику формирования ключей для истории поиска. Миграцию уже существующих записей, созданных с использованием другой политики key_strategy, необходимо выполнять вручную. Если параметр не задан — используется алгоритм по умолчанию.
SearchHistoryItem
Тип данных для элемента поиска, сохраненного в истории поиска: может быть объект или поисковый запрос.
fun match(directoryObject: Function1, searchQuery: Function1): T
directoryObject
searchQuery
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
SearchHistoryPage
SearchHistoryPage(
limit: Long = 100,
offset: Long = 0,
filter: EnumSet<SearchHistoryFilter> = EnumSet.noneOf(SearchHistoryFilter::class.java)
)
limit
offset
filter
SearchHistoryResult
Результат работы истории поиска при запросе истории.
val items
Набор элементов истории поиска.
SearchLayout
UI-элемент, предоставлящий поисковую строку и отображение результатов поиска.
SearchLayout(context: Context)
context
SearchLayout(context: Context, attrs: AttributeSet)
context
attrs
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
fun addSearchViewCallback(callback: SearchViewCallback): Unit
Метод, позволящий добавить SearchViewCallback для реагирования на разные состояния и результаты работы поиска и подсказчика.
fun removeSearchViewCallback(callback: SearchViewCallback): Unit
Метод, позволящий удалить SearchViewCallback из списка.
fun clearSearchViewCallbacks(): Unit
Метод, позволящий очистить список используемых SearchViewCallback.
fun configureSearchEngine(block: Function1): Unit
Метод, позволящий настроить работу поиска и подсказчика. Внутри блока доступны методы интерфeйсы SearchViewConfigurator
block
fun hideResults(): Unit
Метод позволяет скрыть UI выдачи и оставить только поисковую строку. Работает только для текущего запроса, при его обновлении и появлении новых результатов, выдача снова отобразится.
fun setupSpeechRecognition(speechRecognizer: SpeechRecognizer?): Unit
Устанавливает и активирует функцию распознавания речи для поискового интерфейса.
ВАЖНО: Для работы голосового поиска необходимо явно вызвать этот метод. Без вызова данного метода функция голосового ввода будет отключена.
speechRecognizer
Реализация интерфейса SpeechRecognizer для распознавания речи. При передаче null голосовой ввод будет отключен.
Пример использования:
// Включение голосового ввода searchLayout.setupSpeechRecognition( DefaultSpeechRecognizer(activity, "Говорите") )// Отключение голосового ввода searchLayout.setupSpeechRecognition(null)
SearchManager
Поисковик. Основная точка входа для справочного API.
fun suggest(query: SuggestQuery): Future<SuggestResult>
Получить подсказки, соответствующие данному запросу.
query
future, резолвящаяся в ненулевой указатель на результат подбора подсказок или exceptional future, если произошла ошибка при получении подсказок
fun search(query: SearchQuery): Future<SearchResult>
Получить объекты справочника, соответствующие данному запросу.
query
future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска
fun search(suggest: Suggest, searchSettings: SearchSettings): Future<SearchResult>
Получить объекты справочника, соответствующие данному саджесту.
suggest
searchSettings
future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска
fun searchCategories(query: CategoryQuery): Future<SearchCategoriesResult>
Получить категории, соответствующие данному запросу.
query
future, резолвящаяся в ненулевой указатель на результат получения категорий или exceptional future, если произошла ошибка при получении категорий
fun searchByIds(ids: List<String>, locale: Locale? = null): Future<List<DirectoryObject>>
Получить объекты справочника по строковым идентификаторам с указанной локалью. Для онлайна можно передать не более 100 идентификаторов.
ids
locale
future, резолвящаяся в список объектов справочника. Если объекты не найдены, то вернётся пустой список.
fun searchByDirectoryObjectIds(objectIds: List<DgisObjectId>, locale: Locale? = null): Future<List<DirectoryObject>>
Получить объекты справочника по идентификаторам с указанной локалью. Для онлайна можно передать не более 100 идентификаторов.
objectIds
locale
future, резолвящаяся в список объектов справочника. Если объекты не найдены, то вернётся пустой список.
@JvmStatic
fun createOnlineManager(context: Context): SearchManager
Создать поисковик, работающий онлайн.
@JvmStatic
fun createOfflineManager(context: Context): SearchManager
Создать поисковик, работающий с предзагруженными данными.
@JvmStatic
fun createSmartManager(context: Context): SearchManager
Создать поисковик, работающий онлайн или с предзагруженными данными в зависимости от наличия подключения к сети интернет.
SearchOptions
Опции для создания SearchLayout.
SearchOptions(
searchType: SearchType = SearchType.defaultSearchType,
pageSize: Int = defaultPageSize,
sortingType: SortingType = SortingType.BY_RELEVANCE,
suggestorType: SuggestorType = SuggestorType.OBJECT
)
Опции для создания SearchLayout.
val searchType
Тип поисковика. Возможные значения зависят от типа поставки SDK. Подробнее см. SearchType. Значение по умолчанию зависит от типа поставки SDK.
val pageSize
Лимит на количество подсказок в suggest'e и результатов в выдаче. Допустимы значения от 1 до 50. По умолчанию: 10.
val sortingType
Тип сортировки поисковой выдачи. По умолчанию: SortingType.BY_RELEVANCE.
val suggestorType
Тип подсказчика. По умолчанию: SuggestorType.OBJECT.
SearchQuery
Поисковый запрос.
SearchQueryBuilder
Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):
TODO: Данное условие пока не работает. Будет исправлено в ближайших релизах.
SearchQueryBuilder()
fun setQueryText(queryText: String?): SearchQueryBuilder
Задать текст поискового запроса.
fun setRubricIds(rubricIds: List<RubricId>): SearchQueryBuilder
Задать идентификаторы рубрик.
fun setOrgIds(orgIds: List<OrgId>): SearchQueryBuilder
TODO: SDK-4701 - Сделать поддержку нескольких идентификаторов организаций в одном запросе или вернуть старую семантику. Задать фильтр по идентификаторам организаций, к которым относятся компании.
fun setBuildingIds(buildingIds: List<BuildingId>): SearchQueryBuilder
Задать идентификаторы зданий для фильтрации объектов в зданиях.
fun setRestrictionGeometry(restrictionGeometry: Geometry?): SearchQueryBuilder
Задать строгое ограничение области поиска геометрией. Для GeometryKind.Point будет выставлен центр строгого ограничения для поискового запроса. Радиус по умолчанию равен 250 метров.
GeometryKind.Polyline и GeometryKind.Polygon будут установлены как полигоны. Первая и последняя точки контура не обязаны совпадать.
Геометрия типа GeometryKind.Complex будет установлена как мулитиполигон. Для GeometryKind.Point внутри GeometryKind.Complex геометрия будет преобразована в контур полигона с радиусом из set_radius.
по умолчанию ограничение отсутствует.
fun setAreaOfInterest(rect: GeoRect?): SearchQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
fun setTerritoryOfInterest(territoryOfInterest: Geometry?): SearchQueryBuilder
Задать слабое ограничение области поиска: штраф за непопадание вместо строгого отбрасывания. Работает только с онлайн поиском. Будет проигнорировано при выставленном строгом ограничении поиска.
fun setAllowedResultTypes(allowedResultTypes: List<ObjectType>): SearchQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
fun setPageSize(pageSize: Int): SearchQueryBuilder
Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона 1;50
по умолчанию 10
fun setDirectoryFilter(filter: DirectoryFilter): SearchQueryBuilder
Задать фильтрацию для поискового запроса.
fun setSortingType(sortingType: SortingType): SearchQueryBuilder
Задать сортировку для поискового запроса.
fun setRadius(radius: Meter?): SearchQueryBuilder
Задать радиус поиска в метрах. Работает в сочетании с установленным geo_point. Радиус по умолчанию равен 250 метров. Для поискового запроса в точке ограничение от 0 до 2000. Для остальных запросов ограничение от 0 до 50000.
fun setLocale(locale: Locale?): SearchQueryBuilder
Задать локаль для поискового запроса.
fun setSearchNearby(searchNearby: Boolean): SearchQueryBuilder
Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
@JvmStatic
fun fromQuery(query: SearchQuery): SearchQueryBuilder
Начать построение запроса на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
SearchQueryWithInfo
Класс с дополнительной информацией о поисковом запросе для вывода в UI-элементах.
SearchQueryWithInfo(
searchQuery: SearchQuery,
title: String,
subtitle: String
)
val searchQuery
Возвращает объект поискового запроса.
val title
Возвращает текст заголовка, который описывает объекты поискового запроса. Например, это может быть текст из поля title объекта ISuggest.
val subtitle
Возвращает текст подзаголовка. Например, это может быть текст из поля subtitle объекта ISuggest.
val rubrics
Возвращает список рубрик, по которым производится запрос.
SearchResult
Результат работы поисковика.
fun markerTitles(objectIds: List<DgisObjectId>): List<Future<List<UIMarkerInfo>>>
Получение текстов маркеров по их идентификаторам. Возвращается vector <future
, так как в облако за запрос можно отправить не более 50 идентификаторов.
objectIds
Идентификаторы маркеров.
val firstPage
Первая страница результатов поиска.
val representativeArea
Прямоугольная область, подходящая для отображения результатов поиска.
val itemMarkerInfos
Асинхронное получение маркеров.
val searchResultType
Тип поискового запроса.
val dynamicFilters
Динамические фильтры для этого запроса.
val actionWidgets
Виджеты быстрых фильтров.
Это так называемые "быстрые фильтры" - фильтры, наиболее интересные пользователю. Их не больше 5.
val mainWidgets
Виджеты фильтров.
val autoUseFirstResult
Признак того, что первый результат пригоден для непосредственного использования.
val nearbyRequested
Признак того, что запрошены объекты поблизости.
SearchSettings
SearchSettings(saveInHistory: Boolean = false)
saveInHistory
val saveInHistory
SegmentGeoPoint
Описывает географическую точку на сегменте и направление сегмента. Геометрия маршрута представляет собой последовательность точек, которые попарно образуют отрезки (сегменты). При этом во всех функциях, работающих с геометрией маршрута считается, что первая точка из образующей отрезок пары входит в этот отрезок, а вторая - нет: [point_1, point_2),[point_2, point_3),...,[point_n-1, point_n)point_last. Последняя точка образует сама с собой отрезок нулевой длины. Т.о. каждая точка маршрута принадлежит ровно одному отрезку. Направление точки point_last не определено.
SegmentGeoPoint(point: GeoPoint, bearing: Bearing)
Описывает географическую точку на сегменте и направление сегмента. Геометрия маршрута представляет собой последовательность точек, которые попарно образуют отрезки (сегменты). При этом во всех функциях, работающих с геометрией маршрута считается, что первая точка из образующей отрезок пары входит в этот отрезок, а вторая - нет: [point_1, point_2),[point_2, point_3),...,[point_n-1, point_n)point_last. Последняя точка образует сама с собой отрезок нулевой длины. Т.о. каждая точка маршрута принадлежит ровно одному отрезку. Направление точки point_last не определено.
SettlementRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): SettlementRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<SettlementRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
SettlementRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
SettlementRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Settlement
)
Протяженный элемент маршрута - отрезок и значение на нем.
SharedRouteData
Информация о заранее построенном маршруте и параметрах его поиска.
ShowRouteControl
UI-элемент управления перелетом карты к маршруту.
SimpleCheckableItem
Простой отмечаемый элемент из CheckableItemsGroup.
SimpleClusterObject
Кластер простых (simple) объектов-маркеров.
val position
Получение позиции кластера на карте.
val objectCount
Получение количества маркеров в кластере.
val objects
Получение списка маркеров в кластере.
var anchor
Получение и установка точки привязки иконки кластера.
var iconOpacity
Получение и установка прозрачности иконки кластера.
var text
Получение и установка подписи кластера.
var textStyle
Получение и установка стиля подписи кластера.
var iconWidth
Получение и установка целевой ширины кластера, используемой для масштабирования.
var iconMapDirection
Получение и установка угла поворота кластера на карте относительно направления на север, по часовой стрелке.
var animatedAppearance
Получение и установка флага анимируемости появления кластера.
var zIndex
Получение и установка уровня отрисовки объекта.
var suppressOnOverlap
Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).
SimpleClusterOptions
Параметры маркера кластера простых (simple) объектов-маркеров.
SimpleClusterOptions(
icon: Image?,
iconMapDirection: MapDirection? = null,
anchor: Anchor = Anchor(x = 0.5f, y = 0.5f),
text: String? = null,
textStyle: TextStyle? = null,
iconOpacity: Opacity = Opacity(value = 1.0f),
iconWidth: LogicalPixel = LogicalPixel(value = 0.0f),
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
labelingPriority: LabelingPriority = LabelingPriority(value = 0),
animatedAppearance: Boolean = true,
iconAnimationMode: AnimationMode = AnimationMode.NORMAL,
suppressOnOverlap: Boolean = false
)
Параметры маркера кластера простых (simple) объектов-маркеров.
icon
iconMapDirection
anchor
text
textStyle
iconOpacity
iconWidth
userData
zIndex
labelingPriority
animatedAppearance
iconAnimationMode
suppressOnOverlap
val icon
val iconMapDirection
val anchor
val text
val textStyle
val iconOpacity
val iconWidth
Целевая ширина, используемая для масштабирования.
val userData
Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.
val zIndex
Уровень отрисовки объекта.
val labelingPriority
Приоритет лейблинга иконки маркера.
val animatedAppearance
Анимировать ли появление.
val iconAnimationMode
Режим анимации.
val suppressOnOverlap
Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).
SimpleMapObject
Объект на карте, для которого можно задавать видимость.
SimulationAutoWithOverSpeed
Структура для задания режима движения с учетом максимальной скорости на ребре маршрута.
val overSpeed
Используемое превышение скорости в м/с. Допустимы значения только >= 0.
SimulationConstantSpeed
Структура для задания режима движения с постоянной скоростью.
val speed
Скорость движения в м/с. Допустимы значения только >= 0.
SimulationSettings
Настройки симуляции ведения по маршруту.
var speedMode
Режим работы симулятора.
SimulationSpeedMode
SnapToMapLayout
Layout, позволяющий привязать View к точке на карте.
SnapToMapLayout(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Layout, позволяющий привязать View к точке на карте.
context
attrs
defStyle
fun unbindFromMap(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
fun onLayout(
changed: Boolean,
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
changed
left
top
right
bottom
fun checkLayoutParams(p: LayoutParams?): Boolean
p
fun generateLayoutParams(attrs: AttributeSet?): LayoutParams?
attrs
fun generateLayoutParams(p: LayoutParams?): LayoutParams?
p
SortingFilter
Фильтр сортировки.
SortingFilter(tagName: String, displayName: String)
Фильтр сортировки.
tagName
displayName
SoundNotificationSettings
Настройки звуковых оповещений в навигаторе По умолчанию все значения категорий звуков оповещений включены. Пользователь может менять значения во время работы с навигатором.
Source
Источник данных на карте.
Это может быть источник пробочных данных, маршрутов, маркеров, произвольных геометрических или других объектов карты. У любого объекта карты могут быть свои свойства. Свойства объекта влияют на то, какие к нему применяются правила и параметры отображения, описаные в стилях карты. Стиль - набор параметров и правил отображения объектов карты, получаемый через редактор стилей и использующийся для отрисовки карты.
Свойства объекта могут быть заданы:
- непосредственно для объекта;
- источнику данных (все объекты, добавленные в источник, получают эти свойства);
- карте (все объекты, добавленные на карту, получают эти свойства);
- стилю (все объекты, к которым применён стиль, получают эти свойства). Список приведён в порядке понижения приоритета применения свойств. Даже если на карту не добавлен ни один источник данных, свойства стиля и карты всё равно повлияют на карту, т.к. есть специальные отображаемые объекты, например - фон.
SpecialSpace
Особое место для парковки.
SpecialSpace(
type: SpecialSpaceType,
name: String,
count: String?
)
Особое место для парковки.
SpeedInfoControl
SpeedRange
Интервал скоростей. Скорости задаются в метрах в секунду.
SpeedRangeToStyleZoom
Соответствие интервала скоростей, класса дорог и стилевого уровня масштабирования.
val range
Интервал скоростей.
val minDistanceToManeuver
Минимальное расстояние до манёвра, при котором должна включаться логика плавного увеличения уровня зума.
val maxDistanceToManeuver
Максимальное расстояние после манёвра, при котором плавное уменьшение уровня зума должно завершиться.
val roadClassesStyleZooms
Стилевой уровень масштабирования для определенного класса дорог. Переопределяет style_zoom значение по умолчанию.
val roadClassesTilts
Стилевой наклон для определенного класса дорог. Переопределяет style_tilt значение по умолчанию.
val styleZoom
Стилевой уровень масштабирования по умолчанию. Применяется для всех классов дорог.
val styleTilt
Стилевой угол наклона по умолчанию. Применяется для всех классов дорог.
StorageOptions
Опции хранилища оффлайн данных.
StorageOptions(downloadStoragePath: String? = null)
Опции хранилища оффлайн данных.
downloadStoragePath
val downloadStoragePath
Путь к каталогу верхнего уровня для основного хранилища загрузок. Файловое хранилище будет находиться в подкаталоге downloads в данном каталоге. Если путь не указан, будет использоваться директория по умолчанию.
StringRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<StringRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): StringRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): StringRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
StringRouteEntry
Элемент маршрута - точка и значение в ней.
StringRouteEntry(point: RoutePoint, value: String)
Элемент маршрута - точка и значение в ней.
StringRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): StringRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<StringRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
StringRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
StringRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: String
)
Протяженный элемент маршрута - отрезок и значение на нем.
Style
Стиль с набором свойств объектов карты (cм. ISource).
val styleAttributes
Получение свойств по умолчанию для объектов, к которым применён указанный слой.
StyleBuilder
Конструктор стилей.
fun setStyleAttribute(name: String, value: AttributeValue): StyleBuilder
fun loadStyle(file: File): Future<Style>
Загрузка пользовательского стиля.
StyleLayerId
Идентификатор слоя стиля.
StyleLayerId(id: String)
Идентификатор слоя стиля.
id
val id
StyleZoom
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
StyleZoom(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
StyleZoomFollowController
Контроллер слежения за стилевым уровнем масштабирования карты.
StyleZoomFollowController(animationDuration: Duration = Duration.ofMilliseconds(300))
Создание контроллера слежения за стилевым уровнем масштабирования карты.
animationDuration
fun setStyleZoom(styleZoom: StyleZoom): Unit
Установка нового значения стилевого уровня масштабирования.
Suggest
Поисковая подсказка.
SuggestHandler
Обработчик выбора подсказки.
SuggestHandler(performSearchHandler: PerformSearchHandler)
performSearchHandler
SuggestHandler(incompleteTextHandler: IncompleteTextHandler)
incompleteTextHandler
fun match(
objectHandler: Function1,
performSearchHandler: Function1,
incompleteTextHandler: Function1
): T
objectHandler
performSearchHandler
incompleteTextHandler
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
SuggestObjectHandler
Предложен конкретный объект справочника.
val item
Подсказанный объект.
SuggestQuery
Запрос поисковой подсказки.
SuggestQueryBuilder
Построитель запросов к подсказчику.
SuggestQueryBuilder(queryText: String)
Начать построение запроса подсказки для заданного текста и области интереса.
queryText
fun setRestrictionGeometry(restrictionGeometry: Geometry?): SuggestQueryBuilder
Задать строгое ограничение области поиска геометрией. Для GeometryKind.Point геометрия будет преобразована в контур полигона с радиусом 250 метров.
GeometryKind.Polyline и GeometryKind.Polygon будут установлены как полигоны. Первая и последняя точки контура не обязаны совпадать.
Геометрия типа GeometryKind.Complex будет установлена как мулитиполигон.
по умолчанию ограничение отсутствует.
fun setTerritoryOfInterest(territoryOfInterest: Geometry?): SuggestQueryBuilder
Задать слабое ограничение области поиска: штраф за непопадание вместо строгого отбрасывания. Работает только с онлайн поиском. Будет проигнорировано при выставленном строгом ограничении поиска.
fun setAreaOfInterest(rect: GeoRect?): SuggestQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
fun setAllowedResultTypes(allowedResultTypes: List<SuggestedType>): SuggestQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
fun setSuggestorType(suggestorType: SuggestorType): SuggestQueryBuilder
Задать тип подсказчика.
по умолчанию #SuggestorType::Object
fun setLimit(limit: Int): SuggestQueryBuilder
Задать желаемое количество подсказок. Допустимы значения из диапазона 1;50
по умолчанию 10
fun setLocale(locale: Locale?): SuggestQueryBuilder
Локаль, с которой производится запрос подсказки и отдаются результаты.
fun setSearchNearby(searchNearby: Boolean): SuggestQueryBuilder
Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
@JvmStatic
fun fromQuery(query: SuggestQuery): SuggestQueryBuilder
Начать построение запроса подсказки на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
SuggestResult
Результат работы подсказчика.
val suggests
Набор предложенных вариантов подсказок.
набор пуст, если подходящие подсказки не найдены
SystemCertificate
Системный SSL-сертификат.
SystemCertificate()
Системный SSL-сертификат.
fun toString(): String
fun equals(other: Any?): Boolean
other
fun hashCode(): Int
SystemMemoryManager
Интерфейс управления использованием системной памяти.
fun reduceMemoryUsage(): Unit
Уменьшение использования памяти путём очистки всевозможных кешей и буферов.
@JvmStatic
fun instance(context: Context): SystemMemoryManager
Получение объекта для управления использованием системной памяти.
TaxiRouteSearchOptions
Параметры поиска маршрута на такси.
TaxiRouteSearchOptions(car: CarRouteSearchOptions)
Параметры поиска маршрута на такси.
val car
Параметры поиска маршрута, общие с прочими автомобильными.
TerritoriesAlongRouteProvider
Интерфейс для поиска маршрута с учетом пробочных данных.
TerritoriesAlongRouteProvider(context: Context)
Создание объекта для получения списка территорий вдоль маршрута из контекста.
context
fun getTerritories(route: Route): Future<List<Territory>>
Возвращает минимально необходимый список офлайн-территорий в порядке следования маршрута.
Territory
Территория. Данные в 2ГИС нарезаны на некоторые неделимые единицы, называемые сегментами. Но для более удобной и гибкой работы с данными для обновления используются не сами сегменты, а их наборы, называемые территориями. Наборы сегментов в двух территориях могут пересекаться, в том числе одна территория может быть целиком вложена в другую.
TerritoryManager
Интерфейс для взаимодействия со списком территорий: Подписки на изменения информации о территориях; Поиска территорий по координатам и геометриям; Подписки на изменения информации о всеобщем прогрессе установки/обновления территорий; Приостановки и возобновления процесса установки/обновления территорий.
fun findByPoint(geoPoint: GeoPoint): List<Territory>
Поиск территорий, которым принадлежит заданная точка. Бросает исключение в случае передачи некорректных координат точки. Возвращает пустой список в случае ошибки, а именно:
- Координаты точки находятся за пределами проекции;
- Произошла внутренняя ошибка при обработке списка территорий.
fun findByRect(rect: GeoRect): List<Territory>
Поиск территорий, которым принадлежит заданная геометрия. Бросает исключение в случае попытки использования неподдерживаемой геометрии. Возвращает пустой список, если геометрия находится за пределами проекции. Возвращает пустой список в случае внутренней ошибки при обработке списка территорий.
fun pause(): Unit
Приостановка всех запущенных операций установки либо обновления территорий.
fun resume(): Unit
Возобновление всех приостановленных операций установки либо обновления территорий.
@JvmStatic
fun instance(context: Context): TerritoryManager
Получение объекта для работы с территориями из контекста.
val territoriesChannel
Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
val territories
Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
TextStyle
Настройки внешнего вида текста.
TextStyle(
fontSize: LogicalPixel = LogicalPixel(value = 8.0f),
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value = 0.34999999f),
strokeColor: Color = Color(argb = 4294967295.toInt()),
textHorizontalAlignment: TextHorizontalAlignment = TextHorizontalAlignment.AUTO,
textPlacement: TextPlacement = TextPlacement.BOTTOM_CENTER,
textOffset: LogicalPixel = LogicalPixel(value = 0.0f),
fontName: String? = null,
labelingPriority: LabelingPriority = LabelingPriority(value = 0),
suppressOnOverlap: Boolean = true
)
Настройки внешнего вида текста.
fontSize
color
strokeWidth
strokeColor
textHorizontalAlignment
textPlacement
textOffset
fontName
labelingPriority
suppressOnOverlap
val fontSize
val color
val strokeWidth
val strokeColor
val textHorizontalAlignment
val textPlacement
val textOffset
val fontName
val labelingPriority
Приоритет лейблинга текста.
val suppressOnOverlap
Скрывать ли текст при наложении с другими объектами (маркеры, подписи других объектов).
Tilt
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
Tilt(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
TiltFollowController
Контроллер слежения за углом наклона карты.
TiltFollowController(styleZoomToTilt: StyleZoomToTiltRelation)
Создание контроллера слежения за углом наклона карты.
styleZoomToTilt
зависимость угла наклона камеры от стилевого уровня масштабирования.
TiltGestureSettings
Настройки жеста наклона.
TiltKinematicSettings
TiltKinematicSettings(
enabled: Boolean = true,
decelerationCoefficient: Float = 7.0f,
initialForwardSpeedMultiplier: Float = 0.69999999f,
maxInitialForwardAngularSpeed: Float = 50.0f,
minTiltAdditionalBorder: Tilt = Tilt(value = 0.0f),
maxTiltAdditionalBorder: Tilt = Tilt(value = 3.0f),
tiltThreshold: Float = 0.039999999f
)
val enabled
Включает или отключает кинематику наклона. Если установлено в false, наклон мгновенно останавливается после окончания жеста, все остальные параметры игнорируются.
val decelerationCoefficient
Коэффициент затухания наклона после окончания жеста. Чем выше значение, тем быстрее замедляется наклон.
val initialForwardSpeedMultiplier
Множитель начальной скорости наклона.
val maxInitialForwardAngularSpeed
Максимальная начальная угловая скорость наклона после окончания жеста (в радианах в секунду). При вычисоении скорости сначала производится умножение на initial_forward_speed_multiplier, а затем применяется ограничение.
val minTiltAdditionalBorder
val maxTiltAdditionalBorder
val tiltThreshold
Порог углового отклонения (в радианах), при превышении которого карта продолжает наклоняться в направлении жеста. Если меньше — движется в сторону исходного положения.
TiltRecognizeSettings
Настройки распознавания наклона.
TiltRecognizeSettings(
lenOnDegreeMm: Float = 1.0f,
horizontalSwerveDeg: Float = 20.0f,
verticalSwerveDeg: Float = 10.0f,
thresholdMm: Float = 1.1f,
maxParallelsDeviationDeg: Float = 16.0f
)
Настройки распознавания наклона.
lenOnDegreeMm
horizontalSwerveDeg
verticalSwerveDeg
thresholdMm
maxParallelsDeviationDeg
val lenOnDegreeMm
Расстояние, в миллиметрах, на которое нужно сдвинуть пальцы по экрану, чтобы изменить угол наклона камеры на 1 градус. Отрицательное значение приведет к инверсии направления, значение 0 недопустимо.
val horizontalSwerveDeg
Максимально допустимый угол, в градусах, отклонения линии постановки пальцев от горизонта для вертикального свайпа.
val verticalSwerveDeg
Максимально допустимый угол, в градусах, отклонения направления свайпа от вертикальной линии.
val thresholdMm
Порог сдвига взвешенного среднего точек в миллиметрах, преодоление которого говорит о начале наклона.
val maxParallelsDeviationDeg
Максимально допустимый угол между векторами, в градусах, преодоление которого говорит о нарушении сонаправленности.
TimePoint
Класс, представляющий момент времени.
TimePoint(timeFromEpoch: Duration)
Класс, представляющий момент времени.
timeFromEpoch
fun toString(): String
@JvmStatic
fun ofEpochMilliseconds(milliseconds: Long): TimePoint
@JvmStatic
fun now(): TimePoint
Время, прошедшее с 00:00:00 UTC 1 января 1970 года (Unix-время).
TradeLicense
Лицензия организации.
TradeLicense(
type: String,
license: String,
legalForm: String,
endDate: String
)
Лицензия организации.
type
license
legalForm
endDate
val type
Тип.
Пустая строка означает отсутствие этого значения в данных.
val license
Номер.
val legalForm
Форма собственности компании.
Пустая строка означает отсутствие этого значения в данных.
val endDate
Дата, до которой действует лицензия.
Пустая строка означает отсутствие этого значения в данных.
Traffic
Описание пробочных данных.
TrafficAndParkingControl
Контейнер с UI-элементами отображения парковок и пробок.
TrafficCollector
Интерфейс для управления сервисом сбора информации о транспортном трафике.
Этот интерфейс является потокобезопасным.
@JvmStatic
fun instance(context: Context): TrafficCollector
Функция получения сервиса сбора информации о транспортном трафике. Сервис сбора информации о транспортном трафике анализирует состояние трафика на дороге, по которой движется пользователь и отправляет результаты анализа в анонимизированном виде на сервер.
context
Контекст - окружение, необходимое для работы SDK.
Сервис сбора информации о дорожном движении.
var trafficCollectingAllowed
Функция определения состояния разрешения/запрета отправки информации о дорожном движении на сервер.
TrafficControl
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
TrafficControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
context
attrs
defStyle
TrafficControl
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
TrafficControlModel
Модель контрола пробок.
Этот интерфейс является потокобезопасным.
TrafficControlModel(map: Map)
Функция создания модели элемента управления пробками.
map
карта.
fun onClicked(): Unit
Действие при нажатии на контрол. Переключает видимость пробок на карте.
TrafficControlState
Состояние элемента управления видимостью пробок.
TrafficControlState(status: TrafficControlStatus = TrafficControlStatus.HIDDEN, score: Int?)
Состояние элемента управления видимостью пробок.
TrafficJamDetector
Детектор, который определяет, находится ли пользователь вблизи пробки на маршруте.
TrafficJamInfo
Информация о пробке.
TrafficLineColors
TrafficLineControl
UI-элемент, отображающий уровень пробок вдоль маршрута.
var pointObjectsPosition
TrafficLinePointObject
TrafficLinePointObjectView
TrafficRoute
TrafficRouter
Интерфейс для поиска маршрута с учетом пробочных данных.
TrafficRouter(context: Context, routerType: RouterType = RouterType.HYBRID)
fun findRoute(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: List<RouteSearchPoint> = listOf()
): Future<List<TrafficRoute>>
Ищет маршрут по заданным параметрам.
startPoint
Начальная точка маршрута.
finishPoint
Конечная точка маршрута.
routeSearchOptions
Параметры поиска маршрута.
intermediatePoints
Промежуточные точки для проезда в том же порядке, в котором точки заданы в векторе.
Future с набором найденных маршрутов, либо с исключением NativeException в случае ошибки.
Пустой набор маршрутов является валидным результатом - это означает, что маршрут, соответствующий указанным критериям поиска, не может быть найден.
При поиске маршрутов для грузового транспорта возможен возврат маршрутов, проходящих через пропускные зоны, для которых не были предоставлены пропуска, в случае, если не удалось проложить маршрут только через пропускные зоны, для которых пропуска были предоставлены. Для проверки того, достаточен ли список пропусков для проезда по маршруту, следует использовать функцию route_matches_truck_pass_zone_passes.
fun requestRoute(request: ByteArray, serverEndpoint: String): Future<List<TrafficRoute>>
Ищет маршрут по ранее сериализованным параметрам.
request
Сериализованные параметры запроса.
serverEndpoint
Тип искомого маршрута, выступает частью урла, по которому отсылается запрос: bicycle, carrouting, pedestrian, truck.
Future с набором найденных маршрутов, либо с исключением NativeException в случае ошибки.
Не подходит для поиска маршрутов общественного транспорта.
При невозможности найти маршруты для грузового транспорта не пытается найти маршруты на легковом автомобиле без учёта грузовых данных.
fun findBriefRouteInfos(searchPoints: List<BriefRouteInfoSearchPoints>, routeSearchOptions: RouteSearchOptions): Future<List<BriefRouteInfo?>>
Ищет базовую информацию о маршрутах для соответствующего набора поисковых точек.
searchPoints
Набор точек для поиска базовой информации о маршруте.
routeSearchOptions
Параметры поиска маршрута.
Future с базовой информацией о наборе маршрутов, соответствующему набору точек поиска, либо исключением NativeException в случае ошибки.
Если базовая информация для каких-либо из пар точек не будет найдена, элемент с соответствующим индексом в возвращённом результате будет иметь значение null.
val truckPassZonePasses
Возвращает список всех поддерживаемых пропусков, разрешающих движение грузового транспорта в пределах пропускных зон.
TrafficScore
Оценка пробок.
TrafficScore(state: TrafficScoreState = TrafficScoreState.PENDING, value: Int?)
Оценка пробок.
TrafficScoreProvider
Подписка на обновления информации о величине пробок.
Этот интерфейс является потокобезопасным.
TrafficScoreProvider(map: Map)
Функция создания объекта для слежения за баллом пробок в области видимости карты.
map
Карта, для которой будет отслеживаться область видимости.
TrafficSource
TrafficSpeedColorRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TrafficSpeedColorRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TrafficSpeedColorRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
TrafficSpeedColorRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TrafficSpeedColorRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TrafficSpeedColor
)
Протяженный элемент маршрута - отрезок и значение на нем.
TransportTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TransportTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TransportTypeRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
TransportTypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TransportTypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TransportType
)
Протяженный элемент маршрута - отрезок и значение на нем.
TraversalTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TraversalTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TraversalTypeRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
TraversalTypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TraversalTypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TraversalType
)
Протяженный элемент маршрута - отрезок и значение на нем.
TripHighlights
Сводная информация о завершенной поездке
val tripDuration
Длительность поездки
val tripDistance
Фактически пройденное за время поездки расстояние, метры
val maxTripSpeed
Максимальная скорость, достигнутая за время поездки, метры в секунду
val trafficJamTimeWasted
Время, проведенное в пробках
val finishReached
Флаг, указвающий на то, достигнута финальная точка маршрута или нет Если нет, значит маршрут завершен вручную
val visitedRegionIds
Список ID регионов, посещенных за время поездки, в порядке посещения (могут повторяться)
TripHighlightsCollector
Коллектор информации о текущей поездке
val tripHighlights
Получить накопленные данные о текущей поездке.
TruckPassZoneId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
TruckPassZoneId(value: Int = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
TruckPassZoneIdRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TruckPassZoneIdRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TruckPassZoneIdRouteLongEntry>
Элементы, частично или полностью покрываемые отрезком begin,end.
TruckPassZoneIdRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TruckPassZoneIdRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TruckPassZoneId
)
Протяженный элемент маршрута - отрезок и значение на нем.
TruckPassZonePass
Пропуск, разрешающий движение грузового транспорта в пропускных зонах.
TruckPassZonePass(
id: TruckPassZonePassId,
name: String,
passZoneIds: Set<TruckPassZoneId>
)
Пропуск, разрешающий движение грузового транспорта в пропускных зонах.
TruckPassZonePassId
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
TruckPassZonePassId(value: Int = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
TruckRouteSearchOptions
Параметры поиска маршрута на грузовом транспорте. При поиске маршрута учитываются только заполненные параметры.
TruckRouteSearchOptions(
car: CarRouteSearchOptions,
truckLength: Int? = null,
truckHeight: Int? = null,
truckWidth: Int? = null,
actualMass: Int? = null,
maxPermittedMass: Int? = null,
axleLoad: Int? = null,
dangerousCargo: Boolean = false,
explosiveCargo: Boolean = false,
passIds: Set<TruckPassZonePassId> = setOf(),
fallbackOnCar: Boolean = false
)
Параметры поиска маршрута на грузовом транспорте. При поиске маршрута учитываются только заполненные параметры.
car
truckLength
truckHeight
truckWidth
actualMass
maxPermittedMass
axleLoad
dangerousCargo
explosiveCargo
passIds
fallbackOnCar
val car
Параметры поиска маршрута, общие с прочими автомобильными.
val truckLength
Длина грузового транспортного средства в миллиметрах.
val truckHeight
Высота грузового транспортного средства в миллиметрах.
val truckWidth
Ширина грузового транспортного средства в миллиметрах.
val actualMass
Фактическая масса грузового транспортного средства в килограммах.
val maxPermittedMass
Разрешённая максимальная масса грузового транспортного средства в килограммах.
val axleLoad
Нагрузка на ось в килограммах.
val dangerousCargo
Признак наличия опасного груза.
val explosiveCargo
Признак наличия взрывчатых веществ в грузе.
val passIds
Идентификаторы имеющихся у пользователя пропусков, требующихся для движения в пределах пропускных зон.
val fallbackOnCar
Использование автоматического фоллбека с поиска грузового маршрута на поиск автомобильного маршрута при невозможности найти грузовой маршрут, удовлетворяющий параметрам поиска.
UIMarkerInfo
Идентификатор объекта с подписью.
UIMarkerInfo(objectId: DgisObjectId, label: String?)
Идентификатор объекта с подписью.
VendorConfig
Переопределение конфигурации SDK.
VendorConfig()
fun match(
none: Function0<T>,
fromAsset: Function1,
fromFile: Function1,
fromString: Function1
): T
none
fromAsset
fromFile
fromString
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
VendorConfigFromAsset
Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.
VendorConfigFromAsset(path: String)
Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.
path
val path
Путь относительно корневой директории asset-ов.
VendorConfigFromFile
Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.
VendorConfigFromFile(path: String)
Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.
path
val path
Путь к файлу.
VendorConfigFromString
Переопределение настроек SDK через указание содержимого файла.
VendorConfigFromString(contents: String)
Переопределение настроек SDK через указание содержимого файла.
contents
val contents
Содержимое файла переопределения настроек.
Voice
Голосовой пакет с озвучкой навигатора.
VoiceManager
Интерфейс для взаимодействия со списком голосовых пакетов навигатора.
val voicesChannel
Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
val voices
Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
val defaultVoice
Получение голоса на основании списка локалей, которые предоставляет платформа.
VoiceSelector
Управляет голосовыми пакетами в текущей сессии навигатора.
var voice
Голосовой пакет, с помощью которого воспроизводятся голосовые оповещения в текущей сессии навигатора.
VoidRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoutePoint>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RoutePoint?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RoutePoint?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
WeekTime
Момент времени внутри недели.
WeekTimeInterval
Интервал времени в течение недели.
Widget
Базовый класс, представляющий виджет для фильтрации поисковой выдачи.
Виджеты возвращаются в результате поиска и предназначены для фильтрации или сортировки результата по определенным параметрам. Виджеты генерируются динамически для каждого результата поиска и могут отсутствовать для некоторых запросов. Виджет представляет один конкретный фильтр или их группу, объединённую общим признаком. Например, тип кухни в результатах поиска по запросу "Поесть".
WmsRasterUrlTemplate
WmsRasterUrlTemplate(urlTemplate: String)
urlTemplate
val urlTemplate
WorkStatus
Статус работы.
WorkStatus(
openStatus: OpenStatus,
openStatusHint: String,
scheduleHint: String?,
breakHint: String?
)
Статус работы.
val openStatus
Статус.
val openStatusHint
Тескотовое подсказка по текущему статусу. Например: "Откроется через 15 минут", "Сегодня 10:00–22:00", "Ежедневно 09:00–21:00", "Открыто", "Закроется через 15 минут", "Закрыто", "Обед до 14:00", "Перерыв до 16:15".
val scheduleHint
Текстовая подсказка по расписанию работы. Например: "Сегодня 10:00–22:00", "Ежедневно 09:00–21:00", "Сегодня закрыто"
val breakHint
Текстовая подсказка о текущем или ближайшем перерыве. Например: "Обед до 14:00", "Перерыв до 11:30".
WorkTimeFilter
Фильтр по времени работы объекта. Либо открыт сейчас, либо открыт на конкретные дата и время.
fun match(workTime: Function1, isOpenNow: Function1): T
workTime
isOpenNow
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
ZIndex
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
ZIndex(value: Int = 0)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
Zoom
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
Zoom(value: Float = 0.0f)
Отличия от BOOST_STRONG_TYPEDEF:
- может использоваться в constexpr контексте если тип T поддерживает это
- приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)
value
val value
ZoomControl
Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).
ZoomControl
Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).
ZoomControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).
context
attrs
defStyle
ZoomControlModel
Модель контрола зумирования. Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты. При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной. Методы объекта необходимо вызывать на одном потоке.
fun isEnabled(button: ZoomControlButton): StatefulChannel<Boolean>
fun setPressed(button: ZoomControlButton, value: Boolean): Unit
ZoomFollowSettings
Интерфейс, позволяющий управлять настройками масштабирования карты во время ведения.
Во время ведения масштаб зависит от скорости движения, от наличия манёвров впереди и позади на маршруте и от типа дороги.
При отсутствии манёвров впереди и позади, либо на дорогах низкого значения (неглавные улицы населённых пунктов, шоссе, междугородние или федеральные трассы) значение масштаба выбирается на основании значений SpeedRangeToStyleZoom, которые хранятся в последовательности speed_range_to_style_zoom_sequence. Последовательность speed_range_to_style_zoom_sequence должна содержать интервалы скоростей, отсортированные по возрастанию значений min_speed, при этом должны выполняться условия: max_speedi > min_speedi+1
max_speedi < max_speedi+1. То есть интервалы скоростей должны соприкасаться или даже пересекаться, но значение скорости не должно попадать более чем в два интервала. При этом минимальное значение скорости не считается попадающим в интервал, т.е. одно и то же значение скорости может находиться быть максимальной скоростью для одного интервала, минимальной скоростью для другого и находиться внутри интервала для третьего интервала. Исключение - первый интервал скоростей, который должен содержать значение min_speed == 0.
Масштаб карты выбирается из последовательности speed_range_to_style_zoom_sequence по алгоритму:
При приближении к маневру на текущей скорости масштаб будет плавно увеличиваться. Время увеличения зависит от скорости и расстояния до манёвра. При увеличении скорости время анимации увеличивается, при снижении скорости - уменьшается. Увеличение уровня зума завершается на некотором расстоянии до манёвра.
После проезда манёвра уровень зума плавно уменьшается.
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, значения меньше будут игнорироваться.