Перейти к основному содержимому

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

Aggregate​

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

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

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

Parameters

connectorsFree

connectorsTotal

isActive

isBusy

power

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
Unit

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) - правый нижний

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

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

Parameters

x

y

Properties

val x​

val 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(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

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.

Returns
Unit
fun onSurfaceDestroyed(surface: Surface): Unit

Indicates that the surface has been destroyed.

Parameters

surface

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

Forwards the SurfaceCallback.onClick event.

Parameters

x

y

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

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​

Получение индекса текущей анимации модели. Если null, то используется значение из стилей.

var sceneIndex​

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

var sceneName​

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

var animationRepeatCount​

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

var animationSpeed​

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

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​

AudioSettings​

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

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

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>

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

Описание формата данных аудиопотока: Кодировка: 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​

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

val viewportRestrictionChannel​

Получение ограничения на область видимости.

var viewportRestriction​

Получение ограничения на область видимости.

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? = null,
	defStyle: Int = 0
)

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
Properties

val visibilityChannel​

BicycleBriefRouteInfo​

Базовая информация о велосипедном маршруте.

BicycleBriefRouteInfo(length: RouteDistance, landmark: String)

Базовая информация о велосипедном маршруте.

Parameters

length

landmark

Properties

val length​

Длина маршрута.

val landmark​

Ориентир.

BicycleInstructionCrossroad​

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

BicycleInstructionCrossroad(landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.NONE, maneuvers: List<BicycleInstructionCrossroadManeuver>)

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

Parameters

landmark

maneuvers

Properties

val landmark​

Ориентир.

val maneuvers​

Цепочка идущих подряд манёвров.

BicycleInstructionCrossroadManeuver​

BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Parameters

direction

turnAngle

Properties

val direction​

Направление движения.

val turnAngle​

Угол поворота в градусах -180,180.

BicycleInstructionFinish​

Конец велосипедной части маршрута.

BicycleInstructionFinish()

Конец велосипедной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

BicycleInstructionStart​

Начало велосипедной части маршрута.

BicycleInstructionStart()

Начало велосипедной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

BicycleRouteSearchOptions​

Параметры поиска маршрута на велосипеде.

BicycleRouteSearchOptions(
	avoidCarRoads: Boolean = false,
	avoidStairways: Boolean = false,
	avoidUnderpassesAndOverpasses: Boolean = false,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска маршрута на велосипеде.

Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

val avoidCarRoads​

Избегать автомобильных дорог.

val avoidStairways​

Избегать лестниц.

val avoidUnderpassesAndOverpasses​

Избегать подземных и надземных переходов.

val excludedAreas​

Исключаемые области (не больше 25).

BoolRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): BoolRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
BoolRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<BoolRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<BoolRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

BoolRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

BoolRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: Boolean
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

Borders​

Описывает набор непрерывного упорядоченных значений.

Borders(
	snapping: Double?,
	isLg: Boolean,
	value: String,
	min: Double,
	max: Double,
	currentMin: Double? = null,
	currentMax: Double? = null
)

Описывает набор непрерывного упорядоченных значений.

Parameters

snapping

isLg

value

min

max

currentMin

currentMax

Properties

val snapping​

Задаёт притяжку до значения, кратного этому числу.

val isLg​

Признак использования логарифмической шкалы.

val value​

Значение, по которым происходит фильтрация.

val min​

Нижняя граница набора значений.

val max​

Верхняя граница набора значений.

val currentMin​

Текущее установленное минимальное значение.

val currentMax​

Текущее установленное максимальное значение.

BriefExtraRouteInfo​

Дополнительная информация о маршруте для конкретного типа транспорта.

BriefExtraRouteInfo(bicycle: BicycleBriefRouteInfo)
Parameters

bicycle

BriefExtraRouteInfo(car: CarBriefRouteInfo)
Parameters

car

BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)
Parameters

pedestrian

BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)
Parameters

publicTransport

BriefExtraRouteInfo(scooter: ScooterBriefRouteInfo)
Parameters

scooter

Methods
fun match(
	bicycle: Function1,
	car: Function1,
	pedestrian: Function1,
	publicTransport: Function1,
	scooter: Function1
): T
Parameters

bicycle

car

pedestrian

publicTransport

scooter

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

other

Returns
Boolean
Properties

val isBicycle​

val asBicycle​

val isCar​

val asCar​

val isPedestrian​

val asPedestrian​

val isPublicTransport​

val asPublicTransport​

val isScooter​

val asScooter​

val value​

BriefPublicTransportCard​

Краткая карточка, отображающая информацию о маршруте на общественном транспорте. В отличии от PublicTransportCard не содержит информацию о пересадках.

Extends: android.widget.FrameLayout
BriefPublicTransportCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Краткая карточка, отображающая информацию о маршруте на общественном транспорте. В отличии от PublicTransportCard не содержит информацию о пересадках.

Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
Properties

var model​

BriefPublicTransportCardModel​

Модель для BriefPublicTransportCard.

BriefPublicTransportCardModel(route: TrafficRoute, context: Context)

Модель для BriefPublicTransportCard.

Parameters

route

context

Properties

val title​

Заголовок. Предполагаемое время проезда, например, "1 ч 42 мин."

val transports​

Информация о транспорте.

val description​

Описание. Количество пересадок и время пешком, например, 1пересадка,Пешком15мин.

BriefRoadEvent​

BriefRoadEvent(
	id: Long = 0,
	eventType: RoadEventType = RoadEventType.OTHER,
	lanes: EnumSet<Lane>
)
Parameters

id

eventType

lanes

Properties

val id​

val eventType​

val lanes​

BriefRouteInfo​

Базовая информация о маршруте.

BriefRouteInfo(duration: Duration, extraInfo: BriefExtraRouteInfo)

Базовая информация о маршруте.

Parameters

duration

extraInfo

Properties

val duration​

Время движения по маршруту.

val extraInfo​

Дополнительная информация о маршруте для конкретного типа транспорта.

BriefRouteInfoSearchPoints​

Точки для запроса поиска базовой информации о маршруте.

BriefRouteInfoSearchPoints(startPoint: RouteSearchPoint, finishPoint: RouteSearchPoint)

Точки для запроса поиска базовой информации о маршруте.

Parameters

startPoint

finishPoint

Properties

val startPoint​

Начальная точка маршрута.

val finishPoint​

Конечная точка маршрута.

BuildingId​

Идентификатор здания.

BuildingId(value: Long = 0)

Идентификатор здания.

Parameters

value

Properties

val value​

BuildingInfo​

Информация о здании.

BuildingInfo(
	buildingName: String? = null,
	purposeName: String? = null,
	purposeCode: PurposeCode? = null,
	buildingLevels: BuildingLevels? = null
)

Информация о здании.

Parameters

buildingName

purposeName

purposeCode

buildingLevels

Properties

val buildingName​

Собственное имя здания.

val purposeName​

Описание назначения здания.

val purposeCode​

Код назначения здания.

val buildingLevels​

Информация об этажных планах здания.

BuildingLevels​

Информация об этажных планах здания.

BuildingLevels(defaultLevelId: LevelId, levels: List<LevelInfo>)

Информация об этажных планах здания.

Parameters

defaultLevelId

levels

Properties

val defaultLevelId​

Идентификатор этажного плана по умолчанию.

val levels​

Все этажные планы здания.

CalloutMapPosition​

Положение бабла маршрута.

CalloutMapPosition(
	mapId: MapId,
	calloutPosition: GeoPoint?,
	routePoint: RoutePoint?
)

Положение бабла маршрута.

Parameters

mapId

calloutPosition

routePoint

Properties

val mapId​

Идентификатор карты, для которой приведена позиция.

val calloutPosition​

Позиция на карте.

val routePoint​

Позиция бабла на маршруте.

Camera​

Камера для запуска перемещения карты и настроек слежения.

Extends: ru.dgis.sdk.map.BaseCamera
Methods
fun move(moveController: CameraMoveController): Future<CameraAnimatedMoveResult>

Запуск перемещения карты.

Сбрасывает текущий режим слежения карты и прерывает обработку жестов.

Parameters

moveController

Контроллер анимированного перемещения камеры.

