Skip to main content

class

ActiveLevelMode​

Режим отображения этажного плана.

ActiveLevelMode(index: Long)

Режим отображения этажного плана.

Parameters

index

Long
Properties

val index​

Long

Индекс этажа в векторе IIndoorBuilding::levels().

ActivityTracker​

Extends: ru.dgis.sdk.NativeObject
ActivityTracker(
	platformContext: Context,
	model: Model,
	speedBound: Double = 4.2,
	timeThreshold: Duration = Duration.ofMilliseconds(20000)
)

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

Parameters

platformContext

Контекст.

model

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

speedBound

Double

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

timeThreshold

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

Properties

val stopChannel​

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

val stop​

Boolean

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

AddEventResult​

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

AddEventResult(event: RoadEvent)
Parameters

event

AddEventResult(error: AddEventError)
Parameters

error

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

event

(RoadEvent) -> T

error

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

other

Any?
Returns
Boolean
Properties

val isEvent​

Boolean

val asEvent​

val isError​

Boolean

val asError​

val value​

Any?

Address​

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

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

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

Parameters

drillDown

List<AddressAdmDiv>

components

List<AddressComponent>

buildingName

String?

buildingId

postCode

String?

buildingCode

String?

fiasCode

String?

addressComment

String?
Properties

val drillDown​

List<AddressAdmDiv>

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

val components​

List<AddressComponent>

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

val buildingName​

String?

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

val buildingId​

Уникальный идентификатор здания.

val postCode​

String?

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

val buildingCode​

String?

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

val fiasCode​

String?

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

Для получения данной информации запросите дополнительную настройку ключа.

val addressComment​

String?

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

AddressAdmDiv​

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

AddressAdmDiv(type: String, name: String)

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

Parameters

type

String

name

String
Properties

val type​

String

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

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

val name​

String

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

(AddressStreet) -> T

number

(AddressNumber) -> T

location

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

other

Any?
Returns
Boolean
Properties

val isStreetAddress​

Boolean

val asStreetAddress​

val isNumber​

Boolean

val asNumber​

val isLocation​

Boolean

val asLocation​

val value​

Any?

AddressLocation​

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

AddressLocation(comment: String)

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

Parameters

comment

String
Properties

val comment​

String

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

AddressNumber​

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

AddressNumber(number: String, fiasCode: String?)

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

Parameters

number

String

fiasCode

String?
Properties

val number​

String

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

val fiasCode​

String?

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

AddressStreet​

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

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

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

Parameters

street

String

number

String

fiasCode

String?
Properties

val street​

String

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

val number​

String

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

val fiasCode​

String?

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

AddRoadEventButton​

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

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int
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

Context

attrs

AttributeSet?

defStyle

Int
Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
Properties

const MAX_DESCRIPTION_LENGTH​

Int

AddRoadEventCardModel​

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

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

String
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-элементов добавления дорожных событий.

AddRoadEventControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Базовый класс для UI-элементов добавления дорожных событий.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int
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​

MutableList<AutoCloseable>

AddRoadEventControls​

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

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int
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

Context

attrs

AttributeSet?

defStyle

Int
Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
fun detachFromModel(): Unit
Returns
Unit

Aggregate​

Обобщенное описание станции зарядки автомобилей.

Aggregate(
	connectorsFree: Short,
	connectorsTotal: Short,
	isActive: Boolean,
	isBusy: Boolean,
	power: Short
)

Обобщенное описание станции зарядки автомобилей.

Parameters

connectorsFree

Short

connectorsTotal

Short

isActive

Boolean

isBusy

Boolean

power

Short
Properties

val connectorsFree​

Short

Количество доступных коннекторов.

val connectorsTotal​

Short

Общее количество коннекторов (кроме недоступных).

val isActive​

Boolean

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

val isBusy​

Boolean

Статус занятости. true, если половина или более коннекторов заняты.

val power​

Short

Максимальная мощность из всех коннекторов.

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​

Boolean

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

var betterRouteEnabled​

Boolean

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

var routeSearchDelay​

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

var betterRouteTimeCostThreshold​

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

var betterRouteLengthThreshold​

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

var routerType​

Тип поисковика для поиска альтернативных маршрутов.

Anchor​

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

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

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

Parameters

x

Float

y

Float
Properties

val x​

Float

val y​

Float

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(mapOptions: MapOptions)

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.

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 onMapReady callback is triggered.

Parameters

surface

Surface

The Surface object that will be used for rendering content on top of the map.

width

