Skip to main content

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​

Результат добавления события (объект события или ошибка).

AddEventResult(event: RoadEvent)
Parameters

event

AddEventResult(error: AddEventError)
Parameters

error

Methods
fun match(event: Function1, error: Function1): T
Parameters

event

error

Returns
T
fun toString(): String
Returns
String
fun hashCode(): Int
Returns
Int
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
Properties

val isEvent​

val asEvent​

val isError​

val asError​

val value​

Address​

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

Address(
	drillDown: List<AddressAdmDiv>,
	components: List<AddressComponent>,
	buildingName: String?,
	postCode: String?,
	buildingCode: String?,
	fiasCode: String?,
	addressComment: String?
)

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

Parameters

drillDown

components

buildingName

postCode

buildingCode

fiasCode

addressComment

Properties

val drillDown​

Набор объектов административного деления, в которых находится описываемый объект.

val components​

Полный адрес объекта может содержать несколько отдельных адресных компонент.

val buildingName​

Название здания.

val postCode​

Почтовый индекс.

val buildingCode​

Уникальный почтовый код здания.

val fiasCode​

Код ФИАС объекта.

val addressComment​

Комментарий к адресу. Пример: "301 офис; 9 этаж"

AddressAdmDiv​

Объект административного деления.

AddressAdmDiv(type: String, name: String)

Объект административного деления.

Parameters

type

name

Properties

val type​

Тип административной единицы. Один из следующих:

  • country — страна
  • region — регион (область/край/республика и т.п.)
  • district_area — район области
  • city — город
  • settlement — населённый пункт
  • division — округ
  • district — район
  • living_area — жилмассив, микрорайон
  • place — место

val name​

AddressComponent​

Компонент адреса: улица, номер дома или словесное описание местоположения.

AddressComponent(streetAddress: AddressStreet)
Parameters

streetAddress

AddressComponent(number: AddressNumber)
Parameters

number

AddressComponent(location: AddressLocation)
Parameters

location

Methods
fun match(
	streetAddress: Function1,
	number: Function1,
	location: Function1
): T
Parameters

streetAddress

number

location

Returns
T
fun toString(): String
Returns
String
fun hashCode(): Int
Returns
Int
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
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​

В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).

AddressNumber(number: String, fiasCode: String?)

В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).

Parameters

number

fiasCode

Properties

val number​

Номер дома, включая дроби и буквенные обозначения. Возможно, имя собственное, если так принято.

val fiasCode​

Код ФИАС улицы.

AddressStreet​

Обычный адрес, есть улица и номер дома.

AddressStreet(
	street: String,
	number: String,
	fiasCode: String?
)

Обычный адрес, есть улица и номер дома.

Parameters

street

number

fiasCode

Properties

val street​

Название улицы.

val number​

Номер дома, включая дроби, корпусы и буквенные обозначения.

val fiasCode​

Код ФИАС улицы.

AddRoadEventButton​

Кнопка добавления дорожного события.

Extends: ru.dgis.sdk.road_events.AddRoadEventControl
AddRoadEventButton(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Кнопка добавления дорожного события.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit

AddRoadEventCard​

Карточка добавления дорожного события.

Extends: ru.dgis.sdk.road_events.AddRoadEventControl
AddRoadEventCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Карточка добавления дорожного события.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
Properties

const MAX_DESCRIPTION_LENGTH​

AddRoadEventCardModel​

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

Implements: java.lang.AutoCloseable
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)

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

Parameters

roadEventManager

map

Methods
fun onEventTypeClicked(type: RoadEventType): Unit

Действие при нажатии UI-элемента управления выбором типа события.

Parameters

type

Returns
Unit
fun onLaneClicked(lane: Lane): Unit

Действие при нажатии UI-элемента управления выбором полосы.

Parameters

lane

Returns
Unit
fun onDescriptionEntered(description: String): Unit

Действие при вводе описания.

Parameters

description

Returns
Unit
fun onSendClicked(): Unit

Действие при нажатии кнопки отправки.

Returns
Unit
fun close(): Unit
Returns
Unit
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

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
@CallSuper
fun detachFromModel(): Unit
Returns
Unit
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
Properties

var model​

val closeables​

AddRoadEventControls​

Набор UI-элементов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.