Returns
Future<CameraAnimatedMoveResult>
fun move(
	position: CameraPosition,
	time: Duration = Duration.ofMilliseconds(300),
	animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>

Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.

Сбрасывает слежение за позицией, уровнем масштабирования, наклоном и направлением и прерывает обработку жестов.

Parameters

position

Конечная позиция камеры.

time

Время, выделенное на перемещение карты.

animationType

Тип анимации при перемещении камеры.

Returns
Future<CameraAnimatedMoveResult>
fun move(
	point: GeoPoint,
	zoom: Zoom,
	tilt: Tilt?,
	bearing: Bearing,
	time: Duration = Duration.ofMilliseconds(300),
	animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>

Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.

Сбрасывает слежение за позицией, уровнем масштабирования и направлением и прерывает обработку жестов.

Если tilt задан, то сбрасывается слежение за наклоном.

Если tilt не задан и слежения за наклоном нет, то используется текущее значение наклона.

Parameters

point

точка конечной позиции камеры

zoom

уровень масштабирования в конечной позиции камеры

tilt

наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller'а или текущее значение

bearing

поворот в конечной позиции камеры

time

время, выделенное на перемещение карты

animationType

тип анимации при перемещении камеры

Returns
Future<CameraAnimatedMoveResult>
fun processMovementAndStop(): Unit

Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.

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

Returns
Unit
fun setBehaviour(behaviour: CameraBehaviour): Unit

Смена режима слежения камеры. Если новый режим более ограниченный, чем текущий, вызов прервёт перелёт и обработку жестов.

Parameters

behaviour

Returns
Unit
fun addFollowController(followController: FollowController): Unit

Добавление контроллера слежения.

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

Parameters

followController

Returns
Unit
fun removeFollowController(followController: FollowController): Unit

Удаление контроллера слежения.

Parameters

followController

Returns
Unit
fun setCustomFollowController(followController: CustomFollowController): Unit

Добавление контроллера слежения, реализованного на платформе.

Можно установить только один такой контроллер. Если установить несколько контроллеров, то будет использоваться только последний установленный.

Parameters

followController

Returns
Unit
fun removeCustomFollowController(): Unit

Удаление контроллера слежения, реализованного на платформе.

Returns
Unit
Properties

val stateChannel​

Получение актуального состояния камеры.

val state​

Получение актуального состояния камеры.

val behaviourChannel​

Режим слежения камеры.

val behaviour​

Режим слежения камеры.

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

Parameters

position

tilt

Properties

val position​

val tilt​

CameraBehaviourChange​

Изменение режима слежения.

CameraBehaviourChange(newBehaviour: CameraBehaviour, changeReason: CameraBehaviourChangeReason = CameraBehaviourChangeReason.APPLICATION)

Изменение режима слежения.

Parameters

newBehaviour

changeReason

Properties

val newBehaviour​

Новый режим слежения.

val changeReason​

Причина изменения режима слежения.

CameraNotifier​

Предупреждает о попадании в зону действия дорожной камеры.

Extends: ru.dgis.sdk.NativeObject
CameraNotifier(model: Model)

Расширение навигатора, которое предупреждает о попадании в зону действия дорожной камеры.

Parameters

model

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

Properties

val cameraProgressChannel​

Прогресс прохождения зоны действия дорожной камеры.

val cameraProgress​

Прогресс прохождения зоны действия дорожной камеры.

CameraPosition​

Позиция камеры.

CameraPosition(
	point: GeoPoint,
	zoom: Zoom,
	tilt: Tilt = Tilt(value = 0.0f),
	bearing: Bearing = Bearing(value = 0.0)
)

Позиция камеры.

Parameters

point

zoom

tilt

bearing

Properties

val point​

Точка местности, которая находится в точке позиции камеры (см. ICamera::position_point()).

val zoom​

Уровень масштабирования. 0 - это весь мир, вписанный в квадрат 256x256 логических пикселей (см. LogicalPixel)

val tilt​

Угол наклона направления взгляда по вертикали.

0 - надир (смотрим вертикально вниз), максимальное значение - 60 градусов.

val bearing​

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

CameraPositionChange​

Описание изменения части параметров позиции камеры.

CameraPositionChange(
	point: GeoPoint? = null,
	zoom: Zoom? = null,
	tilt: Tilt? = null,
	bearing: Bearing? = null
)

Описание изменения части параметров позиции камеры.

Parameters

point

zoom

tilt

bearing

Properties

val point​

val zoom​

val tilt​

val bearing​

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 - правый нижний

Parameters

x

y

Properties

val x​

val y​

CameraProgressInfo​

Информация о прогрессе прохождения зоны камеры.

CameraProgressInfo(
	camera: RouteCamera,
	position: RoutePoint,
	progress: Float = 0.0f
)

Информация о прогрессе прохождения зоны камеры.

Parameters

camera

position

progress

Properties

val camera​

Камера, для зоны действия которой отслеживается прогресс.

val position​

Позиция камеры на маршруте.

val progress​

Прогресс прохождения зоны действия камеры, 0,1.

CameraRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<CameraRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<CameraRouteEntry>
fun findNearBackward(point: RoutePoint): CameraRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
CameraRouteEntry?
fun findNearForward(point: RoutePoint): CameraRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
CameraRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

CameraRouteEntry​

Элемент маршрута - точка и значение в ней.

CameraRouteEntry(point: RoutePoint, value: RouteCamera)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

CameraZoomRestrictions​

Допустимый диапазон изменения уровня масштабирования.

CameraZoomRestrictions(minZoom: Zoom = Zoom(value = 0.0f), maxZoom: Zoom = Zoom(value = 20.0f))

Допустимый диапазон изменения уровня масштабирования.

Parameters

minZoom

maxZoom

Properties

val minZoom​

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

val maxZoom​

Максимальный масштаб ограничен величиной 20.

CancelEvent​

Событие отмены текущего действия.

Вызывается, например, при отмене жеста, потере фокуса окна или при потере захвата мыши. Также может быть вызван изнутри карты при смене ограничений уровня масштабирования, некоторых изменениях режима слежения и установке интерактивного режима карты.

Extends: ru.dgis.sdk.map.Event
CancelEvent()

CarBriefRouteInfo​

Базовая информация об автомобильном маршруте.

CarBriefRouteInfo(
	length: RouteDistance,
	landmark: String,
	trafficSpeed: CarBriefRouteInfoTrafficSpeed
)

Базовая информация об автомобильном маршруте.

Parameters

length

landmark

trafficSpeed

Properties

val length​

Длина маршрута.

val landmark​

Ориентир.

val trafficSpeed​

Скорость движения.

CarInstructionCrossroad​

Описание манёвров на перекрёстке.

CarInstructionCrossroad(
	direction: CarInstructionCrossroadDirection = CarInstructionCrossroadDirection.STRAIGHT,
	turnAngle: Int = 0,
	landmark: CarInstructionCrossroadLandmark = CarInstructionCrossroadLandmark.NONE,
	exitName: String
)

Описание манёвров на перекрёстке.

Parameters

direction

turnAngle

landmark

exitName

Properties

val direction​

Направление движения на перекрёстке.

val turnAngle​

Угол поворота в градусах -180,180.

val landmark​

Ориентир.

val exitName​

Название съезда.

CarInstructionFinish​

Конец автомобильной части маршрута.

CarInstructionFinish()

Конец автомобильной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

CarInstructionRoundabout​

Описание манёвров на перекрёстке с круговым движением.

CarInstructionRoundabout(
	type: CarInstructionRoundaboutType = CarInstructionRoundaboutType.ENTRY,
	turnAngle: Int = 0,
	exitNumber: Int = 0,
	exitName: String
)

Описание манёвров на перекрёстке с круговым движением.

Parameters

type

turnAngle

exitNumber

exitName

Properties

val type​

Тип инструкции.

val turnAngle​

Угол поворота в градусах -180,180.

val exitNumber​

Номер съезда - 1,inf или 0, если номер съезда неизвестен.

val exitName​

Название съезда.

CarInstructionStart​

Начало автомобильной части маршрута.

CarInstructionStart()

Начало автомобильной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

CarInstructionUTurn​

Разворот на дороге (не на перекрёстке).

Разворот на перекрестке описывается инструкцией Crossroad.

CarInstructionUTurn(exitName: String)

Разворот на дороге (не на перекрёстке).

Разворот на перекрестке описывается инструкцией Crossroad.

Parameters

exitName

Properties

val exitName​

Название съезда.

CarRouteSearchOptions​

Параметры поиска маршрута на легковом автомобиле.

CarRouteSearchOptions(
	avoidTollRoads: Boolean = false,
	avoidUnpavedRoads: Boolean = false,
	avoidFerries: Boolean = false,
	avoidLockedRoads: Boolean = true,
	routeSearchType: RouteSearchType = RouteSearchType.JAM,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска маршрута на легковом автомобиле.

Parameters

avoidTollRoads

avoidUnpavedRoads

avoidFerries

avoidLockedRoads

routeSearchType

excludedAreas

Properties

val avoidTollRoads​

Избегать платных дорог.

val avoidUnpavedRoads​

Избегать грунтовых дорог.

val avoidFerries​

Избегать паромных переправ.

val avoidLockedRoads​

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

val routeSearchType​

Тип поиска маршрута.

val excludedAreas​

Исключаемые области (не больше 25).

Certificate​

SSL-сертификат.

Certificate(system: SystemCertificate)
Parameters

system

Certificate(fromFile: CertificateFromFile)
Parameters

fromFile

Certificate(fromAsset: CertificateFromAsset)
Parameters

fromAsset

Methods
fun match(
	system: Function1,
	fromFile: Function1,
	fromAsset: Function1
): T
Parameters

system

fromFile

fromAsset

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

other

Returns
Boolean
Properties

val isSystem​

val asSystem​

val isFromFile​

val asFromFile​

val isFromAsset​

val asFromAsset​

val value​

val default​

Сертификаты, используемые по умолчанию. Системные + российские, поставляемые вместе с SDK.

CertificateFromAsset​

SSL-сертификат из asset-а.

CertificateFromAsset(path: String)

SSL-сертификат из asset-а.

Parameters

path

Properties

val path​

Путь относительно корневой директории asset-ов.

CertificateFromFile​

SSL-сертификат из файла.

CertificateFromFile(path: String)

SSL-сертификат из файла.

Parameters

path

Properties

val path​

Путь к файлу.

ChargingStation​

Аттрибуты для электрозаправок.

ChargingStation(aggregate: Aggregate, connectors: List<Connector>)

Аттрибуты для электрозаправок.

Parameters

aggregate

connectors

Properties

val aggregate​

val connectors​

CheckableGroupedItem​

Единичный элемент из GroupCheckableItem.

Extends: ru.dgis.sdk.NativeObject
Properties

val text​

Получение текстового описания элемента.

val values​

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

var isChecked​

Получение состояния элемента.

CheckableItem​

Базовое представление отмечаемого элемента из CheckableItemsGroup.

Extends: ru.dgis.sdk.NativeObject
Properties

val type​

Получение типа отмечаемого элемента.

val filterType​

Получение списка фильтров, описывающих текущее состояние виджета. Может быть использован при формировании поискового запроса.

CheckableItemsGroup​

Виджет для представления группы отмечаемых элементов.

Extends: ru.dgis.sdk.directory.Widget
Properties

val items​

Получение группы элементов виджета.

Checkbox​

Виджет-чекбокс.

Extends: ru.dgis.sdk.directory.Widget
Properties

val filterType​

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

val checkedText​

Получение текста подписи для "отмеченного" чекбокса.

val uncheckedText​

Получение текста подписи для "неотмеченного" чекбокса.

val values​

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

var isChecked​

Получение состояния виджета.

Circle​

Окружность.

Extends: ru.dgis.sdk.map.SimpleMapObject
Circle(options: CircleOptions)
Parameters

options

Properties

var position​

Местоположение центра окружности.

var radius​

Радиус окружности.

var color​

Цвет заливки окружности.

var strokeWidth​

Ширина линии границы окружности.

var strokeColor​

Цвет границы окружности.

var dashedStrokeOptions​

Получение параметров пунктирной обводки

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
)

Параметры для создания геометрического объекта карты типа "Окружность".

Parameters

position

radius

color

strokeWidth

strokeColor

dashedStrokeOptions

visible

userData

zIndex

levelId

Properties

val position​

Географическая позиция.

val radius​

Радиус в метрах.

val color​

Цвет заливки.

val strokeWidth​

Ширина линии границы окружности.

val strokeColor​

Цвет линии границы окружности.

val dashedStrokeOptions​

Параметры пунктирной границы.

val visible​

Флаг видимости.

val userData​

Пользовательские данные (не используются внутри SDK, нужны только для пользователя API).

val zIndex​

Уровень отрисовки объекта.

val levelId​

Привязка к поэтажному плану здания.

ClusterObject​

Кластер объектов.

Extends: ru.dgis.sdk.map.MapObject
Properties

val position​

Получение позиции кластера на карте.

val objectCount​

Получение количества маркеров в кластере.

val objects​

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

val geometryObject​

Получение геометрического объекта кластера.

ClusterOptions​

Параметры маркера кластера.

ClusterOptions(attributes: Map, userData: Any? = null)

Параметры маркера кластера.

Parameters

attributes

userData

Properties

val attributes​

Атрибуты кластера.

val userData​

Пользовательские данные. Возвращаются в IClusterObject.

Color​

Цвет

Color(argb: Int = 4278190080.toInt())

Цвет

Parameters

argb

Properties

val argb​

val red​

val green​

val blue​

val alpha​

CompassControl​

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

context

attrs

defStyle

CompassControl​

UI-элемент управления компасом.

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

UI-элемент управления компасом.

Parameters

context

attrs

defStyle

layout

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

CompassControlModel​

Модель контрола компаса. Контрол состоит из кнопки компаса, при нажатии на которую камера карты меняет угол в направлении севера. Если камера карты смотрит на сервер, то контрол необходимо скрывать. Потокобезопасно.

Extends: ru.dgis.sdk.NativeObject
CompassControlModel(map: Map)
Parameters

map

Methods
fun onClicked(): Unit
Returns
Unit
Properties

val bearingChannel​

val bearing​

ComplexGeometry​

Составная геометрия, состоит из набора простых или составных геометрий.

Поддерживается произвольный уровень вложенности составных геометрий в наборе.

Extends: ru.dgis.sdk.geometry.Geometry
ComplexGeometry(geometries: List<Geometry>)
Parameters

geometries

Properties

val elements​

Connector​

Connector(
	power: Short,
	price: Short,
	status: StatusType,
	type: String
)
Parameters

power

price

status

type

Properties

val power​

Мощность зарядки в кВт.

val price​

Стоимость за один кВт·ч.

val status​

Статус.

val type​

Тип коннектора.

ContactInfo​

Способ связаться с организацией.

ContactInfo(
	type: String,
	displayText: String,
	value: String,
	comment: String?
)

Способ связаться с организацией.

Parameters

type

displayText

value

comment

Properties

val type​

Тип контакта. Один из следующих:

  • email — электронная почта
  • website — сайт
  • phone — телефон
  • fax — факс
  • pobox — абонентский ящик
  • icq
  • jabber
  • skype
  • vkontakte
  • twitter
  • odnoklassniki
  • youtube
  • linkedin
  • googleplus
  • pinterest
  • whatsapp
  • 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.

Extends: ru.dgis.sdk.NativeObject

CoordinatesFollowController​

Контроллер слежения за координатами позиции карты.

Extends: ru.dgis.sdk.map.FollowController
CoordinatesFollowController(animationDuration: Duration = Duration.ofMilliseconds(1000), valueThreshold: Meter = Meter(value = 0.1f))

Создание контроллера слежения за координатами позиции карты.

Parameters

animationDuration

длительность изменения реальной позиции.

valueThreshold

неотрицательное пороговое значение учитываемого изменения реальной позиции.

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.

Parameters

left

top

right

bottom

Properties

val left​

val top​

val right​

val bottom​

CopyrightPosition​

Position of the copyright icon on the screen.

CopyrightPosition(gravity: Int, margins: CopyrightMargins)

Position of the copyright icon on the screen.

Parameters

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.

Properties

val gravity​

The gravity value (e.g., Gravity.START, Gravity.BOTTOM) that determines the alignment of the copyright icon within the screen.

val margins​

The margins between the screen and a copyright icon.

CustomDashboardButton​

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

Extends: ru.dgis.sdk.navigation.CustomizableDashboardButton
CustomDashboardButton(icon: Int, onClick: Function0<Unit>)

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

Parameters

icon

onClick

Properties

val icon​

ID drawable-ресурса, который будет использован как иконка кнопки.

val onClick​

Действие, которое будет выполнено при клике на кнопку.

CustomizableDashboardButton​

DashboardButtonAbsent​

Используется в DefaultNavigationControls.setCustomDashboardButton для обозначения того, что кнопку действия необходимо скрыть.

Extends: ru.dgis.sdk.navigation.CustomizableDashboardButton

DashboardControl​

Extends: ru.dgis.sdk.navigation.NavigationControl
DashboardControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)
Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
fun collapse(action: Function0?<Unit> = null): Unit
Parameters

action

Returns
Unit
fun toggleExpandedState(): Unit
Returns
Unit
Properties

val remainingRouteInfoControl​

var onFinishClicked​

var onShowRouteClicked​

var isFreeRoam​

val headerHeight​

DashedPolylineOptions​

Параметры пунктирной полилинии.

DashedPolylineOptions(dashLength: LogicalPixel = LogicalPixel(value = 5.0f), dashSpaceLength: LogicalPixel = LogicalPixel(value = 2.0f))

Параметры пунктирной полилинии.

Parameters

dashLength

dashSpaceLength

Properties

val dashLength​

Длина пунктира.

val dashSpaceLength​

Длина межпунктирного расстояния.

DashedStrokeCircleOptions​

DashedStrokeCircleOptions(dashLength: LogicalPixel = LogicalPixel(value = 5.0f), dashSpaceLength: LogicalPixel = LogicalPixel(value = 2.0f))
Parameters

dashLength

dashSpaceLength

Properties

val dashLength​

Длина пунктира.

val dashSpaceLength​

Длина межпунктирного расстояния.

DayTime​

Момент времени внутри дня.

DayTime(hours: Byte, minutes: Byte)

Момент времени внутри дня.

Parameters

hours

minutes

Properties

val hours​

Часы, 0-23.

val minutes​

Минуты, 0-59.

DefaultLocationSource​

Реализация источника геопозиции, которую рекомендуется использовать по умолчанию. При наличии GMS использует их, иначе - LocationManager.

Implements: ru.dgis.sdk.positioning.LocationSource|ru.dgis.sdk.positioning.LocationService
DefaultLocationSource(context: Context)

Реализация источника геопозиции, которую рекомендуется использовать по умолчанию. При наличии GMS использует их, иначе - LocationManager.

Parameters

context

Methods
@Synchronized
fun activate(listener: LocationChangeListener): Unit
Parameters

listener

Returns
Unit
@Synchronized
fun deactivate(): Unit
Returns
Unit
@Synchronized
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit
Parameters

accuracy

Returns
Unit
fun onPermissionGranted(): Unit

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

Returns
Unit
@Synchronized
fun onProvidersChanged(): Unit
Returns
Unit
Properties

val lastLocation​

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

var isGMSAllowed​

Использовать ли GMS.

DefaultNavigationControls​

UI контролы навигатора, предлагаемые к использованию по умолчанию: полосность, ограничение скорости, обозначение следующего манёвра и т.д. Пользователи SDK также могут создать свои собственные UI контролы и использовать UI модель навигатора для получения оповещений о событиях при ведении по маршруту.

Extends: ru.dgis.sdk.navigation.NavigationControl
DefaultNavigationControls(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI контролы навигатора, предлагаемые к использованию по умолчанию: полосность, ограничение скорости, обозначение следующего манёвра и т.д. Пользователи SDK также могут создать свои собственные UI контролы и использовать UI модель навигатора для получения оповещений о событиях при ведении по маршруту.

Parameters

context

attrs

defStyle

Methods
fun setCustomDashboardButton(button: CustomizableDashboardButton): Unit

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

Должен быть вызван до добавления DefaultNavigationControls в иерархию UI–элементов.

Parameters

button

Returns
Unit
fun onConfigurationChanged(newConfig: Configuration): Unit
Parameters

newConfig

Returns
Unit
fun attachToManager(manager: NavigationManager): Unit
Parameters

manager

Returns
Unit
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
fun onAttachedToWindow(): Unit
Returns
Unit
Properties

var onFinishClicked​

var isFreeRoamDefault​

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

DefaultRasterUrlTemplate​

DefaultRasterUrlTemplate(urlTemplate: String)
Parameters

urlTemplate

Properties

val urlTemplate​

DeviceDensity​

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

В Android соответствует resources.displayMetrics.density В iOS соответствует nativeScale

должен быть положительным.

DeviceDensity(value: Float = 0.0f)

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

В Android соответствует resources.displayMetrics.density В iOS соответствует nativeScale

должен быть положительным.

Parameters

value

Properties

val value​

DevicePpi​

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

должна быть положительной.

DevicePpi(value: Float = 0.0f)

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

должна быть положительной.

Parameters

value

Properties

val value​

DGis​

Точка входа в 2GIS SDK. На старте работы необходимо вызвать initialize.

Methods
@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()
): Context

Необходимо вызвать этот метод до начала работы с SDK.

Parameters

appContext

контекст android приложения.

httpOptions

настройки сетевого клиента.

logOptions

параметры логирования.

vendorConfig

переопределение конфигурации SDK.

keySource

источник ключа.

dataCollectConsent

согласие на сбор данных и обработку данных

platformHttpClient

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

platformAudioDriver

платформенный аудиодрайвер.

mapOptions

настройки, применяемые ко всем картам.

Returns
Context

sdkContext необходимый для работы сервисов SDK.

@JvmStatic
fun context(): Context
Returns
Context

DgisMapObject​

Объект карты 2GIS.

информацию об объекте можно получить через справочник (directory)

Extends: ru.dgis.sdk.map.MapObject
Properties

val id​

Стабильный числовой идентификатор объекта.

DgisObjectId​

DgisObjectId(objectId: Long = 0, entranceId: Long = 0)
Parameters

objectId

entranceId

Properties

val objectId​

Стабильный числовой идентификатор объекта.

Нулевой идентификатор не соответствует ни одному объекту.

val entranceId​

Стабильный числовой идентификатор входа/подъезда для объекта object_id.

Нулевой идентификатор означает что вход/подъезд не задан.

DgisSource​

Основной интерфейс источников данных 2ГИС.

Extends: ru.dgis.sdk.map.Source
Methods
fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit

Установка или снятие выделения объектов.

добавляет объекту атрибут "selected", который можно использовать в стилях.

Parameters

directoryObjectIds

Идентификаторы изменяемых объектов.

highlighted

Установка или снятие выделения.

Returns
Unit
@JvmStatic
fun createDgisSource(context: Context, workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.HYBRID_ONLINE_FIRST): Source

Создание источника, получающего данные с серверов 2ГИС или использующего в работе предварительно загруженные данные.

Parameters

context

workingMode

Returns
Source
Properties

val highlightedObjectsChannel​

Получение списка идентификаторов выделенных объектов.

val highlightedObjects​

Получение списка идентификаторов выделенных объектов.

DirectMapControlBeginEvent​

Событие начала прямого управления картой. Сообщает карте, что необходимо обрабатывать события прямого управления картой. События прямого управления работают только от DirectMapControlBeginEvent до DirectMapControlEndEvent. После завершения последовательности событий прямого управления может запуститься кинематика. Кинематика использует время возникновения события, поэтому лучше использовать время, полученное от системы, а не заполнять значение при обработке. Пока кинематика работает только для перемещения карты, но не для вращения и масштабирования.

Extends: ru.dgis.sdk.map.Event
DirectMapControlBeginEvent()

DirectMapControlEndEvent​

Событие окончания прямого управления картой. Завершает прямое управление картой, начатое после получения события DirectMapControlBeginEvent. О событиях прямого управления картой описано в DirectMapControlBeginEvent.

Extends: ru.dgis.sdk.map.InputEvent
DirectMapControlEndEvent(timestamp: Duration)
Parameters

timestamp

DirectMapRotationEvent​

Событие прямого вращения карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.

Extends: ru.dgis.sdk.map.InputEvent
DirectMapRotationEvent(
	bearingDelta: Bearing,
	timestamp: Duration,
	rotationCenter: ScreenPoint? = null
)
Parameters

bearingDelta

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

timestamp

Время генерации системного события.

rotationCenter

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

Properties

val bearingDelta​

Изменение угла поворота карты.

val rotationCenter​

Точка на экране, вокруг которой вращается карта.

DirectMapScalingEvent​

Событие прямого масштабирования карты. События прямого управления картой описаны в DirectMapControlBeginEvent.

Extends: ru.dgis.sdk.map.InputEvent
DirectMapScalingEvent(
	zoomDelta: Float,
	timestamp: Duration,
	scalingCenter: ScreenPoint? = null
)
Parameters

zoomDelta

Величина, на которую изменится текущее значение масштаба.

timestamp

Время генерации системного события.

scalingCenter

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

Properties

val zoomDelta​

Величина, на которую изменится текущее значение масштаба.

val scalingCenter​

Точка на экране, относительно которой масштабируется карта.

DirectMapShiftEvent​

Событие прямого сдвига карты. События прямого управления картой описаны в DirectMapControlBeginEvent.

Extends: ru.dgis.sdk.map.InputEvent
DirectMapShiftEvent(
	screenShift: ScreenShift,
	shiftedPoint: ScreenPoint,
	timestamp: Duration
)
Parameters

screenShift

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

shiftedPoint

Центральная точка, от которой производится смещение карты.

timestamp

Время генерации системного события.

Properties

val screenShift​

Изменение экранной позиции карты.

val shiftedPoint​

Центральная точка, от которой производится смещение карты.

DirectMapTiltEvent​

Событие прямого наклона камеры. События прямого управления картой описаны в DirectMapControlBeginEvent.

Extends: ru.dgis.sdk.map.InputEvent
DirectMapTiltEvent(delta: Float, timestamp: Duration)
Parameters

delta

Изменение угла наклона в градусах.

timestamp

Время генерации системного события.

Properties

val delta​

Изменение угла наклона в градусах.

DirectoryFilter​

Фильтры для справочника.

DirectoryFilter(workTime: WorkTimeFilter?, dynamic: List<DynamicFilter>)

Фильтры для справочника.

Parameters

workTime

dynamic

Properties

val workTime​

Фильтр по времени работы.

val dynamic​

Динамические фильтры.

DirectoryObject​

Объект справочника.

Extends: ru.dgis.sdk.NativeObject
Methods
fun formattedAddress(type: FormattingType): FormattedAddress?

Cтроковое представление адреса, отформатированное в соответствии с указанным требованием к длине.

Parameters

type

Returns
FormattedAddress?
Properties

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

Информация об этажных планах здания.

val entrances​

Информация о входах.

val tradeLicense​

Данные о лицензии организации.

val buildingInfo​

Информация о здании.

val chargingStation​

Аттрибуты для электрозаправки.

DoubleRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<DoubleRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<DoubleRouteEntry>
fun findNearBackward(point: RoutePoint): DoubleRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
DoubleRouteEntry?
fun findNearForward(point: RoutePoint): DoubleRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
DoubleRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

DoubleRouteEntry​

Элемент маршрута - точка и значение в ней.

DoubleRouteEntry(point: RoutePoint, value: Double)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

DragBeginData​

Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.

DragBeginData(point: ScreenPoint, item: RenderedObject)

Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.

Parameters

point

item

Properties

val point​

val item​

Duration​

Класс, представляющий период времени.

Implements: kotlin.Comparable
Methods
operator fun unaryMinus(): Duration
Returns
Duration
operator fun plus(other: Duration): Duration
Parameters

other

Returns
Duration
operator fun minus(other: Duration): Duration
Parameters

other

Returns
Duration
operator fun times(scale: Int): Duration
Parameters

scale

Returns
Duration
operator fun times(scale: Double): Duration
Parameters

scale

Returns
Duration
operator fun div(scale: Int): Duration
Parameters

scale

Returns
Duration
operator fun div(scale: Double): Duration
Parameters

scale

Returns
Duration
fun compareTo(other: Duration): Int
Parameters

other

Returns
Int
fun toString(): String
Returns
String
@JvmStatic
fun ofMilliseconds(milliseconds: Long): Duration
Parameters

milliseconds

Returns
Duration
@JvmStatic
fun ofSeconds(seconds: Long): Duration
Parameters

seconds

Returns
Duration
@JvmStatic
fun ofMinutes(minutes: Long): Duration
Parameters

minutes

Returns
Duration
@JvmStatic
fun ofHours(hours: Long): Duration
Parameters

hours

Returns
Duration
@JvmStatic
fun ofDays(days: Long): Duration
Parameters

days

Returns
Duration
Properties

val inMilliseconds​

val inSeconds​

val inMinutes​

val inHours​

val inDays​

val ZERO​

DynamicFilter​

Динамические фильтры поисковой выдачи.

DynamicFilter(flagFilter: FlagFilter)
Parameters

flagFilter

DynamicFilter(rangeFilter: RangeFilter)
Parameters

rangeFilter

DynamicFilter(sortingFilter: SortingFilter)
Parameters

sortingFilter

Methods
fun match(
	flagFilter: Function1,
	rangeFilter: Function1,
	sortingFilter: Function1
): T
Parameters

flagFilter

rangeFilter

sortingFilter

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

other

Returns
Boolean
Properties

val isFlagFilter​

val asFlagFilter​

val isRangeFilter​

val asRangeFilter​

val isSortingFilter​

val asSortingFilter​

val value​

DynamicRouteInfo​

DynamicRouteInfo(roadEvents: RoadEventRouteAttribute, traffic: Traffic)
Parameters

roadEvents

traffic

Properties

val roadEvents​

val traffic​

DynamicRouteInfoSettings​

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

Extends: ru.dgis.sdk.NativeObject
Properties

var updatePeriod​

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

Elevation​

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

Elevation(value: Float = 0.0f)

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

Parameters

value

Properties

val value​

EmptyFollowController​

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

Implements: ru.dgis.sdk.map.CustomFollowController
EmptyFollowController()

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

Methods
fun availableValues(): EnumSet<FollowValue>

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

Returns
EnumSet<FollowValue>
fun requestValues(values: EnumSet<FollowValue>): Unit

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

Parameters

values

Returns
Unit
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit

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

Parameters

notifier

Returns
Unit
fun coordinates(): GeoPoint?

Географические координаты. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
GeoPoint?
fun bearing(): Bearing?

Направление. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
Bearing?
fun tilt(): Tilt?

Наклон карты. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
Tilt?
fun styleZoom(): StyleZoom?

Стилевой уровень масштабирования карты. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
StyleZoom?

EntranceGeometry​

Геометрии для отображения входа на карте.

EntranceGeometry(entrancePoints: List<GeoPoint>, entrancePolylines: List<List<GeoPoint>>)

Геометрии для отображения входа на карте.

Parameters

entrancePoints

entrancePolylines

Properties

val entrancePoints​

Местоположение входа.

val entrancePolylines​

Геометрии стрелок, указывающих на вход.

EntranceInfo​

Информация о входе в здание.

EntranceInfo(
	id: DgisObjectId,
	buildingNumber: String?,
	porchName: String?,
	porchNumber: String?,
	apartmentRanges: List<ApartmentRange>,
	geometry: EntranceGeometry?
)

Информация о входе в здание.

Parameters

id

buildingNumber

porchName

porchNumber

apartmentRanges

geometry

Properties

val id​

Идентификатор объекта входа.

val buildingNumber​

Номер дома, к которому относится вход.

val porchName​

Непустое имя подъезда. Заполняется только для подъездов. Может принимать значения имени подъезда (например "Подъезд 1") или номера здания, если подъезд имеет собственный адрес.

val porchNumber​

Непустой номер подъезда. Заполняется только для подъездов. Может принимать значения номера подъезда (например "1") или номера здания, если подъезд имеет собственный адрес.

val apartmentRanges​

Номера квартир, относящихся к подъезду.

val geometry​

Геометрии для отображения входа на карте.

Event​

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

Extends: ru.dgis.sdk.NativeObject

EventsProcessingSettings​

EventsProcessingSettings(rotationCenter: RotationCenter, scalingCenter: ScalingCenter)
Parameters

rotationCenter

scalingCenter

Properties

val rotationCenter​

Точка, относительно которой производится вращение карты.

val scalingCenter​

Точка, относительно которой производится масштабирование карты.

ExceedSpeedLimitSettings​

Настройки обнаружения превышения максимальной разрешённой скорости.

Extends: ru.dgis.sdk.NativeObject
Properties

var exceedSpeedNotificationEnabled​

Включение/выключение детектирования превышения максимальной разрешённой скорости.

var allowableSpeedExcess​

Разрешённое превышение скорости в м/с, по умолчанию равно 0.

ExcludedArea​

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

ExcludedArea(
	type: ExcludedAreaType = ExcludedAreaType.POINT,
	severity: ExcludedAreaSeverity = ExcludedAreaSeverity.SOFT,
	extent: RouteDistance,
	points: List<GeoPoint>
)

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

Parameters

type

severity

extent

points

Properties

val type​

Тип исключаемой области.

val severity​

Приоритет исключения области.

val extent​

Размер исключаемой области (не больше 25 км).

val points​

Координаты точек исключаемой области (не больше 500).

ExtraInstructionInfo​

ExtraInstructionInfo(bicycleStart: BicycleInstructionStart)
Parameters

bicycleStart

ExtraInstructionInfo(bicycleFinish: BicycleInstructionFinish)
Parameters

bicycleFinish

ExtraInstructionInfo(bicycleCrossroad: BicycleInstructionCrossroad)
Parameters

bicycleCrossroad

ExtraInstructionInfo(carStart: CarInstructionStart)
Parameters

carStart

ExtraInstructionInfo(carFinish: CarInstructionFinish)
Parameters

carFinish

ExtraInstructionInfo(carCrossroad: CarInstructionCrossroad)
Parameters

carCrossroad

ExtraInstructionInfo(carRoundabout: CarInstructionRoundabout)
Parameters

carRoundabout

ExtraInstructionInfo(carUturn: CarInstructionUTurn)
Parameters

carUturn

ExtraInstructionInfo(pedestrianStart: PedestrianInstructionStart)
Parameters

pedestrianStart

ExtraInstructionInfo(pedestrianFinish: PedestrianInstructionFinish)
Parameters

pedestrianFinish

ExtraInstructionInfo(pedestrianCrossroad: PedestrianInstructionCrossroad)
Parameters

pedestrianCrossroad

ExtraInstructionInfo(pedestrianIndoorFloorChange: PedestrianInstructionIndoorFloorChange)
Parameters

pedestrianIndoorFloorChange

ExtraInstructionInfo(pedestrianIndoorEnter: PedestrianInstructionIndoorEnter)
Parameters

pedestrianIndoorEnter

ExtraInstructionInfo(pedestrianIndoorExit: PedestrianInstructionIndoorExit)
Parameters

pedestrianIndoorExit

ExtraInstructionInfo(scooterStart: ScooterInstructionStart)
Parameters

scooterStart

ExtraInstructionInfo(scooterFinish: ScooterInstructionFinish)
Parameters

scooterFinish

ExtraInstructionInfo(scooterCrossroad: ScooterInstructionCrossroad)
Parameters

scooterCrossroad

Methods
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
Parameters

bicycleStart

bicycleFinish

bicycleCrossroad

carStart

carFinish

carCrossroad

carRoundabout

carUturn

pedestrianStart

pedestrianFinish

pedestrianCrossroad

pedestrianIndoorFloorChange

pedestrianIndoorEnter

pedestrianIndoorExit

scooterStart

scooterFinish

scooterCrossroad

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

other

Returns
Boolean
Properties

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​

Идентификатор файла.

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

Extends: ru.dgis.sdk.NativeObject
File(path: String)

Файл в файловой системе.

Parameters

path

Путь к файлу.

Methods
@JvmStatic
fun fromString(contents: String): File

Файл с содержимым из заданной строки.

Parameters

contents

Содержимое файла.

Returns
File
@JvmStatic
fun fromAsset(context: Context, path: String): File

Файл из asset-ов Android.

Parameters

context

path

Путь относительно корневой директории asset-ов.

Returns
File

FinishRouteControl​

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

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit
fun expand(): Unit
Returns
Unit
Properties

val heightChannel​

var onFinishClicked​

var isParkingButtonVisible​

FlagFilter​

Фильтр - флаг.

FlagFilter(
	tagName: String,
	displayName: String,
	flagValue: Boolean?
)

Фильтр - флаг.

Parameters

tagName

displayName

flagValue

Properties

val tagName​

Тэг фильтра.

val displayName​

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

val flagValue​

Значение флага.

FloatRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): FloatRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
FloatRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<FloatRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<FloatRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

FloatRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

FloatRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: Float
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

FloorInfo​

Информация об этажном плане для маркера - элемента поисковой выдачи.

FloorInfo(levelId: LevelId, buildingId: BuildingId)

Информация об этажном плане для маркера - элемента поисковой выдачи.

Parameters

levelId

buildingId

Properties

val levelId​

Идентификатор этажного плана.

val buildingId​

Идентификатор здания.

FollowControl​

UI-элемент управления слежением за маркером местоположения.

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

UI-элемент управления слежением за маркером местоположения.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

FollowController​

Класс, позволяющий управлять положением камеры. Реализации всех его методов должны быть потокобезопасны. У большинства методов есть тривиальные реализации по умолчанию (таким образом FollowController, отвечающий за масштаб, не обязан переопределять методы coordinates() и т.п.). Один контроллер может быть единомоментно добавлен только в одну карту.

Extends: ru.dgis.sdk.NativeObject

FollowPosition​

Настройки слежения за позицией.

FollowPosition(bearing: FollowBearing = FollowBearing.OFF, styleZoom: FollowStyleZoom = FollowStyleZoom.OFF)

Настройки слежения за позицией.

Parameters

bearing

styleZoom

Properties

val bearing​

val styleZoom​

FormattedAddress​

Человекочитаемое представление адреса.

FormattedAddress(
	drilldownAddress: String?,
	streetAddress: String?,
	addressComment: String?,
	postCode: String?
)

Человекочитаемое представление адреса.

Parameters

drilldownAddress

streetAddress

addressComment

postCode

Properties

val drilldownAddress​

Адрес из дриллдауна. Пример: "Новосибирск, Кировский район".

val streetAddress​

Адрес внутри населённого пункта. Пример: "Николаева, 11".

val addressComment​

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

val postCode​

Почтовый индекс объекта с кодом здания, если есть. Пример: "630088", "630007/XBVJF8".

Fps​

Frames per second, частота кадров.

Fps(value: Int = 0)

Frames per second, частота кадров.

Parameters

value

Properties

val value​

FreeRoamSettings​

Extends: ru.dgis.sdk.NativeObject
Properties

var onRoutePrefetchLength​

Тайлы дорожного графа загружаются в http-кэш во время ведения по маршруту, если они соответствуют участку маршрута от текущей позиции до указанного расстояния. Значение по умолчанию - 5 км.

Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.

var onRoutePrefetchRadiusMeters​

При кэшировании тайлов дорожного графа во время ведения по маршруту тайлы загружаются в http-кэш, если оказываются ближе заданного расстояния в метрах от линии маршрута. Значение по умолчанию - 1 км.

Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.

var prefetchRadiusMeters​

Тайлы дорожного графа загружаются в http-кэш если оказываются ближе заданного расстояния в метрах от текущей позиции. Значение по умолчанию - 2 км.

Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.

Geometry​

Объект геометрии.

Extends: ru.dgis.sdk.NativeObject
Methods
fun intersects(geometry: Geometry): Boolean

Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии

Parameters

geometry

объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется

Returns
Boolean
Properties

val kind​

val bounds​

Прямоугольник минимального размера, содержащий геометрию.

val minPoint​

Минимальнная точка ограничивающего прямоугольника.

val maxPoint​

Максимальная точка ограничивающего прямоугольника.

GeometryMapObject​

Геометрический объект карты.

методы потокобезопасны

объект будет отображаться на карте при выполнении следующих условий:

  • объект видимый;
  • объект добавлен в источник данных;
  • источник данных, содержащий объект, добавлен в карту;
  • в стилях, установленных в карту, есть параметры отображения, применимые к этому объекту. Подробнее про отображение на карте - см. ISource.

Extends: ru.dgis.sdk.map.MapObject
Properties

val geometryChannel​

Геометрия объекта.

var geometry​

Геометрия объекта.

val objectAttributes​

Получение свойств объекта карты для чтения и изменения.

val isVisibleChannel​

Текущий флаг видимости объекта.

var isVisible​

Текущий флаг видимости объекта.

val isDraggableChannel​

Текущий флаг перемещаемости объекта.

var isDraggable​

Текущий флаг перемещаемости объекта.

val bounds​

Прямоугольник минимального размера, содержащий геометрию.

GeometryMapObjectBuilder​

Класс для установки свойств и последующего создания геометрических объектов.

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

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

Parameters

name

Имя свойства объекта карты.

value

Значение свойства объекта карты.

Returns
GeometryMapObjectBuilder
fun setObjectAttributes(values: Map): GeometryMapObjectBuilder

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

Parameters

values

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

метод не заменяет весь набор свойств объекта, т.е. если свойство в values отсутствует, но уже добавлено в объект ранее, оно не будет изменено.

Returns
GeometryMapObjectBuilder
fun setGeometry(geometry: Geometry): GeometryMapObjectBuilder

Установка геометрии объекта карты.

Parameters

geometry

Returns
GeometryMapObjectBuilder
fun setVisible(visible: Boolean): GeometryMapObjectBuilder

Установка видимости объекта карты.

Parameters

visible

Returns
GeometryMapObjectBuilder
fun setDraggable(draggable: Boolean): GeometryMapObjectBuilder

Установка возможности перетаскивания объекта карты.

Parameters

draggable

Returns
GeometryMapObjectBuilder
fun setUserData(userData: Any?): GeometryMapObjectBuilder

Установка пользовательских данных.

пользовательские данные никак не используются в SDK и нужны только чтобы возвращать их пользователю.

Parameters

userData

Returns
GeometryMapObjectBuilder
fun createObject(): GeometryMapObject

Конструирование объекта карты.

у объекта обязательно должна быть установлена геометрия

после вызова этой функции GeometryMapObjectBuilder непригоден для задания параметров объекта карты или для его создания

Returns
GeometryMapObject
fun setObjectAttribute(name: String, value: Boolean): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Long): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Int): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Double): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Float): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: String): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: ByteArray): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Color): GeometryMapObjectBuilder
Parameters

name

value

Returns
GeometryMapObjectBuilder

GeometryMapObjectSource​

Источник геометрических объектов карты.

Extends: ru.dgis.sdk.map.Source
Methods
fun clusteringObjects(position: CameraPosition): List<MapObject>

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

Parameters

position

Returns
List<MapObject>
fun addObject(item: GeometryMapObject): Unit

Добавление объекта в источник.

Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.

Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.

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

Parameters

item

Returns
Unit
fun addObjects(objects: List<GeometryMapObject>): Unit

Добавление нескольких объектов в источник.

Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.

Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.

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

Parameters

objects

Returns
Unit
fun removeObject(item: GeometryMapObject): Unit

Удаление объекта из источника.

Удаление асинхронное, потокобезопасное, метод можно использовать из любого потока.

Parameters

item

Returns
Unit
fun removeObjects(objects: List<GeometryMapObject>): Unit

Удаление объектов из источника.

Parameters

objects

Returns
Unit
fun removeAndAddObjects(objectsToRemove: List<GeometryMapObject>, objectsToAdd: List<GeometryMapObject>): Unit

Удаление и добавление объектов в источник.

Parameters

objectsToRemove

objectsToAdd

Returns
Unit
fun clear(): Unit

Удаление всех объектов из источника.

Returns
Unit
Properties

val objects​

Получить все объекты, добавленные в источник.

val sourceAttributes​

Получение значений свойств по умолчанию для всех объектов, добавленных в источник (см. IAttributes).

GeometryMapObjectSourceBuilder​

Extends: ru.dgis.sdk.NativeObject
GeometryMapObjectSourceBuilder(context: Context)
Parameters