Int

The width of the surface.

height

Int

The height of the surface.

Returns
Unit
fun onSurfaceDestroyed(surface: Surface): Unit

Indicates that the surface has been destroyed.

Parameters

surface

Surface
Returns
Unit
fun onSurfaceClicked(x: Float, y: Float): Unit

Forwards the SurfaceCallback.onClick event.

Parameters

x

Float

y

Float
Returns
Unit
fun onSurfaceStableAreaChanged(stableArea: Rect): Unit

Forwards the SurfaceCallback.onStableAreaChanged event.

Parameters

stableArea

Rect
Returns
Unit
fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit

Forwards the SurfaceCallback.onVisibleAreaChanged event.

Parameters

visibleArea

Rect
Returns
Unit
fun onMapReady(map: Map): Unit

Provides a map when it is successfully initialized.

Parameters

map

Returns
Unit
fun onMapReadyException(exception: Exception): Unit

Provides an exception in case of an error during initialization.

Parameters

exception

Exception
Returns
Unit
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 the mapOptions#mapTheme.

Parameters

theme

Theme to be applied. The loadingBackground attribute is not utilized.

Returns
Unit
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.

Parameters

position

The position of the copyright icon.

Returns
Unit

AnimationSettings​

Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами "3D model" и "Directional model". Индекс анимации должен быть обязательно указан для анимированной модели.

Extends: ru.dgis.sdk.NativeObject
Properties

var animationIndex​

Int?

Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.

var animationName​

String?

Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.

var sceneIndex​

Int?

Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.

var sceneName​

String?

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

var animationRepeatCount​

Int?

Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.

var animationSpeed​

Float?

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

ApartmentRange​

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

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

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

Parameters

start

String

end

String?
Properties

val start​

String

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

val end​

String?

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

Attribute​

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

Attribute(tag: String, value: String)

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

Parameters

tag

String

value

String
Properties

val tag​

String

Тег.

val value​

String

Значение.

Attributes​

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

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

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

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

Parameters

name

String

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

value

Значение.

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

Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.

Parameters

values

Map

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

attributesToRemove

List<String>

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

Returns
Unit
fun removeAttribute(name: String): Unit

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

Parameters

name

String

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

Returns
Unit
fun getAttributeValue(name: String): AttributeValue

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

Parameters

name

String

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

Returns
AttributeValue
Properties

val attributeNames​

List<String>

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

val changed​

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

AttributeValue​

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

AttributeValue()
AttributeValue(boolean: Boolean)
Parameters

boolean

Boolean
AttributeValue(number: Double)
Parameters

number

Double
AttributeValue(integer: Long)
Parameters

integer

Long
AttributeValue(string: String)
Parameters

string

String
AttributeValue(data: ByteArray)
Parameters

data

ByteArray
AttributeValue(array: List<AttributeValue>)
Parameters

array

List<AttributeValue>
AttributeValue(item: Map)
Parameters

item

Map
Methods
fun match(
	empty: Function0<T>,
	boolean: Function1,
	number: Function1,
	integer: Function1,
	string: Function1,
	data: Function1,
	array: Function1,
	item: Function1
): T
Parameters

empty

() -> T

boolean

(Boolean) -> T

number

(Double) -> T

integer

(Long) -> T

string

(String) -> T

data

(ByteArray) -> T

array

(List) -> T

item

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

other

Any?
Returns
Boolean
Properties

val isEmpty​

Boolean

val isBoolean​

Boolean

val asBoolean​

Boolean?

val isNumber​

Boolean

val asNumber​

Double?

val isInteger​

Boolean

val asInteger​

Long?

val isString​

Boolean

val asString​

String?

val isData​

Boolean

val asData​

ByteArray?

val isArray​

Boolean

val asArray​

List?<AttributeValue>

val isObject​

Boolean

val asObject​

Map?

val value​

Any?

AudioSettings​

Класс для управления звуком.

Все методы могут вызываться из любого потока.

Extends: ru.dgis.sdk.NativeObject
Methods
@JvmStatic
fun get(context: Context): AudioSettings?

Настройки аудио. Null, если аудио драйвер недоступен.

Parameters

context

Returns
AudioSettings?
Properties

var volume​

Int

Уровень громкости звука (0-100).

var mute​

Boolean

Проигрывание звука отключено.

var audioFocusPolicy​

Поведения звуков других приложений при запрошенном фокусе.

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

String
Properties

val type​

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

val name​

String

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

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

AvailableCallback​

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

Доступность аудиоуст