class
ActivityTracker
Extends: ru.dgis.sdk.NativeObject
ActivityTracker(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: Duration = Duration.ofMilliseconds(20000)
)
Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал,
когда пользователь перестал пользоваться навигатором и его можно выключить.
Parameters
platformContext
Контекст.
model
Модель навигатора, состояние которого отслеживается.
speedBound
Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается,
что навигатор активен, т.е. движение продолжается.
timeThreshold
Время, в течение которого в состоянии Finished навигатора отслеживается скорость
движения ниже пороговой для определения состояния неактивности навигатора.
Если в течение этого времени скорость движения меньше установленного порога или
нет данных о локации и скорости, навигатор считается неактивным.
Properties
val stopChannel
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить.
Если в состоянии Finished навигация прекращается,
т.е. движение останавливается или его скорость становится ниже порогового значения,
и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true,
в противном случае он имеет значение false.
val stop
Флаг, активное состояние которо го указывает на то, что навигатор необходимо остановить.
Если в состоянии Finished навигация прекращается,
т.е. движение останавливается или его скорость становится ниже порогового значения,
и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true,
в противном случае он имеет значение false.
AddEventResult
Результат добавления события (объект события или ошибка).
Methods
fun match(event: Function1, error: Function1): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
Properties
Address
Адрес в виде набора отдельных компонентов.
Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
buildingId: BuildingId?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)
Адрес в виде набора отдельных компонентов.
Parameters
drillDown
components
buildingName
buildingId
postCode
buildingCode
fiasCode
addressComment
Properties
val drillDown
Набор объектов административного деления, в которых находится описываемый объект.
val components
Полный адрес объекта может сод ержать несколько отдельных адресных компонент.
val buildingName
Название здания.
val buildingId
Уникальный идентификатор здания.
val postCode
Почтовый индекс.
val buildingCode
Уникальный почтовый код здания.
val fiasCode
Код ФИАС объекта.<p>Для получения данной информации запросите дополнительную настройку ключа.</p>
val addressComment
Комментарий к адресу.
Пример: "301 офис; 9 этаж"
AddressAdmDiv
Объект административного деления.
Properties
val type
Тип административной единицы. Один из следующих:<ul><li>country — страна</li><li>region — регион (область/край/республика и т.п.)</li><li>district_area — район области</li><li>city — город</li><li>settlement — населённый пункт</li><li>division — округ</li><li>district — район</li><li>living_area — жилмассив, микрорайон</li><li>place — место</li></ul>
val name
AddressComponent
Компонент адреса: улица, номер дома или словесное описание местоположения.
Methods
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
Properties
val isStreetAddress
val asStreetAddress
val isNumber
val asNumber
val isLocation
val asLocation
val value
AddressLocation
Применяется для компонентов, которые тяжело описать конкретным адресом.
AddressLocation(comment: String)
Применяется для компонентов, которые тяжело описать конкретным адресом.
Parameters
comment
Properties
val comment
Словесное описание местоположения строения.
AddressNumber
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
AddressStreet
Обычный адрес, есть улица и номер дома.
AddRoadEventButton
Кнопка добавления дорожного события.
AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Кнопка добавления дорожного события.
Parameters
Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
AddRoadEventCard
Карточка добавления дорожного события.
AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка добавления дорожного события.
Parameters
Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
Properties
const MAX_DESCRIPTION_LENGTH
AddRoadEventCardModel
Модель карточки добавления дорожного события.
Implements: java.lang.AutoCloseable
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)
Модель карточки добавления дорожного события.
Parameters
Methods
fun onEventTypeClicked(type: RoadEventType): Unit
Действие при нажатии UI-элемента управления выбором типа события.
Parameters
fun onLaneClicked(lane: Lane): Unit
Действие при нажатии UI-элемента управления выбором полосы.
Parameters
fun onDescriptionEntered(description: String): Unit
Действие при вводе описания.
Parameters
fun close(): Unit
Returns
Properties
val eventTypeChannel
Выбранный тип события.
val lanesChannel
Выбранные полосы.
val canSelectLanesChannel
Есть ли возможность задать полосы.
val descriptionChannel
Введенное описание.
val markerPositionChannel
Позиция маркера на экране.
val canSendChannel
Есть ли возможность отправить событие.
val resultChannel
Результат отправки события.
AddRoadEventControl
Базовый класс для UI-элементов добавления дорожных событий.
Extends: android.widget.FrameLayout
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для UI-элементов добавления дорожных событий.
Parameters
Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
@CallSuper
fun detachFromModel(): Unit
Returns
fun onAttachedToWindow(): Unit
Returns
fun onDetachedFromWindow(): Unit
Returns
Properties
AddRoadEventControls
Набор UI-элементов для добавления дорожных событий.
Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место
добавления события на карте.
Extends: ru.dgis.sdk.map.MapControl
AddRoadEventControls(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Набор UI-элементов для добавления дорожных событий.
Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место
добавления события на карте.
Parameters
Methods
fun show(): Unit
Returns
fun hide(): Unit
Returns
Properties
val cardHeightChannel
Высота в пикселях, на которую раскрыта карточка.
AddRoadEventMarker
Маркер добавления дорожного события.
AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Маркер добавления дорожного события.
Parameters
Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
fun detachFromModel(): Unit
Returns
Aggregate
Обобщенное описание станции зарядки автомобилей.
Properties
val connectorsFree
Количество доступных коннекторов.
val connectorsTotal
Общее количество коннекторов (кроме недоступных).
val isActive
Статус активности. true, если есть хотя бы один доступный, зарезервированный или на зарядке коннектор.
val isBusy
Статус занятости. true, если половина или более коннекторов заняты.
val power
Максимальная мощность из всех коннекторов.
AlternativeRouteSelector
Выбор альтернативного маршрута.
Extends: ru.dgis.sdk.NativeObject
Methods
fun selectAlternativeRoute(trafficRoute: TrafficRoute): Unit
Выбор альтернативного маршрута.
Если переданный маршрут не соответствует одному из актуальных альтернативных маршрутов,
ничего не происходит. В противном случае соответствующий альтернативный маршрут
становится текущим активным маршрутом.
Parameters
trafficRoute
Альтернативный маршрут, который должен быть выбран
в качестве текущего активного маршрута.
Returns
AlternativeRoutesProviderSettings
Настройки поиска альтернативных маршрутов и маршрута лучше.
Extends: ru.dgis.sdk.NativeObject
Properties
var alternativeRoutesEnabled
Флаг включения/выключения предложения альтернативных маршруто в. По умолчанию
предложение альтернативных маршрутов включено.
var betterRouteEnabled
Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение
маршрута лучше включено.
var routeSearchDelay
Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после
перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.
var betterRouteTimeCostThreshold
Минимальная разница во времени движения между исходным маршрутом и альтернативным
маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var betterRouteLengthThreshold
Мин имальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом
и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var routerType
Тип поисковика для поиска альтернативных маршрутов.
Anchor
Точка привязки изображения
(0, 0) - левый верхний угол, (1, 1) - правый нижний
AndroidAutoMapSession
Car App session that renders a map on the surface provided
by the <a href="androidx.car.app.AppManager#setSurfaceCallback">AppManager</a>.<p>Supports both shift and scale gestures.</p><p>The map's visibility is tied to the session's <a href="androidx.car.app.Session#getLifecycle">Lifecycle</a>:</p><ul><li>Map becomes visible during the onStart event.</li><li>Map becomes hidden during the onStop event.</li></ul><p><a href="androidx.car.app.model.Action#PAN">Action.PAN</a> must be included in the <a href="androidx.car.app.model.Template">Template</a>.
Otherwise, the surface won't be available.</p><p>Next permissions are already declared in the SDK:</p><ul><li>androidx.car.app.ACCESS_SURFACE</li><li>androidx.car.app.NAVIGATION_TEMPLATES</li></ul><p>Important: ensure that SDK context has been initialized before creating instance of this class.</p>
AndroidAutoMapSession(mapOptions: MapOptions)
Car App session that renders a map on the surface provided
by the <a href="androidx.car.app.AppManager#setSurfaceCallback">AppManager</a>.<p>Supports both shift and scale gestures.</p><p>The map's visibility is tied to the session's <a href="androidx.car.app.Session#getLifecycle">Lifecycle</a>:</p><ul><li>Map becomes visible during the onStart event.</li><li>Map becomes hidden during the onStop event.</li></ul><p><a href="androidx.car.app.model.Action#PAN">Action.PAN</a> must be included in the <a href="androidx.car.app.model.Template">Template</a>.
Otherwise, the surface won't be available.</p><p>Next permissions are already declared in the SDK:</p><ul><li>androidx.car.app.ACCESS_SURFACE</li><li>androidx.car.app.NAVIGATION_TEMPLATES</li></ul><p>Important: ensure that SDK context has been initialized before creating instance of this class.</p>
Parameters
mapOptions
The configuration of the map. The following parameters are not utilized:
Methods
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 <a href="ru.dgis.sdk.androidauto.AndroidAutoMapSession#onMapReady">onMapReady</a> callback is triggered.
Parameters
fun onSurfaceDestroyed(surface: Surface): Unit
Indicates that the surface has been destroyed.
Parameters
fun onSurfaceClicked(x: Float, y: Float): Unit
Forwards the <a href="androidx.car.app.SurfaceCallback#onClick">SurfaceCallback.onClick</a> event.
Parameters
fun onSurfaceStableAreaChanged(stableArea: Rect): Unit
Forwards the <a href="androidx.car.app.SurfaceCallback#onStableAreaChanged">SurfaceCallback.onStableAreaChanged</a> event.
Parameters
fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit
Forwards the <a href="androidx.car.app.SurfaceCallback#onVisibleAreaChanged">SurfaceCallback.onVisibleAreaChanged</a> event.
Parameters
fun onMapReady(map: Map): Unit
Provides a map when it is successfully initialized.
Parameters
fun onMapReadyException(exception: Exception): Unit
Provides an exception in case of an error during initialization.
Parameters
fun setTheme(theme: MapTheme): Unit
Applies the theme to the map.<p>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 the <a href="ru.dgis.sdk.mapOptions#mapTheme">mapOptions#mapTheme</a>.</p>
Parameters
fun setCopyrightPosition(position: CopyrightPosition): Unit
Sets the position of the copyright icon on the screen.<p>Important: This method must be called only after the onCreate state of <a href="androidx.car.app.Session#getLifecycle">Lifecycle</a>.</p>
Parameters
AnimationSettings
Настройки анимаций объектов карты.
Применяются для слоев стилей, в которых указан источник модели.
Например, такими слоями являются слои с типами "3D model" и "Directional model".
Индекс анимации должен быть обязательно указан для анимированной модели.
Extends: ru.dgis.sdk.NativeObject
Properties
var animationIndex
Индекс текущей анимации модели.
Если null, то используется значение из стилей.
Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.
var animationName
Название текущей анимации модели.
Если null, то используется значение из стилей.
Если в стилях значение не задано, никакая анимация не проигрывается.
var sceneIndex
Индекс текущей сцены модели.
Если null, то используется значение из стилей.
Если в стилях значение не задано или задано отрицательное,
используется сцена по умолчанию, которая определена в самой модели.
var sceneName
Название текущей сцены модели.
Если null, то используется значение из стилей.
Если в стилях значение не задано, используется сцена по умолчанию, которая определена в самой модели.
var animationRepeatCount
Количество повторений анимации модели.
Если null, то используется значение из стилей.
Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.
var animationSpeed
Скорость проигрывания анимации модели.
Если null, то используется значение из стилей.
Значения больше единицы ускоряют проигрывание, меньше замедляют.
Если в стилях значение не задано, используется скорость по умолчанию.
ApartmentRange
Диапазон квартир.
Properties
val start
Начало диапазона/хранимое значение.
На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.
val end
Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая
прогрессия от start до end с шагом 1.
Attribute
Дополнительный атрибут.
Пример:
{
tag: "hotel_room_internet",
name: "Бесплатный интернет в номерах"
}
Attributes
Интерфейс для управления свойствами объекта карты.<p>Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты,
для стиля и для источника (подробнее см. ISource).</p>
Extends: ru.dgis.sdk.NativeObject
Methods
fun setAttributeValue(name: String, value: AttributeValue): Unit
Установка свойства.
Parameters
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit
Установка набора свойств.
Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values.
Если свойство с таким названием уже было добавлено, то оно заменяется.
Parameters
values
Набор пар "имя":"значение" для добавляемых свойства.
attributesToRemove
Список имён свойств, которые нужно удалить.
Returns
fun removeAttribute(name: String): Unit
Удаление свойства.
Parameters
fun getAttributeValue(name: String): AttributeValue
Получение свойства.
Parameters
Properties
val attributeNames
Получение списка свойств.
val changed
Получение канала, уведомляющего об изменении свойств.
AttributeValue
Свойства объектов карты.
AttributeValue()
Methods
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
Parameters
empty
boolean
number
integer
string
data
array
item
Returns
T
fun toString(): String
Returns
fun hashCode(): Int
Returns
Properties
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
Класс для управления звуком.<p>Все методы могут вызываться из любого потока.</p>
Extends: ru.dgis.sdk.NativeObject
Properties
var volume
Уровень громкости звука (0-100).
var mute
Проигрывание звука отключено.
var audioFocusPolicy
Поведения звуков других приложений при запрошенном фокусе.
AudioStreamReader
Extends: ru.dgis.sdk.NativeObject
Methods
fun read(): List<Short>
Описание типа функции обратного вызова, которую вызывает аудиодрайвер для чтения потока аудиоданных.
Returns
List<Short>буфер, в который записывается аудиопоток.
<p>Описание формата данных аудиопотока:
Кодировка: LPCM (https://en.wikipedia.org/wiki/Pulse-code_modulation).
Количество фреймов в пакете: 1.
Количество семплов в фрейме: 1.
Формат сэмпла: знаковое целое.
Размер сэмпла: 16 бит.
Количество каналов: 1.
Частота дискретизации (Sample rate): 22050 семплов в секунду.</p>
AuthorInfo
Информация об авторе события или фотографии.
AuthorInfo(type: AuthorType, name: String)
Информация об авторе события или фотографии.
Parameters
Properties
val type
Категория автора контента.
val name
Строка, содержащая имя пользователя, добавившего событие или фотографию.<ul><li>Имя пользователя в случае, если автор является авторизированным пользователем
и согласился на отображение своего имени.</li><li>Пустая строка для анонимного по льзователя или пользователя, отказавшегося от отображения своего имени.</li></ul>
AvailableCallback
Extends: ru.dgis.sdk.NativeObject
BaseCamera
Камера.<p>Задаёт параметры проецирования карты на экран.</p>
Extends: ru.dgis.sdk.NativeObject
Methods
fun changePosition(positionChange: CameraPositionChange): Unit
Изменение только части параметров позиции камеры.<p>Вызов прерывает перелёт и обработку жесто в,
а также сбрасывает слежение за изменёнными параметрами,
а при изменении координат также и слежение за стилевым уровнем масштабирования и направлением.</p>
Parameters
Properties
val projection
Проекция.<p>Используется для получения точки экрана по точке карты и точки карты по точке экрана.
Параметры камеры фиксируются в момент вызова.</p>
val positionChannel
Получение текущей позиции камеры.
var position
Получение текущей позиции камеры.
val zoomRestrictionsChannel
Получение актуальных ограничений уровня масштабирования.
var zoomRestrictions
Получение актуальных ограничений уровня масштабирования.
val deviceDensityChannel
Получение отношения DPI к базовому DPI устройства.
val deviceDensity
Получение отношения DPI к базовому DPI устройства.
val sizeChannel
Получение размера области просмотра.
var size
Получение размера области просмотра.
val paddingChannel
Получение текущих отступов от краёв экрана.
var padding
Получение текущих отступов от краёв экрана.
val positionPointChannel
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
var viewPoint
Точка взгляда относительно полн ого размера вьюпорта.
val visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
val visibleRectChannel
Объемлющий прямоугольник видимой области карты.
val visibleRect
Объемлющий прямоугольник видимой области карты.
val maxTiltRestrictionChannel
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
var maxTiltRestriction
Получение текущей функции зависимости максимального угла наклон а камеры от стилевого уровня масштабирования.
val viewportRestrictionChannel
Получение ограничения на область видимости.
var viewportRestriction
Получение ограничения на область видимости.
Bearing
Угол между направлением на один объект и на другой объект, либо между направлением на объект и север.
Угол отсчитывается по часовой стрелке. Диапазон значений <a href="#">0°,360°</a>.
Bearing(value: Double = 0.0)
Угол между направлением на один объект и на другой объект, либо между направлением на объект и север.
Угол отсчитывается по часовой стрелке. Диапазон значений <a href="#">0°,360°</a>.
Parameters
value
Properties
val value
BearingFollowController
Контроллер слежения за направлением карты.
Extends: ru.dgis.sdk.map.FollowController
BearingFollowController(
bearingSource: BearingSource,
animationDuration: Duration = Duration.ofMilliseconds(1000),
valueThreshold: Bearing = Bearing(value = 1.0)
)
Создание контроллера слежения за направлением карты.
Parameters
bearingSource
источник информации о направлении.
animationDuration
неотрицательная длительность изменения реального направления.
valueThreshold
неотрицательное пороговое значение учитываемого изменения реального направления.
BetterRouteInfo
Информация о доступном альтернативном маршруте.
BetterRouteInfo(trafficRoute: TrafficRoute, startPoint: RoutePoint)
Информация о доступном альтернативном маршруте.
Parameters
Properties
val trafficRoute
Альтернативный маршрут.
val startPoint
Точка на альтернативном маршруте, с которой начнётся движение в случае
перехода на этот маршрут
BetterRoutePromptControl
Диалог, предлагающий перейти на ведение по маршруту с меньшим ожидаемым временем прибытия.
BetterRoutePromptControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Диалог, предлагающий перейти на ведение по маршруту с меньшим ожидаемым временем прибытия.
Parameters
Properties
val visibilityChannel
BicycleBriefRouteInfo
Базовая информация о велосипедном маршруте.
BicycleBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о велосипедном маршруте.
Parameters
Properties
BicycleInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
BicycleInstructionCrossroad(landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.NONE, maneuvers: List<BicycleInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
Parameters
Properties
val landmark
Ориентир.
val maneuvers
Цепочка идущих подряд манёвров.
BicycleInstructionCrossroadManeuver
BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Parameters
Properties
val direction
Направление движения.
val turnAngle
Угол поворота в градусах <a href="#">-180,180</a>.