context

Methods
fun setSourceAttribute(name: String, value: AttributeValue): GeometryMapObjectSourceBuilder

Установка свойства объектов карты, общего для всего источника (см. ISource).

Parameters

name

Имя свойства.

value

Значение свойства.

Returns
GeometryMapObjectSourceBuilder
fun setSourceAttributes(values: Map): GeometryMapObjectSourceBuilder

Установка свойств объектов карты, общих для всего источника.

Parameters

values

набор пар "имя":"значение" свойств

Returns
GeometryMapObjectSourceBuilder
fun addObject(item: GeometryMapObject): GeometryMapObjectSourceBuilder

Добавление геометрического объекта карты в источник.

Parameters

item

Returns
GeometryMapObjectSourceBuilder
fun addObjects(objects: List<GeometryMapObject>): GeometryMapObjectSourceBuilder

Добавление нескольких геометрических объектов карты в источник.

Parameters

objects

Returns
GeometryMapObjectSourceBuilder
fun createSource(): GeometryMapObjectSource

Создание источника геометрических объектов.

после вызова этой функции использовать GeometryMapObjectSourceBuilder для создания источника данных или для задания параметров источника данных нельзя

Returns
GeometryMapObjectSource

GeoPoint​

Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).

GeoPoint(latitude: Latitude, longitude: Longitude)

Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).

Parameters

latitude

longitude

Methods
fun move(bearing: Bearing, meter: Meter): GeoPoint

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

Parameters

bearing

meter

Returns
GeoPoint
fun withElevation(elevation: Elevation = Elevation(0.0f)): GeoPointWithElevation
Parameters

elevation

Returns
GeoPointWithElevation
fun bearing(point: GeoPoint): Bearing

Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) между двумя точками.

Parameters

point

Returns
Bearing
fun distance(point: GeoPoint): Meter

Вычисляет минимальное (по ортодромии) расстояние между двумя точками.

Parameters

point

Returns
Meter
Properties

val isValid​

val latitude​

val longitude​

GeoPointRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<GeoPointRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<GeoPointRouteEntry>
fun findNearBackward(point: RoutePoint): GeoPointRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
GeoPointRouteEntry?
fun findNearForward(point: RoutePoint): GeoPointRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
GeoPointRouteEntry?
fun calculateGeoPoint(routePoint: RoutePoint): SegmentGeoPoint?

Вычисляет GeoPoint по известной RoutePoint.

Parameters

routePoint

Returns
SegmentGeoPoint?

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

Сложность операции O(log2(N)), где N = route_geometry.size()

fun calculateClosestPoint(point: GeoPoint): RoutePoint?

Вычисляет ближайшую точку на маршруте к заданной в географических координатах точке.

Parameters

point

Проецируемая на маршрут точка.

Returns
RoutePoint?

Ближайшая точка на маршруте. Если маршрут пустой, либо точки range.first и range.second одновременно лежат либо до маршрута, либо после, то возвращается null.

Сложность операции O(N), где N = route_geometry.size()

Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

val length​

Длина маршрута.

GeoPointRouteEntry​

Элемент маршрута - точка и значение в ней.

GeoPointRouteEntry(point: RoutePoint, value: GeoPoint)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

GeoPointWithElevation​

Точка в географической системе координат (широта, долгота, возвышение).

возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.

GeoPointWithElevation(
	latitude: Latitude,
	longitude: Longitude,
	elevation: Elevation = Elevation(value = 0.0f)
)

Точка в географической системе координат (широта, долгота, возвышение).

возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.

Parameters

latitude

longitude

elevation

Methods
fun bearing(point: GeoPoint): Bearing

Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) для проекции точки на карту и заданной точкой.

Parameters

point

Returns
Bearing
fun distance(point: GeoPoint): Meter

Вычисляет минимальное (по ортодромии) расстояние между проекцией точки на карту и заданной точкой.

Parameters

point

Returns
Meter
fun move(bearing: Bearing, meter: Meter): GeoPointWithElevation

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

Parameters

bearing

meter

Returns
GeoPointWithElevation
Properties

val latitude​

val longitude​

val elevation​

val point​

GeoRect​

Прямоугольная область в сферической системе координат (например, WGS84). Данная структура не привязана к конкретной геодезической системе координат.

GeoRect(southWestPoint: GeoPoint, northEastPoint: GeoPoint)

Прямоугольная область в сферической системе координат (например, WGS84). Данная структура не привязана к конкретной геодезической системе координат.

Parameters

southWestPoint

northEastPoint

Methods
fun contains(rect2: GeoRect): Boolean

Содержится ли rect2 внутри rect1, т.е. все его точки находятся внутри.

Parameters

rect2

Returns
Boolean
fun contains(point: GeoPoint): Boolean

Содержит ли прямоугольник точку. Точки, расположенные на границе, так же считаются принадлежащими прямоугольнику.

Parameters

point

Returns
Boolean
fun expand(rect2: GeoRect): GeoRect

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

Parameters

rect2

Returns
GeoRect
fun expand(point: GeoPoint): GeoRect

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

Parameters

point

Returns
GeoRect
fun intersects(rect2: GeoRect): Boolean

Пересекаются ли прямоугольники, т.е. имеют общие точки. Прямогольники, с общими точками лишь на границе, так же считаются пересекающимися.

Parameters

rect2

Returns
Boolean
Properties

val isValid​

Проверяет прямоугольник на корректность.

val isDegenerate​

Проверяет прямоугольник на вырожденность. Если точки в прямоугольнике равны, то он вырождается в точку. Вырожденный прямоугольник является корректным прямоугольником. Некорректный прямоугольник не является вырожденным.

val southWestPoint​

Юго-западная точка, левая нижняя граница прямоугольника.

val northEastPoint​

Северо-восточная точка, правая верхняя граница прямоугольника.

GestureManager​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun enableGesture(gesture: Gesture): Unit
Parameters

gesture

Returns
Unit
fun disableGesture(gesture: Gesture): Unit
Parameters

gesture

Returns
Unit
fun gestureEnabled(gesture: Gesture): Boolean
Parameters

gesture

Returns
Boolean
fun setSettingsAboutMapPositionPoint(settings: EventsProcessingSettings): Unit

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

Parameters

settings

настройки обработки событий.

при вызове функции происходит пересоздание инструментов распознавания жестов.

Returns
Unit
fun setTargetGeoPoint(geoPoint: GeoPoint?): Unit

Установка геопозиции, относительно которой происходит масштабирование и поворот.

Parameters

geoPoint

Returns
Unit
fun setMutuallyExclusiveGestures(rules: List<EnumSet<Gesture>>): Unit

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

К переданному списку правил добавляются правила по умолчанию, которые не позволяют жесту управления наклоном срабатывать одновременно с другими жестами. Каждое правило представляет собой перечень жестов, которые не могут срабатывать одновременно Например, если в правиле указать жесты Scaling и Rotation то эти жесты не будут работать одновременно В случае одновременного выполнения жестов из правила, сработает жест с большим приоритетом Порядок приоритета жестов (по убыванию): (Shift ->) Tilt -> Scaling -> Rotation -> MultiTouchShift

Parameters

rules

Returns
Unit
Properties

var enabledGestures​

var scalingSettings​

var rotationSettings​

var multitouchShiftSettings​

var tiltSettings​

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.

Parameters

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

Callback

rendererCallbackHandler

The Handler on which the renderer callback will be invoked.

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

Parameters

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.

Returns
Unit
fun releaseAndJoinRenderThread(): Unit

Stops the rendering thread, releases all OpenGL resources, and ensures no further callbacks will be executed.

Returns
Unit

GlobalMapOptions​

Глобальные настройки карты. Задаются при инициализации SDK и используются для всех карт.

GlobalMapOptions(graphicsApi: GraphicsApi = GraphicsApi.OPEN_GL)

Глобальные настройки карты. Задаются при инициализации SDK и используются для всех карт.

Parameters

graphicsApi

Properties

val graphicsApi​

Графический API.

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
)

Параметры градиентной полилинии.

Parameters

borderWidth

secondBorderWidth

gradientLength

borderColor

secondBorderColor

colors

colorIndices

Properties

val borderWidth​

Ширина границы линии.

val secondBorderWidth​

Ширина второй границы линии.

val gradientLength​

Длина градиентной линии.

val borderColor​

Цвет окантовки.

val secondBorderColor​

Цвет второй окантовки.

val colors​

Палитра цветов градиентной полилинии.

val colorIndices​

Индексы цветов градиентной полилинии. Количество индексов должно быть на 1 меньше количества точек полилинии.

GroupCheckableItem​

Набор отмечаемых элементов, работающих как радио-группа.

Extends: ru.dgis.sdk.directory.CheckableItem
Properties

val items​

Получение набора элементов группы.

HttpCacheManager​

Интерфейс управления HTTP-кешем.

Extends: ru.dgis.sdk.NativeObject
Methods
fun clear(): Unit

Очистка содержимого HTTP-кеша.

Returns
Unit
Properties

val currentSize​

Текущий размер HTTP-кеша

var maxSize​

Максимальный размер HTTP-кеша

HttpHeader​

HttpHeader(name: String, value: String)
Parameters

name

value

Properties

val name​

val 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-клиента.

Parameters

timeout

useCache

cacheStoragePath

cacheMaxSize

certificates

proxy

Properties

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.

Parameters

host

port

Properties

val host​

val port​

HttpRequest​

Структура для представления HTTP запроса.

HttpRequest(
	url: String,
	method: HttpMethod = HttpMethod.GET,
	headers: List<HttpHeader> = listOf(),
	body: ByteArray? = null
)

Структура для представления HTTP запроса.

Parameters

url

method

headers

body

Properties

val url​

Строковое представление URL запроса.

val method​

Метод HTTP запроса. По умолчанию GET.

val headers​

Заголовки запроса. По умолчанию пусто.

val body​

Тело запроса. По умолчанию отсутствует.

HttpResponse​

Структура для представления ответа на HTTP запрос.

тело ответа хранится и обрабатывается отдельно.

HttpResponse(statusCode: HttpStatusCode, headers: List<HttpHeader>)

Структура для представления ответа на HTTP запрос.

тело ответа хранится и обрабатывается отдельно.

Parameters

statusCode

headers

Properties

val statusCode​

HTTP статус код ответа от сервера.

val headers​

Заголовки ответа.

HttpResponseCallback​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun onResponse(response: HttpResponse): Boolean

Метод, обрабатывающий получение ответа от сервера.

Parameters

response

ответ от сервера.

Returns
Boolean

возвращает false если SDK отменил отправку/обработку запроса.

fun onReceive(body: ByteArray, size: Int): Boolean

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

Parameters

body

тело (или его часть) ответа от сервера.

size

размер данных в байтах.

Returns
Boolean

возвращает false если SDK отменил отправку/обработку запроса.

При обработке присутствует копирование данных для передачи из Java в с++. Рекомендуется передавать данные небольшими кусками.

fun onFinished(): Unit

Метод, оповещающий об окончании обработки запроса. Необходимо вызывать в конце процесса обработки. Даже если запрос был отменен на стороне SDK.

Отсутствие вызова метода может привести к отказу работы сети в SDK.

Returns
Unit

HttpStatusCode​

HTTP статус код ответа.

HttpStatusCode(value: Int = 0)

HTTP статус код ответа.

Parameters

value

Properties

val value​

Image​

Изображение.

Extends: ru.dgis.sdk.NativeObject

ImageData​

Данные изображения: размер, формат и бинарные данные.

ImageData(
	size: ScreenSize,
	format: ImageFormat,
	data: ByteArray
)

Данные изображения: размер, формат и бинарные данные.

Parameters

size

format

data

Methods
fun toBitmap(): Bitmap
Returns
Bitmap
Properties

val size​

val format​

val data​

IncompleteTextHandler​

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

Extends: ru.dgis.sdk.NativeObject
Properties

val queryText​

Нужно подставить в строку поиска этот текст и дать пользователю продолжить вводить запрос.

IndoorBuilding​

Здание с этажными планами.

Extends: ru.dgis.sdk.NativeObject
Properties

val id​

Идентификатор здания с этажными планами.

val defaultLevelIndex​

Индекс этажа по умолчанию.

val levels​

Информация обо всех этажах.

val activeLevelIndexChannel​

Порядковый индекс активного этажа в levels.

var activeLevelIndex​

Порядковый индекс активного этажа в levels.

IndoorControl​

Контрол этажей.

Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.

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

Контрол этажей.

Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit
Properties

var markedLevels​

Этажи, на которых отображаются пометки.

IndoorControlModel​

Модель элемента управления этажами.

Extends: ru.dgis.sdk.NativeObject
IndoorControlModel(map: Map)
Parameters

map

Methods
fun isLevelMarked(index: Long): Boolean

Нужно ли отображать пометку у этажа с указанным индексом.

Parameters

index

Returns
Boolean
Properties

val activeLevelIndexChannel​

Индекс активного этажа.

var activeLevelIndex​

Индекс активного этажа.

var markedLevels​

Этажи, на которых отображаются пометки.

val levelNamesChannel​

Названия этажей. Пусто, если на карте не отображается здание с этажными планами, или у здания всего один этаж.

val levelNames​

Названия этажей. Пусто, если на карте не отображается здание с этажными планами, или у здания всего один этаж.

IndoorDetector​

Детектор, который определяет находится ли пользователь в помещении.

Extends: ru.dgis.sdk.NativeObject
Properties

val indoorChannel​

Канал, который оповещает о нахождении пользователя в помещении.

val indoor​

Канал, который оповещает о нахождении пользователя в помещении.

IndoorManager​

Класс для получения текущего здания с этажными планами.

Extends: ru.dgis.sdk.NativeObject
Methods
fun setIndoorState(newState: IndoorManagerState): Unit

Переключение включенности/выключенности менеджера этажных планов

Parameters

newState

Returns
Unit
Properties

val focusedBuildingChannel​

Получение текущего здания с этажными планами.

val focusedBuilding​

Получение текущего здания с этажными планами.

IndoorRouteLevelsGetter​

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

Extends: ru.dgis.sdk.NativeObject
IndoorRouteLevelsGetter(map: Map)
Parameters

map

Properties

val levelIdsChannel​

val levelIds​

InputEvent​

Событие пользовательского ввода.

Extends: ru.dgis.sdk.map.Event
Properties

val timestamp​

Получение времени регистрации события ввода.

InstructionRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<InstructionRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<InstructionRouteEntry>
fun findNearBackward(point: RoutePoint): InstructionRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
InstructionRouteEntry?
fun findNearForward(point: RoutePoint): InstructionRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
InstructionRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

InstructionRouteEntry​

Элемент маршрута - точка и значение в ней.

InstructionRouteEntry(point: RoutePoint, value: RouteInstruction)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

IntRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<IntRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<IntRouteEntry>
fun findNearBackward(point: RoutePoint): IntRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
IntRouteEntry?
fun findNearForward(point: RoutePoint): IntRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
IntRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

IntRouteEntry​

Элемент маршрута - точка и значение в ней.

IntRouteEntry(point: RoutePoint, value: Int)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

IsOpenNow​

Открыто сейчас.

IsOpenNow()

Открыто сейчас.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

ItemMarkerInfo​

Идентификатор объекта и его координаты.

Extends: ru.dgis.sdk.NativeObject
Properties

val objectId​

val geoPoint​

val floorInfo​

val title​

val rubricIds​

KeyFromAsset​

Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.

KeyFromAsset(path: String)

Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.

Parameters

path

Properties

val path​

Путь относительно корневой директории asset-ов.

KeyFromFile​

Ключ из файла.

KeyFromFile(path: String)

Ключ из файла.

Parameters

path

Properties

val path​

Путь к файлу.

KeyFromString​

Ключ из строки.

KeyFromString(contents: String)

Ключ из строки.

Parameters

contents

Properties

val contents​

Содержимое.

KeySource​

Источник ключа.

KeySource(fromAsset: KeyFromAsset)
Parameters

fromAsset

KeySource(fromFile: KeyFromFile)
Parameters

fromFile

KeySource(fromString: KeyFromString)
Parameters

fromString

Methods
fun match(
	fromAsset: Function1,
	fromFile: Function1,
	fromString: Function1
): T
Parameters

fromAsset

fromFile

fromString

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

other

Returns
Boolean
Properties

val isFromAsset​

val asFromAsset​

val isFromFile​

val asFromFile​

val isFromString​

val asFromString​

val value​

LanesCalloutMapPosition​

Положение бабла полосности для маршрута.

LanesCalloutMapPosition(
	mapId: MapId,
	routePoint: RoutePoint,
	geoPoint: GeoPoint
)

Положение бабла полосности для маршрута.

Parameters

mapId

routePoint

geoPoint

Properties

val mapId​

Идентификатор карты, для которой приведена позиция.

val routePoint​

Позиция бабла полосности на маршруте.

val geoPoint​

Позиция бабла полосности на карте.

LaneSignRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): LaneSignRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
LaneSignRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<LaneSignRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<LaneSignRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

LaneSignRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

LaneSignRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RouteLaneSign
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

Latitude​

Географическая широта.

Latitude(value: Double = 0.0)

Географическая широта.

Parameters

value

Properties

val value​

LevelId​

Идентификатор этажного плана.

LevelId(value: Long = 0)

Идентификатор этажного плана.

Parameters

value

Properties

val value​

LevelInfo​

Информация об этаже здания.

LevelInfo(id: LevelId, name: String)

Информация об этаже здания.

Parameters

id

name

Properties

val id​

Идентификатор этажного плана.

val name​

Название этажа.

Locale​

Локаль.

Locale(language: String, region: String)

Локаль.

Parameters

language

region

Methods
fun toLocalePosix(): String
Returns
String
@JvmStatic
fun makeLocale(localeStr: String): Locale?

Создать локаль по строковому представлению в виде LanguageTag или POSIX.

Parameters

localeStr

Returns
Locale?
Properties

val language​

Код языка, описанный в стандарте ISO 639-1,

val region​

Код страны, описанный в стандарте ISO 3166-1.

LocaleManager​

Менеджер региональных настроек приложения.

Extends: ru.dgis.sdk.NativeObject
Methods
fun overrideLocales(locales: List<Locale>): Unit

Установка списка локалей приложения

Parameters

locales

Returns
Unit
Properties

val localesChannel​

Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.

val locales​

Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.

val systemLocalesChannel​

Получение локалей, предоставляемых ОС.

Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).

val systemLocales​

Получение локалей, предоставляемых ОС.

Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).

Location​

Геопозиция.

Location(
	coordinates: LocationCoordinates,
	altitude: LocationFuzzyDouble?,
	course: LocationCourse?,
	groundSpeed: LocationFuzzyDouble?,
	source: String,
	timestamp: Duration
)

Геопозиция.

Parameters

coordinates

altitude

course

groundSpeed

source

timestamp

Properties

val coordinates​

coordinates::value - координаты геопозиции в системе координат WGS 84. coordinates::accuracy - горизонтальная точность определения координат геопозиции (DRMS), м. https://en.wikipedia.org/wiki/Circular_error_probable Область значений: >= 0.

val altitude​

altitude::value - высота над опорным эллипсоидом WGS 84, м. altitude::accuracy - стандартное отклонение ошибки измерения высоты, м. null означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (null, > 0).

val course​

course::value - путевой угол (направление движения вдоль поверхности Земли). Угол измеряется относительно географического севера). course::accuracy - стандартное отклонение ошибки измерения путевого угла. null означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (null, > 0).

val groundSpeed​

ground_speed - скорость движения вдоль поверхности Земли, м/с. Область значений: >= 0. ground_speed::accuracy - среднеквадратичное отклонение ошибки измерения скорости, м/с. null означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (null, > 0).

val source​

Название источника геопозиции.

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

val timestamp​

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

LocationCoordinates​

LocationCoordinates(value: GeoPoint, accuracy: Double)
Parameters

value

accuracy

Properties

val value​

val accuracy​

LocationCourse​

LocationCourse(value: Bearing, accuracy: Bearing?)
Parameters

value

accuracy

Properties

val value​

val accuracy​

LocationFuzzyDouble​

LocationFuzzyDouble(value: Double, accuracy: Double?)
Parameters

value

accuracy

Properties

val value​

val accuracy​

LogicalPixel​

Пиксель, размер которого не зависит от плотности экрана.

1 логический пиксель соответствует 1 / (базовый ppi) дюйма. Базовый PPI зависит от устройства и вычисляется из отношения DevicePpi/DeviceDensity. DevicePpi и DeviceDensity, в свою очередь, задаются с ОС через интерфейс карты. Для Android LogicalPixel соответствует dp, для iOS - point'у.

LogicalPixel(value: Float = 0.0f)

Пиксель, размер которого не зависит от плотности экрана.

1 логический пиксель соответствует 1 / (базовый ppi) дюйма. Базовый PPI зависит от устройства и вычисляется из отношения DevicePpi/DeviceDensity. DevicePpi и DeviceDensity, в свою очередь, задаются с ОС через интерфейс карты. Для Android LogicalPixel соответствует dp, для iOS - point'у.

Parameters

value

Properties

val value​

LogMessage​

Сообщение, записываемое в лог.

LogMessage(
	level: LogLevel,
	text: String,
	file: String,
	line: Int
)

Сообщение, записываемое в лог.

Parameters

level

text

file

line

Properties

val level​

Уровень логирования.

val text​

Содержимое сообщения.

val file​

Имя файла, в котором было записано сообщение.

val line​

Номер строки, в которой было записано сообщение.

LogOptions​

Настройки логирования.

LogOptions(
	systemLevel: LogLevel = LogLevel.WARNING,
	customLevel: LogLevel = LogLevel.WARNING,
	customSink: LogSink? = null
)

Настройки логирования.

Parameters

systemLevel

customLevel

customSink

Properties

val systemLevel​

Уровень логирования в системный лог.

val customLevel​

Уровень логирования в пользовательский приемник.

val customSink​

Пользовательский приемник логирования.

Longitude​

Географическая долгота.

Longitude(value: Double = 0.0)

Географическая долгота.

Parameters

value

Properties

val value​

MagneticChangeListener​

Класс, отслеживающий изменения направления компаса и его доступность.

Extends: ru.dgis.sdk.NativeProxy
Methods
fun onValueChanged(
	yaw: Float,
	accuracy: Float?,
	timestamp: Long
): Unit
Parameters

yaw

accuracy

timestamp

Returns
Unit
fun onAvailabilityChanged(availability: Boolean): Unit
Parameters

availability

Returns
Unit

ManeuverControl​

Extends: ru.dgis.sdk.navigation.NavigationControl
ManeuverControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)
Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit

Map​

Карта.

Extends: ru.dgis.sdk.NativeObject
Methods
fun resetFontIconSizeMultiplier(): Unit

Сбросить множитель размера для иконок.

Returns
Unit
fun addSource(source: Source): Unit

Добавление источника данных на карту.

Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.

Parameters

source

Returns
Unit
fun removeSource(source: Source): Unit

Удаление источника данных из карты.

Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.

Parameters

source

Returns
Unit
fun getRenderedObjects(centerPoint: ScreenPoint, radius: ScreenDistance = ScreenDistance(value = 1.0f)): Future<List<RenderedObjectInfo>>

Получение отображаемых объектов карты, проецирующихся на окружность на экране.

Parameters

centerPoint

центр окружности.

radius

радиус окружности.

Список объектов формируется в порядке отрисовки от поздних к ранним.

Returns
Future<List<RenderedObjectInfo>>
fun setAttribute(name: String, value: AttributeValue): Unit
Parameters

name

value

Returns
Unit
fun removeAttribute(name: String): Unit
Parameters

name

Returns
Unit
Properties

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.

MapControl​

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

Extends: android.widget.FrameLayout
MapControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

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

Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

MapControls​

Элементы управления картой во время навигации.

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

Элементы управления картой во время навигации.

Parameters

context

attrs

defStyle

Methods
fun onTouchEvent(event: MotionEvent): Boolean
Parameters

event

Returns
Boolean
fun onLayout(
	changed: Boolean,
	left: Int,
	top: Int,
	right: Int,
	bottom: Int
): Unit
Parameters

changed

left

top

right

bottom

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

map

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

map

Returns
Unit
Properties

var isAddRoadEventButtonVisible​

val visibilityChannel​

MapDirection​

Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.

MapDirection(value: Double = 0.0)

Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.

Parameters

value

Properties

val value​

MapId​

Идентификатор экземпляра карты, уникальный в рамках процесса.

MapId(value: Int = 0)

Идентификатор экземпляра карты, уникальный в рамках процесса.

Parameters

value

Properties

val value​

MapLocationController​

Контроллер для управления позиционированием карты в навигаторе.

Extends: ru.dgis.sdk.NativeObject
Properties

var mapToNorthOrientation​

Включена ли принудительная ориентация карты на север.

MapManager​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun addMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

MapObject​

Объект на карте.

Extends: ru.dgis.sdk.NativeObject
Properties

var userData​

Произвольные пользовательские данные, прикрепленные к объекту.

MapObjectManager​

Extends: ru.dgis.sdk.NativeObject
MapObjectManager(map: Map, layerId: String? = null)

Создать IMapObjectManager.

Parameters

map

layerId

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

Methods
fun addObject(item: SimpleMapObject): Unit

Добавить объект.

Parameters

item

Returns
Unit
fun removeObject(item: SimpleMapObject): Unit

Удалить объект.

Parameters

item

Returns
Unit
fun addObjects(objects: List<SimpleMapObject>): Unit

Добавить объекты.

Parameters

objects

Returns
Unit
fun removeObjects(objects: List<SimpleMapObject>): Unit

Удалить объекты.

Parameters

objects

Returns
Unit
fun removeAndAddObjects(objectsToRemove: List<SimpleMapObject>, objectsToAdd: List<SimpleMapObject>): Unit

Удалить и добавить объекты.

Parameters

objectsToRemove

objectsToAdd

Returns
Unit
fun removeAll(): Unit
Returns
Unit
fun clusteringObjects(position: CameraPosition): List<MapObject>

Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и маркеры.

Parameters

position

Returns
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 объекты.

Parameters

map

logicalPixel

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

maxZoom

Уровень, начиная с которого видны все маркеры.

clusterRenderer

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

minZoom