Extends: ru.dgis.sdk.map.MapControl
AddRoadEventControls(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Набор UI-элементов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.

Parameters

context

attrs

defStyle

Methods
fun show(): Unit
Returns
Unit
fun hide(): Unit
Returns
Unit
fun attachToMap(map: Map): Unit
Parameters

map

Returns
Unit
fun detachFromMap(map: Map): Unit
Parameters

map

Returns
Unit
Properties

val cardHeightChannel​

Высота в пикселях, на которую раскрыта карточка.

AddRoadEventMarker​

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

Extends: ru.dgis.sdk.road_events.AddRoadEventControl
AddRoadEventMarker(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
fun detachFromModel(): Unit
Returns
Unit

AlternativeRouteSelector​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun selectAlternativeRoute(trafficRoute: TrafficRoute): Unit

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

Parameters

trafficRoute

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

Returns
Unit

AlternativeRoutesProviderSettings​

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

Extends: ru.dgis.sdk.NativeObject
Properties

var alternativeRoutesEnabled​

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

var betterRouteEnabled​

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

var routeSearchDelay​

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

var betterRouteTimeCostThreshold​

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

var betterRouteLengthThreshold​

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

Anchor​

Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний

Anchor(x: Float = 0.5f, y: Float = 0.5f)

Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний

Parameters

x

y

Properties

val x​

val y​

ApartmentRange​

Диапазон квартир.

ApartmentRange(start: String, end: String? = null)

Диапазон квартир.

Parameters

start

end

Properties

val start​

Начало диапазона/хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.

val end​

Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1.

Attribute​

Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }

Attribute(tag: String, value: String)

Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }

Parameters

tag

value

Properties

val tag​

Тег.

val value​

Значение.

Attributes​

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

Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты, для стиля и для источника (подробнее см. ISource).

Extends: ru.dgis.sdk.NativeObject
Methods
fun setAttributeValue(name: String, value: AttributeValue): Unit

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

Parameters

name

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

value

Значение.

Returns
Unit
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit

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

Parameters

values

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

attributesToRemove

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

Returns
Unit
fun removeAttribute(name: String): Unit

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

Parameters

name

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

Returns
Unit
fun getAttributeValue(name: String): AttributeValue

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

Parameters

name

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

Returns
AttributeValue
Properties

val attributeNames​

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

val changed​

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

AttributeValue​

Свойства объектов карты.

AttributeValue()
AttributeValue(boolean: Boolean)
Parameters

boolean

AttributeValue(number: Double)
Parameters

number

AttributeValue(integer: Long)
Parameters

integer

AttributeValue(string: String)
Parameters

string

AttributeValue(data: ByteArray)
Parameters

data

AttributeValue(array: List<AttributeValue>)
Parameters

array

AttributeValue(item: Map)
Parameters

item

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
String
fun hashCode(): Int
Returns
Int
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
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​

AudioStreamReader​

Extends: ru.dgis.sdk.NativeObject
Methods
fun read(): List<Short>

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

Returns
List<Short>

буфер, в который записывается аудиопоток.

Описание формата данных аудиопотока: Кодировка: LPCM (https://en.wikipedia.org/wiki/Pulse-code_modulation). Количество фреймов в пакете: 1. Количество семплов в фрейме: 1. Формат сэмпла: знаковое целое. Размер сэмпла: 16 бит. Количество каналов: 1. Частота дискретизации (Sample rate): 22050 семплов в секунду.

AuthorInfo​

Информация об авторе события или фотографии.

AuthorInfo(type: AuthorType, name: String)

Информация об авторе события или фотографии.

Parameters

type

name

Properties

val type​

Категория автора контента.

val name​

Строка, содержащая имя пользователя, добавившего событие или фотографию.

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

AvailableCallback​

Extends: ru.dgis.sdk.NativeObject
Methods
fun setAvailable(available: Boolean): Unit

Доступность аудиоустройства приложению.

Parameters

available

Признак доступности аудиоустройства приложению.

Returns
Unit

BaseCamera​

Камера.

Задаёт параметры проецирования карты на экран.

Extends: ru.dgis.sdk.NativeObject
Methods
fun clone(): BaseCamera

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

Returns
BaseCamera
fun changePosition(positionChange: CameraPositionChange): Unit

Изменение только части параметров позиции камеры.

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

Parameters

positionChange

Returns
Unit
Properties

val projection​

Проекция.

Используется для получения точки экрана по точке карты и точки карты по точке экрана. Параметры камеры фиксируются в момент вызова.

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

val visibleArea​

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

val visibleRectChannel​

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

val visibleRect​

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

val maxTiltRestrictionChannel​

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

var maxTiltRestriction​

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

Bearing​

Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений 0°,360°.

Bearing(value: Double = 0.0)

Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений 0°,360°.

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

trafficRoute

startPoint

Properties

val trafficRoute​

Альтернативный маршрут.

val startPoint​

Точка на альтернативном маршруте, с которой начнётся движение в случае перехода на этот маршрут

BetterRoutePromptControl​

Диалог, предлагающий перейти на ведение по маршруту с меньшим ожидаемым временем прибытия.

Extends: ru.dgis.sdk.navigation.NavigationControl
BetterRoutePromptControl(
	context: Context,
	attrs: AttributeSet?