Уровень, начиная с которого формируются кластеры.

layerId

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

Returns
MapObjectManager
@JvmStatic
fun withGeneralization(
	map: Map,
	logicalPixel: LogicalPixel,
	maxZoom: Zoom,
	minZoom: Zoom = Zoom(value = 0.0f),
	layerId: String? = null
): MapObjectManager

Создать IMapObjectManager с генерализацией данных. Генерализуются только IMarker объекты.

Parameters

map

logicalPixel

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

maxZoom

Уровень, начиная с которого видны все маркеры.

minZoom

Уровень, начиная с которого работает генерализация.

layerId

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

Returns
MapObjectManager
Properties

var isVisible​

Переопределение видимости всех объектов, добавленных в экземпляр менеджера. Значение false здесь имеет приоритет над видимостью отдельного объекта.

MapOptions​

Параметры карты.

MapOptions()

Параметры карты.

Methods
fun setTheme(theme: MapTheme): Unit

Устанавливает тему, которая будет использована в карте. Для изменения в течение жизненного цикла MapView, используйте MapView.setTheme.

Parameters

theme

Returns
Unit
@JvmStatic
fun fromAttributes(context: Context, attrs: AttributeSet): MapOptions
Parameters

context

attrs

Returns
MapOptions
Properties

var position​

var sources​

var styleFile​

val mapAttributes​

var fontIconSizeMultiplier​

var maxFps​

var powerSavingMaxFps​

var graphicsPreset​

var renderMode​

MapPaddingControl​

UI-элемент, задающий внутренние отступы (padding) карты.

Extends: ru.dgis.sdk.map.MapControl
Implements: android.view.ViewTreeObserver.OnGlobalLayoutListener
MapPaddingControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент, задающий внутренние отступы (padding) карты.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit
fun onGlobalLayout(): Unit
Returns
Unit

MapRotationBeginEvent​

Событие начала вращения карты вокруг точки.

Extends: ru.dgis.sdk.map.Event
MapRotationBeginEvent(inDirection: MapRotationDirection)
Parameters

inDirection

Properties

val direction​

MapRotationEndEvent​

Событие окончания вращения карты вокруг точки.

Extends: ru.dgis.sdk.map.Event
MapRotationEndEvent()

MapScalingBeginEvent​

Событие начала изменения масштаба.

Extends: ru.dgis.sdk.map.Event
MapScalingBeginEvent(inDirection: MapScalingDirection)
Parameters

inDirection

Properties

val direction​

MapScalingEndEvent​

Событие окончания изменения масштаба.

Extends: ru.dgis.sdk.map.Event
MapScalingEndEvent()

MapShiftBeginEvent​

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

Extends: ru.dgis.sdk.map.Event
MapShiftBeginEvent(inDirection: MapShiftDirection)
Parameters

inDirection

Properties

val direction​

MapShiftEndEvent​

Событие окончания смещения карты.

Extends: ru.dgis.sdk.map.Event
MapShiftEndEvent()

MapTheme​

Тема для использования в карте.

MapTheme(name: String, loadingBackground: Color)

Тема для использования в карте.

Parameters

name

loadingBackground

Properties

val name​

Код стиля из редактора стилей.

val loadingBackground​

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

val defaultTheme​

Стандартная светлая тема для базовых стилей

val defaultDarkTheme​

Стандартная темная тема для базовых стилей

MapView​

Контейнер, содержащий карту и дополнительные элементы управления.

Extends: android.widget.FrameLayout
MapView(context: Context)
Parameters

context

MapView(context: Context, attrs: AttributeSet)
Parameters

context

attrs

MapView(context: Context, options: MapOptions)
Parameters

context

options

MapView(context: Context, map: Map)
Parameters

context

map

Methods
fun setBackgroundColor(color: Int): Unit
Parameters

color

Returns
Unit
fun setBackground(background: Drawable?): Unit
Parameters

background

Returns
Unit
fun setBackgroundResource(resid: Int): Unit
Parameters

resid

Returns
Unit
fun setUriOpener(uriOpener: Function1): Unit
Parameters

uriOpener

Returns
Unit
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
fun getMapAsync(callback: OnMapReadyCallback): Unit
Parameters

callback

Returns
Unit
fun setTouchEventsObserver(observer: TouchEventsObserver?): Unit
Parameters

observer

Returns
Unit
fun addObjectTappedCallback(callback: MapObjectTappedCallback): Unit
Parameters

callback

Returns
Unit
fun removeObjectTappedCallback(callback: MapObjectTappedCallback): Unit
Parameters

callback

Returns
Unit
fun addObjectLongTouchCallback(callback: MapObjectTappedCallback): Unit
Parameters

callback

Returns
Unit
fun removeLongTouchCallback(callback: MapObjectTappedCallback): Unit
Parameters

callback

Returns
Unit
fun setCopyrightMargins(
	left: Int,
	top: Int,
	right: Int,
	bottom: Int
): Unit
Parameters

left

top

right

bottom

Returns
Unit
fun setCopyrightGravity(gravity: Int): Unit
Parameters

gravity

Returns
Unit
fun setTheme(theme: MapTheme): Unit

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

Parameters

theme

Returns
Unit
fun onStart(owner: LifecycleOwner): Unit
Parameters

owner

LifecycleOwner
Returns
Unit
fun onStop(owner: LifecycleOwner): Unit
Parameters

owner

LifecycleOwner
Returns
Unit
fun onConfigurationChanged(newConfig: Configuration): Unit
Parameters

newConfig

Returns
Unit
fun onSaveInstanceState(): Parcelable?
Returns
Parcelable?
fun onRestoreInstanceState(state: Parcelable?): Unit
Parameters

state

Returns
Unit
fun onVisibilityChanged(changedView: View, visibility: Int): Unit
Parameters

changedView

visibility

Returns
Unit
fun takeSnapshot(copyrightPosition: Alignment = Alignment.BOTTOM_RIGHT): Future<ImageData>
Parameters

copyrightPosition

Returns
Future<ImageData>
fun useDefaultGestureRecognitionEngine(): Unit

Использовать встроенный распознаватель жестов.

Returns
Unit
fun useCustomGestureRecognitionEngine(customGestureRecognitionEngine: MapGestureRecognitionEngine): Unit

Использовать пользовательский распознаватель жестов.

Parameters

customGestureRecognitionEngine

Returns
Unit
Properties

lateinit var mapOptions​

var maxFps​

Максимально допустимая частота обновления карты. Если не задана, равна частоте обновления экрана.

var powerSavingMaxFps​

Максимально допустимая частота обновления карты в режиме сохранения энергии. Если не задана, равна maxFps.

val fpsChannel​

Частота обновления карты. Для получения корректного значения необходимо держать подписку на канал. Перед вызовом метода карта должна быть проинициализирована (завершен getMapAsync).

val renderView​

Возвращает View, используемый для рендера OpenGL.

val gestureManager​

val mapTheme​

Тема, которая используется картой. Для изменения в течение жизненного цикла MapView, используйте setTheme.

MarkedByRouteIndoorControl​

UI-элемент, где отмечены этажи, через которые на карте проходят маршруты.

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

UI-элемент, где отмечены этажи, через которые на карте проходят маршруты.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

MarkedUpText​

Размеченный текст.

MarkedUpText(text: String, matchedParts: List<MarkedUpTextSpan>)

Размеченный текст.

Parameters

text

matchedParts

Properties

val text​

Текст.

val matchedParts​

Набор непересекающихся Span в порядке их расположения в строке text, описывающих части, совпадающие с пользовательским запросом.

MarkedUpTextSpan​

Описывает поднабор байтов строки text.

MarkedUpTextSpan(offset: Long, length: Long)

Описывает поднабор байтов строки text.

Parameters

offset

length

Properties

val offset​

val length​

Marker​

Точечная отметка на карте, представляющая интерес для пользователя.

Extends: ru.dgis.sdk.map.SimpleMapObject
Marker(options: MarkerOptions)
Parameters

options

Properties

var position​

Получение местоположения маркера.

var icon​

Получение иконки маркера.

var anchor​

Получение точки привязки иконки маркера.

var iconOpacity​

Получение прозрачности иконки маркера.

var text​

Получение подписи маркера.

var textStyle​

Получение стиля подписи маркера.

var isDraggable​

Получение флага перемещаемости маркера.

var iconWidth​

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

var iconMapDirection​

Угол поворота маркера на карте относительно направления на север, по часовой стрелке.

var animatedAppearance​

Анимировать ли появление.

var iconAnimationMode​

Получение режима анимации анимированного маркера.

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),
	animatedAppearance: Boolean = true,
	levelId: LevelId? = null,
	iconAnimationMode: AnimationMode = AnimationMode.NORMAL
)

Параметры маркера.

Parameters

position

icon

iconMapDirection

anchor

text

textStyle

iconOpacity

visible

draggable

iconWidth

userData

zIndex

animatedAppearance

levelId

iconAnimationMode

Properties

val position​

val icon​

val iconMapDirection​

val anchor​

val text​

val textStyle​

val iconOpacity​

val visible​

val draggable​

val iconWidth​

Целевая ширина, используемая для масштабирования.

val userData​

val zIndex​

Уровень отрисовки объекта.

val animatedAppearance​

Анимировать ли появление.

val levelId​

Привязка к поэтажному плану здания.

val iconAnimationMode​

Режим анимации.

MessageControl​

Extends: ru.dgis.sdk.navigation.NavigationControl
MessageControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)
Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit

Meter​

Длина/расстояние в метрах.

Meter(value: Float = 0.0f)

Длина/расстояние в метрах.

Parameters

value

Properties

val value​

MillisecondsRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<MillisecondsRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<MillisecondsRouteEntry>
fun findNearBackward(point: RoutePoint): MillisecondsRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
MillisecondsRouteEntry?
fun findNearForward(point: RoutePoint): MillisecondsRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
MillisecondsRouteEntry?
fun calculateDuration(routePoint: RoutePoint): Duration
Parameters

routePoint

Returns
Duration
fun calculateDuration(fromRoutePoint: RoutePoint, toRoutePoint: RoutePoint): Duration
Parameters

fromRoutePoint

toRoutePoint

Returns
Duration
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

val duration​

Длительность маршрута.

MillisecondsRouteEntry​

Элемент маршрута - точка и значение в ней.

MillisecondsRouteEntry(point: RoutePoint, value: Duration)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

Model​

Модель навигатора, предназначенная для отображения в UI.

Extends: ru.dgis.sdk.NativeObject
Methods
fun betterRouteResponse(response: BetterRouteResponse): Unit

Ответ пользователя о применении предложенного маршрута лучше.

Parameters

response

Returns
Unit
Properties

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​

MultiTouchShiftSettings​

Настройки обработки сдвига при касании несколькими пальцами.

MultiTouchShiftSettings(thresholdMm: Float)

Настройки обработки сдвига при касании несколькими пальцами.

Parameters

thresholdMm

Properties

val thresholdMm​

Порог сдвига взвешенного среднего точек постановки пальцев, в миллиметрах, по достижению которого начинают генерироваться события смещения несколькими пальцами

MyLocationControl​

Контрол перелёта к текущему местоположению пользователя.

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

Контрол перелёта к текущему местоположению пользователя.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

MyLocationControllerSettings​

Настройки контроллера перемещения маркера геопозиции.

MyLocationControllerSettings(
	bearingSource: BearingSource? = BearingSource.AUTO,
	animationDuration: Duration = Duration.ofMilliseconds(1000),
	coordinatesThreshold: Meter = Meter(value = 0.1f),
	bearingThreshold: Bearing = Bearing(value = 1.0)
)

Настройки контроллера перемещения маркера геопозиции.

Parameters

bearingSource

animationDuration

coordinatesThreshold

bearingThreshold

Properties

val bearingSource​

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

val animationDuration​

Неотрицательная длительность изменения реального направления.

val coordinatesThreshold​

Неотрицательное пороговое значение учитываемого изменения реальной позиции и её точности.

val bearingThreshold​

Неотрицательное пороговое значение учитываемого изменения реального направления.

MyLocationControlModel​

Модель контрола перелета к местоположению пользователя. Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя. Если местоположение не определено, ничего не происходит. Методы объекта необходимо вызывать на одном потоке.

Extends: ru.dgis.sdk.NativeObject
MyLocationControlModel(map: Map)
Parameters

map

Methods
fun onClicked(): Unit
Returns
Unit
Properties

val isEnabledChannel​

val isEnabled​

val followStateChannel​

val followState​

MyLocationMapObject​

Маркер геопозиции.

Extends: ru.dgis.sdk.map.MapObject
Properties

val animationSettings​

Получение настроек анимации для чтения и изменения.

val objectAttributes​

Получение свойств объекта карты для чтения и изменения.

MyLocationMapObjectSource​

Источник, содержащий маркер геопозиции.

Extends: ru.dgis.sdk.map.Source
MyLocationMapObjectSource(
	context: Context,
	controllerSettings: MyLocationControllerSettings = MyLocationControllerSettings(),
	markerType: MyLocationMapObjectMarkerType = MyLocationMapObjectMarkerType.MODEL
)

Создать источник маркера геопозиции.

Parameters

context

controllerSettings

markerType

Properties

val item​

Получить маркер геопозиции.

MyLocationMapObjectSourceProvider​

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

Extends: ru.dgis.sdk.NativeObject
Properties

val myLocationMapObjectSource​

Источник, содержащий маркер геопозиции.

NativeException​

Исключение, преобразованное из исключения, брошенного в нативном коде.

NativeObject​

Базовый класс для объектов, представляющих собой обёртки над объектами в нативном коде.

Implements: java.lang.AutoCloseable
Methods
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int
fun close(): Unit
Returns
Unit
fun isValid(): Boolean
Returns
Boolean

NativeProxy​

Технический класс, инкапсулирующий в себе слабый указатель на объект в нативном коде.

Methods
fun finalize(): Unit
Returns
Unit

NavigationControl​

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

Extends: android.widget.FrameLayout
NavigationControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

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

Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
fun attachToManager(manager: NavigationManager): Unit
Parameters

manager

Returns
Unit
fun detachFromManager(): Unit
Returns
Unit
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
fun detachFromModel(model: Model): Unit
Parameters

model

Returns
Unit
Properties

var manager​

var model​

val closeables​

NavigationControl​

Контейнер с UI-элементами управления уровнем масштабирования и перелётом к текущему местоположению пользователя.

Extends: android.widget.LinearLayout
NavigationControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контейнер с UI-элементами управления уровнем масштабирования и перелётом к текущему местоположению пользователя.

Parameters

context

attrs

defStyle

NavigationFollowController​

Интерфейс для управления слежением карты за маркером геопозиции в навигаторе.

Extends: ru.dgis.sdk.NativeObject
Methods
fun setFollow(follow: Boolean): Unit

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

Parameters

follow

Returns
Unit
Properties

var followReturnDelay​

Таймаут, через который карта автоматически вернется в режим слежения за маркером геопозиции после того, как пользователь подвигал её. 0 - автоматический возврат в режим слежения за маркером геопозиции отключен.

var cameraBehaviour​

Режим слежения камеры за маркером геопозиции в навигаторе.

NavigationManager​

Корневой публичный интерфейс навигатора.

Extends: ru.dgis.sdk.NativeObject
NavigationManager(platformContext: Context)

Точка входа в API навигатора, используемая в SDK по умолчанию.

Parameters

platformContext

Methods
fun start(): Unit

Запускает ведение в режиме без маршрута (free roam). В этом режиме маршрут отсутствует, а навигатор сообщает об объектах, находящихся на дороге рядом с пользователем.

Returns
Unit
fun start(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute? = null): Unit

Запускает ведение по маршруту.

Parameters

routeBuildOptions

Параметры, с которыми навигатор будет перестраивать маршрут.

trafficRoute

Маршрут, по которому запускается ведение. Если значение не задано, то навигатор построит маршрут от текущей геопозиции.

Returns
Unit
fun startSimulation(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute): Unit

Запускает симуляцию ведения по маршруту.

Parameters

routeBuildOptions

Параметры, с которыми навигатор будет перестраивать маршрут.

trafficRoute

Маршрут, по которому запускается симуляция.

Returns
Unit
fun stop(): Unit

Останавливает работу навигатора.

Returns
Unit
Properties

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

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

NavigationView​

UI-элемент, отображающий состояние навигации на карте.

Добавление его в MapView приводит к отображению на ней маршрута, маркера геопозиции, транспортных событий, слежению за камерой. Внутри NavigationView можно размещать навигационные контролы - наследники NavigationControl, в частности готовый к использованию набор контролов DefaultNavigationControls.

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

UI-элемент, отображающий состояние навигации на карте.

Добавление его в MapView приводит к отображению на ней маршрута, маркера геопозиции, транспортных событий, слежению за камерой. Внутри NavigationView можно размещать навигационные контролы - наследники NavigationControl, в частности готовый к использованию набор контролов DefaultNavigationControls.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit
Properties

var navigationManager​

NavigationVoice​

Голос для использования в навигаторе.

Extends: ru.dgis.sdk.NativeObject

NewValuesNotifier​

Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.

Extends: ru.dgis.sdk.NativeObject
Methods
fun sendNotification(): Unit

Необходимо вызывать, чтобы сообщить об обновлении параметров.

Returns
Unit

ObstacleInfo​

Информация о препятствии на маршруте.

ObstacleInfo(type: Obstacle = Obstacle.OTHER, limitation: ObstaclePassLimitation = ObstaclePassLimitation.UNLIMITED)

Информация о препятствии на маршруте.

Parameters

type

limitation

Properties

val type​

val limitation​

ObstacleInfoRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<ObstacleInfoRouteEntry>
fun findNearBackward(point: RoutePoint): ObstacleInfoRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
ObstacleInfoRouteEntry?
fun findNearForward(point: RoutePoint): ObstacleInfoRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
ObstacleInfoRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

ObstacleInfoRouteEntry​

Элемент маршрута - точка и значение в ней.

ObstacleInfoRouteEntry(point: RoutePoint, value: ObstacleInfo)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

ObstacleInfoRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): ObstacleInfoRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
ObstacleInfoRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<ObstacleInfoRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

ObstacleInfoRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

ObstacleInfoRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: ObstacleInfo
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

Opacity​

Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность).

Opacity(value: Float = 0.0f)

Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность).

Parameters

value

Properties

val value​

OpeningHours​

Часы работы организации.

OpeningHours(weekOpeningHours: List<List<WeekTimeInterval>>, isOpen24x7: Boolean)

Часы работы организации.

Parameters

weekOpeningHours

isOpen24x7

Properties

val weekOpeningHours​

Часы работы для каждого дня недели, начиная с понедельника.

val isOpen24x7​

OrderedValue​

Описывает одно значение из набора.

OrderedValue(value: String, text: String?)

Описывает одно значение из набора.

Parameters

value

text

Properties

val value​

Значение, по которым происходит фильтрация.

val text​

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

OrderedValues​

Описывает набор дискретных упорядоченных значений.

OrderedValues(
	values: List<OrderedValue>,
	currentMinIndex: Long? = null,
	currentMaxIndex: Long? = null
)

Описывает набор дискретных упорядоченных значений.

Parameters

values

currentMinIndex

currentMaxIndex

Properties

val values​

Набор значений. Упорядочен по возрастанию.

val currentMinIndex​

Индекс текущего установленного минимального значения.

val currentMaxIndex​

Индекс текущего установленного максимального значения.

Package​

Пакет. Для удобства работы с данными (установки, обновления, удаления), данные в 2ГИС SDK группируются в наборы по функционально-логическому назначению. Набор сгруппированных данных называется пакетом. В пределах одного пакета функциональное назначение данных уникально. Однако, множества данных пакетов с единым функциональным назначением могут пересекаться, то есть, возможна ситуация, когда данные нескольких пакетов имеют общие файлы. При операциях с группой таких пакетов общие данные будут обрабатываться (скачиваться, распаковываться, удаляться) только один раз.

Extends: ru.dgis.sdk.NativeObject
Methods
fun install(): Unit

Запуск операции установки либо обновления пакета.

Returns
Unit
fun uninstall(): Unit

Запуск операции удаления пакета.

Returns
Unit
Properties

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.

Parameters

name

installed

incomplete

preinstalled

compatible

hasUpdate

error

updateStatus

finalSizeOnDisk

currentSizeOnDisk

Properties

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​

Интерфейс для централизованной работы с пакетами:

  • Управления автообновлением и получением его статуса;
  • Принудительной проверкой обновлений;
  • Запуском и остановкой установки/обновления всех доступных пакетов.
  • Подпиской на изменения информации о пакетах;
  • Подпиской на изменения информации о всеобщем прогрессе установки пакетов.

Extends: ru.dgis.sdk.NativeObject
Methods
fun checkForUpdates(): Unit

Принудительная проверка на наличие обновлений.

Returns
Unit
Properties

var autoupdateEnabled​

Статус (включено/выключено) автообновления.

val packagesChannel​

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

val packages​

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

PackedMapState​

Сериализованное состояние карты.

Extends: ru.dgis.sdk.NativeObject
Methods
fun toBytes(): ByteArray

Представление состояния карты в виде последовательности байтов.

Returns
ByteArray
@JvmStatic
fun of(
	position: CameraPosition,
	showTraffic: Boolean,
	behaviour: CameraBehaviour
): PackedMapState

Получение состояния карты.

Parameters

position

Позиция камеры.

showTraffic

Состояние отображения пробок на карте.

behaviour

Режим слежения камеры.

Returns
PackedMapState

Сериализованное состояние карты.

@JvmStatic
fun fromBytes(data: ByteArray): PackedMapState

Получение состояния карты.

Parameters

data

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

Returns
PackedMapState

Сериализованное состояние карты.

@JvmStatic
fun fromMap(map: Map): PackedMapState

Получение состояния карты.

Parameters

map

Карта, состояние которой необходимо получить.

Returns
PackedMapState

Сериализованное состояние карты.

Properties

var showTraffic​

Получение состояния отображения пробок на карте.

var cameraPosition​

Получение позиции камеры.

var cameraBehaviour​

Получения режима слежения камеры.

PackedNavigationState​

Вспомогательный объект для сериализации и десериализации состояния навигации.

Extends: ru.dgis.sdk.NativeObject
Methods
fun toBytes(): ByteArray

Сериализация состояния навигации.

Returns
ByteArray
@JvmStatic
fun of(
	trafficRoute: TrafficRoute,
	routeSearchOptions: RouteSearchOptions? = null,
	finishPoint: RouteSearchPoint? = null,
	routePosition: RoutePoint? = null,
	state: State = State.DISABLED
): PackedNavigationState

Создание объекта из перечисленных элементов.

Parameters

trafficRoute

routeSearchOptions

finishPoint

routePosition

state

Returns
PackedNavigationState
@JvmStatic
fun fromBytes(data: ByteArray): PackedNavigationState

Десериализация состояния навигации. Недопустимые элементы в сохранённом состоянии пропускаются либо заменяются значениями по умолчанию.

Parameters

data

Returns
PackedNavigationState
@JvmStatic
fun fromModel(model: Model): PackedNavigationState

Создание объекта из модели навигатора.

Parameters

model

Returns
PackedNavigationState
Properties

var trafficRoute​

Маршрут.

var finishPoint​

Конечная точка маршрута.

var routeSearchOptions​

Опции построения маршрута.

var routePosition​

Позиция на маршруте.

var state​

Текущее состояние навигации.

PackedSearchQuery​

Вспомогательный объект для сериализации и десериализации поискового запроса.

Extends: ru.dgis.sdk.NativeObject
Methods
fun toBytes(): ByteArray
Returns
ByteArray
fun toSearchQuery(): SearchQuery
Returns
SearchQuery
@JvmStatic
fun fromBytes(data: ByteArray): PackedSearchQuery

Десериализация запроса поиска.

Parameters

data

Returns
PackedSearchQuery
@JvmStatic
fun fromSearchQuery(searchQuery: SearchQuery): PackedSearchQuery
Parameters

searchQuery

Returns
PackedSearchQuery
Properties

val queryText​

Текст запроса. Для некоторых запросов (например, раскрытие рубрики из suggest'а) текст отсутствует, т.к. в запросе хранятся идентификаторы, и поведение отличается от поиска по тексту элемента suggest'а.

val spatialRestriction​

Геометрия, ограничивающая область поиска.

val areaOfInterest​

Прямоугольная область интереса.

val allowedResultTypes​

Ограничение по возвращаемым поиском типам объектов.

val pageSize​

Размер страницы выдачи.

val directoryFilter​

Информация об активных фильтрах.

val sortingType​

Тип сортировки результатов.

Padding​

Отступы от краёв камеры.

Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:

  • точку позиции;
  • анимированное перемещение карты;
  • расположение динамических объектов карты (например баблы маршрутов).

Padding(
	left: Int = 0,
	top: Int = 0,
	right: Int = 0,
	bottom: Int = 0
)

Отступы от краёв камеры.

Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:

  • точку позиции;
  • анимированное перемещение карты;
  • расположение динамических объектов карты (например баблы маршрутов).

Parameters

left

top

right

bottom

Properties

val left​

Отступ слева внутрь.

val top​

Отступ сверху внутрь.

val right​

Отступ справа внутрь.

val bottom​

Отступ снизу внутрь.

Page​

Страница результатов поиска.

Extends: ru.dgis.sdk.NativeObject
Methods
fun fetchPrevPage(): Future<Page?>

Получить предыдущую страницу результатов.

Returns
Future<Page?>

future, резолвящаяся в ненулевой указатель на предыдущую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если предыдущая страница отсутствует exceptional future, если произошла ошибка при получении страницы

fun fetchNextPage(): Future<Page?>

Получить следующую страницу результатов.

Returns
Future<Page?>

future, резолвящаяся в ненулевой указатель на следующую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если следующая страница отсутствует exceptional future, если произошла ошибка при получении страницы

Properties

val items​

Непустой набор объектов справочника этой страницы.

ParkingCapacity​

Вместимость парковки.

ParkingCapacity(total: String?, specialSpaces: List<SpecialSpace>)

Вместимость парковки.

Parameters

total

specialSpaces

Properties

val total​

Общая вместимость парковки, машиномест.

val specialSpaces​

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

ParkingControl​

UI-элемент, переключаюший видимость парковок на карте.

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

UI-элемент, переключаюший видимость парковок на карте.

Parameters

context

attrs

defStyle

Methods
fun attachToMap(map: Map): Unit
Parameters

map

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

map

Returns
Unit

ParkingControlModel​

Модель контрола парковок.

Этот интерфейс является потокобезопасным.

Extends: ru.dgis.sdk.NativeObject
ParkingControlModel(map: Map)

Функция создания модели элемента управления парковками.

Parameters

map

карта.

Methods
fun toggleParkingsVisibility(): Unit

Действие при нажатии на контрол. Переключает видимость парковок на карте.

Returns
Unit
Properties

val isEnabledChannel​

Состояние элемента управления видимостью парковок. true, если парковки видны.

val isEnabled​

Состояние элемента управления видимостью парковок. true, если парковки видны.

ParkingInfo​

Общая информация о парковке.

ParkingInfo(
	type: ParkingType?,
	purpose: ParkingPurpose,
	access: ParkingAccess,
	pavingType: ParkingPavingType?,
	isPaid: Boolean,
	isIncentive: Boolean,
	forTrucks: Boolean,
	levelCount: Short?,
	capacity: ParkingCapacity?
)

Общая информация о парковке.

Parameters

type

purpose

access

pavingType

isPaid

isIncentive

forTrucks

levelCount

capacity

Properties

val type​

Тип.

val purpose​

Назначение.

val access​

Тип доступа.

val pavingType​

Тип покрытия.

val isPaid​

Является ли парковка платной.

val isIncentive​

Является ли парковка перехватывающей.

val forTrucks​

Есть места для грузовиков.

val levelCount​

Количество уровней.

val capacity​

Вместимость.

PedestrianBriefRouteInfo​

Базовая информация о пешеходном маршруте.

PedestrianBriefRouteInfo(length: RouteDistance, landmark: String)

Базовая информация о пешеходном маршруте.

Parameters

length

landmark

Properties

val length​

Длина маршрута.

val landmark​

Ориентир.

PedestrianInstructionCrossroad​

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

PedestrianInstructionCrossroad(landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.NONE, maneuvers: List<PedestrianInstructionCrossroadManeuver>)

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

Parameters

landmark

maneuvers

Properties

val landmark​

Ориентир.

val maneuvers​

Цепочка идущих подряд манёвров.

PedestrianInstructionCrossroadManeuver​

PedestrianInstructionCrossroadManeuver(direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Parameters

direction

turnAngle

Properties

val direction​

Направление движения.

val turnAngle​

Угол поворота в градусах -180,180.

PedestrianInstructionFinish​

Конец пешеходной части маршрута.

PedestrianInstructionFinish()

Конец пешеходной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

PedestrianInstructionIndoorEnter​

Вход в здание.

PedestrianInstructionIndoorEnter(levelId: LevelId = LevelId())

Вход в здание.

Parameters

levelId

Properties

val levelId​

Идентификатор этажа после входа в здание.

PedestrianInstructionIndoorExit​

Выход из здания.

PedestrianInstructionIndoorExit()

Выход из здания.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

PedestrianInstructionIndoorFloorChange​

Смена этажа в здании.

PedestrianInstructionIndoorFloorChange(
	type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.UNDEFINED,
	beginId: LevelId = LevelId(),
	endId: LevelId = LevelId()
)

Смена этажа в здании.

Parameters

type

beginId

endId

Properties

val type​

Тип смены этажа.

val beginId​

Идентификатор этажа до смены.

val endId​

Идентификатор этажа после смены.

PedestrianInstructionStart​

Начало пешеходной части маршрута.

PedestrianInstructionStart()

Начало пешеходной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

PedestrianRouteSearchOptions​

Параметры поиска пешеходного маршрута.

PedestrianRouteSearchOptions(
	avoidStairways: Boolean = false,
	avoidUnderpassesAndOverpasses: Boolean = false,
	useIndoor: Boolean = true,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска пешеходного маршрута.

Parameters

avoidStairways

avoidUnderpassesAndOverpasses

useIndoor

excludedAreas

Properties

val avoidStairways​

Избегать лестниц.

val avoidUnderpassesAndOverpasses​

Избегать подземных и надземных переходов.

val useIndoor​

Строить маршруты внутри зданий.

val excludedAreas​

Исключаемые области (не больше 25).

PerformSearchHandler​

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

Extends: ru.dgis.sdk.NativeObject
Properties

val searchQuery​

Запрос для прогона через поисковик.

PointGeometry​

Точка.

Extends: ru.dgis.sdk.geometry.Geometry
PointGeometry(point: GeoPoint)
Parameters

point

PointGeometry(point: GeoPointWithElevation)
Parameters

point

Properties

val point​

PointGeometryData​

Данные геометрии точечного объекта.

PointGeometryData(geoPoint: GeoPoint)
Parameters

geoPoint

PointGeometryData(geoPointWithElevation: GeoPointWithElevation)
Parameters

geoPointWithElevation

Methods
fun match(geoPoint: Function1, geoPointWithElevation: Function1): T
Parameters

geoPoint

geoPointWithElevation

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

other

Returns
Boolean
Properties

val isGeoPoint​

val asGeoPoint​

val isGeoPointWithElevation​

val asGeoPointWithElevation​

val value​

Polygon​

Полигон на карте.

Extends: ru.dgis.sdk.map.SimpleMapObject
Polygon(options: PolygonOptions)

Cоздание полигона на основе параметров.

Parameters

options

Properties

var contours​

var color​

var strokeWidth​

var strokeColor​

PolygonGeometry​

Полигон.

Extends: ru.dgis.sdk.geometry.Geometry
PolygonGeometry(contours: List<List<GeoPoint>>)
Parameters

contours

Properties

val contours​

PolygonOptions​

Параметры полигона.

PolygonOptions(
	contours: List<List<GeoPoint>>,
	color: Color = Color(),
	strokeWidth: LogicalPixel = LogicalPixel(value = 0.0f),
	strokeColor: Color = Color(),
	visible: Boolean = true,
	userData: Any? = null,
	zIndex: ZIndex = ZIndex(value = 0),
	levelId: LevelId? = null
)

Параметры полигона.

Parameters

contours

color

strokeWidth

strokeColor

visible

userData

zIndex

levelId

Properties

val contours​

val color​

val strokeWidth​

val strokeColor​

val visible​

val userData​

val zIndex​

Уровень отрисовки объекта.

val levelId​

Привязка к поэтажному плану здания.

Polyline​

Ломаная линия на карте.

Extends: ru.dgis.sdk.map.SimpleMapObject
Polyline(options: PolylineOptions)
Parameters

options

Properties

var points​

var width​

var color​

var erasedPart​

var dashedPolylineOptions​

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

var gradientPolylineOptions​

Получение параметров градиентной полилинии.

PolylineGeometry​

Ломаная линия.

Extends: ru.dgis.sdk.geometry.Geometry
PolylineGeometry(points: List<GeoPoint>)
Parameters

points

Properties

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

Параметры полилинии.

Parameters

points

width

color

erasedPart

dashedPolylineOptions

gradientPolylineOptions

visible

userData

zIndex

levelId

Properties

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​

Пользовательские данные.

val zIndex​

Уровень отрисовки объекта.

val levelId​

Привязка к поэтажному плану здания.

Projection​

Проекция.

Используется сферическая проекция Меркатора (EPSG:3857), зацикленная по долготе. Отображаемые данные ограничены по широте от -85.06° до 85.06°.

Extends: ru.dgis.sdk.NativeObject
Methods
fun screenToMap(point: ScreenPoint): GeoPoint?

Вычисление точки карты в указанной точке экрана.

Функция возвращает пустое значение, если указанная точка экрана за пределами проекции карты.

Parameters

point

Returns
GeoPoint?
fun mapToScreen(point: GeoPoint): ScreenPoint?

Вычисление точки экрана, соответствующей указанной точке карты.

Функция возвращает пустое значение:

  • point имеет невалидное значение (latitude лежит вне диапазона -90;90 или longitude лежит вне диапазона -180;180).
  • если указанная точка карты находится выше плоскости проекции карты на экран.
  • если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.

Parameters

point

Returns
ScreenPoint?
fun mapToScreen(point: GeoPointWithElevation): ScreenPoint?

Вычисление точки экрана, соответствующей указанной точке карты с высотой.

Функция возвращает пустое значение:

  • point имеет невалидное значение (latitude лежит вне диапазона -90;90, longitude лежит вне диапазона -180;180 или elevation отрицателен).
  • если указанная точка карты находится выше плоскости проекции карты на экран.
  • если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.

Parameters

point

Returns
ScreenPoint?
fun screenToMapClipped(point: ScreenPoint): GeoPoint

Вычисление ближайшей точки карты к проекции указанной точки экрана.

Parameters

point

Returns
GeoPoint

PublicBriefRouteInfo​

Базовая информация о маршруте на общественном транспорте.

PublicBriefRouteInfo(publicTransportInfos: List<PublicBriefRouteTransportInfo>)

Базовая информация о маршруте на общественном транспорте.

Parameters

publicTransportInfos

Properties

val publicTransportInfos​

Описание способов проезда на общественном транспорте.

PublicBriefRouteTransportInfo​

Описание общественного транспортного средства.

PublicBriefRouteTransportInfo(
	type: PublicTransportType = PublicTransportType.BUS,
	names: List<String>,
	color: Int?,
	routeLogo: String
)

Описание общественного транспортного средства.

Parameters

type

names

color

routeLogo

Properties

val type​

Тип общественного транспортного средства.

val names​

Названия маршрутов общественного транспорта, на которых происходит проезд.

val color​

Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.

Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.

PublicRoutePart​

Описание участка маршрута на общественном транспорте.

PublicRoutePart(transports: List<PublicTransportInfo>, intermediateStops: List<PublicTransportStop>)

Описание участка маршрута на общественном транспорте.

Parameters

transports

intermediateStops

Properties

val transports​

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

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

val intermediateStops​

Промежуточные остановки, которые транспорт проедет прежде, чем доберется до точки пересадки.

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

На этих остановках не нужно выходить.

Начальная и конечная остановки не входят в этот список.

PublicTransportCard​

Карточка, отображающая информацию о маршруте на общественном транспорте.

Extends: android.widget.FrameLayout
PublicTransportCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Карточка, отображающая информацию о маршруте на общественном транспорте.

Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
Properties

var model​

PublicTransportCardModel​

Модель для PublicTransportCard.

PublicTransportCardModel(
	route: TrafficRoute,
	context: Context,
	startName: String? = null,
	finishName: String? = null
)

Модель для PublicTransportCard.

Parameters

route

context

startName

finishName

Properties

val briefModel​

Краткая информация (отображаемая в "шапке" карточки).

val transfers​

Точки пересадки.

PublicTransportInfo​

Описание общественного транспортного средства.

PublicTransportInfo(
	type: PublicTransportType = PublicTransportType.BUS,
	names: List<String>,
	suggestedCarNumbers: List<Int>,
	boardingSuggest: String,
	color: Int?,
	routeLogo: String
)

Описание общественного транспортного средства.

Parameters

type

names

suggestedCarNumbers

boardingSuggest

color

routeLogo

Properties

val type​

Тип общественного транспортного средства.

val names​

Названия маршрутов общественного транспорта, на которых происходит проезд.

val suggestedCarNumbers​

Номера вагонов, в которые рекомендуется посадка.

Если транспортное средство состоит из одного вагона или можно садиться в любой вагон, то этот список будет пустым.

val boardingSuggest​

Текстовое описание вагонов, в которые рекомендуется посадка.

val color​

Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.

Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.

PublicTransportRouteSearchOptions​

Параметры поиска маршрута на общественном транспорте.

PublicTransportRouteSearchOptions(
	startTime: TimePoint? = null,
	useSchedule: Boolean = false,
	transportTypes: EnumSet<PublicTransportType> = EnumSet.noneOf(PublicTransportType::class.java)
)

Параметры поиска маршрута на общественном транспорте.

Parameters

startTime

useSchedule

transportTypes

Properties

val startTime​

Время в UTC, на которое нужно построить маршрут. Если не задано, используется текущее время.

val useSchedule​

Учёт расписания движения общественного транспорта при построении маршрута.

val transportTypes​

Типы общественного транспорта. Если не заполнены, маршруты будут строиться для всех поддерживаемых типов общественного транспорта.

PublicTransportStop​

Описание остановки общественного транспорта.

PublicTransportStop(name: String, coordinates: GeoPoint)

Описание остановки общественного транспорта.

Parameters

name

coordinates

Properties

val name​

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

val coordinates​

Географические координаты остановки.

PublicTransportTransfer​

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

PublicTransportTransfer(
	startPointName: String,
	finishPointName: String,
	routeParts: List<PublicRoutePart>
)

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

Parameters

startPointName

finishPointName

routeParts

Properties

val startPointName​

Название точки, из которой начинается движение для данного участка маршрута.

val finishPointName​

Название точки назначения для данного участка маршрута.

val routeParts​

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

Все участки маршрута из этого списка проходят по одной и той же линии геометрии.

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

PublicTransportTransferRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): PublicTransportTransferRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
PublicTransportTransferRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<PublicTransportTransferRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<PublicTransportTransferRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

PublicTransportTransferRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

PublicTransportTransferRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: PublicTransportTransfer
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

PurposeCode​

Код назначения здания.

PurposeCode(value: Long = 0)

Код назначения здания.

Parameters

value

Properties

val value​

Range​

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

Range(borders: Borders)
Parameters

borders

Range(orderedValues: OrderedValues)
Parameters

orderedValues

Methods
fun match(borders: Function1, orderedValues: Function1): T
Parameters

borders

orderedValues

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

other

Returns
Boolean
Properties

val isBorders​

val asBorders​

val isOrderedValues​

val asOrderedValues​

val value​

RangeFilter​

Фильтр диапазонов значений.

RangeFilter(
	tagName: String,
	displayName: String,
	minValue: Double,
	maxValue: Double
)

Фильтр диапазонов значений.

Parameters

tagName

displayName

minValue

maxValue

Properties

val tagName​

Тэг фильтра.

val displayName​

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

val minValue​

Минимальное значение диапазона.

val maxValue​

Максимальное значение диапазона.

RangeWidget​

Виджет для представления непрерывного или дискретного набора упорядоченных значений.

Extends: ru.dgis.sdk.directory.Widget
Methods
fun setValues(min: Double, max: Double): Unit

Установка текущих выбранных значений.

Parameters

min

текущее минимальное значение.

max

текущее максимальное значение.

Returns
Unit
Properties

val range​

Получение набора упорядоченных значений.

RasterTileSource​

Источник, получающий растровые тайлы.

Extends: ru.dgis.sdk.map.Source
RasterTileSource(
	context: Context,
	sublayerName: String,
	sourceTemplate: RasterUrlTemplate
)

Создание источника, получающего растровые тайлы.

Parameters

context

контекст.

sublayerName

имя, которое будет использовано при генерации объектов. Это имя должно быть указано в стилях в условии filter слоя типа raster для атрибута db_sublayer. Пример: ["match", get,db_sublayer, NAME, true, false] Подробнее см. спецификацию: https://docs.2gis.com/ru/mapgl/stylespecification

sourceTemplate

Шаблон для запроса тайлов.

Methods
fun setOpacity(opacity: Opacity): Unit

Установка значения прозрачности растрового тайла.

Parameters

opacity

Returns
Unit

RasterUrlTemplate​

RasterUrlTemplate(defaultSource: DefaultRasterUrlTemplate)
Parameters

defaultSource

RasterUrlTemplate(wmsSource: WmsRasterUrlTemplate)
Parameters

wmsSource

Methods
fun match(defaultSource: Function1, wmsSource: Function1): T
Parameters

defaultSource

wmsSource

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

other

Returns
Boolean
Properties

val isDefaultSource​

val asDefaultSource​

val isWmsSource​

val asWmsSource​

val value​

RemainingRouteInfoControl​

Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.

Extends: ru.dgis.sdk.navigation.NavigationControl
RemainingRouteInfoControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.

Parameters

context

attrs

defStyle

Methods
fun attachToManager(manager: NavigationManager): Unit
Parameters

manager

Returns
Unit
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
fun detachFromManager(): Unit
Returns
Unit
Properties

var onAddRoadEventButtonClicked​

var onLeftSideActionButtonClicked​

val heightChannel​

var expanded​

const MARGIN​

Remover​

Объект для удаления пользовательского контента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun remove(): Future<ActionResult>

Удаление контента.

действие доступно для контента, автором которого является пользователь.

Returns
Future<ActionResult>

RenderedObject​

Отображаемый объект карты.

RenderedObject(
	item: MapObject,
	source: Source,
	levelId: LevelId? = null
)

Отображаемый объект карты.

Parameters

item

source

levelId

Properties

val item​

Объект карты.

val source​

Источник данных, содержащий объект карты.

val levelId​

Идентификатор этажного плана здания, на котором расположен объект.

RenderedObjectInfo​

Подробная информация об отображаемом объекте карты.

RenderedObjectInfo(
	closestViewportPoint: ScreenPoint,
	closestMapPoint: GeoPointWithElevation,
	item: RenderedObject
)

Подробная информация об отображаемом объекте карты.

Parameters

closestViewportPoint

closestMapPoint

item

Properties

val closestViewportPoint​

Ближайшая точка объекта в координатах экрана.

val closestMapPoint​

Ближайшая точка объекта в координатах карты.

val item​

Отображаемый объект карты.

Reviews​

Отзывы.

Reviews(rating: Float, count: Int)

Отзывы.

Parameters

rating

count

Properties

val rating​

Рейтинг в диапазоне от 0 до 5.

val count​

Количество отзывов.

RoadCameraInfo​

Информация о камере.

RoadCameraInfo(purposes: EnumSet<CameraPurpose>, speedLimit: Short?)

Информация о камере.

Parameters

purposes

speedLimit

Properties

val purposes​

Назначения камеры.

Могут отсутствовать, если нет информации, или если камеру добавил пользователь.

val speedLimit​

Ограничение скорости в км/ч.

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

Может отсутствовать и для камер контроля скорости, если значение неизвестно.

RoadEvent​

Дорожное событие.

Extends: ru.dgis.sdk.NativeObject
Methods
fun photos(): Future<List<RoadEventPhoto>>

Фотографии события.

Returns
Future<List<RoadEventPhoto>>
Properties

val type​

Тип события.

val id​

Идентификатор события.

val name​

Локализованное название события.

val author​

Информация о пользователе, добавившем событие.

val timestamp​

Временная метка создания события.

val location​

Координаты события.

val description​

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

val cameraInfo​

Информация о камере.

Доступна только для событий типа "Camera".

val schedule​

Расписание.

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

val lanes​

Затронутые событием полосы.

На текущий момент могут быть проставлены только у пользовательских событий.

val availableActions​

Список доступных действий с событием.

val remover​

Получение объекта для удаления события.

RoadEventAction​

Действие события.

Extends: ru.dgis.sdk.NativeObject
Methods
fun set(): Future<ActionResult>

Применение действия (например, добавление отметки "нравится", подтверждение события).

Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода сбрасывает применение противоположного - невозможно одновременно поставить "нравится" и "не нравится".

Returns
Future<ActionResult>
fun reset(): Future<ActionResult>

Отмена действия (например, сброс отметки "нравится", сброс подтверждения события).

Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода не вызывает применение противоположного действия.

Returns
Future<ActionResult>
Properties

val type​

Тип действия.

val name​

Локализованное название действия.

val infoChannel​

Информация о действии.

val info​

Информация о действии.

RoadEventActionButton​

Кнопка действия над дорожным событием (подтвердить, поставить "нравится" и т.д.).

Extends: android.widget.FrameLayout
RoadEventActionButton(model: RoadEventActionButtonModel, context: Context)

Кнопка действия над дорожным событием (подтвердить, поставить "нравится" и т.д.).

Parameters

model

context

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
Properties

val model​

RoadEventActionInfo​

Информация о действии.

RoadEventActionInfo(state: RoadEventActionState, count: Int?)

Информация о действии.

Parameters

state

count

Properties

val state​

Состояние действия.

val count​

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

RoadEventCard​

Карточка, отображающая информацию о дорожном событии.

Extends: android.widget.FrameLayout
RoadEventCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Карточка, отображающая информацию о дорожном событии.

Parameters

context

attrs

defStyle

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
Properties

var event​

var onRemoveCompleted​

Уведомление о завершении удаления события.

var onActionCompleted​

Уведомление о завершении действия.

RoadEventCardModel​

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

Implements: java.lang.AutoCloseable
RoadEventCardModel(
	event: RoadEvent,
	photoSize: StatefulChannel<ScreenSize>,
	context: Context
)

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

Parameters

event

photoSize

context

Methods
fun close(): Unit
Returns
Unit
Properties

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​

Действия.

RoadEventManager​

Объект для создания транспортных событий.

Extends: ru.dgis.sdk.NativeObject
RoadEventManager(context: Context)

Получение объекта для создания дорожных событий.

Parameters

context

Methods
fun createAccident(
	location: GeoPoint,
	lanes: EnumSet<Lane>,
	description: String
): Future<AddEventResult>

Создание события "ДТП".

Parameters

location

Местоположение события.

lanes

Полосы дороги, затрагиваемые событием.

description

Пользовательское описание события.

Returns
Future<AddEventResult>
fun createCamera(location: GeoPoint, description: String): Future<AddEventResult>

Создание события "Камера".

Parameters

location

Местоположение события.

description

Пользовательское описание события.

Returns
Future<AddEventResult>
fun createRoadRestriction(location: GeoPoint, description: String): Future<AddEventResult>

Создание события "Перекрытие дорожного движения".

Parameters

location

Местоположение события.

description

Пользовательское описание события.

Returns
Future<AddEventResult>
fun createComment(location: GeoPoint, description: String): Future<AddEventResult>

Создание события "Комментарий".

Parameters

location

Местоположение события.

description

Пользовательское описание события.

Returns
Future<AddEventResult>
fun createOther(
	location: GeoPoint,
	lanes: EnumSet<Lane>,
	description: String
): Future<AddEventResult>

Создание события "Другое".

Parameters

location

Местоположение события.

lanes

Полосы дороги, затрагиваемые событием.

description

Пользовательское описание события.

Returns
Future<AddEventResult>
fun createRoadWorks(
	location: GeoPoint,
	lanes: EnumSet<Lane>,
	description: String
): Future<AddEventResult>

Создание события "Дорожные работы".

Parameters

location

Местоположение события.

lanes

Полосы дороги, затрагиваемые событием.

description

Пользовательское описание события.

Returns
Future<AddEventResult>

RoadEventMapObject​

Объект карты "Дорожное событие".

Extends: ru.dgis.sdk.map.MapObject
Properties

val id​

val event​

Получение дорожного события.

val animationSettings​

Получение настроек анимации дорожных событий для чтения и изменения.

RoadEventMapObjectRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventMapObjectRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<RoadEventMapObjectRouteEntry>
fun findNearBackward(point: RoutePoint): RoadEventMapObjectRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
RoadEventMapObjectRouteEntry?
fun findNearForward(point: RoutePoint): RoadEventMapObjectRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
RoadEventMapObjectRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RoadEventMapObjectRouteEntry​

Элемент маршрута - точка и значение в ней.

RoadEventMapObjectRouteEntry(point: RoutePoint, value: RoadEventMapObject)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

RoadEventPhoto​

Фотография дорожного события.

Extends: ru.dgis.sdk.NativeObject
Methods
fun previewUrl(desiredSize: ScreenSize): String

URL превью фотографии.

Parameters

desiredSize

Returns
String
fun report(): Future<ActionResult>

Отправка жалобы на фотографию.

жалоба на свою фотографию ни к чему не приведёт.

Returns
Future<ActionResult>
Properties

val photoUrl​

URL полноразмерной фотографии.

val author​

Информация о пользователе, добавившем фотографию.

val timestamp​

Временная метка.

val remover​

Получение объекта для удаления фотографии.

RoadEventRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<RoadEventRouteEntry>
fun findNearBackward(point: RoutePoint): RoadEventRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
RoadEventRouteEntry?
fun findNearForward(point: RoutePoint): RoadEventRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
RoadEventRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RoadEventRouteEntry​

Элемент маршрута - точка и значение в ней.

RoadEventRouteEntry(point: RoutePoint, value: BriefRoadEvent)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

RoadEventSource​

Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.

Extends: ru.dgis.sdk.map.Source
RoadEventSource(context: Context)

Создание источника, отображающего дорожные события на карте.

Parameters

context

Methods
fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit

Установка или снятие выделения дорожных событий.

добавляет событию атрибут "selected", который можно использовать в стилях.

Parameters

directoryObjectIds

Идентификаторы изменяемых событий. Можно получить из RoadEventMapObject.

highlighted

Установка или снятие выделения.

Returns
Unit
Properties

var visibleEvents​

Получение текущих категорий событий, предоставляемых данным источником.

val highlightedObjectsChannel​

Получение списка идентификаторов выделенных дорожных событий.

val highlightedObjects​

Получение списка идентификаторов выделенных дорожных событий.

RoadMacroGraph​

Пакет глобального дорожного графа, используется для построения проезда между двумя загруженными offline-территориями.

Extends: ru.dgis.sdk.update.Package

RoadRuleRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): RoadRuleRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
RoadRuleRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadRuleRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<RoadRuleRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RoadRuleRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

RoadRuleRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadRule
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

RoadSubtypeRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): RoadSubtypeRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
RoadSubtypeRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSubtypeRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<RoadSubtypeRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RoadSubtypeRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

RoadSubtypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadSubtype
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

RoadSurfaceRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): RoadSurfaceRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
RoadSurfaceRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSurfaceRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<RoadSurfaceRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RoadSurfaceRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

RoadSurfaceRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadSurface
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

RoadTypeRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): RoadTypeRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
RoadTypeRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadTypeRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<RoadTypeRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RoadTypeRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

RoadTypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadType
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

RotateMapToNorthEvent​

Событие поворота карты на север.

Extends: ru.dgis.sdk.map.Event
RotateMapToNorthEvent()

RotationSettings​

Настройки обработки вращения карты.

RotationSettings(
	angleDiffDeg: Float,
	distanceDiffMm: Float,
	angleDiffInScalingDeg: Float,
	distanceDiffInScalingMm: Float
)

Настройки обработки вращения карты.

Parameters

angleDiffDeg

distanceDiffMm

angleDiffInScalingDeg

distanceDiffInScalingMm

Properties

val angleDiffDeg​

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

val distanceDiffMm​

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

val angleDiffInScalingDeg​

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

val distanceDiffInScalingMm​

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

Route​

Класс, описывающий маршрут. Маршрут представляет собой набор атрибутов, каждый из которых представляет собой контейнер типа RouteAttribute или RouteLongAttribute, в котором хранятся элементы атрибутов маршрута. Атрибуты маршрута делятся на точечные и протяженные. Точечные атрибуты (например, точки геометрии или лежачие полицейские) задаются в виде пары из RoutePoint и значения атрибута. Протяженные атрибуты (например, ширина проезжей части или ограничение скорости) задаются в виде пары из RoutePoint, которая указывает на начало действия атрибута и значения атрибута. В конце маршрута ставится терминатор. Например, пусть ширина проезжей части задана в виде набора пар {{0m, 3m}, {10m, 7m}, {20m, 5m}, {30m, 0m}}, тогда первые 10 метров маршрута проезжая часть имеет ширину 3 метра, на интервале [10м., 20м.) - 7м., с 20м. до конца маршрута - 5м.

Extends: ru.dgis.sdk.NativeObject
Properties

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

Описание способов перемещения на общественном транспорте между точками пересадок.

RouteBuildOptions​

Структура, которая описывает параметры построения маршрута в навигаторе.

RouteBuildOptions(finishPoint: RouteSearchPoint, routeSearchOptions: RouteSearchOptions)

Структура, которая описывает параметры построения маршрута в навигаторе.

Parameters

finishPoint

routeSearchOptions

Properties

val finishPoint​

Точка, к которой строится маршут.

val routeSearchOptions​

Параметры поиска маршрута.

RouteCamera​

Структура, описывающая дорожную камеру.

RouteCamera(
	purposes: EnumSet<RouteCameraPurpose>,
	rangeAgainst: RouteDistance,
	rangeAlong: RouteDistance,
	direction: RouteCameraDirection = RouteCameraDirection.AGAINST,
	maxSpeedLimit: Float?
)

Структура, описывающая дорожную камеру.

Parameters

purposes

rangeAgainst

rangeAlong

direction

maxSpeedLimit

Properties

val purposes​

Назначения камеры.

val rangeAgainst​

Дальность действия камеры против хода движения.

val rangeAlong​

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

val direction​

Направление действия камеры.

val maxSpeedLimit​

Скорость, превышение которое фиксируется камерой, в м/с. Отсутствует, если камера не фиксирует превышение скорости.

RouteDistance​

Расстояние вдоль маршрута.

RouteDistance(millimeters: Long = 0)

Расстояние вдоль маршрута.

Parameters

millimeters

Methods
fun absoluteValue(): RouteDistance
Returns
RouteDistance
operator fun compareTo(other: RouteDistance): Int
Parameters

other

Returns
Int
operator fun plus(other: RouteDistance): RouteDistance
Parameters

other

Returns
RouteDistance
operator fun minus(other: RouteDistance): RouteDistance
Parameters

other

Returns
RouteDistance
operator fun times(multiplier: Int): RouteDistance
Parameters

multiplier

Returns
RouteDistance
operator fun div(divisor: Int): RouteDistance
Parameters

divisor

Returns
RouteDistance
operator fun rem(divisor: Int): RouteDistance
Parameters

divisor

Returns
RouteDistance
Properties

val millimeters​

val meters​

val kilometers​

RouteEditor​

Интерфейс для редактора маршрута. Редактор маршрута получает точки начала и конца маршрута, строит маршруты и через каналы оповещает об их обновлениях и перестроениях.

Все методы этого интерфейса вызываются из одного потока.

Extends: ru.dgis.sdk.NativeObject
RouteEditor(context: Context)

Функция создания редактора маршрута.

Parameters

context

Methods
fun setRouteParams(routeParams: RouteEditorRouteParams): Unit

Установка параметров редактора маршрута. Запускает поиск нового маршрута согласно переданным параметрам.

Parameters

routeParams

Returns
Unit
fun setActiveRouteIndex(index: RouteIndex): Unit

Установка индекса активного маршрута.

Parameters

index

Returns
Unit
Properties

val routesInfoChannel​

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

val routesInfo​

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

val activeRouteIndexChannel​

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

val activeRouteIndex​

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

RouteEditorRouteParams​

Информация о параметрах маршрута.

RouteEditorRouteParams(
	startPoint: RouteSearchPoint,
	finishPoint: RouteSearchPoint,
	routeSearchOptions: RouteSearchOptions,
	intermediatePoints: List<RouteSearchPoint> = listOf()
)

Информация о параметрах маршрута.

Parameters

startPoint

finishPoint

routeSearchOptions

intermediatePoints

Properties

val startPoint​

val finishPoint​

val routeSearchOptions​

val intermediatePoints​

RouteEditorRoutesInfo​

Информация о маршрутах, которыми оперирует редактор.

RouteEditorRoutesInfo(routes: List<TrafficRoute>, routeParams: RouteEditorRouteParams)

Информация о маршрутах, которыми оперирует редактор.

Parameters

routes

routeParams

Properties

val routes​

При обновлении списка маршрутов активным будет первый маршрут, если список маршрутов непустой.

val routeParams​

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

RouteEditorSource​

Интерфейс класса, управляющего отображением маршрутов на карте.

Extends: ru.dgis.sdk.map.Source
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.

Parameters

context

routeEditor

activeDisplayFlags

inactiveDisplayFlags

activeCalloutLabelFlags

inactiveCalloutLabelFlags

calloutLabelDisplayMode

activePermanentDisplayFlags

inactivePermanentDisplayFlags

Methods
fun setRoutesVisible(visible: Boolean): Unit

Включить или выключить отображение маршрутов на карте.

Parameters

visible

Returns
Unit
fun setShowOnlyActiveRoute(showOnlyActiveRoute: Boolean): Unit

Отображать на карте все маршруты (false) или только текущий активный маршрут (true).

Parameters

showOnlyActiveRoute

Returns
Unit
fun setPassedDistanceVisualization(passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization): Unit

Изменить способ визуализации расстояния, пройденного вдоль маршрута.

Parameters

passedDistanceVisualization

Returns
Unit
Properties

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.

RouteExitSign​

Информация о знаке съезда.

RouteExitSign(
	type: RouteExitSignType = RouteExitSignType.UNDEFINED,
	roadNameTable: RouteExitSignTable,
	roadNumberTable: RouteExitSignTable?
)

Информация о знаке съезда.

Parameters

type

roadNameTable

roadNumberTable

Properties

val type​

Тип съезда.

val roadNameTable​

Табличка съезда с названием дороги.

val roadNumberTable​

Табличка съезда с номером дороги.

RouteExitSignRouteAttribute​

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteExitSignRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

end

Returns
List<RouteExitSignRouteEntry>
fun findNearBackward(point: RoutePoint): RouteExitSignRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
RouteExitSignRouteEntry?
fun findNearForward(point: RoutePoint): RouteExitSignRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

Returns
RouteExitSignRouteEntry?
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RouteExitSignRouteEntry​

Элемент маршрута - точка и значение в ней.

RouteExitSignRouteEntry(point: RoutePoint, value: RouteExitSign)

Элемент маршрута - точка и значение в ней.

Parameters

point

value

Properties

val point​

val value​

RouteExitSignTable​

Информация о табличке съезда.

RouteExitSignTable(backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.UNDEFINED, text: String)

Информация о табличке съезда.

Parameters

backgroundColor

text

Properties

val backgroundColor​

Цвет фона таблички съезда.

val text​

Текст на табличке съезда.

RouteIndex​

Индекс активного маршрута.

RouteIndex(value: Long = 0)

Индекс активного маршрута.

Parameters

value

Properties

val value​

RouteInfo​

Описание маршрута с манёврами.

RouteInfo(
	route: Route,
	routeBuildOptions: RouteBuildOptions?,
	external: Boolean = false
)

Описание маршрута с манёврами.

Parameters

route

routeBuildOptions

external

Properties

val route​

Маршрут.

val routeBuildOptions​

Параметры построения маршрута в навигаторе. Значение равное null означает, что у маршрута отсутствует конечная точка. В этом случае, на основании дорожного графа и параметров движения пользователя, вычисляется участок дороги, по которому предположительно движется пользователь и возвращается в виде маршрута в поле route. Следовательно, такой "маршрут" не может содержать инструкции и последняя точка в этом "маршруте" не является точкой назначения, в которую движется пользователь, а просто является точкой, до которой удалось предугадать движение пользователя. Куда он поедет дальше - неизвестно. Такой режим работы навигатора называется режим ведения без маршрута или free roam.

val external​

Источник маршрута. True - маршрут передан навигатору снаружи в методе start. False - маршрут сгенерирован самим навигатором.

RouteInfoCalloutMapObject​

Объект бабла с информацией о длине и/или длительности маршрута на карте.

Extends: ru.dgis.sdk.map.MapObject
Properties

val route​

Маршрут, часть которого представляет данный объект бабла.

val routeIndex​

Индекс маршрута.

val routePoint​

Позиция на маршруте, на которой расположен бабл.

RouteInstruction​

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

RouteInstruction(
	roadName: String,
	range: RouteDistance,
	extraInstructionInfo: ExtraInstructionInfo
)

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

Parameters

roadName

range

extraInstructionInfo

Properties

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
)

Структура, описывающая одну полосу движения.

Parameters

routeManeuver

maneuvers

speedLimit

prohibited

onlyPublicTransport

Properties

val routeManeuver​

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

val maneuvers​

Допустимые манёвры на полосе.

val speedLimit​

Максимальная разрешенная скорость на полосе, м/с. 0 - ограничение скорости неизвестно.

val prohibited​

Проезд по полосе запрещён.

val onlyPublicTransport​

Полоса для общественного транспорта.

RouteLaneSign​

Описание полос движения.

RouteLaneSign(
	lanes: List<RouteLane>,
	signStartPoint: RoutePoint?,
	signPoint: RoutePoint?,
	signEndPoint: RoutePoint?
)

Описание полос движения.

Parameters

lanes

signStartPoint

signPoint

signEndPoint

Properties

val lanes​

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

Если количество полос неизвестно либо в направлении маршрута на дороге находится одна полоса движения, то этот массив будет пустым.

val signStartPoint​

Точка на маршруте, в которой начинается действие знака, регулирующего движение по полосам. null, если положение начала действия знака неизвестно.

val signPoint​

Точка на маршруте, в которой установлен знак, регулирующий движение по полосам. null, если положение знака неизвестно.

val signEndPoint​

Точка на маршруте, в которой заканчивается действие знака, регулирующего движение по полосам. null, если положение окончания действия знака неизвестно.

RouteLevelInfo​

Информация об этаже здания, соответствующая участку маршрута.

RouteLevelInfo(
	beginId: LevelId?,
	endId: LevelId?,
	name: String
)

Информация об этаже здания, соответствующая участку маршрута.

Parameters

beginId

endId

name

Properties

val beginId​

Идентификатор этажного плана в начальной точке участка маршрута. Отсутствует, если точка не находится в здании.

val endId​

Идентификатор этажного плана в конечной точке участка маршрута. Отсутствует, если точка не находится в здании.

val name​

Название этажа. Пусто, если участок маршрута соединяет разные этажи.

RouteLevelInfoRouteLongAttribute​

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

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): RouteLevelInfoRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

Returns
RouteLevelInfoRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteLevelInfoRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

end

Returns
List<RouteLevelInfoRouteLongEntry>
Properties

val size​

Количество элементов.

val isEmpty​

Элементы отсутствуют.

val first​

Первый элемент.

val last​

Последний элемент.

val entries​

Все элементы.

RouteLevelInfoRouteLongEntry​

Протяженный элемент маршрута - отрезок и значение на нем.

RouteLevelInfoRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RouteLevelInfo
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

length

value

Properties

val point​

val length​

val value​

RouteMapObject​

Объект маршрута на карте.

Extends: ru.dgis.sdk.map.MapObject
RouteMapObject(
	trafficRoute: TrafficRoute,
	isActive: Boolean,
	index: RouteIndex,
	displayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
	calloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
	calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.ABSOLUTE_VALUES,
	permanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null
)
Parameters

trafficRoute

isActive

index

displayFlags

calloutLabelFlags

calloutLabelDisplayMode

permanentDisplayFlags

Properties

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

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

val lanesCalloutPositions​

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

val roadEventObjectsChannel​

Отображаемые на карте объекты дорожных событий вдоль маршрута.

val roadEventObjects​

Отображаемые на карте объекты дорожных событий вдоль маршрута.

RouteMapObjectSource​

Источник объектов маршрута на карте.

Extends: ru.dgis.sdk.map.Source
RouteMapObjectSource(context: Context, routeVisualizationType: RouteVisualizationType = RouteVisualizationType.NORMAL)

Функция создания IRouteMapObjectSource.

Parameters

context

routeVisualizationType

Methods
fun addObject(item: RouteMapObject): Unit

Добавление объекта маршрута в источник.

Parameters

item

Returns
Unit
fun removeObject(item: RouteMapObject): Unit

Удаление объекта маршрута из источника.

Parameters

item

Returns
Unit
fun replaceObject(oldObject: RouteMapObject, newObject: RouteMapObject): Unit

Замена одного объекта маршрута в источнике на другой. В отличие от удаления и добавления объектов маршрута через последовательные вызовы remove_object и add_object замена одного маршрута на другой выполняется атомарно - старый маршрут удаляется, а новый появляется на карте одновременно.

Если старый маршрут не найден в источнике, то вызов эквивалентен вызову add_object.

Parameters

oldObject

newObject

Returns
Unit
fun clear(): Unit

Удаление всех объектов маршрута из источника.

Returns
Unit
fun replaceAllObjects(objects: List<RouteMapObject>): Unit

Замена всех ранее добавленных в источник объектов на передаваемый список объектов. В отличие от удаления и добавления объектов по одному замена выполняется атомарно - старые маршруты удаляются, а новые маршруты появляются на карте одновременно.

Parameters

objects

Returns
Unit
Properties

val objects​

Объекты маршрута.

val routeSourceSettings​

Настройка отображения объектов в источнике.

RouteMapObjectsProvider​

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

Extends: ru.dgis.sdk.NativeObject
Properties

val objectsChannel​

Объекты маршрута на карте.

val objects​

Объекты маршрута на карте.

RouteMapSettings​

Настройки отображения маршрута на карте.

Extends: ru.dgis.sdk.NativeObject
Properties

var onRouteDisplayFlags​

Флаги отображения маршрута на карте для режима ведения по маршруту. По умолчанию включены все флаги, за исключением флага InactiveFloors.

var freeRoamDisplayFlags​

Флаги отображения маршрута на карте для режима free roam. По умолчанию включены флаги Cameras, Humps, Accidents, RoadWorks, Comments, RoadRestrictions, OtherEvents.

var onRoutePermanentDisplayFlags​

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

var freeRoamPermanentDisplayFlags​

Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима free roam. По умолчанию скрываются все элементы маршрута.

RouteOverviewControl​

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

Extends: ru.dgis.sdk.navigation.NavigationControl
RouteOverviewControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
fun onVisibilityChanged(changedView: View, visibility: Int): Unit
Parameters

changedView

visibility

Returns
Unit

RoutePoint​

Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.

RoutePoint(distance: RouteDistance)

Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.

Parameters

distance

Methods
operator fun compareTo(other: RoutePoint): Int
Parameters

other

Returns
Int
operator fun plus(distance: RouteDistance): RoutePoint
Parameters

distance

Returns
RoutePoint
operator fun minus(distance: RouteDistance): RoutePoint
Parameters

distance

Returns
RoutePoint
operator fun minus(other: RoutePoint): RouteDistance
Parameters

other

Returns
RouteDistance
Properties

val distance​

RoutePointMapObject​

Точечный объект, являющийся частью маршрута на карте (например, точка начала или конца маршрута).

Extends: ru.dgis.sdk.map.MapObject
Properties

val route​

Маршрут, часть которого представляет данный точечный объект.

val routeIndex​

Индекс маршрута.

val kind​

Тип точечного объекта маршрута.

val routePoint​

Позиция на маршруте, соответствующая данному точечному объекту.

val pointChannel​

Географические координаты, в которых находится данный точечный объект.

var point​

Географические координаты, в которых находится данный точечный объект.

RouteSearchOptions​

Параметры поиска маршрута.

RouteSearchOptions(bicycle: BicycleRouteSearchOptions)
Parameters

bicycle

RouteSearchOptions(car: CarRouteSearchOptions)
Parameters

car

RouteSearchOptions(pedestrian: PedestrianRouteSearchOptions)
Parameters

pedestrian

RouteSearchOptions(publicTransport: PublicTransportRouteSearchOptions)
Parameters

publicTransport

RouteSearchOptions(scooter: ScooterRouteSearchOptions)
Parameters

scooter

RouteSearchOptions(taxi: TaxiRouteSearchOptions)
Parameters

taxi

RouteSearchOptions(truck: TruckRouteSearchOptions)
Parameters

truck

Methods
fun match(
	bicycle: Function1,
	car: Function1,
	pedestrian: Function1,
	publicTransport: Function1,
	scooter: Function1,
	taxi: Function1,
	truck: Function1
): T
Parameters

bicycle

car

pedestrian

publicTransport

scooter

taxi

truck

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

other

Returns
Boolean
Properties

val isBicycle​

val asBicycle​

val isCar​

val asCar​

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
)

Описание точек, по которым строится маршрут.

Parameters

coordinates

course

objectId

levelId

Properties

val coordinates​

Координаты, через которые нужно проложить маршрут.

val course​

Направление, в котором нужно преодолеть точку.

val objectId​

ID объекта, до которого будет проложена пешеходная часть маршрута.

val levelId​

Идентификатор этажного плана (для пешеходных маршрутов).

RouteSourceSettings​

Настройки источника маршрута.

Extends: ru.dgis.sdk.NativeObject
Methods
fun getLargeScaleMergeDistanceMeters(transportType: TransportType): Float

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

Parameters

transportType

Тип транспорта, для которого запрашивается расстояние.

Returns
Float
fun setLargeScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit

Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба.

Parameters

distance

Расстояние в метрах.

transportType

Тип транспорта, для которого устанавливается расстояние.

Returns
Unit
fun getSmallScaleMergeDistanceMeters(transportType: TransportType): Float

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

Parameters

transportType

Тип транспорта, для которого запрашивается расстояние.

Returns
Float
fun setSmallScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit

Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба.

Parameters

distance

Расстояние в метрах.

transportType

Тип транспорта, для которого устанавливается расстояние.

Returns
Unit
fun getLargeScaleCrossroadsOffsetMeters(transportType: TransportType): Float

Смещение в метрах от точки перекрестка до начала и конца стрелки манёвра для крупного масштаба.

Parameters

transportType

Тип транспорта, для которого запрашивается смещение.

Returns
Float
fun setLargeScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit

Установить смещение в метрах от точки перекрестка до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.

Parameters

offset

Смещение в метрах.

transportType

Тип транспорта, для которого устанавливается смещение.

Returns
Unit
fun getSmallScaleCrossroadsOffsetMeters(transportType: TransportType): Float

Смещение от точки перекрестка до начала и конца стрелки манёвра для мелкого масштаба.

Parameters

transportType

Тип транспорта, для которого запрашивается смещение.

Returns
Float
fun setSmallScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit

Установить смещение от точки перекрестка до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.

Parameters

offset

Смещение в метрах.

transportType

Тип транспорта, для которого устанавливается смещение.

Returns
Unit
Properties

var largeScaleRingroadOffsetMeters​

Смещение от точки съезда с кольца до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.

var smallScaleRingroadOffsetMeters​

Смещение от точки съезда с кольца до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.

var calloutVisualizationMode​

Режим отображения баблов со временем и длиной маршрута.

RubricId​

Идентификатор рубрики.

RubricId(value: Long = 0)

Идентификатор рубрики.

Parameters

value

Properties

val value​

ScaleMapEvent​

Событие изменения масштаба карты.

Extends: ru.dgis.sdk.map.Event
ScaleMapEvent(zoomDelta: Float, scalingCenter: ScreenPoint? = null)

Конструктор события изменения масштаба.

Parameters

zoomDelta

Величина, на которую изменится текущее значение масштаба.

scalingCenter

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

Properties

val zoomDelta​

Величина, на которую изменится текущее значение масштаба.

val scalingCenter​

Точка на экране, относительно которой масштабируется карта.

ScalingSettings​

ScalingSettings(scaleRatioThreshold: Float, scaleRatioThresholdInRotation: Float)
Parameters

scaleRatioThreshold

scaleRatioThresholdInRotation

Properties

val scaleRatioThreshold​

Порог коэффицента масштабирования, по достижению которого начнёт отправляться событие масштабирования. Используется, если вращение неактивно. Множитель должен выйти за пределы (1 / scale_ratio_threshold, scale_ratio_threshold).

val scaleRatioThresholdInRotation​

Порог коэффицента масштабирования, по достижению которого начнёт отправляться сообщения масштабирования. Используется, если вращение активно. Множитель должен выйти за пределы (1 / scale_ratio_threshold_in_rotation, scale_ratio_threshold_in_rotation).

Schedule​

Расписание действия дорожного события.

Schedule(
	startTime: TimePoint?,
	finishTime: TimePoint?,
	weekTimeIntervals: List<WeekTimeInterval>
)

Расписание действия дорожного события.

Parameters

startTime

finishTime

weekTimeIntervals

Properties

val startTime​

Время начала действия. Отсутствует, если неизвестно.

val finishTime​

Время начала действия. Отсутствует, если неизвестно.

val weekTimeIntervals​

Интервалы работы внутри недели.

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

Первый интервал может начинаться с прошлой недели.

ScooterBriefRouteInfo​

Базовая информация о маршруте на самокате.

ScooterBriefRouteInfo(length: RouteDistance, landmark: String)

Базовая информация о маршруте на самокате.

Parameters

length

landmark

Properties

val length​

Длина маршрута.

val landmark​

Ориентир.

ScooterInstructionCrossroad​

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

ScooterInstructionCrossroad(landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.NONE, maneuvers: List<ScooterInstructionCrossroadManeuver>)

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

Parameters

landmark

maneuvers

Properties

val landmark​

Ориентир.

val maneuvers​

Цепочка идущих подряд манёвров.

ScooterInstructionCrossroadManeuver​

ScooterInstructionCrossroadManeuver(direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Parameters

direction

turnAngle

Properties

val direction​

Направление движения.

val turnAngle​

Угол поворота в градусах -180,180.

ScooterInstructionFinish​

Конец самокатной части маршрута.

ScooterInstructionFinish()

Конец самокатной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

ScooterInstructionStart​

Начало самокатной части маршрута.

ScooterInstructionStart()

Начало самокатной части маршрута.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

ScooterRouteSearchOptions​

Параметры поиска маршрута на самокате.

ScooterRouteSearchOptions(
	avoidCarRoads: Boolean = true,
	avoidStairways: Boolean = true,
	avoidUnderpassesAndOverpasses: Boolean = true,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска маршрута на самокате.

Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

val avoidCarRoads​

Избегать автомобильных дорог.

val avoidStairways​

Избегать лестниц.

val avoidUnderpassesAndOverpasses​

Избегать подземных и надземных переходов.

val excludedAreas​

Исключаемые области (не больше 25).

ScreenDistance​

Расстояние между объектами на экране в миллиметрах.

не может быть отрицательным

ScreenDistance(value: Float = 0.0f)

Расстояние между объектами на экране в миллиметрах.

не может быть отрицательным

Parameters

value

Properties

val value​

ScreenPoint​

Точка в экранных координатах.

Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.

ScreenPoint(x: Float = 0.0f, y: Float = 0.0f)

Точка в экранных координатах.

Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.

Parameters

x

y

Properties

val x​

val y​

ScreenShift​

Смещение карты по горизонтали и вертикали в координатном пространстве экрана.

Положительное направление смещения: dx - вправо, dy - вниз.

ScreenShift(dx: Float = 0.0f, dy: Float = 0.0f)

Смещение карты по горизонтали и вертикали в координатном пространстве экрана.

Положительное направление смещения: dx - вправо, dy - вниз.

Parameters

dx

dy

Properties

val dx​

val dy​

ScreenSize​

Размер в пикселях.

ScreenSize(width: Int = 0, height: Int = 0)

Размер в пикселях.

Parameters

width

height

Properties

val width​

val height​

SearchLayout​

UI-элемент, предоставлящий поисковую строку и отображение результатов поиска.

Extends: android.widget.LinearLayout
SearchLayout(context: Context)
Parameters

context

SearchLayout(context: Context, attrs: AttributeSet)
Parameters

context

attrs

SearchLayout(context: Context, options: SearchOptions)
Parameters

context

options

Methods
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
fun addSearchViewCallback(callback: SearchViewCallback): Unit

Метод, позволящий добавить SearchViewCallback для реагирования на разные состояния и результаты работы поиска и подсказчика.

Parameters

callback

Returns
Unit
fun configureSearchEngine(block: Function1): Unit

Метод, позволящий настроить работу поиска и подсказчика. Внутри блока доступны методы интерфeйсы SearchViewConfigurator

Parameters

block

Returns
Unit
fun hideResults(): Unit

Метод позволяет скрыть UI выдачи и оставить только поисковую строку. Работает только для текущего запроса, при его обновлении и появлении новых результатов, выдача снова отобразится.

Returns
Unit

SearchManager​

Поисковик. Основная точка входа для справочного API.

Extends: ru.dgis.sdk.NativeObject
Methods
fun suggest(query: SuggestQuery): Future<SuggestResult>

Получить подсказки, соответствующие данному запросу.

Parameters

query

Returns
Future<SuggestResult>

future, резолвящаяся в ненулевой указатель на результат подбора подсказок или exceptional future, если произошла ошибка при получении подсказок

fun search(query: SearchQuery): Future<SearchResult>

Получить объекты справочника, соответствующие данному запросу.

Parameters

query

Returns
Future<SearchResult>

future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска

fun searchById(id: String): Future<DirectoryObject?>

Получить объект справочника по строковому идентификатору.

Parameters

id

Returns
Future<DirectoryObject?>

future, резолвящаяся в указатель на объект справочника. Если объект не найден, то вернется пустой указатель

fun searchByDirectoryObjectId(objectId: DgisObjectId): Future<DirectoryObject?>

Получить объект справочника по идентификатору.

Parameters

objectId

Returns
Future<DirectoryObject?>

future, резолвящаяся в указатель на объект справочника. Если объект не найден, то вернется пустой указатель

@JvmStatic
fun createOnlineManager(context: Context): SearchManager

Создать поисковик, работающий онлайн.

Parameters

context

Returns
SearchManager
@JvmStatic
fun createOfflineManager(context: Context): SearchManager

Создать поисковик, работающий с предзагруженными данными.

Parameters

context

Returns
SearchManager
@JvmStatic
fun createSmartManager(context: Context): SearchManager

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

Parameters

context

Returns
SearchManager

SearchOptions​

Опции для создания SearchLayout.

SearchOptions(
	searchType: SearchType = SearchType.defaultSearchType,
	pageSize: Int = defaultPageSize,
	sortingType: SortingType = SortingType.BY_RELEVANCE,
	suggestorType: SuggestorType = SuggestorType.OBJECT
)

Опции для создания SearchLayout.

Parameters

searchType

pageSize

sortingType

suggestorType

Properties

val searchType​

Тип поисковика. Возможные значения зависят от типа поставки SDK. Подробнее см. SearchType. Значение по умолчанию зависит от типа поставки SDK.

val pageSize​

Лимит на количество подсказок в suggest'e и результатов в выдаче. Допустимы значения от 1 до 50. По умолчанию: 10.

val sortingType​

Тип сортировки поисковой выдачи. По умолчанию: SortingType.BY_RELEVANCE.

val suggestorType​

Тип подсказчика. По умолчанию: SuggestorType.OBJECT.

SearchQuery​

Поисковый запрос.

Extends: ru.dgis.sdk.NativeObject

SearchQueryBuilder​

Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):

  • Если явно задается область в виде полигона в запросе (spatial_restriction), то она учитывается в первую очередь. Способы ниже по приоритету отключаются, однако используются для учёта расстояний в релевантности поиска.
  • При указании прямоугольной области интереса (bounding_rect), поиск ведется в некоторой ее окрестности.
  • Если не указаны вышестоящие по приоритету параметры, то учитывается точка положения пользователя.

    • TODO: Данное условие пока не работает. Будет исправлено в ближайших релизах.

  • При упоминании в тексте запроса широко известного объекта (город, область или другой топоним) добавляется в поиск тот сегмент, в который попадает точка найденного объекта из глобального индекса.
  • Если не указано ничего из вышеперечисленного, то осуществляется поиск по глобальному индексу.

    • Extends: ru.dgis.sdk.NativeObject
    Methods
    fun setSpatialRestriction(spatialRestriction: List?<GeoPoint>): SearchQueryBuilder

    Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.

    по умолчанию ограничение отсутствует

    Parameters

    spatialRestriction

    Returns
    SearchQueryBuilder
    fun setAreaOfInterest(rect: GeoRect?): SearchQueryBuilder

    Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.

    Parameters

    rect

    Returns
    SearchQueryBuilder
    fun setAllowedResultTypes(allowedResultTypes: List<ObjectType>): SearchQueryBuilder

    Задать типы объектов, разрешенные в результате запроса.

    по умолчанию все, кроме Route

    Parameters

    allowedResultTypes

    Returns
    SearchQueryBuilder
    fun setPageSize(pageSize: Int): SearchQueryBuilder

    Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона 1;50

    по умолчанию 10

    Parameters

    pageSize

    Returns
    SearchQueryBuilder
    fun setDirectoryFilter(filter: DirectoryFilter): SearchQueryBuilder

    Задать фильтрацию для поискового запроса.

    Parameters

    filter

    Returns
    SearchQueryBuilder
    fun setSortingType(sortingType: SortingType): SearchQueryBuilder

    Задать сортировку для поискового запроса.

    Parameters

    sortingType

    Returns
    SearchQueryBuilder
    fun build(): SearchQuery

    Сформировать поисковый запрос.

    Returns
    SearchQuery
    @JvmStatic
    fun fromQueryText(queryText: String): SearchQueryBuilder

    Начать построение текстового поискового запроса c указанным текстом.

    Parameters

    queryText

    Returns
    SearchQueryBuilder
    @JvmStatic
    fun fromRubricIds(rubricIds: List<RubricId>): SearchQueryBuilder

    Начать построение поискового запроса на основе идентификаторов рубрик.

    Parameters

    rubricIds

    Returns
    SearchQueryBuilder
    @JvmStatic
    fun fromQueryTextAndRubricIds(queryText: String, rubricIds: List<RubricId>): SearchQueryBuilder

    Начать построение текстового поискового запроса с фильтрацией по идентификаторам рубрик.

    Parameters

    queryText

    rubricIds

    Returns
    SearchQueryBuilder
    @JvmStatic
    fun fromQuery(query: SearchQuery): SearchQueryBuilder

    Начать построение запроса на основе запроса #query для изменения части параметров.

    Исходный запрос #query остается без изменений

    Parameters

    query

    Returns
    SearchQueryBuilder

    SearchResult​

    Результат работы поисковика.

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun markerTitles(objectIds: List<DgisObjectId>): List<Future<List<UIMarkerInfo>>>

    Получение текстов маркеров по их идентификаторам. Возвращается vector <future

    , так как в облако за запрос можно отправить не более 50 идентификаторов.

    Parameters

    objectIds

    Идентификаторы маркеров.

    Returns
    List<Future<List<UIMarkerInfo>>>
    Properties

    val firstPage​

    Первая страница результатов поиска.

    val representativeArea​

    Прямоугольная область, подходящая для отображения результатов поиска.

    val itemMarkerInfos​

    Асинхронное получение маркеров.

    val searchResultType​

    Тип поискового запроса.

    val dynamicFilters​

    Динамические фильтры для этого запроса.

    val actionWidgets​

    Виджеты быстрых фильтров.

    Это так называемые "быстрые фильтры" - фильтры, наиболее интересные пользователю. Их не больше 5.

    val mainWidgets​

    Виджеты фильтров.

    val autoUseFirstResult​

    Признак того, что первый результат пригоден для непосредственного использования.

    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 не определено.

    Parameters

    point

    bearing

    Properties

    val point​

    val bearing​

    SettlementRouteLongAttribute​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entry(point: RoutePoint): SettlementRouteLongEntry?

    Элемент, в который попадает заданная точка.

    Parameters

    point

    Returns
    SettlementRouteLongEntry?
    fun entries(begin: RoutePoint, end: RoutePoint): List<SettlementRouteLongEntry>

    Элементы, частично или полностью покрываемые отрезком begin,end.

    Parameters

    begin

    end

    Returns
    List<SettlementRouteLongEntry>
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    SettlementRouteLongEntry​

    Протяженный элемент маршрута - отрезок и значение на нем.

    SettlementRouteLongEntry(
    	point: RoutePoint,
    	length: RouteDistance,
    	value: Settlement
    )

    Протяженный элемент маршрута - отрезок и значение на нем.

    Parameters

    point

    length

    value

    Properties

    val point​

    val length​

    val value​

    ShowRouteControl​

    UI-элемент управления перелетом карты к маршруту.

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

    UI-элемент управления перелетом карты к маршруту.

    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToMap(map: Map): Unit
    Parameters

    map

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

    map

    Returns
    Unit
    fun showRoute(geometry: Geometry, styleZoomToTiltRelation: StyleZoomToTiltRelation?): Unit
    Parameters

    geometry

    styleZoomToTiltRelation

    Returns
    Unit
    fun cancelRouteOverview(): Unit
    Returns
    Unit
    fun setRouteOverview(value: Boolean): Unit
    Parameters

    value

    Returns
    Unit
    Properties

    val isRouteOverviewChannel​

    val isRouteOverview​

    SimpleCheckableItem​

    Простой отмечаемый элемент из CheckableItemsGroup.

    Extends: ru.dgis.sdk.directory.CheckableItem
    Properties

    val text​

    Получение текстового описания элемента.

    val values​

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

    var isChecked​

    Получение состояния элемента.

    SimpleClusterObject​

    Кластер простых (simple) объектов-маркеров.

    Extends: ru.dgis.sdk.map.MapObject
    Methods
    fun setIcon(icon: Image?): Unit

    Установка иконки кластера.

    Parameters

    icon

    Returns
    Unit
    Properties

    val position​

    Получение позиции кластера на карте.

    val objectCount​

    Получение количества маркеров в кластере.

    val objects​

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

    var anchor​

    Получение и установка точки привязки иконки кластера.

    var iconOpacity​

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

    var text​

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

    var textStyle​

    Получение и установка стиля подписи кластера.

    var iconWidth​

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

    var iconMapDirection​

    Получение и установка угла поворота кластера на карте относительно направления на север, по часовой стрелке.

    var animatedAppearance​

    Получение и установка флага анимируемости появления кластера.

    var zIndex​

    Получение и установка уровня отрисовки объекта.

    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),
    	animatedAppearance: Boolean = true,
    	iconAnimationMode: AnimationMode = AnimationMode.NORMAL
    )

    Параметры маркера кластера простых (simple) объектов-маркеров.

    Parameters

    icon

    iconMapDirection

    anchor

    text

    textStyle

    iconOpacity

    iconWidth

    userData

    zIndex

    animatedAppearance

    iconAnimationMode

    Properties

    val icon​

    val iconMapDirection​

    val anchor​

    val text​

    val textStyle​

    val iconOpacity​

    val iconWidth​

    Целевая ширина, используемая для масштабирования.

    val userData​

    val zIndex​

    Уровень отрисовки объекта.

    val animatedAppearance​

    Анимировать ли появление.

    val iconAnimationMode​

    Режим анимации.

    SimpleMapObject​

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

    Extends: ru.dgis.sdk.map.MapObject
    Properties

    var isVisible​

    var zIndex​

    Получение уровня отрисовки объекта.

    var levelId​

    Получение привязки объекта к этажу в здании.

    val bounds​

    Прямоугольник минимального размера, содержащий геометрию.

    SimulationAutoWithOverSpeed​

    Структура для задания режима движения с учетом максимальной скорости на ребре маршрута.

    SimulationAutoWithOverSpeed(overSpeed: Double = 0.0)

    Структура для задания режима движения с учетом максимальной скорости на ребре маршрута.

    Parameters

    overSpeed

    Properties

    val overSpeed​

    Используемое превышение скорости в м/с. Допустимы значения только >= 0.

    SimulationConstantSpeed​

    Структура для задания режима движения с постоянной скоростью.

    SimulationConstantSpeed(speed: Double = 0.0)

    Структура для задания режима движения с постоянной скоростью.

    Parameters

    speed

    Properties

    val speed​

    Скорость движения в м/с. Допустимы значения только >= 0.

    SimulationSettings​

    Настройки симуляции ведения по маршруту.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    var speedMode​

    Режим работы симулятора.

    SimulationSpeedMode​

    SimulationSpeedMode(speed: SimulationConstantSpeed)
    Parameters

    speed

    SimulationSpeedMode(overSpeed: SimulationAutoWithOverSpeed)
    Parameters

    overSpeed

    Methods
    fun match(speed: Function1, overSpeed: Function1): T
    Parameters

    speed

    overSpeed

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

    other

    Returns
    Boolean
    Properties

    val isSpeed​

    val asSpeed​

    val isOverSpeed​

    val asOverSpeed​

    val value​

    SnapToMapLayout​

    Layout, позволяющий привязать View к точке на карте.

    Extends: android.view.ViewGroup
    SnapToMapLayout(
    	context: Context,
    	attrs: AttributeSet? = null,
    	defStyle: Int = 0
    )

    Layout, позволяющий привязать View к точке на карте.

    Parameters

    context

    attrs

    defStyle

    Methods
    fun onAttachedToWindow(): Unit
    Returns
    Unit
    fun onDetachedFromWindow(): Unit
    Returns
    Unit
    fun onLayout(
    	changed: Boolean,
    	left: Int,
    	top: Int,
    	right: Int,
    	bottom: Int
    ): Unit
    Parameters

    changed

    left

    top

    right

    bottom

    Returns
    Unit
    fun checkLayoutParams(p: LayoutParams?): Boolean
    Parameters

    p

    Returns
    Boolean
    fun generateLayoutParams(attrs: AttributeSet?): LayoutParams?
    Parameters

    attrs

    Returns
    LayoutParams?
    fun generateLayoutParams(p: LayoutParams?): LayoutParams?
    Parameters

    p

    Returns
    LayoutParams?

    SortingFilter​

    Фильтр сортировки.

    SortingFilter(tagName: String, displayName: String)

    Фильтр сортировки.

    Parameters

    tagName

    displayName

    Properties

    val tagName​

    Тэг фильтра.

    val displayName​

    Название фильтра для отображения.

    Зависит от языка выдачи. Не все названия могут быть переведены.

    SoundNotificationSettings​

    Настройки звуковых оповещений в навигаторе По умолчанию все значения категорий звуков оповещений включены. Пользователь может менять значения во время работы с навигатором.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    var enabledSoundCategories​

    Набор флагов для звуковых оповещений.

    var notificationVolume​

    var mute​

    Source​

    Источник данных на карте.

    Это может быть источник пробочных данных, маршрутов, маркеров, произвольных геометрических или других объектов карты. У любого объекта карты могут быть свои свойства. Свойства объекта влияют на то, какие к нему применяются правила и параметры отображения, описаные в стилях карты. Стиль - набор параметров и правил отображения объектов карты, получаемый через редактор стилей и использующийся для отрисовки карты.

    Свойства объекта могут быть заданы:

    • непосредственно для объекта;
    • источнику данных (все объекты, добавленные в источник, получают эти свойства);
    • карте (все объекты, добавленные на карту, получают эти свойства);
    • стилю (все объекты, к которым применён стиль, получают эти свойства). Список приведён в порядке понижения приоритета применения свойств. Даже если на карту не добавлен ни один источник данных, свойства стиля и карты всё равно повлияют на карту, т.к. есть специальные отображаемые объекты, например - фон.

    Extends: ru.dgis.sdk.NativeObject

    SpecialSpace​

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

    SpecialSpace(
    	type: SpecialSpaceType,
    	name: String,
    	count: String?
    )

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

    Parameters

    type

    name

    count

    Properties

    val type​

    Тип.

    val name​

    Локализованное название особого места.

    val count​

    Количество мест такого типа на парковке.

    SpeedInfoControl​

    Extends: ru.dgis.sdk.navigation.NavigationControl
    SpeedInfoControl(
    	context: Context,
    	attrs: AttributeSet? = null,
    	defStyle: Int = 0
    )
    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToModel(model: Model): Unit
    Parameters

    model

    Returns
    Unit

    SpeedRange​

    Интервал скоростей. Скорости задаются в метрах в секунду.

    SpeedRange(minSpeed: Double = 0.0, maxSpeed: Double = 0.0)

    Интервал скоростей. Скорости задаются в метрах в секунду.

    Parameters

    minSpeed

    maxSpeed

    Properties

    val minSpeed​

    val maxSpeed​

    SpeedRangeToStyleZoom​

    Соответствие интервала скоростей и стилевого уровня масштабирования.

    SpeedRangeToStyleZoom(
    	range: SpeedRange,
    	minDistanceToManeuver: RouteDistance,
    	maxDistanceToManeuver: RouteDistance,
    	styleZoom: StyleZoom
    )

    Соответствие интервала скоростей и стилевого уровня масштабирования.

    Parameters

    range

    minDistanceToManeuver

    maxDistanceToManeuver

    styleZoom

    Properties

    val range​

    Интервал скоростей.

    val minDistanceToManeuver​

    Минимальное расстояние до манёвра, при котором должна включаться логика плавного увеличения уровня зума.

    val maxDistanceToManeuver​

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

    val styleZoom​

    Стилевой уровень масштабирования.

    StringRouteLongAttribute​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entry(point: RoutePoint): StringRouteLongEntry?

    Элемент, в который попадает заданная точка.

    Parameters

    point

    Returns
    StringRouteLongEntry?
    fun entries(begin: RoutePoint, end: RoutePoint): List<StringRouteLongEntry>

    Элементы, частично или полностью покрываемые отрезком begin,end.

    Parameters

    begin

    end

    Returns
    List<StringRouteLongEntry>
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    StringRouteLongEntry​

    Протяженный элемент маршрута - отрезок и значение на нем.

    StringRouteLongEntry(
    	point: RoutePoint,
    	length: RouteDistance,
    	value: String
    )

    Протяженный элемент маршрута - отрезок и значение на нем.

    Parameters

    point

    length

    value

    Properties

    val point​

    val length​

    val value​

    Style​

    Стиль с набором свойств объектов карты (cм. ISource).

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val styleAttributes​

    Получение свойств по умолчанию для объектов, к которым применён указанный слой.

    StyleBuilder​

    Конструктор стилей.

    Extends: ru.dgis.sdk.NativeObject
    StyleBuilder(context: Context)
    Parameters

    context

    Methods
    fun setStyleAttribute(name: String, value: AttributeValue): StyleBuilder
    Parameters

    name

    value

    Returns
    StyleBuilder
    fun getDefaultStyle(): Future<Style>

    Получение предустановленного стиля.

    Returns
    Future<Style>
    fun loadStyle(file: File): Future<Style>

    Загрузка пользовательского стиля.

    Parameters

    file

    Returns
    Future<Style>

    StyleLayerId​

    Идентификатор слоя стиля.

    StyleLayerId(id: String)

    Идентификатор слоя стиля.

    Parameters

    id

    Properties

    val id​

    StyleZoom​

    Стилевой уровень масштабирования.

    Задаётся в редакторе стилей и отличается от обычного уровня масштабирования тем, что для одного StyleZoom масштаб карты одинаков независимо от широты. Однако, при Zoom < 9 или при latitude > 60 градусов StyleZoom == Zoom и масштаб карты на разных широтах отличается.

    StyleZoom не может быть отрицательным.

    StyleZoom(value: Float = 0.0f)

    Стилевой уровень масштабирования.

    Задаётся в редакторе стилей и отличается от обычного уровня масштабирования тем, что для одного StyleZoom масштаб карты одинаков независимо от широты. Однако, при Zoom < 9 или при latitude > 60 градусов StyleZoom == Zoom и масштаб карты на разных широтах отличается.

    StyleZoom не может быть отрицательным.

    Parameters

    value

    Properties

    val value​

    StyleZoomFollowController​

    Контроллер слежения за стилевым уровнем масштабирования карты.

    Extends: ru.dgis.sdk.map.FollowController
    StyleZoomFollowController(animationDuration: Duration = Duration.ofMilliseconds(300))

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

    Parameters

    animationDuration

    Methods
    fun setStyleZoom(styleZoom: StyleZoom): Unit

    Установка нового значения стилевого уровня масштабирования.

    Parameters

    styleZoom

    Returns
    Unit
    fun setStyleZoomRange(minStyleZoom: StyleZoom, maxStyleZoom: StyleZoom): Unit

    Установка интервала допустимых значений стилевого уровня масштабирования.

    Parameters

    minStyleZoom

    maxStyleZoom

    Returns
    Unit

    Suggest​

    Поисковая подсказка.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val handler​

    Обработчик выбора подсказки.

    val suggestedType​

    Тип подсказки.

    val title​

    Заголовок подсказки.

    val subtitle​

    Подзаголовок подсказки.

    SuggestHandler​

    Обработчик выбора подсказки.

    SuggestHandler(objectHandler: SuggestObjectHandler?)
    Parameters

    objectHandler

    SuggestHandler(performSearchHandler: PerformSearchHandler?)
    Parameters

    performSearchHandler

    SuggestHandler(incompleteTextHandler: IncompleteTextHandler?)
    Parameters

    incompleteTextHandler

    Methods
    fun match(
    	objectHandler: Function1,
    	performSearchHandler: Function1,
    	incompleteTextHandler: Function1
    ): T
    Parameters

    objectHandler

    performSearchHandler

    incompleteTextHandler

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

    other

    Returns
    Boolean
    Properties

    val isObjectHandler​

    val asObjectHandler​

    val isPerformSearchHandler​

    val asPerformSearchHandler​

    val isIncompleteTextHandler​

    val asIncompleteTextHandler​

    val value​

    SuggestObjectHandler​

    Предложен конкретный объект справочника.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val item​

    Подсказанный объект.

    SuggestQuery​

    Запрос поисковой подсказки.

    Extends: ru.dgis.sdk.NativeObject

    SuggestQueryBuilder​

    Построитель запросов к подсказчику.

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun setSpatialRestriction(spatialRestriction: List?<GeoPoint>): SuggestQueryBuilder

    Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.

    по умолчанию ограничение отсутствует

    Parameters

    spatialRestriction

    Returns
    SuggestQueryBuilder
    fun setAreaOfInterest(rect: GeoRect?): SuggestQueryBuilder

    Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.

    Parameters

    rect

    Returns
    SuggestQueryBuilder
    fun setAllowedResultTypes(allowedResultTypes: List<SuggestedType>): SuggestQueryBuilder

    Задать типы объектов, разрешенные в результате запроса.

    по умолчанию все, кроме Route

    Parameters

    allowedResultTypes

    Returns
    SuggestQueryBuilder
    fun setSuggestorType(suggestorType: SuggestorType): SuggestQueryBuilder

    Задать тип подсказчика.

    по умолчанию #SuggestorType::Object

    Parameters

    suggestorType

    Returns
    SuggestQueryBuilder
    fun setLimit(limit: Int): SuggestQueryBuilder

    Задать желаемое количество подсказок. Допустимы значения из диапазона 1;50

    по умолчанию 10

    Parameters

    limit

    Returns
    SuggestQueryBuilder
    fun build(): SuggestQuery

    Сформировать запрос к подсказчику.

    Returns
    SuggestQuery
    @JvmStatic
    fun fromQueryText(queryText: String): SuggestQueryBuilder

    Начать построение запроса подсказки для заданного текста и области интереса.

    Parameters

    queryText

    Returns
    SuggestQueryBuilder
    @JvmStatic
    fun fromQuery(query: SuggestQuery): SuggestQueryBuilder

    Начать построение запроса подсказки на основе запроса #query для изменения части параметров.

    Исходный запрос #query остается без изменений

    Parameters

    query

    Returns
    SuggestQueryBuilder

    SuggestResult​

    Результат работы подсказчика.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val suggests​

    Набор предложенных вариантов подсказок.

    набор пуст, если подходящие подсказки не найдены

    SystemCertificate​

    Системный SSL-сертификат.

    SystemCertificate()

    Системный SSL-сертификат.

    Methods
    fun toString(): String
    Returns
    String
    fun equals(other: Any?): Boolean
    Parameters

    other

    Returns
    Boolean
    fun hashCode(): Int
    Returns
    Int

    SystemMemoryManager​

    Интерфейс управления использованием системной памяти.

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun reduceMemoryUsage(): Unit

    Уменьшение использования памяти путём очистки всевозможных кешей и буферов.

    Returns
    Unit

    TaxiRouteSearchOptions​

    Параметры поиска маршрута на такси.

    TaxiRouteSearchOptions(car: CarRouteSearchOptions)

    Параметры поиска маршрута на такси.

    Parameters

    car

    Properties

    val car​

    Параметры поиска маршрута, общие с прочими автомобильными.

    TerritoriesAlongRouteProvider​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun getTerritories(route: Route): Future<List<Territory>>

    Возвращает минимально необходимый список офлайн-территорий в порядке следования маршрута.

    Parameters

    route

    Returns
    Future<List<Territory>>

    future с массивом территорий.

    Territory​

    Территория. Данные в 2ГИС нарезаны на некоторые неделимые единицы, называемые сегментами. Но для более удобной и гибкой работы с данными для обновления используются не сами сегменты, а их наборы, называемые территориями. Наборы сегментов в двух территориях могут пересекаться, в том числе одна территория может быть целиком вложена в другую.

    Extends: ru.dgis.sdk.update.Package

    TerritoryManager​

    Интерфейс для взаимодействия со списком территорий: Подписки на изменения информации о территориях; Поиска территорий по координатам и геометриям; Подписки на изменения информации о всеобщем прогрессе установки/обновления территорий; Приостановки и возобновления процесса установки/обновления территорий.

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun findByPoint(geoPoint: GeoPoint): List<Territory>

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

    • Координаты точки находятся за пределами проекции;
    • Произошла внутренняя ошибка при обработке списка территорий.

    Parameters

    geoPoint

    Returns
    List<Territory>
    fun findByRect(rect: GeoRect): List<Territory>

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

    Parameters

    rect

    Returns
    List<Territory>
    fun pause(): Unit

    Приостановка всех запущенных операций установки либо обновления территорий.

    Returns
    Unit
    fun resume(): Unit

    Возобновление всех приостановленных операций установки либо обновления территорий.

    Returns
    Unit
    Properties

    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
    )

    Настройки внешнего вида текста.

    Parameters

    fontSize

    color

    strokeWidth

    strokeColor

    textHorizontalAlignment

    textPlacement

    textOffset

    fontName

    Properties

    val fontSize​

    val color​

    val strokeWidth​

    val strokeColor​

    val textHorizontalAlignment​

    val textPlacement​

    val textOffset​

    val fontName​

    Tilt​

    Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.

    Допустимыми считаются значения в интервале от 0 до 70 градусов. В случаях, когда точка позиции камеры расположена ближе к нижнему краю экрана, значение может быть дополнительно уменьшено.

    Tilt(value: Float = 0.0f)

    Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.

    Допустимыми считаются значения в интервале от 0 до 70 градусов. В случаях, когда точка позиции камеры расположена ближе к нижнему краю экрана, значение может быть дополнительно уменьшено.

    Parameters

    value

    Properties

    val value​

    TiltFollowController​

    Контроллер слежения за углом наклона карты.

    Extends: ru.dgis.sdk.map.FollowController
    TiltFollowController(styleZoomToTilt: StyleZoomToTiltRelation)

    Создание контроллера слежения за углом наклона карты.

    Parameters

    styleZoomToTilt

    зависимость угла наклона камеры от стилевого уровня масштабирования.

    TiltSettings​

    TiltSettings(
    	lenOnDegreeMm: Float,
    	horizontalSwerveDeg: Float,
    	verticalSwerveDeg: Float,
    	thresholdMm: Float,
    	maxParallelsDeviationDeg: Float
    )
    Parameters

    lenOnDegreeMm

    horizontalSwerveDeg

    verticalSwerveDeg

    thresholdMm

    maxParallelsDeviationDeg

    Properties

    val lenOnDegreeMm​

    Расстояние, в мм, на которое нужно сдвинуть пальцы по экрану, чтобы изменить угол наклона камеры на 1 градус. Отрицательное значение прведет к инверсии направления. значение 0 недопустимо.

    val horizontalSwerveDeg​

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

    val verticalSwerveDeg​

    Максимально допустимый угол отклонения направления свайпа от вертикальной линии. Измеряется в градусах

    val thresholdMm​

    Порог сдвига взвешенного среднего точек в миллиметрах. Если сдвиг не превысит порог, то событие не отправляется.

    val maxParallelsDeviationDeg​

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

    TimePoint​

    Класс, представляющий момент времени.

    Implements: kotlin.Comparable
    TimePoint(timeFromEpoch: Duration)

    Класс, представляющий момент времени.

    Parameters

    timeFromEpoch

    Methods
    operator fun plus(duration: Duration): TimePoint
    Parameters

    duration

    Returns
    TimePoint
    operator fun minus(duration: Duration): TimePoint
    Parameters

    duration

    Returns
    TimePoint
    operator fun minus(other: TimePoint): Duration
    Parameters

    other

    Returns
    Duration
    fun compareTo(other: TimePoint): Int
    Parameters

    other

    Returns
    Int
    fun toString(): String
    Returns
    String
    @JvmStatic
    fun ofEpochMilliseconds(milliseconds: Long): TimePoint
    Parameters

    milliseconds

    Returns
    TimePoint
    @JvmStatic
    fun ofEpochSeconds(seconds: Long): TimePoint
    Parameters

    seconds

    Returns
    TimePoint
    @JvmStatic
    fun ofEpochMinutes(minutes: Long): TimePoint
    Parameters

    minutes

    Returns
    TimePoint
    @JvmStatic
    fun ofEpochHours(hours: Long): TimePoint
    Parameters

    hours

    Returns
    TimePoint
    @JvmStatic
    fun ofEpochDays(days: Long): TimePoint
    Parameters

    days

    Returns
    TimePoint
    @JvmStatic
    fun now(): TimePoint

    Время, прошедшее с 00:00:00 UTC 1 января 1970 года (Unix-время).

    Returns
    TimePoint
    Properties

    val timeFromEpoch​

    val EPOCH​

    val INFINITY​

    TradeLicense​

    Лицензия организации.

    TradeLicense(
    	type: String,
    	license: String,
    	legalForm: String,
    	endDate: String
    )

    Лицензия организации.

    Parameters

    type

    license

    legalForm

    endDate

    Properties

    val type​

    Тип.

    val license​

    Номер.

    Форма собственности компании.

    val endDate​

    Дата, до которой действует лицензия.

    Traffic​

    Описание пробочных данных.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val durations​

    Длительности движения на участках маршрута. 0 - длительность движения на участке маршрута неизвестна.

    val speedColors​

    Цветовое представление скоростей движения ТС на маршруте (протяженный атрибут).

    TrafficAndParkingControl​

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

    Extends: android.widget.FrameLayout
    TrafficAndParkingControl(
    	context: Context,
    	attrs: AttributeSet? = null,
    	defStyle: Int = 0
    )

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

    Parameters

    context

    attrs

    defStyle

    TrafficCollector​

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

    Этот интерфейс является потокобезопасным.

    Extends: ru.dgis.sdk.NativeObject
    TrafficCollector(context: Context)

    Функция создания сервиса сбора информации о транспортном трафике. Сервис сбора информации о транспортном трафике анализирует состояние трафика на дороге, по которой движется пользователь и отправляет результаты анализа в анонимизированном виде на сервер.

    Parameters

    context

    Контекст - окружение, необходимое для работы SDK.

    Properties

    var trafficCollectingAllowed​

    Функция определения состояния разрешения/запрета отправки информации о дорожном движении на сервер.

    TrafficControl​

    Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

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

    Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToMap(map: Map): Unit
    Parameters

    map

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

    map

    Returns
    Unit

    TrafficControl​

    Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

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

    Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToMap(map: Map): Unit
    Parameters

    map

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

    map

    Returns
    Unit
    fun processClick(): Unit
    Returns
    Unit

    TrafficControlModel​

    Модель контрола пробок.

    Этот интерфейс является потокобезопасным.

    Extends: ru.dgis.sdk.NativeObject
    TrafficControlModel(map: Map)

    Функция создания модели элемента управления пробками.

    Parameters

    map

    карта.

    Methods
    fun onClicked(): Unit

    Действие при нажатии на контрол. Переключает видимость пробок на карте.

    Returns
    Unit
    Properties

    val stateChannel​

    Состояние элемента управления видимостью пробок.

    val state​

    Состояние элемента управления видимостью пробок.

    TrafficControlState​

    Состояние элемента управления видимостью пробок.

    TrafficControlState(status: TrafficControlStatus = TrafficControlStatus.HIDDEN, score: Int?)

    Состояние элемента управления видимостью пробок.

    Parameters

    status

    score

    Properties

    val status​

    Статус, в зависимости от которого меняется внешний вид элемента управления.

    val score​

    Балл пробок. Отображается в виде надписи на контроле. Если отсутствует, отображается иконка-заглушка.

    TrafficLineControl​

    UI-элемент, отображающий уровень пробок вдоль маршрута.

    Extends: ru.dgis.sdk.navigation.NavigationControl
    TrafficLineControl(
    	context: Context,
    	attrs: AttributeSet? = null,
    	defStyle: Int = 0
    )

    UI-элемент, отображающий уровень пробок вдоль маршрута.

    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToModel(model: Model): Unit
    Parameters

    model

    Returns
    Unit
    Properties

    var pointObjectsPosition​

    PointObjectsPosition

    TrafficLinePointObject​

    TrafficLinePointObject(
    	position: Float,
    	type: Type,
    	text: String? = null
    )
    Parameters

    position

    type

    Type

    text

    Properties

    val position​

    val type​

    Type

    val text​

    TrafficLinePointObjectView​

    Extends: android.widget.FrameLayout
    TrafficLinePointObjectView(
    	context: Context,
    	pointObject: TrafficLinePointObject,
    	position: PointObjectsPosition
    )
    Parameters

    context

    pointObject

    position

    PointObjectsPosition
    Methods
    fun removeWithAnimation(): Unit
    Returns
    Unit
    Properties

    var isRemoved​

    val pointObject​

    const ANIMATION_DURATION​

    TrafficRoute​

    Extends: ru.dgis.sdk.NativeObject
    Methods
    @JvmStatic
    fun fromNavigationState(navigationState: PackedNavigationState, context: Context): TrafficRoute

    Создание маршрута из десериализованного состояния навигации с добавлением содержащихся в нём объектов в базу дорожных событий (необходимо для отображения событий на маршруте на карте при невозможности получить события онлайн).

    Parameters

    navigationState

    context

    Returns
    TrafficRoute
    Properties

    val route​

    Маршрут.

    val traffic​

    Пробочные данные.

    TrafficRouter​

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

    Extends: ru.dgis.sdk.NativeObject
    TrafficRouter(context: Context)
    Parameters

    context

    Methods
    fun findRoute(
    	startPoint: RouteSearchPoint,
    	finishPoint: RouteSearchPoint,
    	routeSearchOptions: RouteSearchOptions,
    	intermediatePoints: List<RouteSearchPoint> = listOf()
    ): Future<List<TrafficRoute>>

    Ищет маршрут по заданным параметрам.

    Parameters

    startPoint

    Начальная точка маршрута.

    finishPoint

    Конечная точка маршрута.

    routeSearchOptions

    Параметры поиска маршрута.

    intermediatePoints

    Промежуточные точки для проезда в том же порядке, в котором точки заданы в векторе.

    Returns
    Future<List<TrafficRoute>>

    Future с набором найденных маршрутов, либо исключением NativeException в случае ошибки.

    Пустой набор маршрутов является валидным результатом - это означает, что маршрут, соответствующий указанным критериям поиска, не может быть найден.

    При поиске маршрутов для грузового транспорта возможен возврат маршрутов, проходящих через пропускные зоны, для которых не были предоставлены пропуска, в случае, если не удалось проложить маршрут только через пропускные зоны, для которых пропуска были предоставлены. Для проверки того, достаточен ли список пропусков для проезда по маршруту, следует использовать функцию route_matches_truck_pass_zone_passes.

    fun findBriefRouteInfos(searchPoints: List<BriefRouteInfoSearchPoints>, routeSearchOptions: RouteSearchOptions): Future<List<BriefRouteInfo?>>

    Ищет базовую информацию о маршрутах для соответствующего набора поисковых точек.

    Parameters

    searchPoints

    Набор точек для поиска базовой информации о маршруте.

    routeSearchOptions

    Параметры поиска маршрута.

    Returns
    Future<List<BriefRouteInfo?>>

    Future с базовой информацией о наборе маршрутов, соответствующему набору точек поиска, либо исключением NativeException в случае ошибки.

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

    Properties

    val truckPassZonePasses​

    Возвращает список всех поддерживаемых пропусков, разрешающих движение грузового транспорта в пределах пропускных зон.

    TrafficScore​

    Оценка пробок.

    TrafficScore(state: TrafficScoreState = TrafficScoreState.PENDING, value: Int?)

    Оценка пробок.

    Parameters

    state

    value

    Properties

    val state​

    Актуальность значения.

    val value​

    Значение в баллах. Как правило, значения находятся в диапазоне от 1 до 10. Пустое значение, если информация ещё не получена, либо уже устарела, либо недоступна для заданного местоположения.

    TrafficScoreProvider​

    Подписка на обновления информации о величине пробок.

    Этот интерфейс является потокобезопасным.

    Extends: ru.dgis.sdk.NativeObject
    TrafficScoreProvider(map: Map)

    Функция создания объекта для слежения за баллом пробок в области видимости карты.

    Parameters

    map

    Карта, для которой будет отслеживаться область видимости.

    TrafficScoreProvider(context: Context, point: GeoPoint)

    Функция создания объекта для слежения за баллом пробок для заданного местоположения.

    Parameters

    context

    Контекст - окружение, необходимое для работы SDK.

    point

    Геоточка, для которой необходимо получать балл пробок.

    Properties

    val scoreChannel​

    Текущее состояние пробок и их балл.

    val score​

    Текущее состояние пробок и их балл.

    TrafficSource​

    Интерфейс класса, управляющего отображением пробок на карте.

    Extends: ru.dgis.sdk.map.Source
    TrafficSource(context: Context)
    Parameters

    context

    TrafficSpeedColorRouteLongAttribute​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entry(point: RoutePoint): TrafficSpeedColorRouteLongEntry?

    Элемент, в который попадает заданная точка.

    Parameters

    point

    Returns
    TrafficSpeedColorRouteLongEntry?
    fun entries(begin: RoutePoint, end: RoutePoint): List<TrafficSpeedColorRouteLongEntry>

    Элементы, частично или полностью покрываемые отрезком begin,end.

    Parameters

    begin

    end

    Returns
    List<TrafficSpeedColorRouteLongEntry>
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    TrafficSpeedColorRouteLongEntry​

    Протяженный элемент маршрута - отрезок и значение на нем.

    TrafficSpeedColorRouteLongEntry(
    	point: RoutePoint,
    	length: RouteDistance,
    	value: TrafficSpeedColor
    )

    Протяженный элемент маршрута - отрезок и значение на нем.

    Parameters

    point

    length

    value

    Properties

    val point​

    val length​

    val value​

    TransportTypeRouteLongAttribute​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entry(point: RoutePoint): TransportTypeRouteLongEntry?

    Элемент, в который попадает заданная точка.

    Parameters

    point

    Returns
    TransportTypeRouteLongEntry?
    fun entries(begin: RoutePoint, end: RoutePoint): List<TransportTypeRouteLongEntry>

    Элементы, частично или полностью покрываемые отрезком begin,end.

    Parameters

    begin

    end

    Returns
    List<TransportTypeRouteLongEntry>
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    TransportTypeRouteLongEntry​

    Протяженный элемент маршрута - отрезок и значение на нем.

    TransportTypeRouteLongEntry(
    	point: RoutePoint,
    	length: RouteDistance,
    	value: TransportType
    )

    Протяженный элемент маршрута - отрезок и значение на нем.

    Parameters

    point

    length

    value

    Properties

    val point​

    val length​

    val value​

    TruckPassZoneId​

    Идентификатор пропускной зоны для грузовиков. Значение 0 соответствует отсутствию пропускной зоны.

    TruckPassZoneId(value: Int = 0)

    Идентификатор пропускной зоны для грузовиков. Значение 0 соответствует отсутствию пропускной зоны.

    Parameters

    value

    Properties

    val value​

    TruckPassZoneIdRouteLongAttribute​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entry(point: RoutePoint): TruckPassZoneIdRouteLongEntry?

    Элемент, в который попадает заданная точка.

    Parameters

    point

    Returns
    TruckPassZoneIdRouteLongEntry?
    fun entries(begin: RoutePoint, end: RoutePoint): List<TruckPassZoneIdRouteLongEntry>

    Элементы, частично или полностью покрываемые отрезком begin,end.

    Parameters

    begin

    end

    Returns
    List<TruckPassZoneIdRouteLongEntry>
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    TruckPassZoneIdRouteLongEntry​

    Протяженный элемент маршрута - отрезок и значение на нем.

    TruckPassZoneIdRouteLongEntry(
    	point: RoutePoint,
    	length: RouteDistance,
    	value: TruckPassZoneId
    )

    Протяженный элемент маршрута - отрезок и значение на нем.

    Parameters

    point

    length

    value

    Properties

    val point​

    val length​

    val value​

    TruckPassZonePass​

    Пропуск, разрешающий движение грузового транспорта в пропускных зонах.

    TruckPassZonePass(
    	id: TruckPassZonePassId,
    	name: String,
    	passZoneIds: Set<TruckPassZoneId>
    )

    Пропуск, разрешающий движение грузового транспорта в пропускных зонах.

    Parameters

    id

    name

    passZoneIds

    Properties

    val id​

    Идентификатор пропуска.

    val name​

    Название пропуска.

    val passZoneIds​

    Идентификаторы пропускных зон, по которым разрешает движение данный пропуск

    TruckPassZonePassId​

    Идентификатор пропуска, разрешающего движение грузового транспорта в пропускных зонах.

    TruckPassZonePassId(value: Int = 0)

    Идентификатор пропуска, разрешающего движение грузового транспорта в пропускных зонах.

    Parameters

    value

    Properties

    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
    )

    Параметры поиска маршрута на грузовом транспорте. При поиске маршрута учитываются только заполненные параметры.

    Parameters

    car

    truckLength

    truckHeight

    truckWidth

    actualMass

    maxPermittedMass

    axleLoad

    dangerousCargo

    explosiveCargo

    passIds

    fallbackOnCar

    Properties

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

    Идентификатор объекта с подписью.

    Parameters

    objectId

    label

    Properties

    val objectId​

    val label​

    UIntRouteLongAttribute​

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

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entry(point: RoutePoint): UIntRouteLongEntry?

    Элемент, в который попадает заданная точка.

    Parameters

    point

    Returns
    UIntRouteLongEntry?
    fun entries(begin: RoutePoint, end: RoutePoint): List<UIntRouteLongEntry>

    Элементы, частично или полностью покрываемые отрезком begin,end.

    Parameters

    begin

    end

    Returns
    List<UIntRouteLongEntry>
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    UIntRouteLongEntry​

    Протяженный элемент маршрута - отрезок и значение на нем.

    UIntRouteLongEntry(
    	point: RoutePoint,
    	length: RouteDistance,
    	value: Int
    )

    Протяженный элемент маршрута - отрезок и значение на нем.

    Parameters

    point

    length

    value

    Properties

    val point​

    val length​

    val value​

    VendorConfig​

    Переопределение конфигурации SDK.

    VendorConfig()
    VendorConfig(fromAsset: VendorConfigFromAsset)
    Parameters

    fromAsset

    VendorConfig(fromFile: VendorConfigFromFile)
    Parameters

    fromFile

    VendorConfig(fromString: VendorConfigFromString)
    Parameters

    fromString

    Methods
    fun match(
    	none: Function0<T>,
    	fromAsset: Function1,
    	fromFile: Function1,
    	fromString: Function1
    ): T
    Parameters

    none

    fromAsset

    fromFile

    fromString

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

    other

    Returns
    Boolean
    Properties

    val isNone​

    val isFromAsset​

    val asFromAsset​

    val isFromFile​

    val asFromFile​

    val isFromString​

    val asFromString​

    val value​

    VendorConfigFromAsset​

    Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.

    VendorConfigFromAsset(path: String)

    Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.

    Parameters

    path

    Properties

    val path​

    Путь относительно корневой директории asset-ов.

    VendorConfigFromFile​

    Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.

    VendorConfigFromFile(path: String)

    Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.

    Parameters

    path

    Properties

    val path​

    Путь к файлу.

    VendorConfigFromString​

    Переопределение настроек SDK через указание содержимого файла.

    VendorConfigFromString(contents: String)

    Переопределение настроек SDK через указание содержимого файла.

    Parameters

    contents

    Properties

    val contents​

    Содержимое файла переопределения настроек.

    Voice​

    Голосовой пакет с озвучкой навигатора.

    Extends: ru.dgis.sdk.update.Package
    Methods
    fun playWelcome(): Future<Unit>

    Воспроизвести образец голоса.

    Returns
    Future<Unit>

    future, который становится готовым, когда проигрывание сэмпла завершается.

    Properties

    val navigationVoice​

    Получение голоса для использования в навигаторе.

    val language​

    Язык озвучки в формате ISO 639-1.

    VoiceManager​

    Интерфейс для взаимодействия со списком голосовых пакетов навигатора.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val voicesChannel​

    Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.

    val voices​

    Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.

    VoiceSelector​

    Управляет голосовыми пакетами в текущей сессии навигатора.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    var voice​

    Голосовой пакет, с помощью которого воспроизводятся голосовые оповещения в текущей сессии навигатора.

    VoidRouteAttribute​

    Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

    Extends: ru.dgis.sdk.NativeObject
    Methods
    fun entries(begin: RoutePoint, end: RoutePoint): List<RoutePoint>

    Элементы, попадающие в отрезок [begin, end).

    Parameters

    begin

    end

    Returns
    List<RoutePoint>
    fun findNearBackward(point: RoutePoint): RoutePoint?

    Найти ближайший элемент, позиция которого < = point.

    Сложность операции log2(N), где N = size.

    Parameters

    point

    Returns
    RoutePoint?
    fun findNearForward(point: RoutePoint): RoutePoint?

    Найти ближайший элемент, позиция которого >= point.

    Сложность операции log2(N), где N = size.

    Parameters

    point

    Returns
    RoutePoint?
    Properties

    val size​

    Количество элементов.

    val isEmpty​

    Элементы отсутствуют.

    val first​

    Первый элемент.

    val last​

    Последний элемент.

    val entries​

    Все элементы.

    WeekTime​

    Момент времени внутри недели.

    WeekTime(weekDay: WeekDay, time: DayTime)

    Момент времени внутри недели.

    Parameters

    weekDay

    time

    Properties

    val weekDay​

    День недели.

    val time​

    Время.

    WeekTimeInterval​

    Интервал времени в течение недели.

    WeekTimeInterval(startTime: WeekTime, finishTime: WeekTime)

    Интервал времени в течение недели.

    Parameters

    startTime

    finishTime

    Properties

    val startTime​

    Время начала.

    val finishTime​

    Время окончания.

    Widget​

    Базовый класс, представляющий виджет для фильтрации поисковой выдачи.

    Виджеты возвращаются в результате поиска и предназначены для фильтрации или сортировки результата по определенным параметрам. Виджеты генерируются динамически для каждого результата поиска и могут отсутствовать для некоторых запросов. Виджет представляет один конкретный фильтр или их группу, объединённую общим признаком. Например, тип кухни в результатах поиска по запросу "Поесть".

    Extends: ru.dgis.sdk.NativeObject
    Properties

    val type​

    Получение типа виджета.

    val caption​

    Получение заголовка виджета. Может отсутствовать.

    val filters​

    Получение списка фильтров, описывающих текущее состояние виджета. Может быть использован при формировании поискового запроса.

    WmsRasterUrlTemplate​

    WmsRasterUrlTemplate(urlTemplate: String)
    Parameters

    urlTemplate

    Properties

    val urlTemplate​

    WorkStatus​

    Статус работы.

    WorkStatus(isOpen: Boolean, description: String)

    Статус работы.

    Parameters

    isOpen

    description

    Properties

    val isOpen​

    Открыто ли сейчас.

    val description​

    Текстовое описание. Например, "Открыто до 21:00", "Круглосуточно", "Закроется через 5 минут".

    WorkTimeFilter​

    Фильтр по времени работы объекта. Либо открыт сейчас, либо открыт на конкретные дата и время.

    WorkTimeFilter(workTime: WeekTime)
    Parameters

    workTime

    WorkTimeFilter(isOpenNow: IsOpenNow)
    Parameters

    isOpenNow

    Methods
    fun match(workTime: Function1, isOpenNow: Function1): T
    Parameters

    workTime

    isOpenNow

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

    other

    Returns
    Boolean
    Properties

    val isWorkTime​

    val asWorkTime​

    val isIsOpenNow​

    val asIsOpenNow​

    val value​

    ZIndex​

    Индекс, задающий порядок отрисовки объектов в рамках слоя.

    ZIndex(value: Int = 0)

    Индекс, задающий порядок отрисовки объектов в рамках слоя.

    Parameters

    value

    Properties

    val value​

    Zoom​

    Уровень масштабирования.

    Zoom = 0 это такой масштаб, при котором весь мир вписан в квадрат 256x256 логических пикселей (см. LogicalPixel) Zoom = 1 это такой масштаб, при котором весь мир вписан в квадрат 512x512 логических пикселей Масштаб пропорционален величине 2^Zoom.

    Zoom не может быть отрицательным.

    Zoom(value: Float = 0.0f)

    Уровень масштабирования.

    Zoom = 0 это такой масштаб, при котором весь мир вписан в квадрат 256x256 логических пикселей (см. LogicalPixel) Zoom = 1 это такой масштаб, при котором весь мир вписан в квадрат 512x512 логических пикселей Масштаб пропорционален величине 2^Zoom.

    Zoom не может быть отрицательным.

    Parameters

    value

    Properties

    val value​

    ZoomControl​

    Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

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

    Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToMap(map: Map): Unit
    Parameters

    map

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

    map

    Returns
    Unit

    ZoomControl​

    Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

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

    Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

    Parameters

    context

    attrs

    defStyle

    Methods
    fun attachToMap(map: Map): Unit
    Parameters

    map

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

    map

    Returns
    Unit

    ZoomControlModel​

    Модель контрола зумирования. Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты. При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной. Методы объекта необходимо вызывать на одном потоке.

    Extends: ru.dgis.sdk.NativeObject
    ZoomControlModel(map: Map)
    Parameters

    map

    Methods
    fun isEnabled(button: ZoomControlButton): StatefulChannel<Boolean>
    Parameters

    button

    Returns
    StatefulChannel<Boolean>
    fun setPressed(button: ZoomControlButton, value: Boolean): Unit
    Parameters

    button

    value

    Returns
    Unit

    ZoomFollowSettings​

    Интерфейс, позволяющий управлять настройками масштабирования карты во время ведения.

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

    При отсутствии манёвров впереди и позади, либо на дорогах низкого значения (неглавные улицы населённых пунктов, шоссе, междугородние или федеральные трассы) значение масштаба выбирается на основании значений SpeedRangeToStyleZoom, которые хранятся в последовательности speed_range_to_style_zoom_sequence. Последовательность speed_range_to_style_zoom_sequence должна содержать интервалы скоростей, отсортированные по возрастанию значений min_speed, при этом должны выполняться условия: max_speedi > min_speedi+1

    max_speedi < = min_speedi+2

    max_speedi < max_speedi+1. То есть интервалы скоростей должны соприкасаться или даже пересекаться, но значение скорости не должно попадать более чем в два интервала. При этом минимальное значение скорости не считается попадающим в интервал, т.е. одно и то же значение скорости может находиться быть максимальной скоростью для одного интервала, минимальной скоростью для другого и находиться внутри интервала для третьего интервала. Исключение - первый интервал скоростей, который должен содержать значение min_speed == 0.

    Масштаб карты выбирается из последовательности speed_range_to_style_zoom_sequence по алгоритму:

  • На старте ведения выбирается элемент последовательности с index == 0.
  • Во время движение происходит проверка на то, не вышло ли текущее значение скорости за пределы интервала скоростей, указанных в элементе последовательности с индексом index. Если скорость вышла за пределы интервала, то происходит поиск соседнего интервала, в который попадает значение скорости, и запоминается его индекс.
  • Происходит проверка, не проезжаем ли мы маневр. Считается, что мы проезжаем маневр, если есть маневр по ходу движения и дистанция до маневра не превышает указанной в SpeedRangeToStyleZoom, или мы проехали маневр, но не отдалились от него на дистанцию больше указанной в SpeedRangeToStyleZoom. Если мы проезжаем маневр, то выбирается масштаб, соответствующий элементу последовательности с index == 0, иначе выбирается масштаб, соответствующий элементу index.

    • При приближении к маневру на текущей скорости масштаб будет плавно увеличиваться. Время увеличения зависит от скорости и расстояния до манёвра. При увеличении скорости время анимации увеличивается, при снижении скорости - уменьшается. Увеличение уровня зума завершается на некотором расстоянии до манёвра.

    После проезда манёвра уровень зума плавно уменьшается.

    Extends: ru.dgis.sdk.NativeObject
    Properties

    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, значения меньше будут игнорироваться.