class

ActiveLevelMode

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

ActiveLevelMode(index: Long)

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

Parameters

index

Long

Properties

val index

Long

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

ActivityTracker

Extends: ru.dgis.sdk.NativeObject

ActivityTracker(
	platformContext: Context,
	model: Model,
	speedBound: Double = 4.2,
	timeThreshold: Duration = Duration.ofMilliseconds(20000)
)

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

Parameters

platformContext

Context

Контекст.

model

Model

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

speedBound

Double

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

timeThreshold

Duration

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

Properties

val stopChannel

StatefulChannel<Boolean>

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

val stop

Boolean

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

AddEventResult

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

AddEventResult(event: RoadEvent)

Parameters

event

RoadEvent

AddEventResult(error: AddEventError)

Parameters

error

AddEventError

Methods

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

Parameters

event

(RoadEvent) -> T

error

(AddEventError) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isEvent

Boolean

val asEvent

RoadEvent?

val isError

Boolean

val asError

AddEventError?

val value

Any?

Address

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

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

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

Parameters

drillDown

List<AddressAdmDiv>

components

List<AddressComponent>

buildingName

String?

buildingId

BuildingId?

postCode

String?

buildingCode

String?

fiasCode

String?

addressComment

String?

Properties

val drillDown

List<AddressAdmDiv>

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

val components

List<AddressComponent>

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

val buildingName

String?

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

val buildingId

BuildingId?

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

val postCode

String?

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

val buildingCode

String?

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

val fiasCode

String?

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

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

val addressComment

String?

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

AddressAdmDiv

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

AddressAdmDiv(type: String, name: String)

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

Parameters

type

String

name

String

Properties

val type

String

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

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

val name

String

AddressComponent

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

AddressComponent(streetAddress: AddressStreet)

Parameters

streetAddress

AddressStreet

AddressComponent(number: AddressNumber)

Parameters

number

AddressNumber

AddressComponent(location: AddressLocation)

Parameters

location

AddressLocation

Methods

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

Parameters

streetAddress

(AddressStreet) -> T

number

(AddressNumber) -> T

location

(AddressLocation) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isStreetAddress

Boolean

val asStreetAddress

AddressStreet?

val isNumber

Boolean

val asNumber

AddressNumber?

val isLocation

Boolean

val asLocation

AddressLocation?

val value

Any?

AddressLocation

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

AddressLocation(comment: String)

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

Parameters

comment

String

Properties

val comment

String

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

AddressNumber

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

AddressNumber(number: String, fiasCode: String?)

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

Parameters

number

String

fiasCode

String?

Properties

val number

String

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

val fiasCode

String?

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

AddressStreet

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

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

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

Parameters

street

String

number

String

fiasCode

String?

Properties

val street

String

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

val number

String

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

val fiasCode

String?

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

AddRoadEventButton

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

Extends: ru.dgis.sdk.road_events.AddRoadEventControl

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: AddRoadEventCardModel): Unit

Parameters

model

AddRoadEventCardModel

Returns

Unit

AddRoadEventCard

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

Extends: ru.dgis.sdk.road_events.AddRoadEventControl

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: AddRoadEventCardModel): Unit

Parameters

model

AddRoadEventCardModel

Returns

Unit

Properties

const MAX_DESCRIPTION_LENGTH

Int

AddRoadEventCardModel

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

AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)

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

Parameters

roadEventManager

RoadEventManager

map

Map

Methods

fun onEventTypeClicked(type: RoadEventType): Unit

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

Parameters

type

RoadEventType

Returns

Unit

fun onLaneClicked(lane: Lane): Unit

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

Parameters

lane

Lane

Returns

Unit

fun onDescriptionEntered(description: String): Unit

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

Parameters

description

String

Returns

Unit

fun onSendClicked(): Unit

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

Returns

Unit

fun close(): Unit

Returns

Unit

Properties

val eventTypeChannel

StatefulChannel<RoadEventType>

Выбранный тип события.

val lanesChannel

StatefulChannel<EnumSet<Lane>>

Выбранные полосы.

val canSelectLanesChannel

StatefulChannel<Boolean>

Есть ли возможность задать полосы.

val descriptionChannel

StatefulChannel<String>

Введенное описание.

val markerPositionChannel

StatefulChannel<ScreenPoint>

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

val canSendChannel

StatefulChannel<Boolean>

Есть ли возможность отправить событие.

val resultChannel

Channel<AddEventResult>

Результат отправки события.

AddRoadEventControl

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

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: AddRoadEventCardModel): Unit

Parameters

model

AddRoadEventCardModel

Returns

Unit

@CallSuper
fun detachFromModel(): Unit

Returns

Unit

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

Properties

var model

AddRoadEventCardModel?

val closeables

MutableList<AutoCloseable>

AddRoadEventControls

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

Extends: ru.dgis.sdk.map.MapControl

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun show(): Unit

Returns

Unit

fun hide(): Unit

Returns

Unit

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

Properties

val cardHeightChannel

StatefulChannel<Int>

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

AddRoadEventMarker

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

Extends: ru.dgis.sdk.road_events.AddRoadEventControl

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: AddRoadEventCardModel): Unit

Parameters

model

AddRoadEventCardModel

Returns

Unit

fun detachFromModel(): Unit

Returns

Unit

Aggregate

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

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

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

Parameters

connectorsFree

Short

connectorsTotal

Short

isActive

Boolean

isBusy

Boolean

power

Short

Properties

val connectorsFree

Short

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

val connectorsTotal

Short

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

val isActive

Boolean

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

val isBusy

Boolean

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

val power

Short

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

AlternativeRouteSelector

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun selectAlternativeRoute(trafficRoute: TrafficRoute): Unit

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

Parameters

trafficRoute

TrafficRoute

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

Returns

Unit

AlternativeRoutesProviderSettings

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

Extends: ru.dgis.sdk.NativeObject

Properties

var alternativeRoutesEnabled

Boolean

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

var betterRouteEnabled

Boolean

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

var routeSearchDelay

Duration

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

var onAlternativeRoutesSuggestedRouteSearchDelay

Duration

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

var betterRouteTimeCostThreshold

Duration

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

var betterRouteLengthThreshold

RouteDistance

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

var routerType

RouterType

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

Anchor

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

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

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

Parameters

x

Float

y

Float

Properties

val x

Float

val y

Float

AndroidAutoMapSession

Car App session that renders a map on the surface provided by the AppManager.

Supports both shift and scale gestures.

The map's visibility is tied to the session's Lifecycle:

• Map becomes visible during the onStart event.
• Map becomes hidden during the onStop event.

Action.PAN must be included in the Template. Otherwise, the surface won't be available.

Next permissions are already declared in the SDK:

• androidx.car.app.ACCESS_SURFACE
• androidx.car.app.NAVIGATION_TEMPLATES

Important: ensure that SDK context has been initialized before creating instance of this class.

AndroidAutoMapSession(options: MapControllerOptions)

Car App session that renders a map on the surface provided by the AppManager.

Supports both shift and scale gestures.

The map's visibility is tied to the session's Lifecycle:

• Map becomes visible during the onStart event.
• Map becomes hidden during the onStop event.

Action.PAN must be included in the Template. Otherwise, the surface won't be available.

Next permissions are already declared in the SDK:

• androidx.car.app.ACCESS_SURFACE
• androidx.car.app.NAVIGATION_TEMPLATES

Important: ensure that SDK context has been initialized before creating instance of this class.

Parameters

options

MapControllerOptions

The configuration of the map controller.

Methods

fun onSurfaceAvailable(
	surface: Surface,
	width: Int,
	height: Int
): Unit

Provides a surface for rendering additional content on top of the map. This surface can be created and provided before the onMapReady callback is triggered.

Parameters

surface

Surface

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

width

Int

The width of the surface.

height

Int

The height of the surface.

Returns

Unit

fun onSurfaceDestroyed(surface: Surface): Unit

Indicates that the surface has been destroyed.

Parameters

surface

Surface

Returns

Unit

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

Forwards the SurfaceCallback.onClick event.

Parameters

x

Float

y

Float

Returns

Unit

fun onSurfaceStableAreaChanged(stableArea: Rect): Unit

Forwards the SurfaceCallback.onStableAreaChanged event.

Parameters

stableArea

Rect

Returns

Unit

fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit

Forwards the SurfaceCallback.onVisibleAreaChanged event.

Parameters

visibleArea

Rect

Returns

Unit

fun onMapReady(map: Map): Unit

Provides a map when it is successfully initialized.

Parameters

map

Map

Returns

Unit

fun onMapReadyException(exception: Exception): Unit

Provides an exception in case of an error during initialization.

Parameters

exception

Exception

Returns

Unit

fun setAppearance(appearance: MapAppearance): Unit

Applies the appearance to the map.

This takes effect only after the map has been initialized (i.e., after onMapReady has been called). To set a theme before the map is initialized, use MapControllerOptions.attributes.

Parameters

appearance

MapAppearance

Appearance 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

CopyrightPosition

The position of the copyright icon.

Returns

Unit

AnimationSettings

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

Extends: ru.dgis.sdk.NativeObject

Properties

var animationIndex

Int?

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

var animationName

String?

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

var sceneIndex

Int?

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

var sceneName

String?

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

var animationRepeatCount

Int?

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

var animationSpeed

Float?

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

ApartmentRange

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

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

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

Parameters

start

String

end

String?

Properties

val start

String

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

val end

String?

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

Attribute

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

Attribute(tag: String, value: String)

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

Parameters

tag

String

value

String

Properties

val tag

String

Тег.

val value

String

Значение.

Attributes

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

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun setAttributeValue(name: String, value: AttributeValue): Unit

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

Parameters

name

String

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

value

AttributeValue

Значение.

Returns

Unit

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

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

Parameters

values

Map

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

attributesToRemove

List<String>

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

Returns

Unit

fun removeAttribute(name: String): Unit

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

Parameters

name

String

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

Returns

Unit

fun getAttributeValue(name: String): AttributeValue

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

Parameters

name

String

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

Returns

AttributeValue

Properties

val attributeNames

List<String>

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

val changed

Channel<List<String>>

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

AttributeValue

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

AttributeValue()

AttributeValue(boolean: Boolean)

Parameters

boolean

Boolean

AttributeValue(number: Double)

Parameters

number

Double

AttributeValue(integer: Long)

Parameters

integer

Long

AttributeValue(string: String)

Parameters

string

String

AttributeValue(data: ByteArray)

Parameters

data

ByteArray

AttributeValue(array: List<AttributeValue>)

Parameters

array

List<AttributeValue>

AttributeValue(item: Map)

Parameters

item

Map

Methods

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

Parameters

empty

() -> T

boolean

(Boolean) -> T

number

(Double) -> T

integer

(Long) -> T

string

(String) -> T

data

(ByteArray) -> T

array

(List) -> T

item

(Map) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isEmpty

Boolean

val isBoolean

Boolean

val asBoolean

Boolean?

val isNumber

Boolean

val asNumber

Double?

val isInteger

Boolean

val asInteger

Long?

val isString

Boolean

val asString

String?

val isData

Boolean

val asData

ByteArray?

val isArray

Boolean

val asArray

List?<AttributeValue>

val isObject

Boolean

val asObject

Map?

val value

Any?

AudioSettings

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

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

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun get(context: Context): AudioSettings?

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

Parameters

context

Context

Returns

AudioSettings?

Properties

var volume

Int

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

var mute

Boolean

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

var audioFocusPolicy

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

AuthorType

name

String

Properties

val type

AuthorType

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

val name

String

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

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

AvailableCallback

Extends: ru.dgis.sdk.NativeObject

Methods

fun setAvailable(available: Boolean): Unit

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

Parameters

available

Boolean

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

Returns

Unit

BaseCamera

Камера.

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun clone(): BaseCamera

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

Returns

BaseCamera

fun changePosition(positionChange: CameraPositionChange): Unit

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

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

Parameters

positionChange

CameraPositionChange

Returns

Unit

Properties

val projection

Projection

Проекция.

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

var position

CameraPosition

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

var zoomRestrictions

CameraZoomRestrictions

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

val deviceDensity

DeviceDensity

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

var size

ScreenSize

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

var padding

Padding

Получение текущих отступов от краёв экрана.

var positionPoint

CameraPositionPoint

Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).

var viewPoint

CameraViewPoint?

Точка взгляда относительно полного размера вьюпорта.

val visibleArea

Geometry

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

val visibleRect

GeoRect

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

var maxTiltRestriction

StyleZoomToTiltRelation?

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

var viewportRestriction

GeoRect?

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

val changed

Channel<CameraChange>

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

Измененные свойства доступны в соответствующих каналах.

Bearing

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

Bearing(value: Double = 0.0)

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

Parameters

value

Double

Properties

val value

Double

BearingFollowController

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

Extends: ru.dgis.sdk.map.FollowController

BearingFollowController(
	bearingSource: BearingSource,
	animationDuration: Duration = Duration.ofMilliseconds(1000),
	valueThreshold: Bearing = Bearing(value = 1.0)
)

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

Parameters

bearingSource

BearingSource

источник информации о направлении.

animationDuration

Duration

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

valueThreshold

Bearing

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

BetterRouteInfo

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

BetterRouteInfo(trafficRoute: TrafficRoute, startPoint: RoutePoint)

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

Parameters

trafficRoute

TrafficRoute

startPoint

RoutePoint

Properties

val trafficRoute

TrafficRoute

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

val startPoint

RoutePoint

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

BetterRoutePromptControl

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

Extends: ru.dgis.sdk.navigation.NavigationControl

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

Properties

val visibilityChannel

StatefulChannel<Boolean>

BicycleBriefRouteInfo

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

BicycleBriefRouteInfo(length: RouteDistance, landmark: String)

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

Parameters

length

RouteDistance

landmark

String

Properties

val length

RouteDistance

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

val landmark

String

Ориентир.

BicycleInstructionCrossroad

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

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

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

Parameters

landmark

BicycleInstructionCrossroadLandmark

maneuvers

List<BicycleInstructionCrossroadManeuver>

Properties

val landmark

BicycleInstructionCrossroadLandmark

Ориентир.

val maneuvers

List<BicycleInstructionCrossroadManeuver>

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

BicycleInstructionCrossroadManeuver

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

Parameters

direction

BicycleInstructionCrossroadManeuverDirection

turnAngle

Int

Properties

val direction

BicycleInstructionCrossroadManeuverDirection

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

val turnAngle

Int

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

BicycleInstructionFinish

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

BicycleInstructionFinish()

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

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

BicycleInstructionStart

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

BicycleInstructionStart()

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

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

BicycleRouteSearchOptions

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

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

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

Parameters

avoidCarRoads

Boolean

avoidStairways

Boolean

avoidUnderpassesAndOverpasses

Boolean

avoidUnpavedRoads

Boolean

avoidLockedRoads

Boolean

excludedAreas

List<ExcludedArea>

Properties

val avoidCarRoads

Boolean

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

val avoidStairways

Boolean

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

val avoidUnderpassesAndOverpasses

Boolean

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

val avoidUnpavedRoads

Boolean

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

val avoidLockedRoads

Boolean

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

val excludedAreas

List<ExcludedArea>

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

BicycleRouteSummary

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

BicycleRouteSummary(
	routeType: BicycleSummaryRouteType = BicycleSummaryRouteType.UNKNOWN,
	stairways: Int = 0,
	gates: Int = 0,
	barriers: Int = 0,
	calories: Int = 0,
	carRoadsLength: Int = 0,
	groundRoadsLength: Int = 0,
	gravelRoadsLength: Int = 0,
	bicycleRoadsLength: Int = 0,
	bicycleLanesLength: Int = 0,
	badRoadsLength: Int = 0,
	roadBlocks: Int = 0
)

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

Parameters

routeType

BicycleSummaryRouteType

stairways

Int

gates

Int

barriers

Int

calories

Int

carRoadsLength

Int

groundRoadsLength

Int

gravelRoadsLength

Int

bicycleRoadsLength

Int

bicycleLanesLength

Int

badRoadsLength

Int

roadBlocks

Int

Properties

val routeType

BicycleSummaryRouteType

Тип велосипедного маршрута.

val stairways

Int

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

val gates

Int

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

val barriers

Int

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

val calories

Int

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

val carRoadsLength

Int

Суммарная протяжённость автомобильной дороги на маршруте в метрах.

val groundRoadsLength

Int

Суммарная протяжённость грунтовых дорог на маршруте в метрах.

val gravelRoadsLength

Int

Суммарная протяжённость гравийных дорог на маршруте в метрах.

val bicycleRoadsLength

Int

Суммарная протяжённость велодорожек на маршруте в метрах.

val bicycleLanesLength

Int

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

val badRoadsLength

Int

Суммарная протяжённость участков плохой дороги на маршруте в метрах.

val roadBlocks

Int

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

BoolRouteLongAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): BoolRouteLongEntry?

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

Parameters

point

RoutePoint

Returns

BoolRouteLongEntry?

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

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<BoolRouteLongEntry>

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

BoolRouteLongEntry?

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

val last

BoolRouteLongEntry?

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

val entries

List<BoolRouteLongEntry>

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

BoolRouteLongEntry

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

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

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

Parameters

point

RoutePoint

length

RouteDistance

value

Boolean

Properties

val point

RoutePoint

val length

RouteDistance

val value

Boolean

Borders

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

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

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

Parameters

snapping

Double?

isLg

Boolean

value

String

min

Double

max

Double

currentMin

Double?

currentMax

Double?

Properties

val snapping

Double?

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

val isLg

Boolean

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

val value

String

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

val min

Double

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

val max

Double

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

val currentMin

Double?

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

val currentMax

Double?

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

BranchesInfo

Информация о связанных организациях.

BranchesInfo(count: Short = 0)

Информация о связанных организациях.

Parameters

count

Short

Properties

val count

Short

Количество связанных объектов.

BriefExtraRouteInfo

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

BriefExtraRouteInfo(bicycle: BicycleBriefRouteInfo)

Parameters

bicycle

BicycleBriefRouteInfo

BriefExtraRouteInfo(car: CarBriefRouteInfo)

Parameters

car

CarBriefRouteInfo

BriefExtraRouteInfo(motorcycle: MotorcycleBriefRouteInfo)

Parameters

motorcycle

MotorcycleBriefRouteInfo

BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)

Parameters

pedestrian

PedestrianBriefRouteInfo

BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)

Parameters

publicTransport

PublicBriefRouteInfo

BriefExtraRouteInfo(scooter: ScooterBriefRouteInfo)

Parameters

scooter

ScooterBriefRouteInfo

Methods

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

Parameters

bicycle

(BicycleBriefRouteInfo) -> T

car

(CarBriefRouteInfo) -> T

motorcycle

(MotorcycleBriefRouteInfo) -> T

pedestrian

(PedestrianBriefRouteInfo) -> T

publicTransport

(PublicBriefRouteInfo) -> T

scooter

(ScooterBriefRouteInfo) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isBicycle

Boolean

val asBicycle

BicycleBriefRouteInfo?

val isCar

Boolean

val asCar

CarBriefRouteInfo?

val isMotorcycle

Boolean

val asMotorcycle

MotorcycleBriefRouteInfo?

val isPedestrian

Boolean

val asPedestrian

PedestrianBriefRouteInfo?

val isPublicTransport

Boolean

val asPublicTransport

PublicBriefRouteInfo?

val isScooter

Boolean

val asScooter

ScooterBriefRouteInfo?

val value

Any?

BriefPublicTransportCard

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

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

Properties

var model

BriefPublicTransportCardModel?

BriefPublicTransportCardModel

Модель для BriefPublicTransportCard.

BriefPublicTransportCardModel(route: TrafficRoute, context: Context)

Модель для BriefPublicTransportCard.

Parameters

route

TrafficRoute

context

Context

Properties

val title

String

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

val transports

List<Transport>

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

val description

List<String>

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

BriefRoadEvent

Дорожное событие.

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

Дорожное событие.

Parameters

id

Long

eventType

RoadEventType

lanes

EnumSet<Lane>

trustworthy

Boolean

Properties

val id

Long

Идентификатор дорожного события.

val eventType

RoadEventType

Тип дорожного события.

val lanes

EnumSet<Lane>

Полосы дорожного события.

val trustworthy

Boolean

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

BriefRouteInfo

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

BriefRouteInfo(duration: Duration, extraInfo: BriefExtraRouteInfo)

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

Parameters

duration

Duration

extraInfo

BriefExtraRouteInfo

Properties

val duration

Duration

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

val extraInfo

BriefExtraRouteInfo

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

BriefRouteInfoSearchPoints

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

BriefRouteInfoSearchPoints(startPoint: RouteSearchPoint, finishPoint: RouteSearchPoint)

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

Parameters

startPoint

RouteSearchPoint

finishPoint

RouteSearchPoint

Properties

val startPoint

RouteSearchPoint

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

val finishPoint

RouteSearchPoint

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

BuildingId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

BuildingId(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

BuildingInfo

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

BuildingInfo(
	buildingName: String?,
	purposeName: String?,
	purposeCode: PurposeCode?,
	buildingLevels: BuildingLevels?,
	floorsInfo: FloorsInfo?,
	buildingId: BuildingId
)

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

Parameters

buildingName

String?

purposeName

String?

purposeCode

PurposeCode?

buildingLevels

BuildingLevels?

floorsInfo

FloorsInfo?

buildingId

BuildingId

Properties

val buildingName

String?

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

val purposeName

String?

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

val purposeCode

PurposeCode?

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

val buildingLevels

BuildingLevels?

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

val floorsInfo

FloorsInfo?

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

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

val buildingId

BuildingId

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

BuildingLevels

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

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

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

Parameters

defaultLevelId

LevelId

levels

List<LevelInfo>

Properties

val defaultLevelId

LevelId

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

val levels

List<LevelInfo>

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

BySystem

BySystem(light: MapTheme, dark: MapTheme)

Parameters

light

MapTheme

dark

MapTheme

Properties

val light

MapTheme

val dark

MapTheme

CalloutMapPosition

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

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

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

Parameters

mapId

MapId

calloutPosition

GeoPoint?

routePoint

RoutePoint?

Properties

val mapId

MapId

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

val calloutPosition

GeoPoint?

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

val routePoint

RoutePoint?

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

Camera

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

Extends: ru.dgis.sdk.map.BaseCamera

Methods

fun move(moveController: CameraMoveController): Future<CameraAnimatedMoveResult>

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

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

Parameters

moveController

CameraMoveController

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

Returns

Future<CameraAnimatedMoveResult>

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

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

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

Parameters

position

CameraPosition

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

time

Duration

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

animationType

CameraAnimationType

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

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

GeoPoint

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

zoom

Zoom

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

tilt

Tilt?

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

bearing

Bearing

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

time

Duration

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

animationType

CameraAnimationType

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

Returns

Future<CameraAnimatedMoveResult>

fun processMovementAndStop(): Unit

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

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

Returns

Unit

fun setBehaviour(behaviour: CameraBehaviour): Unit

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

Parameters

behaviour

CameraBehaviour

Returns

Unit

fun addFollowController(followController: FollowController): Unit

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

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

Parameters

followController

FollowController

Returns

Unit

fun removeFollowController(followController: FollowController): Unit

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

Parameters

followController

FollowController

Returns

Unit

fun setCustomFollowController(followController: CustomFollowController): Unit

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

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

Parameters

followController

CustomFollowController

Returns

Unit

fun removeCustomFollowController(): Unit

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

Returns

Unit

fun statefulChanges(byReason: CameraChangeReason, valueGetter: Function0<T>): Channel<T>

Фильтрует изменения камеры по byReason причине, фактические значения получает с помощью valueGetter. При подписке получает начальное значение с помощью valueGetter.

Parameters

byReason

CameraChangeReason

valueGetter

() -> T

Returns

Channel<T>

Properties

val state

CameraState

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

val behaviour

CameraBehaviourChange

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

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

FollowPosition?

tilt

FollowTilt

Properties

val position

FollowPosition?

val tilt

FollowTilt

CameraBehaviourChange

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

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

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

Parameters

newBehaviour

CameraBehaviour

changeReason

CameraBehaviourChangeReason

Properties

val newBehaviour

CameraBehaviour

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

val changeReason

CameraBehaviourChangeReason

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

CameraChange

Изменение состояние камеры.

CameraChange(changeReasons: EnumSet<CameraChangeReason>)

Изменение состояние камеры.

Parameters

changeReasons

EnumSet<CameraChangeReason>

Properties

val changeReasons

EnumSet<CameraChangeReason>

Причины (набор флагов) изменения состояния камеры.

CameraNotifier

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

Extends: ru.dgis.sdk.NativeObject

CameraNotifier(model: Model)

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

Parameters

model

Model

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

Properties

val cameraProgressChannel

StatefulChannel<CameraProgressInfo?>

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

val cameraProgress

CameraProgressInfo?

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

CameraPosition

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

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

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

Parameters

point

GeoPoint

zoom

Zoom

tilt

Tilt

bearing

Bearing

Properties

val point

GeoPoint

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

val zoom

Zoom

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

val tilt

Tilt

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

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

val bearing

Bearing

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

CameraPositionChange

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

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

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

Parameters

point

GeoPoint?

zoom

Zoom?

tilt

Tilt?

bearing

Bearing?

Properties

val point

GeoPoint?

val zoom

Zoom?

val tilt

Tilt?

val bearing

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

Float

y

Float

Properties

val x

Float

val y

Float

CameraProgressInfo

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

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

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

Parameters

camera

RouteCamera

position

RoutePoint

progress

Float

Properties

val camera

RouteCamera

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

val position

RoutePoint

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

val progress

Float

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

CameraRouteAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<CameraRouteEntry>

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<CameraRouteEntry>

fun findNearBackward(point: RoutePoint): CameraRouteEntry?

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

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

Parameters

point

RoutePoint

Returns

CameraRouteEntry?

fun findNearForward(point: RoutePoint): CameraRouteEntry?

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

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

Parameters

point

RoutePoint

Returns

CameraRouteEntry?

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

CameraRouteEntry?

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

val last

CameraRouteEntry?

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

val entries

List<CameraRouteEntry>

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

CameraRouteEntry

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

CameraRouteEntry(point: RoutePoint, value: RouteCamera)

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

Parameters

point

RoutePoint

value

RouteCamera

Properties

val point

RoutePoint

val value

RouteCamera

CameraTransactionGuard

Extends: ru.dgis.sdk.NativeObject

CameraViewPoint

Относительная экранная позиция точки, в которую направлен взгляд камеры.

Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол вьюпорта, 1,1 - правый нижний

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

Относительная экранная позиция точки, в которую направлен взгляд камеры.

Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол вьюпорта, 1,1 - правый нижний

Parameters

x

Float

y

Float

Properties

val x

Float

val y

Float

CameraZoomRestrictions

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

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

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

Parameters

minZoom

Zoom

maxZoom

Zoom

Properties

val minZoom

Zoom

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

val maxZoom

Zoom

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

CancelEvent

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

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

Extends: ru.dgis.sdk.map.Event

CancelEvent()

CarBriefRouteInfo

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

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

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

Parameters

length

RouteDistance

landmark

String

trafficSpeed

CarBriefRouteInfoTrafficSpeed

Properties

val length

RouteDistance

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

val landmark

String

Ориентир.

val trafficSpeed

CarBriefRouteInfoTrafficSpeed

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

CarInstructionCrossroad

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

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

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

Parameters

direction

CarInstructionCrossroadDirection

turnAngle

Int

landmark

CarInstructionCrossroadLandmark

exitName

String

Properties

val direction

CarInstructionCrossroadDirection

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

val turnAngle

Int

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

val landmark

CarInstructionCrossroadLandmark

Ориентир.

val exitName

String

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

CarInstructionFinish

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

CarInstructionFinish()

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

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

CarInstructionRoundabout

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

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

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

Parameters

type

CarInstructionRoundaboutType

turnAngle

Int

exitNumber

Int

exitName

String

Properties

val type

CarInstructionRoundaboutType

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

val turnAngle

Int

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

val exitNumber

Int

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

val exitName

String

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

CarInstructionStart

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

CarInstructionStart()

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

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

CarInstructionUTurn

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

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

CarInstructionUTurn(exitName: String)

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

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

Parameters

exitName

String

Properties

val exitName

String

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

CarRouteSearchOptions

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

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

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

Parameters

avoidTollRoads

Boolean

avoidUnpavedRoads

Boolean

avoidFerries

Boolean

avoidLockedRoads

Boolean

routeSearchType

RouteSearchType

excludedAreas

List<ExcludedArea>

Properties

val avoidTollRoads

Boolean

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

val avoidUnpavedRoads

Boolean

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

val avoidFerries

Boolean

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

val avoidLockedRoads

Boolean

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

val routeSearchType

RouteSearchType

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

val excludedAreas

List<ExcludedArea>

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

CarRouteSummary

Саммари информация для автомобильного маршрута.

CarRouteSummary(
	roadBlocks: Int = 0,
	accidents: Int = 0,
	roadWorks: Int = 0,
	tollRoads: Int = 0,
	ferryCrossings: Int = 0,
	iceCrossings: Int = 0,
	trafficLights: Int = 0,
	carRoadsLength: Int = 0,
	groundRoadsLength: Int = 0,
	gravelRoadsLength: Int = 0,
	badRoadsLength: Int = 0
)

Саммари информация для автомобильного маршрута.

Parameters

roadBlocks

Int

accidents

Int

roadWorks

Int

tollRoads

Int

ferryCrossings

Int

iceCrossings

Int

trafficLights

Int

carRoadsLength

Int

groundRoadsLength

Int

gravelRoadsLength

Int

badRoadsLength

Int

Properties

val roadBlocks

Int

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

val accidents

Int

Суммарное количество аварий на маршруте.

val roadWorks

Int

Суммарное количество дорожных работ на маршруте.

val tollRoads

Int

Суммарное количество платных дорог на маршруте.

val ferryCrossings

Int

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

val iceCrossings

Int

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

val trafficLights

Int

Суммарное количество светофоров на маршруте.

val carRoadsLength

Int

Суммарная протяжённость автомобильной дороги на маршруте в метрах.

val groundRoadsLength

Int

Суммарная протяжённость грунтовых дорог на маршруте в метрах.

val gravelRoadsLength

Int

Суммарная протяжённость гравийных дорог на маршруте в метрах.

val badRoadsLength

Int

Суммарная протяжённость участков плохой дороги на маршруте в метрах.

CategoriesPage

Страница результатов запроса категорий.

Extends: ru.dgis.sdk.NativeObject

Methods

fun fetchPrevPage(): Future<CategoriesPage?>

Получить предыдущую страницу результатов.

Returns

Future<CategoriesPage?>

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

fun fetchNextPage(): Future<CategoriesPage?>

Получить следующую страницу результатов.

Returns

Future<CategoriesPage?>

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

Properties

val items

List<Category>

Категории этой страницы.

Category

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

Extends: ru.dgis.sdk.NativeObject

Properties

val id

RubricId

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

val type

CategoryType

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

val name

String

Название категории.

val alias

String

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

при отсутствии может быть пустой строкой.

val title

String

Заголовок для отображения в UI.

при отсутствии может быть пустой строкой.

val caption

String

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

при отсутствии может быть пустой строкой.

val seoName

String

SEO-синоним.

при отсутствии может быть пустой строкой.

val keyword

String

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

при отсутствии может быть пустой строкой.

val tag

String

Уникальное имя, которое можно использовать как часть имени файла-иконки.

при отсутствии может быть пустой строкой.

val iconUrl

String

Ссылка на изображение.

при отсутствии может быть пустой строкой.

val suggestIcon

String

Иконка категории для выдачи suggest.

при отсутствии может быть пустой строкой.

val parentId

RubricId?

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

при отсутствии может быть пустой строкой.

val branchCount

Long

Количество филиалов организаций в данной категории.

val orgCount

Long

Количество организаций в данной категории.

val geoCount

Long

Количество геообъектов в данной категории.

val isReviewableOnFlamp

Boolean

Разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.

val children

List<Category>

Дочерние категории.

CategoryGeoContext

Географический контекст, по которому SDK уточнит регион при запросе категорий.

CategoryGeoContext(geoRect: GeoRect)

Parameters

geoRect

GeoRect

CategoryGeoContext(geoPoint: GeoPoint)

Parameters

geoPoint

GeoPoint

Methods

fun match(geoRect: Function1, geoPoint: Function1): T

Parameters

geoRect

(GeoRect) -> T

geoPoint

(GeoPoint) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isGeoRect

Boolean

val asGeoRect

GeoRect?

val isGeoPoint

Boolean

val asGeoPoint

GeoPoint?

val value

Any?

CategoryGetByIdsQueryBuilder

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

Extends: ru.dgis.sdk.NativeObject

CategoryGetByIdsQueryBuilder(ids: List<RubricId>)

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

Parameters

ids

List<RubricId>

Methods

fun setGeoContext(geoContext: CategoryGeoContext?): CategoryGetByIdsQueryBuilder

Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.

Parameters

geoContext

CategoryGeoContext?

Returns

CategoryGetByIdsQueryBuilder

fun setLocale(locale: Locale?): CategoryGetByIdsQueryBuilder

Задать локаль для запроса категорий.

Parameters

locale

Locale?

Returns

CategoryGetByIdsQueryBuilder

fun build(): CategoryQuery

Сформировать запрос категорий.

Returns

CategoryQuery

CategoryListQueryBuilder

Построитель запроса списка категорий.

Extends: ru.dgis.sdk.NativeObject

CategoryListQueryBuilder()

Начать построение запроса списка категорий.

Methods

fun setParentId(parentId: RubricId?): CategoryListQueryBuilder

Задать родителя для запроса списка категорий.

Parameters

parentId

RubricId?

Returns

CategoryListQueryBuilder

fun setSortType(sortType: CategorySortType): CategoryListQueryBuilder

Задать сортировку для запроса списка категорий.

Parameters

sortType

CategorySortType

Returns

CategoryListQueryBuilder

fun setGeoContext(geoContext: CategoryGeoContext?): CategoryListQueryBuilder

Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.

Parameters

geoContext

CategoryGeoContext?

Returns

CategoryListQueryBuilder

fun setPageSize(pageSize: Int): CategoryListQueryBuilder

Задать размер страницы.

Parameters

pageSize

Int

Returns

CategoryListQueryBuilder

fun setLocale(locale: Locale?): CategoryListQueryBuilder

Задать локаль для запроса категорий.

Parameters

locale

Locale?

Returns

CategoryListQueryBuilder

fun build(): CategoryQuery

Сформировать запрос категорий.

Returns

CategoryQuery

CategoryQuery

Запрос категорий.

Extends: ru.dgis.sdk.NativeObject

CategorySearchQueryBuilder

Построитель запроса поиска категорий по тексту.

Extends: ru.dgis.sdk.NativeObject

CategorySearchQueryBuilder(queryText: String)

Начать построение запроса поиска категорий по тексту.

Parameters

queryText

String

Methods

fun setGeoContext(geoContext: CategoryGeoContext?): CategorySearchQueryBuilder

Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.

Parameters

geoContext

CategoryGeoContext?

Returns

CategorySearchQueryBuilder

fun setPageSize(pageSize: Int): CategorySearchQueryBuilder

Задать размер страницы.

Parameters

pageSize

Int

Returns

CategorySearchQueryBuilder

fun setLocale(locale: Locale?): CategorySearchQueryBuilder

Задать локаль для запроса категорий.

Parameters

locale

Locale?

Returns

CategorySearchQueryBuilder

fun build(): CategoryQuery

Сформировать запрос категорий.

Returns

CategoryQuery

Certificate

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

Certificate(system: SystemCertificate)

Parameters

system

SystemCertificate

Certificate(fromFile: CertificateFromFile)

Parameters

fromFile

CertificateFromFile

Certificate(fromAsset: CertificateFromAsset)

Parameters

fromAsset

CertificateFromAsset

Methods

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

Parameters

system

(SystemCertificate) -> T

fromFile

(CertificateFromFile) -> T

fromAsset

(CertificateFromAsset) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isSystem

Boolean

val asSystem

SystemCertificate?

val isFromFile

Boolean

val asFromFile

CertificateFromFile?

val isFromAsset

Boolean

val asFromAsset

CertificateFromAsset?

val value

Any?

val default

List<Certificate>

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

CertificateFromAsset

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

CertificateFromAsset(path: String)

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

Parameters

path

String

Properties

val path

String

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

CertificateFromFile

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

CertificateFromFile(path: String)

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

Parameters

path

String

Properties

val path

String

Путь к файлу.

ChargingStation

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

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

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

Parameters

aggregate

Aggregate

connectors

List<Connector>

Properties

val aggregate

Aggregate

val connectors

List<Connector>

CheckableGroupedItem

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

Extends: ru.dgis.sdk.NativeObject

Properties

val text

String

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

val values

List<String>

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

var isChecked

Boolean

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

CheckableItem

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

Extends: ru.dgis.sdk.NativeObject

Properties

val type

CheckableItemType

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

val filterType

FilterType

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

CheckableItemsGroup

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

Extends: ru.dgis.sdk.directory.Widget

Properties

val items

List<CheckableItem>

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

Checkbox

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

Extends: ru.dgis.sdk.directory.Widget

Properties

val filterType

FilterType

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

val checkedText

String?

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

val uncheckedText

String?

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

val values

List<String>

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

var isChecked

Boolean

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

Circle

Окружность.

Extends: ru.dgis.sdk.map.SimpleMapObject

Circle(options: CircleOptions)

Parameters

options

CircleOptions

Properties

var position

GeoPoint

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

var radius

Meter

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

var color

Color

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

var strokeWidth

LogicalPixel

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

var strokeColor

Color

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

var dashedStrokeOptions

DashedStrokeCircleOptions?

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

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

GeoPoint

radius

Meter

color

Color

strokeWidth

LogicalPixel

strokeColor

Color

dashedStrokeOptions

DashedStrokeCircleOptions?

visible

Boolean

userData

Any?

zIndex

ZIndex

levelId

LevelId?

Properties

val position

GeoPoint

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

val radius

Meter

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

val color

Color

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

val strokeWidth

LogicalPixel

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

val strokeColor

Color

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

val dashedStrokeOptions

DashedStrokeCircleOptions?

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

val visible

Boolean

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

val userData

Any?

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

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

val zIndex

ZIndex

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

val levelId

LevelId?

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

Closed

Закрыто.

Closed(timeUntilOpen: Duration?, reason: ClosedReason)

Закрыто.

Parameters

timeUntilOpen

Duration?

reason

ClosedReason

Properties

val timeUntilOpen

Duration?

Время до открытия. Отсутствует, если организация закрыта навсегда.

val reason

ClosedReason

Причина, по которой организация закрыта.

ClosingHours

Интервал, когда заведение закрыто.

ClosingHours(interval: WeekTimeInterval, reason: ClosedReason)

Интервал, когда заведение закрыто.

Parameters

interval

WeekTimeInterval

reason

ClosedReason

Properties

val interval

WeekTimeInterval

Временной интервал.

val reason

ClosedReason

Причина закрытия.

ClosingSoon

Скоро закроется.

ClosingSoon(timeUntilClose: Duration, reason: ClosedReason)

Скоро закроется.

Parameters

timeUntilClose

Duration

reason

ClosedReason

Properties

val timeUntilClose

Duration

Время до закрытия.

val reason

ClosedReason

Причина, по которой организация будет закрыта.

ClusterObject

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

Extends: ru.dgis.sdk.map.MapObject

Properties

val position

GeoPointWithElevation

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

val objectCount

Int

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

val objects

List<GeometryMapObject>

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

val geometryObject

GeometryMapObject?

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

ClusterOptions

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

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

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

Parameters

attributes

Map

userData

Any?

Properties

val attributes

Map

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

val userData

Any?

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

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

Color

Цвет

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

Цвет

Parameters

argb

Int

Properties

val argb

Int

val red

Int

val green

Int

val blue

Int

val alpha

Int

CommonGestureSettings

Extends: ru.dgis.sdk.NativeObject

Properties

var recognizeSettings

CommonRecognizeSettings

Общие настройки распознавания жестов.

CommonRecognizeSettings

Общие настройки распознавания жестов.

CommonRecognizeSettings(interGestureTimeout: Duration = Duration.ofMilliseconds(50))

Общие настройки распознавания жестов.

Parameters

interGestureTimeout

Duration

Properties

val interGestureTimeout

Duration

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

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

Context

attrs

AttributeSet?

defStyle

Int

layout

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

CompassControl

Extends: ru.dgis.sdk.map.CompassControl

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

CompassControlModel

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

Extends: ru.dgis.sdk.NativeObject

CompassControlModel(map: Map)

Parameters

map

Map

Methods

fun onClicked(): Unit

Returns

Unit

Properties

val bearingChannel

StatefulChannel<Bearing>

val bearing

Bearing

ComplexGeometry

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

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

Extends: ru.dgis.sdk.geometry.Geometry

ComplexGeometry(geometries: List<Geometry>)

Parameters

geometries

List<Geometry>

Properties

val elements

List<Geometry>

Connector

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

Parameters

power

Short

price

Short

status

StatusType

type

String

Properties

val power

Short

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

val price

Short

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

val status

StatusType

Статус.

val type

String

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

ContactInfo

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

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

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

Parameters

type

String

displayText

String

value

String

comment

String?

Properties

val type

String

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

• email — электронная почта
• website — сайт
• phone — телефон
• fax — факс
• pobox — абонентский ящик
• icq
• jabber
• skype
• vkontakte
• twitter
• odnoklassniki
• youtube
• linkedin
• googleplus
• pinterest
• whatsapp
• viber
• telegram

val displayText

String

Значение контакта для вывода на экран.

val value

String

Техническое значение контакта. В зависимости от типа контакта имеет следующую семантику:

• 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

String?

Уточняющая информация о контакте.

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

Duration

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

valueThreshold

Meter

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

CopyrightMargins

CopyrightMargins(
	left: Int = 0,
	top: Int = 0,
	right: Int = 0,
	bottom: Int = 0
)

Parameters

left

Int

top

Int

right

Int

bottom

Int

Properties

val left

Int

val top

Int

val right

Int

val bottom

Int

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

Int

top

Int

right

Int

bottom

Int

Properties

val left

Int

val top

Int

val right

Int

val bottom

Int

CopyrightPosition

Position of the copyright icon on the screen.

CopyrightPosition(gravity: Int, margins: CopyrightMargins)

Position of the copyright icon on the screen.

Parameters

gravity

Int

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

margins

CopyrightMargins

The margins between the screen and a copyright icon.

Properties

val gravity

Int

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

val margins

CopyrightMargins

The margins between the screen and a copyright icon.

CrossingTypeRouteLongAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): CrossingTypeRouteLongEntry?

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

Parameters

point

RoutePoint

Returns

CrossingTypeRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<CrossingTypeRouteLongEntry>

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<CrossingTypeRouteLongEntry>

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

CrossingTypeRouteLongEntry?

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

val last

CrossingTypeRouteLongEntry?

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

val entries

List<CrossingTypeRouteLongEntry>

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

CrossingTypeRouteLongEntry

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

CrossingTypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: CrossingType
)

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

Parameters

point

RoutePoint

length

RouteDistance

value

CrossingType

Properties

val point

RoutePoint

val length

RouteDistance

val value

CrossingType

CustomDashboardButton

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

Extends: ru.dgis.sdk.navigation.CustomizableDashboardButton

CustomDashboardButton(icon: Int, onClick: Function0<Unit>)

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

Parameters

icon

Int

onClick

() -> Unit

Properties

val icon

Int

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

val onClick

() -> Unit

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

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

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

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

Parameters

action

() -> Unit

Returns

Unit

fun toggleExpandedState(): Unit

Returns

Unit

Properties

val remainingRouteInfoControl

RemainingRouteInfoControl

var onFinishClicked

() -> Unit

var onShowRouteClicked

() -> Unit

var isFreeRoam

Boolean

val headerHeight

Int

DashedPolygonOptions

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

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

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

Parameters

dashLength

LogicalPixel

dashSpaceLength

LogicalPixel

Properties

val dashLength

LogicalPixel

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

val dashSpaceLength

LogicalPixel

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

DashedPolylineOptions

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

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

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

Parameters

dashLength

LogicalPixel

dashSpaceLength

LogicalPixel

Properties

val dashLength

LogicalPixel

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

val dashSpaceLength

LogicalPixel

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

DashedStrokeCircleOptions

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

Parameters

dashLength

LogicalPixel

dashSpaceLength

LogicalPixel

Properties

val dashLength

LogicalPixel

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

val dashSpaceLength

LogicalPixel

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

DataPrefetcher

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

Extends: ru.dgis.sdk.NativeObject

Properties

var enabled

Boolean

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

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

var minZoom

Zoom

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

var maxZoom

Zoom

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

var radius

LogicalPixel

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

var segmentSize

RouteDistance

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

var maxPrefetchDistance

RouteDistance

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

DayTime

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

DayTime(hours: Byte, minutes: Byte)

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

Parameters

hours

Byte

minutes

Byte

Properties

val hours

Byte

Часы, 0-23.

val minutes

Byte

Минуты, 0-59.

DefaultHttpClient

Стандартная реализация HTTP-клиента (транспортной части) для запросов к сервису Radar. Не логирует тела и заголовки запросов и ответов сервера на всех уровнях логирования из-за соображений приватности. При необходимости логирования запросов – подготовьте свою реализацию и передайте при инициализации DefaultLocationSource как параметр для настроек RadarSettings.

Implements: ru.dgis.sdk.positioning.radar.RadarApiHttpClient

DefaultHttpClient()

Стандартная реализация HTTP-клиента (транспортной части) для запросов к сервису Radar. Не логирует тела и заголовки запросов и ответов сервера на всех уровнях логирования из-за соображений приватности. При необходимости логирования запросов – подготовьте свою реализацию и передайте при инициализации DefaultLocationSource как параметр для настроек RadarSettings.

Methods

fun post(
	url: String,
	body: String,
	headers: Map
): RadarHttpResponse

Выполняет POST-запрос к указанному URL

Parameters

url

String

URL для запроса

body

String

Тело запроса в формате JSON

headers

Map

Returns

RadarHttpResponse

Ответ от сервера в виде RadarHttpResponse

DefaultInstallFallback

Фабрика, производящая предустановленные стратегии поведения при ошибке установки или обновления пакета.

see IInstallFallback

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun noOperation(): InstallFallback

Создание fallback, который не выполняет никаких операций (no-op).

Returns

InstallFallback

@JvmStatic
fun retryOnError(retryCount: Long): InstallFallback

Создание fallback, вызывающего повторный install при возникновении ошибки загрузки пакета.

Parameters

retryCount

Long

количество повторных вызовов install, по достижении которого перестает выполнять операции.

Returns

InstallFallback

DefaultLocationSource

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

Implements: ru.dgis.sdk.positioning.LocationSource|ru.dgis.sdk.positioning.LocationService

DefaultLocationSource(context: Context, radarApiSettings: RadarApiSettings = RadarApiSettings.OFF)

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

Parameters

context

Context

radarApiSettings

RadarApiSettings

Methods

@Synchronized
fun activate(listener: LocationChangeListener): Unit

Parameters

listener

LocationChangeListener

Returns

Unit

@Synchronized
fun deactivate(): Unit

Returns

Unit

@Synchronized
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit

Parameters

accuracy

DesiredAccuracy

Returns

Unit

fun onPermissionGranted(): Unit

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

Returns

Unit

@Synchronized
fun onLocationServicesChanged(): Unit

Метод обрабатывает изменения доступности источников

Returns

Unit

Properties

val lastLocation

Location?

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

var isGMSAllowed

Boolean

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

DefaultMapControllerViewModel

MapControllerViewModel that creates the controller with factory and owns it.

Creation starts in the constructor. The instance must be closed when the map is no longer needed; closing the view model also closes the controller.

Main thread only.

Implements: ru.dgis.sdk.map.MapControllerViewModel

DefaultMapControllerViewModel(
	sdkContext: Context,
	options: MapControllerOptions,
	factory: MapControllerFactory = MapControllerFactory.Default
)

MapControllerViewModel that creates the controller with factory and owns it.

Creation starts in the constructor. The instance must be closed when the map is no longer needed; closing the view model also closes the controller.

Main thread only.

Parameters

sdkContext

Context

options

MapControllerOptions

factory

MapControllerFactory

Methods

fun close(): Unit

Returns

Unit

suspend fun awaitController(): MapController

Suspends until the map is created and returns its controller.

Returns

MapController

suspend fun awaitMap(): Map

Same as awaitController, but returns Map of the controller.

Returns

Map

Properties

val state

<ERROR CLASS><MapControllerState>

Current state of the map.

val controller

MapController?

The controller, or null if the map is not created. Does not wait.

val map

Map?

The map, or null if it is not created. Does not wait.

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

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun setCustomDashboardButton(button: CustomizableDashboardButton): Unit

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

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

Parameters

button

CustomizableDashboardButton

Returns

Unit

fun onConfigurationChanged(newConfig: Configuration): Unit

Parameters

newConfig

Configuration

Returns

Unit

fun attachToManager(manager: NavigationManager): Unit

Parameters

manager

NavigationManager

Returns

Unit

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

fun onAttachedToWindow(): Unit

Returns

Unit

Properties

var onFinishClicked

() -> Unit

var isFreeRoamDefault

Boolean

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

DefaultRasterUrlTemplate

DefaultRasterUrlTemplate(urlTemplate: String)

Parameters

urlTemplate

String

Properties

val urlTemplate

String

DefaultRoadEventFilter

Фабрика для создания стандартных временных фильтров дорожных событий.

see IDefaultRoadEventFilter.

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun create(
	context: Context,
	displayCategories: EnumSet?<RoadEventDisplayCategory>,
	startTimeCutoff: Duration?
): RoadEventFilter

Создает фильтр отображаемых дорожных событий на карте.

Parameters

context

Context

Контекст.

displayCategories

EnumSet?<RoadEventDisplayCategory>

Категории событий, которые нужно отображать на карте. Если не задано — фильтрация по категориям не применяется.

startTimeCutoff

Duration?

Максимально допустимое время начала события относительно текущего момента. События с start_time позже этого порога будут скрыты. Например, +1d — скрыть события, которые начнутся позже чем через сутки. События без start_time не фильтруются. Если не задано — фильтрация по времени начала не применяется.

Returns

RoadEventFilter

DefaultSpeechRecognizer

Стандартная реализация SpeechRecognizer, использующая системный механизм распознавания речи Android через RecognizerIntent.

Implements: ru.dgis.sdk.directory.SpeechRecognizer

DefaultSpeechRecognizer(activity: <ERROR CLASS>, prompt: String? = "Speak Now")

Стандартная реализация SpeechRecognizer, использующая системный механизм распознавания речи Android через RecognizerIntent.

Parameters

activity

<ERROR CLASS>

prompt

String?

Methods

fun recognize(onResult: Function1, onError: Function1): Unit

Реализация метода SpeechRecognizer.recognize. Запускает системный интерфейс распознавания речи и обрабатывает результаты.

Parameters

onResult

(String) -> Unit

Функция обратного вызова для получения распознанного текста.

onError

(Exception) -> Unit

Функция обратного вызова для обработки возможных ошибок.

Returns

Unit

DeviceDensity

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

DeviceDensity(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

DevicePpi

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

DevicePpi(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

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(),
	storageOptions: StorageOptions = StorageOptions()
): Context

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

Parameters

appContext

Context

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

httpOptions

HttpOptions

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

logOptions

LogOptions

параметры логирования. Игнорируются при повторном вызове после deinitialize().

vendorConfig

VendorConfig

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

keySource

KeySource

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

dataCollectConsent

PersonalDataCollectionConsent

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

platformHttpClient

HttpClient?

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

platformAudioDriver

AudioDriver?

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

mapOptions

GlobalMapOptions

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

storageOptions

StorageOptions

настройки, применяемые к файловому хранилищу.

Returns

Context

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

@JvmStatic
fun deinitialize(): Unit

Деинициализация SDK. Освобождает ресурсы контекста.

Перед вызовом убедитесь, что все объекты SDK (карты, маркеры, источники данных и т.д.) освобождены. Если деинициализация завершилась с ошибкой, контекст останется активным.

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

Returns

Unit

@JvmStatic
fun context(): Context

Returns

Context

DgisMapObject

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

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

Extends: ru.dgis.sdk.map.MapObject

Properties

val id

DgisObjectId

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

DgisObjectId

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

Parameters

objectId

Long

entranceId

Long

Properties

val objectId

Long

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

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

val entranceId

Long

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

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

DgisSource

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

Extends: ru.dgis.sdk.map.Source

Methods

fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit

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

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

Parameters

directoryObjectIds

List<DgisObjectId>

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

highlighted

Boolean

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

Returns

Unit

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

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

Parameters

context

Context

workingMode

DgisSourceWorkingMode

Returns

Source

@JvmStatic
fun createImmersiveDgisSource(context: Context): Source

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

Parameters

context

Context

Returns

Source

@JvmStatic
fun createReliefDgisSource(context: Context): Source

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

Parameters

context

Context

Returns

Source

Properties

val highlightedObjectsChannel

StatefulChannel<List<DgisObjectId>>

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

val highlightedObjects

List<DgisObjectId>

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

DirectMapControlBeginEvent

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

Extends: ru.dgis.sdk.map.Event

DirectMapControlBeginEvent()

DirectMapControlEndEvent

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

Extends: ru.dgis.sdk.map.InputEvent

DirectMapControlEndEvent(timestamp: Duration)

Parameters

timestamp

Duration

DirectMapRotationEvent

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

Extends: ru.dgis.sdk.map.InputEvent

DirectMapRotationEvent(
	bearingDelta: Bearing,
	timestamp: Duration,
	rotationCenter: ScreenPoint? = null
)

Parameters

bearingDelta

Bearing

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

timestamp

Duration

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

rotationCenter

ScreenPoint?

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

Properties

val bearingDelta

Bearing

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

val rotationCenter

ScreenPoint?

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

DirectMapScalingEvent

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

Extends: ru.dgis.sdk.map.InputEvent

DirectMapScalingEvent(
	zoomDelta: Float,
	timestamp: Duration,
	scalingCenter: ScreenPoint? = null
)

Parameters

zoomDelta

Float

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

timestamp

Duration

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

scalingCenter

ScreenPoint?

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

Properties

val zoomDelta

Float

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

val scalingCenter

ScreenPoint?

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

DirectMapShiftEvent

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

Extends: ru.dgis.sdk.map.InputEvent

DirectMapShiftEvent(
	screenShift: ScreenShift,
	shiftedPoint: ScreenPoint,
	timestamp: Duration
)

Parameters

screenShift

ScreenShift

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

shiftedPoint

ScreenPoint

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

timestamp

Duration

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

Properties

val screenShift

ScreenShift

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

val shiftedPoint

ScreenPoint

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

DirectMapTiltEvent

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

Extends: ru.dgis.sdk.map.InputEvent

DirectMapTiltEvent(delta: Float, timestamp: Duration)

Parameters

delta

Float

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

timestamp

Duration

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

Properties

val delta

Float

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

DirectoryFilter

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

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

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

Parameters

workTime

WorkTimeFilter?

dynamic

List<DynamicFilter>

Properties

val workTime

WorkTimeFilter?

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

val dynamic

List<DynamicFilter>

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

DirectoryObject

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun formattedAddress(type: FormattingType): FormattedAddress?

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

Parameters

type

FormattingType

Returns

FormattedAddress?

fun publicTransportScheduleInfo(departureTimeUtc: Long): Future<PublicTransportDirectoryScheduleInfo?>

Информация о расписаниях платформ и направлений.

Parameters

departureTimeUtc

Long

Время в системе UNIX по UTC, на которое необходимо получить расписание.

Returns

Future<PublicTransportDirectoryScheduleInfo?>

Properties

val types

List<ObjectType>

Тип объекта. Может быть несколько, например, ТЦ Сан Сити - филиал организации и здание одновременно. Первый тип в этом списке - основной.

val title

String

Заголовок объекта.

val titleAddition

String

Дополнительная информация заголовка Пример: "(кв. 1-12)"

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

val subtitle

String

Подзаголовок объекта.

при отсутствии может быть пустой строкой

val description

String

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

val id

DgisObjectId?

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

val markerPosition

GeoPointWithElevation?

Точка объекта, где следует разместить маркер.

val address

Address?

Адрес объекта в виде набора компонент.

val attributes

List<Attribute>

Дополнительные атрибуты объекта.

val contextAttributes

List<Attribute>

Контекстные дополнительные атрибуты объекта.

val timeZoneOffset

Duration?

Сдвиг локального времени объекта относительно UTC в секундах в текущий момент.

val openingHours

OpeningHours?

Время работы объекта.

val contactInfos

List<ContactInfo>

Контакты объекта.

val reviews

Reviews?

Отзывы.

val parkingInfo

ParkingInfo?

Дополнительная информация о парковке.

val workStatus

WorkStatus?

Статус работы.

val levelId

LevelId?

Идентификатор этажа, на котором расположен объект.

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

val entrances

List<EntranceInfo>

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

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

val tradeLicense

TradeLicense?

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

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

val buildingInfo

BuildingInfo?

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

val branchesInfo

BranchesInfo?

Информация о связанных организациях.

val chargingStation

ChargingStation?

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

val rubricIds

List<RubricId>

Идентификаторы рубрик.

val orgInfo

OrgInfo?

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

val group

List<GroupItem>

Связанные в объединённую карточку объекты.

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

val routeInfos

List<PublicTransportDirectoryRouteInfo>

Справочная информация о маршрутах общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.

Для маршрута (тип ObjectType.Route) содержит информацию только об одном маршруте. Для остановочной платформы (тип ObjectType.StationPlatform), станции метро (тип ObjectType.StationMetro) и входа на станцию (тип ObjectType.StationEntrance) содержит информацию обо всех маршрутах, которые проходят через объект.

val platformIds

List<DgisObjectId>

Справочная информация о идентификаторах платформ общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.

Для входа на станцию (тип ObjectType.StationEntrance) и станции метро (тип ObjectType.StationMetro) содержит информацию обо всех идентификаторах платформ.

val nearestParkingIds

List<DgisObjectId>

Ближайшие парковки.

val nearestStations

List<NearestStation>

Ближайшие остановки.

val nearestPlatforms

List<NearestPlatform>

Ближайшие остановочные платформы.

DoubleRouteAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<DoubleRouteEntry>

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<DoubleRouteEntry>

fun findNearBackward(point: RoutePoint): DoubleRouteEntry?

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

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

Parameters

point

RoutePoint

Returns

DoubleRouteEntry?

fun findNearForward(point: RoutePoint): DoubleRouteEntry?

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

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

Parameters

point

RoutePoint

Returns

DoubleRouteEntry?

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

DoubleRouteEntry?

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

val last

DoubleRouteEntry?

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

val entries

List<DoubleRouteEntry>

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

DoubleRouteEntry

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

DoubleRouteEntry(point: RoutePoint, value: Double)

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

Parameters

point

RoutePoint

value

Double

Properties

val point

RoutePoint

val value

Double

DoubleRouteLongAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): DoubleRouteLongEntry?

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

Parameters

point

RoutePoint

Returns

DoubleRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<DoubleRouteLongEntry>

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<DoubleRouteLongEntry>

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

DoubleRouteLongEntry?

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

val last

DoubleRouteLongEntry?

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

val entries

List<DoubleRouteLongEntry>

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

DoubleRouteLongEntry

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

DoubleRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: Double
)

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

Parameters

point

RoutePoint

length

RouteDistance

value

Double

Properties

val point

RoutePoint

val length

RouteDistance

val value

Double

DragBeginData

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

DragBeginData(point: ScreenPoint, item: RenderedObject)

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

Parameters

point

ScreenPoint

item

RenderedObject

Properties

val point

ScreenPoint

val item

RenderedObject

Duration

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

Methods

operator fun unaryMinus(): Duration

Returns

Duration

operator fun plus(other: Duration): Duration

Parameters

other

Duration

Returns

Duration

operator fun minus(other: Duration): Duration

Parameters

other

Duration

Returns

Duration

operator fun times(scale: Int): Duration

Parameters

scale

Int

Returns

Duration

operator fun times(scale: Double): Duration

Parameters

scale

Double

Returns

Duration

operator fun div(scale: Int): Duration

Parameters

scale

Int

Returns

Duration

operator fun div(scale: Double): Duration

Parameters

scale

Double

Returns

Duration

fun compareTo(other: Duration): Int

Parameters

other

Duration

Returns

Int

fun toString(): String

Returns

String

@JvmStatic
fun ofMilliseconds(milliseconds: Long): Duration

Parameters

milliseconds

Long

Returns

Duration

@JvmStatic
fun ofSeconds(seconds: Long): Duration

Parameters

seconds

Long

Returns

Duration

@JvmStatic
fun ofMinutes(minutes: Long): Duration

Parameters

minutes

Long

Returns

Duration

@JvmStatic
fun ofHours(hours: Long): Duration

Parameters

hours

Long

Returns

Duration

@JvmStatic
fun ofDays(days: Long): Duration

Parameters

days

Long

Returns

Duration

fun toFormattedMeasure(context: Context): FormattedMeasure

Преобразование Duration в FormattedMeasure для показа в UI-элементах.

Parameters

context

Context

Returns

FormattedMeasure

fun toTimeString(context: Context): String

Преобразование Duration в строку для показа в UI-элементах.

Parameters

context

Context

Returns

String

fun toArrivalTimeString(locale: Locale = Locale.getDefault(), timeZone: TimeZone = TimeZone.getDefault()): String

Преобразование Duration в строку времени прибытия для показа в UI-элементах.

Parameters

locale

Locale

timeZone

TimeZone

Returns

String

Properties

val inMilliseconds

Long

val inSeconds

Long

val inMinutes

Long

val inHours

Long

val inDays

Long

val ZERO

Duration

DynamicFilter

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

DynamicFilter(flagFilter: FlagFilter)

Parameters

flagFilter

FlagFilter

DynamicFilter(rangeFilter: RangeFilter)

Parameters

rangeFilter

RangeFilter

DynamicFilter(sortingFilter: SortingFilter)

Parameters

sortingFilter

SortingFilter

Methods

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

Parameters

flagFilter

(FlagFilter) -> T

rangeFilter

(RangeFilter) -> T

sortingFilter

(SortingFilter) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isFlagFilter

Boolean

val asFlagFilter

FlagFilter?

val isRangeFilter

Boolean

val asRangeFilter

RangeFilter?

val isSortingFilter

Boolean

val asSortingFilter

SortingFilter?

val value

Any?

DynamicRouteInfo

DynamicRouteInfo(roadEvents: RoadEventRouteAttribute, traffic: Traffic)

Parameters

roadEvents

RoadEventRouteAttribute

traffic

Traffic

Properties

val roadEvents

RoadEventRouteAttribute

val traffic

Traffic

DynamicRouteInfoSettings

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

Extends: ru.dgis.sdk.NativeObject

Properties

var updatePeriod

Duration

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

Elevation

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Elevation(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

EmptyFollowController

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

Implements: ru.dgis.sdk.map.CustomFollowController

EmptyFollowController()

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

Methods

fun availableValues(): EnumSet<FollowValue>

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

Returns

EnumSet<FollowValue>

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

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

Parameters

values

EnumSet<FollowValue>

Returns

Unit

fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit

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

Parameters

notifier

NewValuesNotifier?

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

List<GeoPoint>

entrancePolylines

List<List<GeoPoint>>

Properties

val entrancePoints

List<GeoPoint>

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

val entrancePolylines

List<List<GeoPoint>>

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

EntranceInfo

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

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

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

Parameters

id

DgisObjectId

buildingNumber

String?

porchName

String?

porchNumber

String?

apartmentRanges

List<ApartmentRange>

geometry

EntranceGeometry?

entranceNumber

String?

Properties

val id

DgisObjectId

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

val buildingNumber

String?

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

val porchName

String?

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

val porchNumber

String?

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

val apartmentRanges

List<ApartmentRange>

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

val geometry

EntranceGeometry?

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

val entranceNumber

String?

Номер входа на станцию. Будет содержать информацию для объекта с типом ObjectType.StationEntrance.

Event

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

Extends: ru.dgis.sdk.NativeObject

ExceedSpeedLimitSettings

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

Extends: ru.dgis.sdk.NativeObject

Properties

var exceedSpeedNotificationEnabled

Boolean

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

var allowableSpeedExcess

Float

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

ExcludedArea

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

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

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

Parameters

type

ExcludedAreaType

severity

ExcludedAreaSeverity

extent

RouteDistance

points

List<GeoPoint>

Properties

val type

ExcludedAreaType

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

val severity

ExcludedAreaSeverity

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

val extent

RouteDistance

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

val points

List<GeoPoint>

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

ExtraInstructionInfo

ExtraInstructionInfo(bicycleStart: BicycleInstructionStart)

Parameters

bicycleStart

BicycleInstructionStart

ExtraInstructionInfo(bicycleFinish: BicycleInstructionFinish)

Parameters

bicycleFinish

BicycleInstructionFinish

ExtraInstructionInfo(bicycleCrossroad: BicycleInstructionCrossroad)

Parameters

bicycleCrossroad

BicycleInstructionCrossroad

ExtraInstructionInfo(carStart: CarInstructionStart)

Parameters

carStart

CarInstructionStart

ExtraInstructionInfo(carFinish: CarInstructionFinish)

Parameters

carFinish

CarInstructionFinish

ExtraInstructionInfo(carCrossroad: CarInstructionCrossroad)

Parameters

carCrossroad

CarInstructionCrossroad

ExtraInstructionInfo(carRoundabout: CarInstructionRoundabout)

Parameters

carRoundabout

CarInstructionRoundabout

ExtraInstructionInfo(carUturn: CarInstructionUTurn)

Parameters

carUturn

CarInstructionUTurn

ExtraInstructionInfo(pedestrianStart: PedestrianInstructionStart)

Parameters

pedestrianStart

PedestrianInstructionStart

ExtraInstructionInfo(pedestrianFinish: PedestrianInstructionFinish)

Parameters

pedestrianFinish

PedestrianInstructionFinish

ExtraInstructionInfo(pedestrianCrossroad: PedestrianInstructionCrossroad)

Parameters

pedestrianCrossroad

PedestrianInstructionCrossroad

ExtraInstructionInfo(pedestrianIndoorFloorChange: PedestrianInstructionIndoorFloorChange)

Parameters

pedestrianIndoorFloorChange

PedestrianInstructionIndoorFloorChange

ExtraInstructionInfo(pedestrianIndoorEnter: PedestrianInstructionIndoorEnter)

Parameters

pedestrianIndoorEnter

PedestrianInstructionIndoorEnter

ExtraInstructionInfo(pedestrianIndoorExit: PedestrianInstructionIndoorExit)

Parameters

pedestrianIndoorExit

PedestrianInstructionIndoorExit

ExtraInstructionInfo(scooterStart: ScooterInstructionStart)

Parameters

scooterStart

ScooterInstructionStart

ExtraInstructionInfo(scooterFinish: ScooterInstructionFinish)

Parameters

scooterFinish

ScooterInstructionFinish

ExtraInstructionInfo(scooterCrossroad: ScooterInstructionCrossroad)

Parameters

scooterCrossroad

ScooterInstructionCrossroad

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

(BicycleInstructionStart) -> T

bicycleFinish

(BicycleInstructionFinish) -> T

bicycleCrossroad

(BicycleInstructionCrossroad) -> T

carStart

(CarInstructionStart) -> T

carFinish

(CarInstructionFinish) -> T

carCrossroad

(CarInstructionCrossroad) -> T

carRoundabout

(CarInstructionRoundabout) -> T

carUturn

(CarInstructionUTurn) -> T

pedestrianStart

(PedestrianInstructionStart) -> T

pedestrianFinish

(PedestrianInstructionFinish) -> T

pedestrianCrossroad

(PedestrianInstructionCrossroad) -> T

pedestrianIndoorFloorChange

(PedestrianInstructionIndoorFloorChange) -> T

pedestrianIndoorEnter

(PedestrianInstructionIndoorEnter) -> T

pedestrianIndoorExit

(PedestrianInstructionIndoorExit) -> T

scooterStart

(ScooterInstructionStart) -> T

scooterFinish

(ScooterInstructionFinish) -> T

scooterCrossroad

(ScooterInstructionCrossroad) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isBicycleStart

Boolean

val asBicycleStart

BicycleInstructionStart?

val isBicycleFinish

Boolean

val asBicycleFinish

BicycleInstructionFinish?

val isBicycleCrossroad

Boolean

val asBicycleCrossroad

BicycleInstructionCrossroad?

val isCarStart

Boolean

val asCarStart

CarInstructionStart?

val isCarFinish

Boolean

val asCarFinish

CarInstructionFinish?

val isCarCrossroad

Boolean

val asCarCrossroad

CarInstructionCrossroad?

val isCarRoundabout

Boolean

val asCarRoundabout

CarInstructionRoundabout?

val isCarUturn

Boolean

val asCarUturn

CarInstructionUTurn?

val isPedestrianStart

Boolean

val asPedestrianStart

PedestrianInstructionStart?

val isPedestrianFinish

Boolean

val asPedestrianFinish

PedestrianInstructionFinish?

val isPedestrianCrossroad

Boolean

val asPedestrianCrossroad

PedestrianInstructionCrossroad?

val isPedestrianIndoorFloorChange

Boolean

val asPedestrianIndoorFloorChange

PedestrianInstructionIndoorFloorChange?

val isPedestrianIndoorEnter

Boolean

val asPedestrianIndoorEnter

PedestrianInstructionIndoorEnter?

val isPedestrianIndoorExit

Boolean

val asPedestrianIndoorExit

PedestrianInstructionIndoorExit?

val isScooterStart

Boolean

val asScooterStart

ScooterInstructionStart?

val isScooterFinish

Boolean

val asScooterFinish

ScooterInstructionFinish?

val isScooterCrossroad

Boolean

val asScooterCrossroad

ScooterInstructionCrossroad?

val value

Any?

File

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

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

Extends: ru.dgis.sdk.NativeObject

File(path: String)

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

Parameters

path

String

Путь к файлу.

Methods

@JvmStatic
fun fromString(contents: String): File

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

Parameters

contents

String

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

Returns

File

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

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

Parameters

context

Context

path

String

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

Returns

File

FinishDetector

Extends: ru.dgis.sdk.NativeObject

Properties

var softLimitMeters

RouteDistance

var hardLimitMeters

RouteDistance

var vehicleSoftLimitMeters

RouteDistance

var vehicleHardLimitMeters

RouteDistance

var distanceToFinishInStraightLineLimitMeters

Double

FinishRouteControl

Extends: ru.dgis.sdk.map.MapControl

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun expand(): Unit

Returns

Unit

Properties

val heightChannel

StatefulChannel<Int>

var onFinishClicked

() -> Unit

var isParkingButtonVisible

Boolean

Fixed

Fixed(theme: MapTheme)

Parameters

theme

MapTheme

Properties

val theme

MapTheme

FlagFilter

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

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

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

Parameters

tagName

String

displayName

String

flagValue

Boolean?

Properties

val tagName

String

Тэг фильтра.

val displayName

String

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

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

val flagValue

Boolean?

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

FloatRouteLongAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): FloatRouteLongEntry?

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

Parameters

point

RoutePoint

Returns

FloatRouteLongEntry?

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

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<FloatRouteLongEntry>

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

FloatRouteLongEntry?

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

val last

FloatRouteLongEntry?

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

val entries

List<FloatRouteLongEntry>

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

FloatRouteLongEntry

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

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

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

Parameters

point

RoutePoint

length

RouteDistance

value

Float

Properties

val point

RoutePoint

val length

RouteDistance

val value

Float

FloorInfo

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

FloorInfo(levelId: LevelId, buildingId: BuildingId)

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

Parameters

levelId

LevelId

buildingId

BuildingId

Properties

val levelId

LevelId

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

val buildingId

BuildingId

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

FloorsInfo

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

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

FloorsInfo(
	groundCount: Short = 0,
	groundMinCount: Short?,
	undergroundCount: Short?
)

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

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

Parameters

groundCount

Short

groundMinCount

Short?

undergroundCount

Short?

Properties

val groundCount

Short

Количество надземный этажей (для домов переменной этажности — максимальное количество надземных этажей).

val groundMinCount

Short?

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

val undergroundCount

Short?

Количество подземных этажей

FollowControl

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

Extends: ru.dgis.sdk.map.MapControl

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

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

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

FollowController

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

Extends: ru.dgis.sdk.NativeObject

FollowPosition

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

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

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

Parameters

bearing

FollowBearing

styleZoom

FollowStyleZoom

Properties

val bearing

FollowBearing

val styleZoom

FollowStyleZoom

FormattedAddress

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

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

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

Parameters

drilldownAddress

String?

streetAddress

String?

addressComment

String?

postCode

String?

Properties

val drilldownAddress

String?

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

val streetAddress

String?

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

val addressComment

String?

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

val postCode

String?

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

FormattedMeasure

Значение с единицами измерения, например ("1.5", "км")

FormattedMeasure(value: String, unit: String)

Значение с единицами измерения, например ("1.5", "км")

Parameters

value

String

unit

String

Properties

val value

String

val unit

String

Fps

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Fps(value: Int = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Int

Properties

val value

Int

FreeRoamSelector

Контроллер перевода навигатора в режим FreeRoam при слишком долгом перестроении маршрута.

Extends: ru.dgis.sdk.NativeObject

Properties

var enabled

Boolean

FreeRoamSettings

Extends: ru.dgis.sdk.NativeObject

Properties

var onRoutePrefetchLength

RouteDistance

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

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

var onRoutePrefetchRadiusMeters

Double

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

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

var prefetchRadiusMeters

Double

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

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

Geometry

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun intersects(geometry: Geometry): Boolean

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

Parameters

geometry

Geometry

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

Returns

Boolean

Properties

val kind

GeometryKind

val bounds

GeoRect

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

val minPoint

GeoPoint

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

val maxPoint

GeoPoint

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

GeometryMapObject

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

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

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

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

Extends: ru.dgis.sdk.map.MapObject

Properties

val geometryChannel

StatefulChannel<Geometry>

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

var geometry

Geometry

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

val objectAttributes

Attributes

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

val isVisibleChannel

StatefulChannel<Boolean>

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

var isVisible

Boolean

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

val isDraggableChannel

StatefulChannel<Boolean>

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

var isDraggable

Boolean

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

val animationSettings

AnimationSettings

Получение настроек анимации. Применяется для объектов с типом "3D model" или "Directional model".

val bounds

GeoRect

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

GeometryMapObjectBuilder

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

Extends: ru.dgis.sdk.NativeObject

GeometryMapObjectBuilder()

Methods

fun setObjectAttribute(name: String, value: AttributeValue): GeometryMapObjectBuilder

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

Parameters

name

String

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

value

AttributeValue

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

Returns

GeometryMapObjectBuilder

fun setObjectAttributes(values: Map): GeometryMapObjectBuilder

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

Parameters

values

Map

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

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

Returns

GeometryMapObjectBuilder

fun setGeometry(geometry: Geometry): GeometryMapObjectBuilder

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

Parameters

geometry

Geometry

Returns

GeometryMapObjectBuilder

fun setVisible(visible: Boolean): GeometryMapObjectBuilder

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

Parameters

visible

Boolean

Returns

GeometryMapObjectBuilder

fun setDraggable(draggable: Boolean): GeometryMapObjectBuilder

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

Parameters

draggable

Boolean

Returns

GeometryMapObjectBuilder

fun setUserData(userData: Any?): GeometryMapObjectBuilder

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

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

Parameters

userData

Any?

Returns

GeometryMapObjectBuilder

fun createObject(): GeometryMapObject

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

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

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

Returns

GeometryMapObject

fun setObjectAttribute(name: String, value: Boolean): GeometryMapObjectBuilder

Parameters

name

String

value

Boolean

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

Long

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

Int

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

Double

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

Float

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

String

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

ByteArray

Returns

GeometryMapObjectBuilder

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

Parameters

name

String

value

Color

Returns

GeometryMapObjectBuilder

GeometryMapObjectSource

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

Extends: ru.dgis.sdk.map.Source

Methods

fun clusteringObjects(position: CameraPosition): List<MapObject>

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

Parameters

position

CameraPosition

Returns

List<MapObject>

fun addObject(item: GeometryMapObject): Unit

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

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

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

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

Parameters

item

GeometryMapObject

Returns

Unit

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

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

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

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

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

Parameters

objects

List<GeometryMapObject>

Returns

Unit

fun removeObject(item: GeometryMapObject): Unit

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

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

Parameters

item

GeometryMapObject

Returns

Unit

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

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

Parameters

objects

List<GeometryMapObject>

Returns

Unit

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

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

Parameters

objectsToRemove

List<GeometryMapObject>

objectsToAdd

List<GeometryMapObject>

Returns

Unit

fun clear(): Unit

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

Returns

Unit

Properties

val objects

List<GeometryMapObject>

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

val sourceAttributes

Attributes

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

GeometryMapObjectSourceBuilder

Extends: ru.dgis.sdk.NativeObject

GeometryMapObjectSourceBuilder(context: Context)

Parameters

context

Context

Methods

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

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

Parameters

name

String

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

value

AttributeValue

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

Returns

GeometryMapObjectSourceBuilder

fun setSourceAttributes(values: Map): GeometryMapObjectSourceBuilder

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

Parameters

values

Map

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

Returns

GeometryMapObjectSourceBuilder

fun addObject(item: GeometryMapObject): GeometryMapObjectSourceBuilder

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

Parameters

item

GeometryMapObject

Returns

GeometryMapObjectSourceBuilder

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

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

Parameters

objects

List<GeometryMapObject>

Returns

GeometryMapObjectSourceBuilder

fun createSource(): GeometryMapObjectSource

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

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

Returns

GeometryMapObjectSource

GeoPoint

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

GeoPoint(latitude: Latitude, longitude: Longitude)

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

Parameters

latitude

Latitude

longitude

Longitude

Methods

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

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

Parameters

bearing

Bearing

meter

Meter

Returns

GeoPoint

fun withElevation(elevation: Elevation = Elevation(0.0f)): GeoPointWithElevation

Parameters

elevation

Elevation

Returns

GeoPointWithElevation

fun bearing(point: GeoPoint): Bearing

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

Parameters

point

GeoPoint

Returns

Bearing

fun distance(point: GeoPoint): Meter

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

Parameters

point

GeoPoint

Returns

Meter

Properties

val isValid

Boolean

val latitude

Latitude

val longitude

Longitude

GeoPointRouteAttribute

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<GeoPointRouteEntry>

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

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<GeoPointRouteEntry>

fun findNearBackward(point: RoutePoint): GeoPointRouteEntry?

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

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

Parameters

point

RoutePoint

Returns

GeoPointRouteEntry?

fun findNearForward(point: RoutePoint): GeoPointRouteEntry?

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

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

Parameters

point

RoutePoint

Returns

GeoPointRouteEntry?

fun calculateGeoPoint(routePoint: RoutePoint): SegmentGeoPoint?

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

Parameters

routePoint

RoutePoint

Returns

SegmentGeoPoint?

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

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

fun calculateClosestPoint(point: GeoPoint): RoutePoint?

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

Parameters

point

GeoPoint

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

Returns

RoutePoint?

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

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

Properties

val size

Long

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

val isEmpty

Boolean

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

val first

GeoPointRouteEntry?

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

val last

GeoPointRouteEntry?

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

val entries

List<GeoPointRouteEntry>

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

val length

RouteDistance

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

GeoPointRouteEntry

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

GeoPointRouteEntry(point: RoutePoint, value: GeoPoint)

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

Parameters

point

RoutePoint

value

GeoPoint

Properties

val point

RoutePoint

val value

GeoPoint

GeoPointWithElevation

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

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

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

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

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

Parameters

latitude

Latitude

longitude

Longitude

elevation

Elevation

Methods

fun bearing(point: GeoPoint): Bearing

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

Parameters

point

GeoPoint

Returns

Bearing

fun distance(point: GeoPoint): Meter

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

Parameters

point

GeoPoint

Returns

Meter

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

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

Parameters

bearing

Bearing

meter

Meter

Returns

GeoPointWithElevation

Properties

val latitude

Latitude

val longitude

Longitude

val elevation

Elevation

val point

GeoPoint

GeoRect

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

GeoRect(southWestPoint: GeoPoint, northEastPoint: GeoPoint)

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

Parameters

southWestPoint

GeoPoint

northEastPoint

GeoPoint

Methods

fun contains(rect2: GeoRect): Boolean

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

Parameters

rect2

GeoRect

Returns

Boolean

fun contains(point: GeoPoint): Boolean

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

Parameters

point

GeoPoint

Returns

Boolean

fun expand(rect2: GeoRect): GeoRect

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

Parameters

rect2

GeoRect

Returns

GeoRect

fun expand(point: GeoPoint): GeoRect

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

Parameters

point

GeoPoint

Returns

GeoRect

fun intersects(rect2: GeoRect): Boolean

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

Parameters

rect2

GeoRect

Returns

Boolean

Properties

val isValid

Boolean

val isDegenerate

Boolean

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

val southWestPoint

GeoPoint

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

val northEastPoint

GeoPoint

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

GestureActionEventCenter

Выполнить жест относительно геометрического центра множества точек постановки пальцев.

GestureActionEventCenter()

Выполнить жест относительно геометрического центра множества точек постановки пальцев.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

GestureActionMapPosition

Выполнить жест относительно точки позиции карты.

GestureActionMapPosition()

Выполнить жест относительно точки позиции карты.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

GestureActionPoint

Задает правило обработки событий карты.

GestureActionPoint(eventCenter: GestureActionEventCenter)

Parameters

eventCenter

GestureActionEventCenter

GestureActionPoint(mapPosition: GestureActionMapPosition)

Parameters

mapPosition

GestureActionMapPosition

GestureActionPoint(targetGeoPoint: GestureActionTargetGeoPoint)

Parameters

targetGeoPoint

GestureActionTargetGeoPoint

Methods

fun match(
	eventCenter: Function1,
	mapPosition: Function1,
	targetGeoPoint: Function1
): T

Parameters

eventCenter

(GestureActionEventCenter) -> T

mapPosition

(GestureActionMapPosition) -> T

targetGeoPoint

(GestureActionTargetGeoPoint) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isEventCenter

Boolean

val asEventCenter

GestureActionEventCenter?

val isMapPosition

Boolean

val asMapPosition

GestureActionMapPosition?

val isTargetGeoPoint

Boolean

val asTargetGeoPoint

GestureActionTargetGeoPoint?

val value

Any?

GestureActionTargetGeoPoint

Выполнить жест относительно геопозиции target_geo_point.

GestureActionTargetGeoPoint(targetGeoPoint: GeoPoint)

Выполнить жест относительно геопозиции target_geo_point.

Parameters

targetGeoPoint

GeoPoint

Properties

val targetGeoPoint

GeoPoint

GestureManager

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

Extends: ru.dgis.sdk.NativeObject

Methods

fun enableGesture(gesture: TransformGesture): Unit

Parameters

gesture

TransformGesture

Returns

Unit

fun disableGesture(gesture: TransformGesture): Unit

Parameters

gesture

TransformGesture

Returns

Unit

fun gestureEnabled(gesture: TransformGesture): Boolean

Parameters

gesture

TransformGesture

Returns

Boolean

fun setMutuallyExclusiveGestures(rules: List<EnumSet<TransformGesture>>): Unit

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

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

Parameters

rules

List<EnumSet<TransformGesture>>

Returns

Unit

Properties

var enabledGestures

EnumSet<TransformGesture>

val scalingSettings

ScalingGestureSettings

val rotationSettings

RotationGestureSettings

val multiTouchShiftSettings

MultiTouchGestureSettings

val tiltSettings

TiltGestureSettings

val commonSettings

CommonGestureSettings

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

Int

The number of input surfaces to create for rendering.

outputSurface

Surface

The Surface object representing the output surface where the final rendered content will be displayed.

outputSurfaceSize

Size

The size of the output surface, which also determines the size of all input surfaces.

rendererCallback

Callback

rendererCallbackHandler

Handler

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

Bitmap?

The bitmap representing the copyright icon. Can be null to clear the current icon.

position

Point

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.VULKAN, vulkanEmulatorSupportEnabled: Boolean = false)

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

Parameters

graphicsApi

GraphicsApi

vulkanEmulatorSupportEnabled

Boolean

Properties

val graphicsApi

GraphicsApi

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

val vulkanEmulatorSupportEnabled

Boolean

Включить ли поддержку запуска на эмуляторах с Vulkan.

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

LogicalPixel

secondBorderWidth

LogicalPixel

gradientLength

LogicalPixel

borderColor

Color

secondBorderColor

Color

colors

List<Color>

colorIndices

ByteArray

Properties

val borderWidth

LogicalPixel

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

val secondBorderWidth

LogicalPixel

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

val gradientLength

LogicalPixel

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

val borderColor

Color

Цвет окантовки.

val secondBorderColor

Color

Цвет второй окантовки.

val colors

List<Color>

Палитра цветов градиентной полилинии.

val colorIndices

ByteArray

Индексы цветов градиентной полилинии. Количество индексов должно быть на 1 меньше количества точек полилинии.

GroupCheckableItem

Набор отмечаемых элементов, работающих как радио-группа.

Extends: ru.dgis.sdk.directory.CheckableItem

Properties

val items

List<CheckableGroupedItem>

Получение набора элементов группы.

GroupItem

Элемент объединенной карточки, содержащий информацию об объекте.

GroupItem(id: DgisObjectId, type: ObjectType)

Элемент объединенной карточки, содержащий информацию об объекте.

Parameters

id

DgisObjectId

type

ObjectType

Properties

val id

DgisObjectId

Идентификатор объекта.

val type

ObjectType

Тип объекта.

HttpCacheManager

Интерфейс управления HTTP-кешем.

Extends: ru.dgis.sdk.NativeObject

Methods

fun clear(): Unit

Очистка содержимого HTTP-кеша.

Returns

Unit

@JvmStatic
fun get(context: Context): HttpCacheManager?

Интерфейс управления HTTP-кешем. Null, если HTTP кэш не используется.

Parameters

context

Context

Returns

HttpCacheManager?

Properties

val currentSize

Long

Текущий размер HTTP-кеша

var maxSize

Long

Максимальный размер HTTP-кеша

HttpHeader

HttpHeader(name: String, value: String)

Parameters

name

String

value

String

Properties

val name

String

val value

String

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

Duration

useCache

Boolean

cacheStoragePath

String?

cacheMaxSize

Long?

certificates

List?<Certificate>

proxy

HttpProxyOptions?

Properties

val timeout

Duration

Таймаут для HTTP-запросов.

val useCache

Boolean

Использовать HTTP кэш.

val cacheStoragePath

String?

Путь к каталогу верхнего уровня для основного файлового хранилища HTTP кэша. Файловое хранилище будет находиться в подкаталоге http_cache в данном каталоге. Если путь не указан, будет использоваться директория по умолчанию.

val cacheMaxSize

Long?

Максимальный размер HTTP-кеша в байтах. Если не указан, по умолчанию максимальный размер HTTP кэша составляет 300 Мб.

val certificates

List?<Certificate>

Сертификаты в PEM-формате. Если не заданы, используются системные + поставляемые вместе с SDK.

val proxy

HttpProxyOptions?

Настройки proxy.

HttpProxyOptions

Настройки proxy.

HttpProxyOptions(host: String, port: Int = 0)

Настройки proxy.

Parameters

host

String

port

Int

Properties

val host

String

val port

Int

HttpRequest

Структура для представления HTTP запроса.

HttpRequest(
	url: String,
	method: HttpMethod = HttpMethod.GET,
	headers: List<HttpHeader> = listOf(),
	body: ByteArray? = null
)

Структура для представления HTTP запроса.

Parameters

url

String

method

HttpMethod

headers

List<HttpHeader>

body

ByteArray?

Properties

val url

String

Строковое представление URL запроса.

val method

HttpMethod

Метод HTTP запроса. По умолчанию GET.

val headers

List<HttpHeader>

Заголовки запроса. По умолчанию пусто.

val body

ByteArray?

Тело запроса. По умолчанию отсутствует.

HttpResponse

Структура для представления ответа на HTTP запрос.

тело ответа хранится и обрабатывается отдельно.

HttpResponse(statusCode: HttpStatusCode, headers: List<HttpHeader>)

Структура для представления ответа на HTTP запрос.

тело ответа хранится и обрабатывается отдельно.

Parameters

statusCode

HttpStatusCode

headers

List<HttpHeader>

Properties

val statusCode

HttpStatusCode

HTTP статус код ответа от сервера.

val headers

List<HttpHeader>

Заголовки ответа.

HttpResponseCallback

Объект с обратными вызовами для обработки отправки и получения данных.

Extends: ru.dgis.sdk.NativeObject

Methods

fun onResponse(response: HttpResponse): Boolean

Метод, обрабатывающий получение ответа от сервера.

Parameters

response

HttpResponse

ответ от сервера.

Returns

Boolean

возвращает false если SDK отменил отправку/обработку запроса.

fun onReceive(body: ByteArray, size: Int): Boolean

Метод, обрабатывающий получение тела ответа. Обработка может вестись по частям.

Parameters

body

ByteArray

тело (или его часть) ответа от сервера.

size

Int

размер данных в байтах.

Returns

Boolean

возвращает false если SDK отменил отправку/обработку запроса.

При обработке присутствует копирование данных для передачи из Java в с++. Рекомендуется передавать данные небольшими кусками.

fun onFinished(): Unit

Метод, оповещающий об окончании обработки запроса. Необходимо вызывать в конце процесса обработки. Даже если запрос был отменен на стороне SDK.

Отсутствие вызова метода может привести к отказу работы сети в SDK.

Returns

Unit

HttpStatusCode

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

HttpStatusCode(value: Int = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Int

Properties

val value

Int

Image

Изображение.

Extends: ru.dgis.sdk.NativeObject

ImageData

Данные изображения: размер, формат и бинарные данные.

ImageData(
	size: ScreenSize,
	format: ImageFormat,
	data: ByteArray
)

Данные изображения: размер, формат и бинарные данные.

Parameters

size

ScreenSize

format

ImageFormat

data

ByteArray

Methods

fun toBitmap(): Bitmap

Returns

Bitmap

Properties

val size

ScreenSize

val format

ImageFormat

val data

ByteArray

IncompleteTextHandler

Предложено автодополнение для введенного пользователем текста.

Extends: ru.dgis.sdk.NativeObject

Properties

val queryText

String

Нужно подставить в строку поиска этот текст и дать пользователю продолжить вводить запрос.

val searchQuery

SearchQuery

Сформированный запрос для поиска по query_text.

IndoorBuilding

Здание с этажными планами.

Extends: ru.dgis.sdk.NativeObject

Methods

fun linkedWith(other: IndoorBuilding): Boolean

Признак того, что текущее здание и other связаны.

Несколько зданий с этажными планами могут быть связаны между собой. Группа связанных зданий ведёт себя как единое целое:

• метод levels() выдаёт объединённый список этажей по всей группе;
• активный режим отображения меняется согласованно у всей группы.

Parameters

other

IndoorBuilding

Returns

Boolean

Properties

val id

DgisObjectId

Идентификатор здания с этажными планами.

val defaultLevelIndex

Long

Индекс этажа по умолчанию.

val levels

List<LevelInfo>

Информация обо всех этажах.

val activeLevelIndexChannel

StatefulChannel<Long>

Порядковый индекс активного этажа в levels.

var activeLevelIndex

Long

Порядковый индекс активного этажа в levels.

val modeChannel

StatefulChannel<IndoorBuildingMode>

Активный режим. Если ActiveLevelMode, то index указывает порядковый индекс активного этажа в levels. Если OverviewMode, значит, активен обзорный вид на здание.

var mode

IndoorBuildingMode

Активный режим. Если ActiveLevelMode, то index указывает порядковый индекс активного этажа в levels. Если OverviewMode, значит, активен обзорный вид на здание.

IndoorBuildingMode

Режим отображения здания.

IndoorBuildingMode(activeLevel: ActiveLevelMode)

Parameters

activeLevel

ActiveLevelMode

IndoorBuildingMode(overview: OverviewMode)

Parameters

overview

OverviewMode

Methods

fun match(activeLevel: Function1, overview: Function1): T

Parameters

activeLevel

(ActiveLevelMode) -> T

overview

(OverviewMode) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isActiveLevel

Boolean

val asActiveLevel

ActiveLevelMode?

val isOverview

Boolean

val asOverview

OverviewMode?

val value

Any?

IndoorControl

Контрол этажей.

Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.

Extends: ru.dgis.sdk.map.MapControl

IndoorControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контрол этажей.

Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

Properties

var markedLevels

Set<LevelId>

Этажи, на которых отображаются пометки.

IndoorControlModel

Модель элемента управления этажами.

Extends: ru.dgis.sdk.NativeObject

IndoorControlModel(map: Map)

Parameters

map

Map

Methods

fun isLevelMarked(index: Long): Boolean

Нужно ли отображать пометку у этажа с указанным индексом.

Parameters

index

Long

Returns

Boolean

Properties

val activeLevelIndexChannel

StatefulChannel<Long?>

Индекс активного этажа.

var activeLevelIndex

Long?

Индекс активного этажа.

var markedLevels

Set<LevelId>

Этажи, на которых отображаются пометки.

val levelNamesChannel

StatefulChannel<List<String>>

Названия этажей. Пусто, если на карте не отображается здание с этажными планами.

val levelNames

List<String>

Названия этажей. Пусто, если на карте не отображается здание с этажными планами.

IndoorDetector

Детектор, который определяет находится ли пользователь в помещении.

Extends: ru.dgis.sdk.NativeObject

Properties

val indoorChannel

StatefulChannel<Boolean>

Канал, который оповещает о нахождении пользователя в помещении.

val indoor

Boolean

Канал, который оповещает о нахождении пользователя в помещении.

IndoorManager

Класс для получения текущего здания с этажными планами.

Extends: ru.dgis.sdk.NativeObject

Methods

fun setIndoorState(newState: IndoorManagerState): Unit

Переключение включенности/выключенности менеджера этажных планов

Parameters

newState

IndoorManagerState

Returns

Unit

Properties

val focusedBuildingChannel

StatefulChannel<IndoorBuilding?>

Получение текущего здания с этажными планами.

val focusedBuilding

IndoorBuilding?

Получение текущего здания с этажными планами.

IndoorRouteLevelsGetter

Позволяет получать множество этажей, через которые проходят маршруты, отображаемые на карте.

Extends: ru.dgis.sdk.NativeObject

IndoorRouteLevelsGetter(map: Map)

Parameters

map

Map

Properties

val levelIdsChannel

StatefulChannel<Set<LevelId>>

val levelIds

Set<LevelId>

InputEvent

Событие пользовательского ввода.

Extends: ru.dgis.sdk.map.Event

Properties

val timestamp

Duration

Получение времени регистрации события ввода.

InstructionRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<InstructionRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<InstructionRouteEntry>

fun findNearBackward(point: RoutePoint): InstructionRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

InstructionRouteEntry?

fun findNearForward(point: RoutePoint): InstructionRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

InstructionRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

InstructionRouteEntry?

Первый элемент.

val last

InstructionRouteEntry?

Последний элемент.

val entries

List<InstructionRouteEntry>

Все элементы.

InstructionRouteEntry

Элемент маршрута - точка и значение в ней.

InstructionRouteEntry(point: RoutePoint, value: RouteInstruction)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

RouteInstruction

Properties

val point

RoutePoint

val value

RouteInstruction

IntRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<IntRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<IntRouteEntry>

fun findNearBackward(point: RoutePoint): IntRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

IntRouteEntry?

fun findNearForward(point: RoutePoint): IntRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

IntRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

IntRouteEntry?

Первый элемент.

val last

IntRouteEntry?

Последний элемент.

val entries

List<IntRouteEntry>

Все элементы.

IntRouteEntry

Элемент маршрута - точка и значение в ней.

IntRouteEntry(point: RoutePoint, value: Int)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

Int

Properties

val point

RoutePoint

val value

Int

IsOpenAllDay

Работает круглосуточно в указанный день недели. Если день не указан - проверяется сегодняшний день.

IsOpenAllDay(weekDay: WeekDay?)

Работает круглосуточно в указанный день недели. Если день не указан - проверяется сегодняшний день.

Parameters

weekDay

WeekDay?

Properties

val weekDay

WeekDay?

IsOpenNow

Открыто сейчас.

IsOpenNow()

Открыто сейчас.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

ItemMarkerInfo

Идентификатор объекта и его координаты.

Extends: ru.dgis.sdk.NativeObject

Properties

val objectId

DgisObjectId?

val geoPoint

GeoPointWithElevation

val floorInfo

FloorInfo?

val title

String?

val rubricIds

List<RubricId>

val tradeLicense

TradeLicense?

Для получения данной информации запросите дополнительную настройку ключа.

KeyFromAsset

Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.

KeyFromAsset(path: String)

Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.

Parameters

path

String

Properties

val path

String

Путь относительно корневой директории asset-ов.

KeyFromFile

Ключ из файла.

KeyFromFile(path: String)

Ключ из файла.

Parameters

path

String

Properties

val path

String

Путь к файлу.

KeyFromString

Ключ из строки.

KeyFromString(contents: String)

Ключ из строки.

Parameters

contents

String

Properties

val contents

String

Содержимое.

KeySource

Источник ключа.

KeySource(fromAsset: KeyFromAsset)

Parameters

fromAsset

KeyFromAsset

KeySource(fromFile: KeyFromFile)

Parameters

fromFile

KeyFromFile

KeySource(fromString: KeyFromString)

Parameters

fromString

KeyFromString

Methods

fun match(
	fromAsset: Function1,
	fromFile: Function1,
	fromString: Function1
): T

Parameters

fromAsset

(KeyFromAsset) -> T

fromFile

(KeyFromFile) -> T

fromString

(KeyFromString) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isFromAsset

Boolean

val asFromAsset

KeyFromAsset?

val isFromFile

Boolean

val asFromFile

KeyFromFile?

val isFromString

Boolean

val asFromString

KeyFromString?

val value

Any?

LabelingPriority

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

LabelingPriority(value: Byte = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Byte

Properties

val value

Byte

LaneSignRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): LaneSignRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

LaneSignRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<LaneSignRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<LaneSignRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

LaneSignRouteLongEntry?

Первый элемент.

val last

LaneSignRouteLongEntry?

Последний элемент.

val entries

List<LaneSignRouteLongEntry>

Все элементы.

LaneSignRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

LaneSignRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RouteLaneSign
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RouteLaneSign

Properties

val point

RoutePoint

val length

RouteDistance

val value

RouteLaneSign

Latitude

Географическая широта.

Latitude(value: Double = 0.0)

Географическая широта.

Parameters

value

Double

Properties

val value

Double

LazyMapControllerViewModel

MapControllerViewModel that creates T on the first read of state and delegates to it.

For owners that build the model in advance but may never show the map: the map is created when a view actually subscribes to the state. Closing closes the wrapped model if it was created.

Main thread only.

Implements: ru.dgis.sdk.map.MapControllerViewModel

LazyMapControllerViewModel(factory: Function0<T>)

MapControllerViewModel that creates T on the first read of state and delegates to it.

For owners that build the model in advance but may never show the map: the map is created when a view actually subscribes to the state. Closing closes the wrapped model if it was created.

Main thread only.

Parameters

factory

() -> T

Methods

fun close(): Unit

Returns

Unit

suspend fun awaitController(): MapController

Suspends until the map is created and returns its controller.

Returns

MapController

suspend fun awaitMap(): Map

Same as awaitController, but returns Map of the controller.

Returns

Map

Properties

val state

<ERROR CLASS><MapControllerState>

Current state of the map.

val controller

MapController?

The controller, or null if the map is not created. Does not wait.

val map

Map?

The map, or null if it is not created. Does not wait.

LevelId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

LevelId(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

LevelInfo

Информация об этаже здания.

LevelInfo(
	id: LevelId?,
	name: String,
	linkedLevelIds: List<LevelId>
)

Информация об этаже здания.

Parameters

id

LevelId?

name

String

linkedLevelIds

List<LevelId>

Properties

val id

LevelId?

Идентификатор этажного плана.

val name

String

Название этажа.

val linkedLevelIds

List<LevelId>

Идентификаторы связанных этажных планов.

Locale

Локаль.

Locale(language: String, region: String)

Локаль.

Parameters

language

String

region

String

Methods

fun toLocalePosix(): String

Returns

String

@JvmStatic
fun makeLocale(localeStr: String): Locale?

Создать локаль по строковому представлению в виде LanguageTag или POSIX.

Parameters

localeStr

String

Returns

Locale?

Properties

val language

String

Код языка, описанный в стандарте ISO 639-1,

val region

String

Код страны, описанный в стандарте ISO 3166-1.

LocaleManager

Менеджер региональных настроек приложения.

Extends: ru.dgis.sdk.NativeObject

Methods

fun overrideLocales(locales: List<Locale>): Unit

Установка списка локалей приложения

Parameters

locales

List<Locale>

Returns

Unit

@JvmStatic
fun instance(context: Context): LocaleManager

Интерфейс управления локалями приложения.

Parameters

context

Context

Returns

LocaleManager

Properties

val localesChannel

StatefulChannel<List<Locale>>

Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.

val locales

List<Locale>

Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.

val systemLocalesChannel

StatefulChannel<List<Locale>>

Получение локалей, предоставляемых ОС.

Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).

val systemLocales

List<Locale>

Получение локалей, предоставляемых ОС.

Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).

Location

Location(
	coordinates: LocationCoordinates,
	altitude: LocationFuzzyDouble?,
	course: LocationCourse?,
	groundSpeed: LocationFuzzyDouble?,
	source: String,
	timestamp: Duration = Duration.ofMilliseconds(0)
)

Parameters

coordinates

LocationCoordinates

altitude

LocationFuzzyDouble?

course

LocationCourse?

groundSpeed

LocationFuzzyDouble?

source

String

timestamp

Duration

Properties

val coordinates

LocationCoordinates

val altitude

LocationFuzzyDouble?

val course

LocationCourse?

val groundSpeed

LocationFuzzyDouble?

val source

String

val timestamp

Duration

LocationCoordinates

LocationCoordinates(value: GeoPoint, accuracy: Double)

Parameters

value

GeoPoint

accuracy

Double

Properties

val value

GeoPoint

val accuracy

Double

LocationCourse

LocationCourse(value: Bearing, accuracy: Bearing?)

Parameters

value

Bearing

accuracy

Bearing?

Properties

val value

Bearing

val accuracy

Bearing?

LocationFuzzyDouble

LocationFuzzyDouble(value: Double, accuracy: Double?)

Parameters

value

Double

accuracy

Double?

Properties

val value

Double

val accuracy

Double?

LogicalPixel

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

LogicalPixel(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

LogMessage

Сообщение, записываемое в лог.

LogMessage(
	level: LogLevel,
	text: String,
	file: String,
	line: Int
)

Сообщение, записываемое в лог.

Parameters

level

LogLevel

text

String

file

String

line

Int

Properties

val level

LogLevel

Уровень логирования.

val text

String

Содержимое сообщения.

val file

String

Имя файла, в котором было записано сообщение.

val line

Int

Номер строки, в которой было записано сообщение.

LogOptions

Настройки логирования.

LogOptions(
	systemLevel: LogLevel = LogLevel.WARNING,
	customLevel: LogLevel = LogLevel.WARNING,
	customSink: LogSink? = null
)

Настройки логирования.

Parameters

systemLevel

LogLevel

customLevel

LogLevel

customSink

LogSink?

Properties

val systemLevel

LogLevel

Уровень логирования в системный лог.

val customLevel

LogLevel

Уровень логирования в пользовательский приемник.

val customSink

LogSink?

Пользовательский приемник логирования.

Longitude

Географическая долгота.

Longitude(value: Double = 0.0)

Географическая долгота.

Parameters

value

Double

Properties

val value

Double

MagneticChangeListener

Класс, отслеживающий изменения направления компаса и его доступность.

Extends: ru.dgis.sdk.NativeProxy

Methods

fun onValueChanged(
	yaw: Float,
	accuracy: Float?,
	timestamp: Long
): Unit

Parameters

yaw

Float

accuracy

Float?

timestamp

Long

Returns

Unit

fun onAvailabilityChanged(availability: Boolean): Unit

Parameters

availability

Boolean

Returns

Unit

ManeuverControl

Extends: ru.dgis.sdk.navigation.NavigationControl

ManeuverControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

Map

Карта.

Extends: ru.dgis.sdk.NativeObject

Methods

fun resetFontIconSizeMultiplier(): Unit

Сбросить множитель размера для иконок.

Returns

Unit

fun addSource(source: Source): Unit

Добавление источника данных на карту.

Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.

Parameters

source

Source

Returns

Unit

fun removeSource(source: Source): Unit

Удаление источника данных из карты.

Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.

Parameters

source

Source

Returns

Unit

fun getRenderedObjects(centerPoint: ScreenPoint, radius: ScreenDistance = ScreenDistance(value = 1.0f)): Future<List<RenderedObjectInfo>>

Получение отображаемых объектов карты, проецирующихся на окружность на экране.

Parameters

centerPoint

ScreenPoint

центр окружности.

radius

ScreenDistance

радиус окружности.

Список объектов формируется в порядке отрисовки от поздних к ранним.

Returns

Future<List<RenderedObjectInfo>>

fun sublayerAttributes(sublayerName: String): Attributes

Получение атрибутов подслоя.

Parameters

sublayerName

String

Название подслоя.

Полученные атрибуты содержат только добавленные туда ранее (явно).

Returns

Attributes

fun setAttribute(name: String, value: AttributeValue): Unit

Parameters

name

String

value

AttributeValue

Returns

Unit

fun removeAttribute(name: String): Unit

Parameters

name

String

Returns

Unit

Properties

val id

MapId

Идентификатор экземпляра карты, уникальный в рамках процесса.

val camera

Camera

Получение камеры.

val indoorManager

IndoorManager

Получение менеджера этажных планов.

val dataLoadingStateChannel

StatefulChannel<MapDataLoadingState>

Нотификация о состоянии загружаемых в карту данных.

При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.

val dataLoadingState

MapDataLoadingState

Нотификация о состоянии загружаемых в карту данных.

При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.

val styleChannel

StatefulChannel<Style>

Получение текущих стилей карты.

var style

Style

Получение текущих стилей карты.

val fontIconSizeMultiplierChannel

StatefulChannel<Float>

Множитель размера иконок и шрифтов, полученный из приложения.

Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.

var fontIconSizeMultiplier

Float

Множитель размера иконок и шрифтов, полученный из приложения.

Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.

val sources

List<Source>

Получение источников данных карты.

Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.

val mapVisibilityStateChannel

StatefulChannel<MapVisibilityState>

var mapVisibilityState

MapVisibilityState

val attributes

Attributes

Получение атрибутов.

должны быть указаны свойства: "theme"="day|night" "navigatorOn"="true|false"

TODO: стилевые свойства для пробок

val interactiveChannel

StatefulChannel<Boolean>

Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).

функция может быть вызвана из любого потока.

var interactive

Boolean

Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).

функция может быть вызвана из любого потока.

val graphicsPresetHintChannel

StatefulChannel<GraphicsPreset?>

Получение рекомендуемого режима графики для данного устройства.

val graphicsPresetHint

GraphicsPreset?

Получение рекомендуемого режима графики для данного устройства.

val graphicsPresetChannel

StatefulChannel<GraphicsPreset?>

Получение режима графики. В случае null используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.

var graphicsPreset

GraphicsPreset?

Получение режима графики. В случае null используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.

val universeDrawingModeChannel

StatefulChannel<UniverseDrawingMode>

Режим отображения Universe.

var universeDrawingMode

UniverseDrawingMode

Режим отображения Universe.

val themeChannel

StatefulChannel<MapTheme>

Текущая тема, установленная в соответствии с appearance.

val theme

MapTheme

Текущая тема, установленная в соответствии с appearance.

var appearance

MapAppearance

Текущий внешний вид карты.

MapAppearance

MapAppearance(bySystem: BySystem)

Parameters

bySystem

BySystem

MapAppearance(fixed: Fixed)

Parameters

fixed

Fixed

Methods

fun match(bySystem: Function1, fixed: Function1): T

Parameters

bySystem

(BySystem) -> T

fixed

(Fixed) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun effectiveTheme(isPlatformDarkMode: Boolean): MapTheme

Тема карты, которую задаёт этот внешний вид: для BySystem - светлая или тёмная по платформенному тёмному режиму, для Fixed - всегда его тема, независимо от is_platform_dark_mode.

Parameters

isPlatformDarkMode

Boolean

Returns

MapTheme

@JvmStatic
fun defaultAppearance(): MapAppearance

Внешний вид карты по умолчанию: следование системной теме со стандартными светлой (default_theme) и тёмной (default_dark_theme) темами.

Returns

MapAppearance

@JvmStatic
fun defaultAppearanceInverted(): MapAppearance

Внешний вид карты по умолчанию с перевёрнутыми темами: светлая тема в платформенном тёмном режиме и наоборот.

Returns

MapAppearance

Properties

val isBySystem

Boolean

val asBySystem

BySystem?

val isFixed

Boolean

val asFixed

Fixed?

val value

Any?

MapControl

Base class for map UI controls.

A control placed inside a MapView binds to its map automatically while attached to the window; the map view owns the binding and rebinds the control on map changes. A control placed outside a MapView is bound explicitly via bindToMap.

MapControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Base class for map UI controls.

A control placed inside a MapView binds to its map automatically while attached to the window; the map view owns the binding and rebinds the control on map changes. A control placed outside a MapView is bound explicitly via bindToMap.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun bindToMap(controller: MapController, mapView: View): Unit

Parameters

controller

MapController

mapView

View

Returns

Unit

fun bindToMap(map: Map, mapView: View): Unit

Parameters

map

Map

mapView

View

Returns

Unit

fun unbindFromMap(): Unit

Returns

Unit

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

Properties

var mapView

View?

MapController

Готовая к показу карта вместе с рендерером и распознавателем жестов.

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun create(context: Context, options: MapControllerOptions): Future<MapController>

Создаёт карту с параметрами из options.

Parameters

context

Context

контекст SDK. Должен быть валиден на время создания карты.

options

MapControllerOptions

параметры начального состояния карты.

Returns

Future<MapController>

future с готовым MapController либо с ошибкой создания.

Properties

val map

Map

Карта, управляемая этим контроллером.

val renderer

MapRenderer

Рендерер карты.

val gestureRecognizer

MapGestureRecognizer

Распознаватель жестов карты.

val renderedObjectObserver

MapRenderedObjectObserver

Наблюдатель за объектами карты.

MapControllerOptions

MapControllerOptions(
	position: CameraPosition? = null,
	positionPoint: CameraPositionPoint? = null,
	zoomRestrictions: CameraZoomRestrictions? = null,
	sources: List<Source> = listOf(),
	attributes: Map = mapOf(),
	style: Style? = null,
	styleFile: File? = null,
	fontIconSizeMultiplier: Float? = null,
	graphicsPreset: GraphicsPreset? = null,
	mapAppearance: MapAppearance? = null,
	maxFps: Fps? = null,
	powerSavingMaxFps: Fps? = null
)

Parameters

position

CameraPosition?

positionPoint

CameraPositionPoint?

zoomRestrictions

CameraZoomRestrictions?

sources

List<Source>

attributes

Map

style

Style?

styleFile

File?

fontIconSizeMultiplier

Float?

graphicsPreset

GraphicsPreset?

mapAppearance

MapAppearance?

maxFps

Fps?

powerSavingMaxFps

Fps?

Properties

val position

CameraPosition?

Начальная позиция камеры. Не задано: позиция по умолчанию.

val positionPoint

CameraPositionPoint?

Относительное расположение точки местоположения карты в пространстве вида камеры.

val zoomRestrictions

CameraZoomRestrictions?

Начальный допустимый диапазон изменения уровня масштабирования. Не задано: диапазон по умолчанию.

val sources

List<Source>

Источники данных, добавляемые на карту при создании.

val attributes

Map

Атрибуты карты, применяемые при создании.

val style

Style?

Cтиль карты. Не задано: используется стиль по умолчанию.

val styleFile

File?

Файл стиля карты. Не задано: используется стиль по умолчанию.

val fontIconSizeMultiplier

Float?

Множитель размера иконок и шрифтов. Не задано: множитель не применяется.

val graphicsPreset

GraphicsPreset?

Графический пресет качества. Не задано: пресет по умолчанию.

val mapAppearance

MapAppearance?

Выбор темы внутри выбранного стиля карты с учётом окружения.

val maxFps

Fps?

Ограничение частоты кадров. Не задано: ограничения нет.

val powerSavingMaxFps

Fps?

Ограничение частоты кадров в режиме энергосбережения. Не задано: ограничения нет.

MapControls

Элементы управления картой во время навигации.

Extends: ru.dgis.sdk.map.MapControl

MapControls(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Элементы управления картой во время навигации.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onTouchEvent(event: MotionEvent): Boolean

Parameters

event

MotionEvent

Returns

Boolean

fun onLayout(
	changed: Boolean,
	left: Int,
	top: Int,
	right: Int,
	bottom: Int
): Unit

Parameters

changed

Boolean

left

Int

top

Int

right

Int

bottom

Int

Returns

Unit

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

Properties

var isAddRoadEventButtonVisible

Boolean

var isTrafficAndParkingControlHidden

Boolean

val visibilityChannel

StatefulChannel<Boolean>

MapCopyrightOptions

Configuration options for the copyright notice displayed on the map.

This data class allows you to customize the position, margins, visibility of the API version, link handling behavior, and system insets application for the copyright label.

MapCopyrightOptions(
	gravity: Int = Gravity.BOTTOM or Gravity.END,
	margins: CopyrightMargins = CopyrightMargins(),
	showApiVersion: Boolean = false,
	uriOpener: Function1? = null,
	insetsSides: Int? = null
)

Configuration options for the copyright notice displayed on the map.

This data class allows you to customize the position, margins, visibility of the API version, link handling behavior, and system insets application for the copyright label.

Parameters

gravity

Int

margins

CopyrightMargins

showApiVersion

Boolean

uriOpener

(String) -> Unit

insetsSides

Int?

Properties

val gravity

Int

Placement of the copyright inside the map view.

Uses Android gravity constants (e.g., Gravity.BOTTOM or Gravity.END). The default is bottom-end corner.

val margins

CopyrightMargins

Margins of the copyright.

Defines the spacing between the copyright label and the edges of the map view. Default margins are provided by CopyrightMargins.

val showApiVersion

Boolean

Whether to show the SDK version next to the copyright.

When true, the version number of the SDK will be appended to the copyright text.

val uriOpener

(String) -> Unit

Custom handler for links in the copyright.

null does not disable link handling — it means the default handler (opens the link in the browser). Passing null after a custom handler reverts to the default one.

val insetsSides

Int?

Sides from which system insets are applied to the copyright.

A bit mask of CopyrightInsetsSide values. If null, all sides are applied.

MapDirection

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

MapDirection(value: Double = 0.0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Double

Properties

val value

Double

MapGestureRecognizer

Принимает информацию о нажатиях и преобразует их в жесты карты. Обработка происходит в два этапа:

• Добавляется несколько точек - add_touch_point
• Точки обрабатываются - process_touch_event

Extends: ru.dgis.sdk.NativeObject

Properties

val dragBegin

Channel<DragBeginData>

val dragEnd

Channel<Boolean>

val dragMove

Channel<ScreenPoint>

val tap

Channel<ScreenPoint>

val longTouch

Channel<ScreenPoint>

val gestureManager

GestureManager?

MapId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

MapId(value: Int = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Int

Properties

val value

Int

MapLocationController

Контроллер для управления позиционированием карты в навигаторе.

Extends: ru.dgis.sdk.NativeObject

Properties

var mapToNorthOrientation

Boolean

Включена ли принудительная ориентация карты на север.

var userControlOverMap

Boolean

Признак использования пользовательских значений зума и наклона для отображения карты.

MapManager

Интерфейс, позволяющий добавлять карты в навигатор и убирать их из него.

Extends: ru.dgis.sdk.NativeObject

Methods

fun addMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun removeMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

MapObject

Объект на карте.

Extends: ru.dgis.sdk.NativeObject

Properties

var userData

Any?

Произвольные пользовательские данные, прикрепленные к объекту.

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

MapObjectManager

Extends: ru.dgis.sdk.NativeObject

MapObjectManager(map: Map, layerId: String? = null)

Создать IMapObjectManager.

Parameters

map

Map

layerId

String?

ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.

Methods

fun addObject(item: SimpleMapObject): Unit

Добавить объект.

Parameters

item

SimpleMapObject

Returns

Unit

fun removeObject(item: SimpleMapObject): Unit

Удалить объект.

Parameters

item

SimpleMapObject

Returns

Unit

fun addObjects(objects: List<SimpleMapObject>): Unit

Добавить объекты.

Parameters

objects

List<SimpleMapObject>

Returns

Unit

fun removeObjects(objects: List<SimpleMapObject>): Unit

Удалить объекты.

Parameters

objects

List<SimpleMapObject>

Returns

Unit

fun removeAndAddObjects(objectsToRemove: List<SimpleMapObject>, objectsToAdd: List<SimpleMapObject>): Unit

Удалить и добавить объекты.

Parameters

objectsToRemove

List<SimpleMapObject>

objectsToAdd

List<SimpleMapObject>

Returns

Unit

fun removeAll(): Unit

Returns

Unit

fun clusteringObjects(position: CameraPosition): List<MapObject>

Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и маркеры.

Parameters

position

CameraPosition

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

Map

logicalPixel

LogicalPixel

Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает кластеризация.

maxZoom

Zoom

Уровень, начиная с которого видны все маркеры.

clusterRenderer

SimpleClusterRenderer

Интерфейс для задания параметров отображения кластера.

minZoom

Zoom

Уровень, начиная с которого формируются кластеры.

layerId

String?

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

Map

logicalPixel

LogicalPixel

Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает генерализация.

maxZoom

Zoom

Уровень, начиная с которого видны все маркеры.

minZoom

Zoom

Уровень, начиная с которого работает генерализация.

layerId

String?

ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.

Returns

MapObjectManager

Properties

var isVisible

Boolean

Переопределение видимости всех объектов, добавленных в экземпляр менеджера. Значение false здесь имеет приоритет над видимостью отдельного объекта.

MapPaddingControl

UI-элемент, задающий внутренние отступы (padding) карты.

Extends: ru.dgis.sdk.map.MapControl

MapPaddingControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент, задающий внутренние отступы (padding) карты.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun onGlobalLayout(): Unit

Returns

Unit

MapRenderedObjectObserver

Наблюдатель за взаимодействиями с рендеренными объектами на карте.

Этот интерфейс предоставляет каналы для прослушивания событий взаимодействия пользователя с рендеренными объектами на карте, такими как касания и долгие нажатия.

Extends: ru.dgis.sdk.NativeObject

Properties

val objectTapped

Channel<List<RenderedObjectInfo>>

Канал, который возвращает список RenderedObjectInfo при касании пользователем рендеренного объекта. Может быть пустым, при тапе мимо объекта.

val objectLongTouched

Channel<List<RenderedObjectInfo>>

Канал, который возвращает список RenderedObjectInfo при долгом нажатии пользователем на рендеренный объект. Может быть пустым, при долгом нажатии мимо объекта.

MapRenderer

Создание этого объекта приводит к началу рисования карты.

Extends: ru.dgis.sdk.NativeObject

Methods

fun setMaxFps(maxFps: Fps?, powerSavingMaxFps: Fps?): Unit

Parameters

maxFps

Fps?

powerSavingMaxFps

Fps?

Returns

Unit

fun takeSnapshot(copyrightAlign: Alignment): Future<ImageData>

Parameters

copyrightAlign

Alignment

Returns

Future<ImageData>

Properties

val maxFps

Fps?

val powerSavingMaxFps

Fps?

val fpsChannel

StatefulChannel<Fps>

val fps

Fps

MapRenderOptions

Rendering options for the map (view-layer).

This configuration affects how the map is rendered on screen, including the underlying surface type and device-specific scaling parameters. Note that this does not contain map-specific parameters like style, camera, or data sources — those are specified via MapControllerOptions.

MapRenderOptions(
	renderMode: MapRenderMode = MapRenderMode.SURFACE,
	devicePpi: DevicePpi? = null,
	deviceDensity: DeviceDensity? = null
)

Rendering options for the map (view-layer).

This configuration affects how the map is rendered on screen, including the underlying surface type and device-specific scaling parameters. Note that this does not contain map-specific parameters like style, camera, or data sources — those are specified via MapControllerOptions.

Parameters

renderMode

MapRenderMode

devicePpi

DevicePpi?

deviceDensity

DeviceDensity?

Properties

val renderMode

MapRenderMode

Rendering mode: MapRenderMode.SURFACE (better performance) or MapRenderMode.TEXTURE (the map takes part in window animations).

val devicePpi

DevicePpi?

Device PPI for correct map scaling. If null, it is automatically determined from DisplayMetrics.

val deviceDensity

DeviceDensity?

Screen density (density multiplier). If null, it is automatically determined from DisplayMetrics.

MapRotationBeginEvent

Событие начала вращения карты вокруг точки.

Extends: ru.dgis.sdk.map.Event

MapRotationBeginEvent(direction: MapRotationDirection)

Parameters

direction

MapRotationDirection

Properties

val direction

MapRotationDirection

Направление вращения карты.

MapRotationEndEvent

Событие окончания вращения карты вокруг точки.

Extends: ru.dgis.sdk.map.Event

MapRotationEndEvent()

MapScalingBeginEvent

Событие начала изменения масштаба.

Extends: ru.dgis.sdk.map.Event

MapScalingBeginEvent(direction: MapScalingDirection)

Parameters

direction

MapScalingDirection

Properties

val direction

MapScalingDirection

Направление изменения масштаба карты.

MapScalingEndEvent

Событие окончания изменения масштаба.

Extends: ru.dgis.sdk.map.Event

MapScalingEndEvent()

MapShiftBeginEvent

Событие начала сдвига карты.

Extends: ru.dgis.sdk.map.Event

MapShiftBeginEvent(direction: MapShiftDirection)

Parameters

direction

MapShiftDirection

Properties

val direction

MapShiftDirection

Направление смещения карты.

MapShiftEndEvent

Событие окончания смещения карты.

Extends: ru.dgis.sdk.map.Event

MapShiftEndEvent()

MapTheme

Тема для использования в карте.

MapTheme(name: String, loadingBackground: Color)

Тема для использования в карте.

Parameters

name

String

loadingBackground

Color

Properties

val name

String

Код стиля из редактора стилей.

val loadingBackground

Color

Цвет подложки, используемый до загрузки стилей и отображения подложки карты. В темах по умолчанию соответствует цвету подложки карты по умолчанию.

val defaultTheme

MapTheme

Стандартная светлая тема для базовых стилей

val defaultDarkTheme

MapTheme

Стандартная темная тема для базовых стилей

MapView

View that renders the map of an attached MapControllerViewModel.

A MapControl or SnapToMapLayout placed inside this view (at any depth) finds it and binds to its map automatically while attached to the window. Controls placed outside the view are bound explicitly via their bindToMap.

MapView(
	context: Context,
	renderOptions: MapRenderOptions = MapRenderOptions(),
	copyrightOptions: MapCopyrightOptions = MapCopyrightOptions()
)

Parameters

context

Context

renderOptions

MapRenderOptions

copyrightOptions

MapCopyrightOptions

MapView(context: Context, attrs: AttributeSet)

Constructor used when the view is declared in an XML layout.

Only view-level settings are read from XML: dgis_renderMode goes to MapRenderOptions.renderMode, dgis_copyrightInsetsSides goes to MapCopyrightOptions.insetsSides. Map settings (camera, style, sources, appearance) belong to MapControllerOptions and are not configurable from XML.

Parameters

context

Context

attrs

AttributeSet

Methods

fun setMapControllerViewModel(viewModel: MapControllerViewModel?): Unit

Attaches the view to a MapControllerViewModel: the view follows its state and renders the map once it is created. null detaches the view from the current view model and hides the map.

The view does not own the view model and never closes it.

Parameters

viewModel

MapControllerViewModel?

Returns

Unit

fun useCustomGestureRecognitionEngine(engine: MapGestureRecognitionEngine): Unit

Parameters

engine

MapGestureRecognitionEngine

Returns

Unit

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

fun onWindowVisibilityChanged(visibility: Int): Unit

Parameters

visibility

Int

Returns

Unit

fun onConfigurationChanged(newConfig: Configuration): Unit

Parameters

newConfig

Configuration

Returns

Unit

Properties

var renderOptions

MapRenderOptions

Текущие опции рендеринга. При смене MapRenderOptions.renderMode поверхность рендеринга пересоздаётся на лету; возможен кратковременный blank frame. Все остальные поля применяются без визуальных артефактов.

var copyrightOptions

MapCopyrightOptions

Текущие настройки копирайта. Setter применяет изменения атомарно и переиспользует актуальные WindowInsets.

MarkedByRouteIndoorControl

UI-элемент, где отмечены этажи, через которые на карте проходят маршруты.

Extends: ru.dgis.sdk.map.IndoorControl

MarkedByRouteIndoorControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент, где отмечены этажи, через которые на карте проходят маршруты.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

MarkedUpText

Размеченный текст.

MarkedUpText(text: String, matchedParts: List<MarkedUpTextSpan>)

Размеченный текст.

Parameters

text

String

matchedParts

List<MarkedUpTextSpan>

Properties

val text

String

Текст.

val matchedParts

List<MarkedUpTextSpan>

Набор непересекающихся Span в порядке их расположения в строке text, описывающих части, совпадающие с пользовательским запросом.

MarkedUpTextSpan

Описывает поднабор байтов строки text.

MarkedUpTextSpan(offset: Long, length: Long)

Описывает поднабор байтов строки text.

Parameters

offset

Long

length

Long

Properties

val offset

Long

val length

Long

Marker

Точечная отметка на карте, представляющая интерес для пользователя.

Extends: ru.dgis.sdk.map.SimpleMapObject

Marker(options: MarkerOptions)

Parameters

options

MarkerOptions

Properties

var position

GeoPointWithElevation

Получение местоположения маркера.

var icon

Image?

Получение иконки маркера.

var anchor

Anchor

Получение точки привязки иконки маркера.

var iconOpacity

Opacity

Получение прозрачности иконки маркера.

var text

String

Получение подписи маркера.

var textStyle

TextStyle

Получение стиля подписи маркера.

var isDraggable

Boolean

Получение флага перемещаемости маркера.

var iconWidth

LogicalPixel

Получение целевой ширины маркера, используемой для масштабирования.

var iconMapDirection

MapDirection?

Угол поворота маркера на карте относительно направления на север, по часовой стрелке.

var animatedAppearance

Boolean

Анимировать ли появление.

var iconAnimationMode

AnimationMode

Получение режима анимации анимированного маркера.

var labelingPriority

LabelingPriority

Получение приоритета лейблинга маркера.

var suppressOnOverlap

Boolean

Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).

MarkerOptions

Параметры маркера.

MarkerOptions(
	position: GeoPointWithElevation,
	icon: Image?,
	iconMapDirection: MapDirection? = null,
	anchor: Anchor = Anchor(x = 0.5f, y = 0.5f),
	text: String? = null,
	textStyle: TextStyle? = null,
	iconOpacity: Opacity = Opacity(value = 1.0f),
	visible: Boolean = true,
	draggable: Boolean = false,
	iconWidth: LogicalPixel = LogicalPixel(value = 0.0f),
	userData: Any? = null,
	zIndex: ZIndex = ZIndex(value = 0),
	labelingPriority: LabelingPriority = LabelingPriority(value = 0),
	animatedAppearance: Boolean = true,
	levelId: LevelId? = null,
	iconAnimationMode: AnimationMode = AnimationMode.NORMAL,
	suppressOnOverlap: Boolean = false
)

Параметры маркера.

Parameters

position

GeoPointWithElevation

icon

Image?

iconMapDirection

MapDirection?

anchor

Anchor

text

String?

textStyle

TextStyle?

iconOpacity

Opacity

visible

Boolean

draggable

Boolean

iconWidth

LogicalPixel

userData

Any?

zIndex

ZIndex

labelingPriority

LabelingPriority

animatedAppearance

Boolean

levelId

LevelId?

iconAnimationMode

AnimationMode

suppressOnOverlap

Boolean

Properties

val position

GeoPointWithElevation

val icon

Image?

val iconMapDirection

MapDirection?

val anchor

Anchor

val text

String?

val textStyle

TextStyle?

val iconOpacity

Opacity

val visible

Boolean

val draggable

Boolean

val iconWidth

LogicalPixel

Целевая ширина, используемая для масштабирования.

val userData

Any?

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

val zIndex

ZIndex

Уровень отрисовки объекта.

val labelingPriority

LabelingPriority

Приоритет лейблинга иконки маркера.

val animatedAppearance

Boolean

Анимировать ли появление.

val levelId

LevelId?

Привязка к поэтажному плану здания.

val iconAnimationMode

AnimationMode

Режим анимации.

val suppressOnOverlap

Boolean

Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).

MessageControl

Extends: ru.dgis.sdk.navigation.NavigationControl

MessageControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

Meter

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Meter(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

MillisecondsRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<MillisecondsRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<MillisecondsRouteEntry>

fun findNearBackward(point: RoutePoint): MillisecondsRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

MillisecondsRouteEntry?

fun findNearForward(point: RoutePoint): MillisecondsRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

MillisecondsRouteEntry?

fun calculateDuration(routePoint: RoutePoint): Duration

Parameters

routePoint

RoutePoint

Returns

Duration

fun calculateDuration(fromRoutePoint: RoutePoint, toRoutePoint: RoutePoint): Duration

Parameters

fromRoutePoint

RoutePoint

toRoutePoint

RoutePoint

Returns

Duration

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

MillisecondsRouteEntry?

Первый элемент.

val last

MillisecondsRouteEntry?

Последний элемент.

val entries

List<MillisecondsRouteEntry>

Все элементы.

val duration

Duration

Длительность маршрута.

MillisecondsRouteEntry

Элемент маршрута - точка и значение в ней.

MillisecondsRouteEntry(point: RoutePoint, value: Duration)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

Duration

Properties

val point

RoutePoint

val value

Duration

MiniMapControlModel

Интерфейс модели контрола миникарты. Предназначен для управления позицией маркера на экране, зумом и прочим положением камеры так, чтобы маршрут было лучше видно на миникарте.

Extends: ru.dgis.sdk.NativeObject

MiniMapControlModel(
	context: Context,
	model: Model,
	map: Map
)

Parameters

context

Context

model

Model

map

Map

Model

Модель навигатора, предназначенная для отображения в UI.

Extends: ru.dgis.sdk.NativeObject

Methods

fun betterRouteResponse(response: BetterRouteResponse): Unit

Ответ пользователя о применении предложенного маршрута лучше.

Parameters

response

BetterRouteResponse

Returns

Unit

Properties

val stateChannel

StatefulChannel<State>

Состояние навигатора.

val state

State

Состояние навигатора.

val locationChannel

StatefulChannel<Location?>

Текущая геопозиция, с которой работает навигатор.

see location_available_channel

val location

Location?

Текущая геопозиция, с которой работает навигатор.

see location_available_channel

val locationAvailableChannel

StatefulChannel<Boolean>

Флаг, который указывает используется ли текущая геопозиция для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.

Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.

see location_channel

val locationAvailable

Boolean

Флаг, который указывает используется ли текущая геопозиция для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.

Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.

see location_channel

val routeChannel

StatefulChannel<RouteInfo>

Маршрут с манёврами.

В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.

val route

RouteInfo

Маршрут с манёврами.

В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.

val dynamicRouteInfoChannel

StatefulChannel<DynamicRouteInfo>

Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.

val dynamicRouteInfo

DynamicRouteInfo

Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.

val routePositionChannel

StatefulChannel<RoutePoint?>

Текущая позиция пользователя на маршруте.

val routePosition

RoutePoint?

Текущая позиция пользователя на маршруте.

val exceedingMaxSpeedLimitChannel

StatefulChannel<Boolean>

Флаг превышения максимальной разрешенной скорости.

val exceedingMaxSpeedLimit

Boolean

Флаг превышения максимальной разрешенной скорости.

val betterRouteChannel

StatefulChannel<BetterRouteInfo?>

Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно null, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.

val betterRoute

BetterRouteInfo?

Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно null, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.

val duration

Duration?

val isFreeRoam

Boolean

ModelData

Данные модели.

Extends: ru.dgis.sdk.NativeObject

ModelMapObject

Модель на карте.

Extends: ru.dgis.sdk.map.SimpleMapObject

ModelMapObject(options: ModelMapObjectOptions)

Parameters

options

ModelMapObjectOptions

Properties

var position

GeoPointWithElevation

Местоположения модели.

var modelData

ModelData?

Данные модели.

var opacity

Opacity

Прозрачность модели.

var size

ModelSize

Размер модели.

var mapDirection

MapDirection?

Угол поворота модели на карте относительно направления на север, по часовой стрелке.

val animationSettings

AnimationSettings

Настройки анимации.

ModelMapObjectOptions

Параметры модели.

ModelMapObjectOptions(
	position: GeoPointWithElevation,
	data: ModelData?,
	size: ModelSize,
	mapDirection: MapDirection? = null,
	opacity: Opacity = Opacity(value = 1.0f),
	visible: Boolean = true,
	userData: Any? = null,
	levelId: LevelId? = null
)

Параметры модели.

Parameters

position

GeoPointWithElevation

data

ModelData?

size

ModelSize

mapDirection

MapDirection?

opacity

Opacity

visible

Boolean

userData

Any?

levelId

LevelId?

Properties

val position

GeoPointWithElevation

Местоположение.

val data

ModelData?

Данные.

val size

ModelSize

Целевая ширина, используемая для масштабирования.

val mapDirection

MapDirection?

Угол поворота модели на карте относительно направления на север, по часовой стрелке.

val opacity

Opacity

Прозрачность.

val visible

Boolean

Видимость.

val userData

Any?

Пользовательские данные.

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

val levelId

LevelId?

Привязка к поэтажному плану здания.

ModelScale

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

ModelScale(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

ModelSize

Размер модели. Если LogicalPixel, то размер модели не будет привязан к масштабу карты и останется неизменным относительно экрана. Если ModelScale, то размер модели умножится на коэффициент и привяжется к масштабу карты.

ModelSize(logicalPixel: LogicalPixel)

Parameters

logicalPixel

LogicalPixel

ModelSize(scale: ModelScale)

Parameters

scale

ModelScale

Methods

fun match(logicalPixel: Function1, scale: Function1): T

Parameters

logicalPixel

(LogicalPixel) -> T

scale

(ModelScale) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isLogicalPixel

Boolean

val asLogicalPixel

LogicalPixel?

val isScale

Boolean

val asScale

ModelScale?

val value

Any?

MotorcycleBriefRouteInfo

Базовая информация об маршруте на мотоцикле.

MotorcycleBriefRouteInfo(
	length: RouteDistance,
	landmark: String,
	trafficSpeed: MotorcycleBriefRouteInfoTrafficSpeed
)

Базовая информация об маршруте на мотоцикле.

Parameters

length

RouteDistance

landmark

String

trafficSpeed

MotorcycleBriefRouteInfoTrafficSpeed

Properties

val length

RouteDistance

Длина маршрута.

val landmark

String

Ориентир.

val trafficSpeed

MotorcycleBriefRouteInfoTrafficSpeed

Скорость движения.

MotorcycleRouteSearchOptions

Параметры поиска маршрута на мотоцикле.

MotorcycleRouteSearchOptions(
	avoidTollRoads: Boolean = false,
	avoidUnpavedRoads: Boolean = false,
	avoidFerries: Boolean = false,
	avoidLockedRoads: Boolean = true,
	routeSearchType: RouteSearchType = RouteSearchType.JAM,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска маршрута на мотоцикле.

Parameters

avoidTollRoads

Boolean

avoidUnpavedRoads

Boolean

avoidFerries

Boolean

avoidLockedRoads

Boolean

routeSearchType

RouteSearchType

excludedAreas

List<ExcludedArea>

Properties

val avoidTollRoads

Boolean

Избегать платных дорог.

val avoidUnpavedRoads

Boolean

Избегать грунтовых дорог.

val avoidFerries

Boolean

Избегать паромных переправ.

val avoidLockedRoads

Boolean

Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.

val routeSearchType

RouteSearchType

Тип поиска маршрута.

val excludedAreas

List<ExcludedArea>

Исключаемые области (не больше 25).

MotorcycleRouteSummary

Саммари информация для мотоциклетного маршрута.

MotorcycleRouteSummary(
	roadBlocks: Int = 0,
	accidents: Int = 0,
	roadWorks: Int = 0,
	tollRoads: Int = 0,
	ferryCrossings: Int = 0,
	iceCrossings: Int = 0,
	trafficLights: Int = 0,
	carRoadsLength: Int = 0,
	groundRoadsLength: Int = 0,
	gravelRoadsLength: Int = 0,
	badRoadsLength: Int = 0
)

Саммари информация для мотоциклетного маршрута.

Parameters

roadBlocks

Int

accidents

Int

roadWorks

Int

tollRoads

Int

ferryCrossings

Int

iceCrossings

Int

trafficLights

Int

carRoadsLength

Int

groundRoadsLength

Int

gravelRoadsLength

Int

badRoadsLength

Int

Properties

val roadBlocks

Int

Суммарное количество перекрытий на маршруте.

val accidents

Int

Суммарное количество аварий на маршруте.

val roadWorks

Int

Суммарное количество дорожных работ на маршруте.

val tollRoads

Int

Суммарное количество платных дорог на маршруте.

val ferryCrossings

Int

Суммарное количество паромных переправ на маршруте.

val iceCrossings

Int

Суммарное количество ледовых переправ на маршруте.

val trafficLights

Int

Суммарное количество светофоров на маршруте.

val carRoadsLength

Int

Суммарная протяжённость автомобильной дороги на маршруте в метрах.

val groundRoadsLength

Int

Суммарная протяжённость грунтовых дорог на маршруте в метрах.

val gravelRoadsLength

Int

Суммарная протяжённость гравийных дорог на маршруте в метрах.

val badRoadsLength

Int

Суммарная протяжённость участков плохой дороги на маршруте в метрах.

MultiTouchGestureSettings

Настройки жеста касания несколькими пальцами.

Extends: ru.dgis.sdk.NativeObject

Properties

var recognizeSettings

MultiTouchRecognizeSettings

Настройки распознавания касания несколькими пальцами.

MultiTouchRecognizeSettings

Настройки распознавания касания несколькими пальцами.

MultiTouchRecognizeSettings(multiTouchShiftThresholdMm: Float = 7.0f)

Настройки распознавания касания несколькими пальцами.

Parameters

multiTouchShiftThresholdMm

Float

Properties

val multiTouchShiftThresholdMm

Float

Порог сдвига взвешенного среднего точек, в миллиметрах, преодоление которого говорит о начале сдвига несколькими пальцами.

MyLocationControl

Контрол перелёта к текущему местоположению пользователя.

Extends: ru.dgis.sdk.map.MapControl

MyLocationControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контрол перелёта к текущему местоположению пользователя.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

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

BearingSource?

animationDuration

Duration

coordinatesThreshold

Meter

bearingThreshold

Bearing

Properties

val bearingSource

BearingSource?

Источник направления. Если отсутствует, будет отображаться маркер без направления.

val animationDuration

Duration

Неотрицательная длительность изменения реального направления.

val coordinatesThreshold

Meter

Неотрицательное пороговое значение учитываемого изменения реальной позиции и её точности.

val bearingThreshold

Bearing

Неотрицательное пороговое значение учитываемого изменения реального направления.

MyLocationControlModel

Модель контрола перелета к местоположению пользователя. Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя. Если местоположение не определено, ничего не происходит. Методы объекта необходимо вызывать на одном потоке.

Extends: ru.dgis.sdk.NativeObject

MyLocationControlModel(map: Map)

Parameters

map

Map

Methods

fun onClicked(): Unit

Returns

Unit

Properties

val isEnabledChannel

StatefulChannel<Boolean>

Состояние элемента перелета к местоположению пользователя.

val isEnabled

Boolean

Состояние элемента перелета к местоположению пользователя.

val followStateChannel

StatefulChannel<CameraFollowState>

Состояние слежения камеры за текущим местоположением пользователя.

val followState

CameraFollowState

Состояние слежения камеры за текущим местоположением пользователя.

val locationQualityChannel

StatefulChannel<LocationQuality>

Качество определения текущего местоположения.

val locationQuality

LocationQuality

Качество определения текущего местоположения.

MyLocationMapObject

Маркер геопозиции.

Extends: ru.dgis.sdk.map.MapObject

Methods

fun setModelData(data: ModelData?): Unit

Установить данные модели.

Parameters

data

ModelData?

Returns

Unit

Properties

val animationSettings

AnimationSettings

Получение настроек анимации для чтения и изменения.

val objectAttributes

Attributes

Получение свойств объекта карты для чтения и изменения.

MyLocationMapObjectSource

Источник, содержащий маркер геопозиции.

Extends: ru.dgis.sdk.map.Source

MyLocationMapObjectSource(
	context: Context,
	controllerSettings: MyLocationControllerSettings = MyLocationControllerSettings(),
	markerType: MyLocationMapObjectMarkerType = MyLocationMapObjectMarkerType.MODEL
)

Создать источник маркера геопозиции.

Parameters

context

Context

controllerSettings

MyLocationControllerSettings

markerType

MyLocationMapObjectMarkerType

Properties

val item

MyLocationMapObject

Получить маркер геопозиции.

MyLocationMapObjectSourceProvider

Провайдер, предоставляющий источник маркера геопозиции.

Extends: ru.dgis.sdk.NativeObject

Properties

val myLocationMapObjectSource

MyLocationMapObjectSource

Источник, содержащий маркер геопозиции.

NativeException

Исключение, преобразованное из исключения, брошенного в нативном коде.

NativeObject

Базовый класс для объектов, представляющих собой обёртки над объектами в нативном коде.

Methods

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

fun close(): Unit

Returns

Unit

fun isValid(): Boolean

Returns

Boolean

NativeProxy

Технический класс, инкапсулирующий в себе слабый указатель на объект в нативном коде.

Methods

fun finalize(): Unit

Returns

Unit

NativeReference

Indicates that the native layer holds a strong reference to an object of this type.

If the implementation is an inner/anonymous class or a lambda that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while the native reference is alive, causing a memory leak.

Implement such interfaces in a standalone class without capturing this, passing required dependencies via the constructor wrapped in WeakReference.

NativeReference()

Indicates that the native layer holds a strong reference to an object of this type.

If the implementation is an inner/anonymous class or a lambda that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while the native reference is alive, causing a memory leak.

Implement such interfaces in a standalone class without capturing this, passing required dependencies via the constructor wrapped in WeakReference.

NavigationControl

Контейнер с UI-элементами управления уровнем масштабирования и перелётом к текущему местоположению пользователя.

NavigationControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контейнер с UI-элементами управления уровнем масштабирования и перелётом к текущему местоположению пользователя.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

NavigationControl

Базовый класс для UI-элементов навигатора.

NavigationControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Базовый класс для UI-элементов навигатора.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

fun attachToManager(manager: NavigationManager): Unit

Parameters

manager

NavigationManager

Returns

Unit

fun detachFromManager(): Unit

Returns

Unit

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

fun detachFromModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

Properties

var manager

NavigationManager?

var model

Model?

val closeables

MutableList<AutoCloseable>

NavigationFollowController

Интерфейс для управления слежением карты за маркером геопозиции в навигаторе.

Extends: ru.dgis.sdk.NativeObject

Methods

fun setFollow(follow: Boolean): Unit

Немедленно включает либо отключает режим слежения карты за маркером геопозиции.

Parameters

follow

Boolean

Returns

Unit

Properties

var followReturnDelay

Duration

Таймаут, через который карта автоматически вернется в режим слежения за маркером геопозиции после того, как пользователь подвигал её. 0 - автоматический возврат в режим слежения за маркером геопозиции отключен.

var cameraBehaviour

CameraBehaviour

Режим слежения камеры за маркером геопозиции в навигаторе.

NavigationManager

Корневой публичный интерфейс навигатора.

Extends: ru.dgis.sdk.NativeObject

NavigationManager(platformContext: Context, trafficRouter: TrafficRouter? = null)

Точка входа в API навигатора, используемая в SDK по умолчанию.

Parameters

platformContext

Context

Контекст.

trafficRouter

TrafficRouter?

Поисковик маршрута для использования внутри навигатора. Если не задан, по умолчанию используется гибридный поисковик.

Methods

fun start(): Unit

Запускает ведение в режиме без маршрута (free roam). В этом режиме маршрут отсутствует, а навигатор сообщает об объектах, находящихся на дороге рядом с пользователем.

Returns

Unit

fun start(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute? = null): Unit

Запускает ведение по маршруту.

Parameters

routeBuildOptions

RouteBuildOptions

Параметры, с которыми навигатор будет перестраивать маршрут.

trafficRoute

TrafficRoute?

Маршрут, по которому запускается ведение. Если значение не задано, то навигатор построит маршрут от текущей геопозиции.

Returns

Unit

fun startSimulation(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute): Unit

Запускает симуляцию ведения по маршруту.

Parameters

routeBuildOptions

RouteBuildOptions

Параметры, с которыми навигатор будет перестраивать маршрут.

trafficRoute

TrafficRoute

Маршрут, по которому запускается симуляция.

Returns

Unit

fun stop(): Unit

Останавливает работу навигатора.

Returns

Unit

Properties

val uiModel

Model

Модель навигатора, предназначенная для отображения в UI.

val indoorDetector

IndoorDetector

Навигация внутри помещений.

val mapFollowController

NavigationFollowController

Управление автоматическим возвратом карты к слежению за маркером геопозиции.

val mapLocationController

MapLocationController

Контроллер для управления позиционированием карты в навигаторе.

val mapManager

MapManager

Менеджер карт навигатора.

val zoomFollowSettings

ZoomFollowSettings

Настройки масштабирования карты во время режима ведения.

val routeMapSettings

RouteMapSettings

Настройки отображения маршрута на карте.

val routeSourceSettings

RouteSourceSettings

Настройки источника, используемого для отображения маршрута на карте.

val routeMapObjectsProvider

RouteMapObjectsProvider

Провайдер объектов маршрутов на карте.

val simulationSettings

SimulationSettings

Настройки симуляции ведения по маршруту.

val voiceSelector

VoiceSelector

Управление голосовыми пакетами в текущей сессии навигатора.

val exceedSpeedLimitSettings

ExceedSpeedLimitSettings

Настройки детектирования превышения скорости.

val dynamicRouteInfoSettings

DynamicRouteInfoSettings

Настройки получения и обновления динамических данных о маршруте.

val soundNotificationSettings

SoundNotificationSettings

Настройки звуковых оповещений в текущей сессии навигатора.

val freeRoamSettings

FreeRoamSettings

Настройки ведения без маршрута в режиме free roam.

val alternativeRoutesProviderSettings

AlternativeRoutesProviderSettings

Настройки поиска альтернативных маршрутов в режиме ведения.

val alternativeRouteSelector

AlternativeRouteSelector

Выбор альтернативного маршрута.

val trafficJamDetector

TrafficJamDetector

Информация о пробках на маршруте.

val myLocationMapObjectSourceProvider

MyLocationMapObjectSourceProvider

Провайдер, предоставляющий источник маркера геопозиции.

val routeRebuilder

RouteRebuilder

Контроллер поиска нового маршрута при сходе с текущего маршрута.

val freeRoamSelector

FreeRoamSelector

Контроллер перевода навигатора в режим FreeRoam при слишком долгом перестроении маршрута.

val dataPrefetcher

DataPrefetcher

Контроллер предварительной загрузки тайлов карты вдоль маршрута.

val finishDetector

FinishDetector

Контроллер завершения маршрута

val tripHighlightsCollector

TripHighlightsCollector

Коллектор сводки о завершенном маршруте

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

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

Properties

var navigationManager

NavigationManager?

NavigationVoice

Голос для использования в навигаторе.

Extends: ru.dgis.sdk.NativeObject

NearestPlatform

Информация о платформе.

NearestPlatform(
	id: DgisObjectId,
	name: String,
	headingTo: String?,
	color: Color?,
	transitionType: NearestPlatformTransitionType?
)

Информация о платформе.

Parameters

id

DgisObjectId

name

String

headingTo

String?

color

Color?

transitionType

NearestPlatformTransitionType?

Properties

val id

DgisObjectId

Уникальный идентификатор остановочной платформы.

val name

String

Название остановки.

val headingTo

String?

Описание направления остановочной платформы.

val color

Color?

Цветовое кодирование маршрута.

val transitionType

NearestPlatformTransitionType?

Тип перехода.

NearestStation

Информация о станции.

NearestStation(
	id: DgisObjectId,
	name: String,
	distance: Int = 0,
	routeTypes: List<PublicTransportRouteType>,
	internalTransition: Boolean = false,
	color: Color?
)

Информация о станции.

Parameters

id

DgisObjectId

name

String

distance

Int

routeTypes

List<PublicTransportRouteType>

internalTransition

Boolean

color

Color?

Properties

val id

DgisObjectId

Уникальный идентификатор остановки.

val name

String

Название остановки.

val distance

Int

Расстояние от описываемого объекта до ближайшей остановочной платформы данной остановки в метрах.

val routeTypes

List<PublicTransportRouteType>

Типы транспорта, проходящие через эту остановку.

val internalTransition

Boolean

Существует ли внутренний переход на эту станцию из описываемого объекта.

val color

Color?

Цветовое кодирование маршрута.

NewValuesNotifier

Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.

Extends: ru.dgis.sdk.NativeObject

Methods

fun sendNotification(): Unit

Необходимо вызывать, чтобы сообщить об обновлении параметров.

Returns

Unit

ObstacleInfo

Информация о препятствии на маршруте.

ObstacleInfo(
	type: Obstacle = Obstacle.OTHER,
	limitation: ObstaclePassLimitation = ObstaclePassLimitation.UNLIMITED,
	objectId: Long = 0
)

Информация о препятствии на маршруте.

Parameters

type

Obstacle

limitation

ObstaclePassLimitation

objectId

Long

Properties

val type

Obstacle

val limitation

ObstaclePassLimitation

val objectId

Long

Идентификатор объекта препятствия. Остается неизменным при перестроении маршрута.

ObstacleInfoRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<ObstacleInfoRouteEntry>

fun findNearBackward(point: RoutePoint): ObstacleInfoRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

ObstacleInfoRouteEntry?

fun findNearForward(point: RoutePoint): ObstacleInfoRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

ObstacleInfoRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

ObstacleInfoRouteEntry?

Первый элемент.

val last

ObstacleInfoRouteEntry?

Последний элемент.

val entries

List<ObstacleInfoRouteEntry>

Все элементы.

ObstacleInfoRouteEntry

Элемент маршрута - точка и значение в ней.

ObstacleInfoRouteEntry(point: RoutePoint, value: ObstacleInfo)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

ObstacleInfo

Properties

val point

RoutePoint

val value

ObstacleInfo

ObstacleInfoRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): ObstacleInfoRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

ObstacleInfoRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<ObstacleInfoRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

ObstacleInfoRouteLongEntry?

Первый элемент.

val last

ObstacleInfoRouteLongEntry?

Последний элемент.

val entries

List<ObstacleInfoRouteLongEntry>

Все элементы.

ObstacleInfoRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

ObstacleInfoRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: ObstacleInfo
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

ObstacleInfo

Properties

val point

RoutePoint

val length

RouteDistance

val value

ObstacleInfo

Opacity

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Opacity(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

Opened

Открыто.

Opened(timeUntilClose: Duration?)

Открыто.

Parameters

timeUntilClose

Duration?

Properties

val timeUntilClose

Duration?

Время до закрытия. Отсутствует у круглосуточных организаций.

OpeningHours

Часы работы организации.

OpeningHours(
	weekOpeningHours: List<List<WeekTimeInterval>>,
	weekClosingHours: List<List<ClosingHours>>,
	isOpen24x7: Boolean
)

Часы работы организации.

Parameters

weekOpeningHours

List<List<WeekTimeInterval>>

weekClosingHours

List<List<ClosingHours>>

isOpen24x7

Boolean

Properties

val weekOpeningHours

List<List<WeekTimeInterval>>

Часы работы для каждого дня недели, начиная с понедельника.

val weekClosingHours

List<List<ClosingHours>>

Нерабочие интервалы для каждого дня недели, начиная с понедельника.

val isOpen24x7

Boolean

Признак, что организация работает круглосуточно.

OpeningSoon

Скоро откроется.

OpeningSoon(timeUntilOpen: Duration)

Скоро откроется.

Parameters

timeUntilOpen

Duration

Properties

val timeUntilOpen

Duration

Время до открытия.

OpenStatus

OpenStatus(opened: Opened)

Parameters

opened

Opened

OpenStatus(openingSoon: OpeningSoon)

Parameters

openingSoon

OpeningSoon

OpenStatus(closingSoon: ClosingSoon)

Parameters

closingSoon

ClosingSoon

OpenStatus(closed: Closed)

Parameters

closed

Closed

Methods

fun match(
	opened: Function1,
	openingSoon: Function1,
	closingSoon: Function1,
	closed: Function1
): T

Parameters

opened

(Opened) -> T

openingSoon

(OpeningSoon) -> T

closingSoon

(ClosingSoon) -> T

closed

(Closed) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isOpened

Boolean

val asOpened

Opened?

val isOpeningSoon

Boolean

val asOpeningSoon

OpeningSoon?

val isClosingSoon

Boolean

val asClosingSoon

ClosingSoon?

val isClosed

Boolean

val asClosed

Closed?

val value

Any?

val isOpen

Boolean

OrderedValue

Описывает одно значение из набора.

OrderedValue(value: String, text: String?)

Описывает одно значение из набора.

Parameters

value

String

text

String?

Properties

val value

String

Значение, по которым происходит фильтрация.

val text

String?

Название значения.

OrderedValues

Описывает набор дискретных упорядоченных значений.

OrderedValues(
	values: List<OrderedValue>,
	currentMinIndex: Long? = null,
	currentMaxIndex: Long? = null
)

Описывает набор дискретных упорядоченных значений.

Parameters

values

List<OrderedValue>

currentMinIndex

Long?

currentMaxIndex

Long?

Properties

val values

List<OrderedValue>

Набор значений. Упорядочен по возрастанию.

val currentMinIndex

Long?

Индекс текущего установленного минимального значения.

val currentMaxIndex

Long?

Индекс текущего установленного максимального значения.

OrgId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

OrgId(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

OrgInfo

Информация об организации.

OrgInfo(
	branchCount: Int,
	id: OrgId,
	name: String?
)

Информация об организации.

Parameters

branchCount

Int

id

OrgId

name

String?

Properties

val branchCount

Int

Количество филиалов организации.

val id

OrgId

Уникальный идентификатор организации.

val name

String?

Название организации.

OverviewMode

Режим обзорного вида здания (модель или мастер-план).

OverviewMode()

Режим обзорного вида здания (модель или мастер-план).

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

Package

Пакет. Для удобства работы с данными (установки, обновления, удаления), данные в 2ГИС SDK группируются в наборы по функционально-логическому назначению. Набор сгруппированных данных называется пакетом. В пределах одного пакета функциональное назначение данных уникально. Однако, множества данных пакетов с единым функциональным назначением могут пересекаться, то есть, возможна ситуация, когда данные нескольких пакетов имеют общие файлы. При операциях с группой таких пакетов общие данные будут обрабатываться (скачиваться, распаковываться, удаляться) только один раз.

Extends: ru.dgis.sdk.NativeObject

Methods

fun install(): Unit

Запуск операции установки либо обновления пакета.

Returns

Unit

fun install(fallback: InstallFallback): Unit

Запуск операции установки либо обновления пакета.

Parameters

fallback

InstallFallback

поведение при ошибке.

Returns

Unit

fun uninstall(): Unit

Запуск операции удаления пакета.

Returns

Unit

fun pause(): Unit

Постановка операции установки либо обновления пакета на паузу.

Returns

Unit

Properties

val id

String

Стабильный технический идентификатор пакета.

val infoChannel

StatefulChannel<PackageInfo>

Информация о пакете.

val info

PackageInfo

Информация о пакете.

val progressChannel

StatefulChannel<Byte>

Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне 0,100.

val progress

Byte

Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне 0,100.

PackageInfo

Информация о пакете. См. IPackage.

PackageInfo(
	name: String,
	description: 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

String

description

String

installed

Boolean

incomplete

Boolean

preinstalled

Boolean

compatible

Boolean

hasUpdate

Boolean

error

PackageInfoError?

updateStatus

PackageUpdateStatus

finalSizeOnDisk

Long?

currentSizeOnDisk

Long

Properties

val name

String

Локализованное название пакета.

val description

String

Локализованное развёрнутое описание пакета.

val installed

Boolean

Признак установки - true в случае, если пакет был выбран для установки.

val incomplete

Boolean

Признак незавершенности установки - true, если нет полностью загруженной версии пакета (возможно, несовместимой с текущей версией SDK).

val preinstalled

Boolean

Признак предустановленных пакетов. Предустановленные пакеты всегда установлены и полностью загружены, и их нельзя удалить.

val compatible

Boolean

Признак совместимости - true в случае, если загруженный пакет совместим с текущей версией SDK.

val hasUpdate

Boolean

Признак наличия обновления - true в случае наличия обновления для загруженного пакета. Возможна ситуация, когда во время процесса обновления до новой версии на сервере стала доступна ещё более новая версия пакета. В этом случае значение будет true как во время обновления, так и по его окончании.

val error

PackageInfoError?

Ошибка, произошедшая при попытке загрузки и/или установки пакета, или null, если ошибки нет.

val updateStatus

PackageUpdateStatus

Статус обновления пакета.

val finalSizeOnDisk

Long?

Размер территории в байтах, который она занимает на диске после установки. Неинициализированное значение означает, что территория не содержит файлов (информация получена на основе предустановленного файла состояния, в котором нет списка файлов для территории).

val currentSizeOnDisk

Long

Размер в байтах, который занимают на данный момент уже установленные файлы территории.

PackageManager

Интерфейс для централизованной работы с пакетами:

• Управления автообновлением и получением его статуса;
• Принудительной проверкой обновлений;
• Запуском и остановкой установки/обновления всех доступных пакетов.
• Подпиской на изменения информации о пакетах;
• Подпиской на изменения информации о всеобщем прогрессе установки пакетов.

Extends: ru.dgis.sdk.NativeObject

Methods

fun checkForUpdates(): Unit

Принудительная проверка на наличие обновлений.

Returns

Unit

@JvmStatic
fun instance(context: Context): PackageManager

Получение объекта для работы с пакетами из контекста.

Parameters

context

Context

Returns

PackageManager

Properties

var autoupdateEnabled

Boolean

Статус (включено/выключено) автообновления.

val packagesChannel

StatefulChannel<List<Package>>

Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.

val packages

List<Package>

Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.

PackedMapState

Сериализованное состояние карты.

Extends: ru.dgis.sdk.NativeObject

Methods

fun toBytes(): ByteArray

Представление состояния карты в виде последовательности байтов.

Returns

ByteArray

@JvmStatic
fun of(
	position: CameraPosition,
	showTraffic: Boolean,
	behaviour: CameraBehaviour
): PackedMapState

Получение состояния карты.

Parameters

position

CameraPosition

Позиция камеры.

showTraffic

Boolean

Состояние отображения пробок на карте.

behaviour

CameraBehaviour

Режим слежения камеры.

Returns

PackedMapState

Сериализованное состояние карты.

@JvmStatic
fun fromBytes(data: ByteArray): PackedMapState

Получение состояния карты.

Parameters

data

ByteArray

Состояние карты в виде последовательности байтов.

Returns

PackedMapState

Сериализованное состояние карты.

@JvmStatic
fun fromMap(map: Map): PackedMapState

Получение состояния карты.

Parameters

map

Map

Карта, состояние которой необходимо получить.

Returns

PackedMapState

Сериализованное состояние карты.

Properties

var showTraffic

Boolean

Получение состояния отображения пробок на карте.

var cameraPosition

CameraPosition

Получение позиции камеры.

var cameraBehaviour

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

TrafficRoute

routeSearchOptions

RouteSearchOptions?

finishPoint

RouteSearchPoint?

routePosition

RoutePoint?

state

State

Returns

PackedNavigationState

@JvmStatic
fun fromBytes(data: ByteArray): PackedNavigationState

Десериализация состояния навигации. Недопустимые элементы в сохранённом состоянии пропускаются либо заменяются значениями по умолчанию.

Parameters

data

ByteArray

Returns

PackedNavigationState

@JvmStatic
fun fromModel(model: Model): PackedNavigationState

Создание объекта из модели навигатора.

Parameters

model

Model

Returns

PackedNavigationState

Properties

var trafficRoute

TrafficRoute

Маршрут.

var finishPoint

RouteSearchPoint?

Конечная точка маршрута.

var routeSearchOptions

RouteSearchOptions?

Опции построения маршрута.

var routePosition

RoutePoint?

Позиция на маршруте.

var state

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

ByteArray

Returns

PackedSearchQuery

@JvmStatic
fun fromSearchQuery(searchQuery: SearchQuery): PackedSearchQuery

Parameters

searchQuery

SearchQuery

Returns

PackedSearchQuery

Properties

val queryText

String

Текст запроса. Для некоторых запросов (например, раскрытие рубрики из suggest'а) текст отсутствует, т.к. в запросе хранятся идентификаторы, и поведение отличается от поиска по тексту элемента suggest'а.

val orgIds

List<OrgId>

Идентификаторы организаций.

val rubricIds

List<RubricId>

Идентификаторы рубрик.

val objectIds

List<DgisObjectId>

Идентификаторы объектов.

val buildingIds

List<BuildingId>

Идентификаторы зданий.

val geometryRestriction

Geometry?

Геометрия, ограничивающая область поиска.

val areaOfInterest

GeoRect?

Прямоугольная область интереса.

val territoryOfInterest

Geometry?

Слабое ограничение области поиска объектов: штраф за непопадание вместо строгого отбрасывания.

val allowedResultTypes

List<ObjectType>

Ограничение по возвращаемым поиском типам объектов.

val pageSize

Int

Размер страницы выдачи.

val directoryFilter

DirectoryFilter

Информация об активных фильтрах.

val sortingType

SortingType

Тип сортировки результатов.

val radius

Meter?

Радиус поиска в метрах.

val locale

Locale?

Локаль поискового запроса.

val searchNearby

Boolean

Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.

Padding

Отступы от краёв камеры.

Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:

• точку позиции;
• анимированное перемещение карты;
• расположение динамических объектов карты (например баблы маршрутов).

Padding(
	left: Int = 0,
	top: Int = 0,
	right: Int = 0,
	bottom: Int = 0
)

Отступы от краёв камеры.

Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:

• точку позиции;
• анимированное перемещение карты;
• расположение динамических объектов карты (например баблы маршрутов).

Parameters

left

Int

top

Int

right

Int

bottom

Int

Properties

val left

Int

Отступ слева внутрь.

val top

Int

Отступ сверху внутрь.

val right

Int

Отступ справа внутрь.

val bottom

Int

Отступ снизу внутрь.

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

List<DirectoryObject>

Непустой набор объектов справочника этой страницы.

ParkingCapacity

Вместимость парковки.

ParkingCapacity(total: String?, specialSpaces: List<SpecialSpace>)

Вместимость парковки.

Parameters

total

String?

specialSpaces

List<SpecialSpace>

Properties

val total

String?

Общая вместимость парковки, машиномест.

val specialSpaces

List<SpecialSpace>

Описание особых мест для парковки.

ParkingControl

UI-элемент, переключаюший видимость парковок на карте.

Extends: ru.dgis.sdk.map.MapControl

ParkingControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент, переключаюший видимость парковок на карте.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

ParkingControlModel

Модель контрола парковок.

Этот интерфейс является потокобезопасным.

Extends: ru.dgis.sdk.NativeObject

ParkingControlModel(map: Map)

Функция создания модели элемента управления парковками.

Parameters

map

Map

карта.

Methods

fun toggleParkingsVisibility(): Unit

Действие при нажатии на контрол. Переключает видимость парковок на карте.

Returns

Unit

Properties

val isEnabledChannel

StatefulChannel<Boolean>

Состояние элемента управления видимостью парковок. true, если парковки видны.

val isEnabled

Boolean

Состояние элемента управления видимостью парковок. true, если парковки видны.

ParkingInfo

Общая информация о парковке.

ParkingInfo(
	type: ParkingType?,
	purpose: ParkingPurpose,
	access: ParkingAccess,
	pavingType: ParkingPavingType?,
	isPaid: Boolean,
	isIncentive: Boolean,
	forTrucks: Boolean,
	levelCount: Short?,
	capacity: ParkingCapacity?
)

Общая информация о парковке.

Parameters

type

ParkingType?

purpose

ParkingPurpose

access

ParkingAccess

pavingType

ParkingPavingType?

isPaid

Boolean

isIncentive

Boolean

forTrucks

Boolean

levelCount

Short?

capacity

ParkingCapacity?

Properties

val type

ParkingType?

Тип.

val purpose

ParkingPurpose

Назначение.

val access

ParkingAccess

Тип доступа.

val pavingType

ParkingPavingType?

Тип покрытия.

val isPaid

Boolean

Является ли парковка платной.

val isIncentive

Boolean

Является ли парковка перехватывающей.

val forTrucks

Boolean

Есть места для грузовиков.

val levelCount

Short?

Количество уровней.

val capacity

ParkingCapacity?

Вместимость.

PedestrianBriefRouteInfo

Базовая информация о пешеходном маршруте.

PedestrianBriefRouteInfo(length: RouteDistance, landmark: String)

Базовая информация о пешеходном маршруте.

Parameters

length

RouteDistance

landmark

String

Properties

val length

RouteDistance

Длина маршрута.

val landmark

String

Ориентир.

PedestrianInstructionCrossroad

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

PedestrianInstructionCrossroad(landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.NONE, maneuvers: List<PedestrianInstructionCrossroadManeuver>)

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

Parameters

landmark

PedestrianInstructionCrossroadLandmark

maneuvers

List<PedestrianInstructionCrossroadManeuver>

Properties

val landmark

PedestrianInstructionCrossroadLandmark

Ориентир.

val maneuvers

List<PedestrianInstructionCrossroadManeuver>

Цепочка идущих подряд манёвров.

PedestrianInstructionCrossroadManeuver

PedestrianInstructionCrossroadManeuver(direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)

Parameters

direction

PedestrianInstructionCrossroadManeuverDirection

turnAngle

Int

Properties

val direction

PedestrianInstructionCrossroadManeuverDirection

Направление движения.

val turnAngle

Int

Угол поворота в градусах -180,180.

PedestrianInstructionFinish

Конец пешеходной части маршрута.

PedestrianInstructionFinish()

Конец пешеходной части маршрута.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

PedestrianInstructionIndoorEnter

Вход в здание.

PedestrianInstructionIndoorEnter(levelId: LevelId = LevelId())

Вход в здание.

Parameters

levelId

LevelId

Properties

val levelId

LevelId

Идентификатор этажа после входа в здание.

PedestrianInstructionIndoorExit

Выход из здания.

PedestrianInstructionIndoorExit()

Выход из здания.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

PedestrianInstructionIndoorFloorChange

Смена этажа в здании.

PedestrianInstructionIndoorFloorChange(
	type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.UNDEFINED,
	beginId: LevelId = LevelId(),
	endId: LevelId = LevelId()
)

Смена этажа в здании.

Parameters

type

PedestrianInstructionIndoorFloorChangeType

beginId

LevelId

endId

LevelId

Properties

val type

PedestrianInstructionIndoorFloorChangeType

Тип смены этажа.

val beginId

LevelId

Идентификатор этажа до смены.

val endId

LevelId

Идентификатор этажа после смены.

PedestrianInstructionStart

Начало пешеходной части маршрута.

PedestrianInstructionStart()

Начало пешеходной части маршрута.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

PedestrianRouteSearchOptions

Параметры поиска пешеходного маршрута.

PedestrianRouteSearchOptions(
	avoidStairways: Boolean = false,
	avoidUnderpassesAndOverpasses: Boolean = false,
	useIndoor: Boolean = true,
	avoidUnpavedRoads: Boolean = false,
	avoidLockedRoads: Boolean = true,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска пешеходного маршрута.

Parameters

avoidStairways

Boolean

avoidUnderpassesAndOverpasses

Boolean

useIndoor

Boolean

avoidUnpavedRoads

Boolean

avoidLockedRoads

Boolean

excludedAreas

List<ExcludedArea>

Properties

val avoidStairways

Boolean

Избегать лестниц.

val avoidUnderpassesAndOverpasses

Boolean

Избегать подземных и надземных переходов.

val useIndoor

Boolean

Строить маршруты внутри зданий.

val avoidUnpavedRoads

Boolean

Избегать грунтовых дорог.

val avoidLockedRoads

Boolean

Избегать закрытых для прохода дорог. При значении true поиск маршрута не будет учитывать перекрытые для прохода участки дорог. При значении false маршрут может быть проложен через перекрытые для прохода участки дорог, если невозможно построить маршрут без прохода через перекрытые участки.

val excludedAreas

List<ExcludedArea>

Исключаемые области (не больше 25).

PedestrianRouteSummary

Саммари информация для пешеходного маршрута.

PedestrianRouteSummary(
	routeType: PedestrianSummaryRouteType = PedestrianSummaryRouteType.UNKNOWN,
	stairways: Int = 0,
	gates: Int = 0,
	barriers: Int = 0,
	calories: Int = 0,
	groundRoadsLength: Int = 0,
	gravelRoadsLength: Int = 0,
	badRoadsLength: Int = 0,
	elevationGainLength: Int = 0,
	elevationLossLength: Int = 0,
	steps: Int = 0,
	roadBlocks: Int = 0,
	defaultUserAverageSpeed: Float = 0.0f,
	personalizedUserAverageSpeed: Float? = null
)

Саммари информация для пешеходного маршрута.

Parameters

routeType

PedestrianSummaryRouteType

stairways

Int

gates

Int

barriers

Int

calories

Int

groundRoadsLength

Int

gravelRoadsLength

Int

badRoadsLength

Int

elevationGainLength

Int

elevationLossLength

Int

steps

Int

roadBlocks

Int

defaultUserAverageSpeed

Float

personalizedUserAverageSpeed

Float?

Properties

val routeType

PedestrianSummaryRouteType

Тип пешеходного маршрута.

val stairways

Int

Количество лестниц на маршруте.

val gates

Int

Количество калиток на маршруте.

val barriers

Int

Количество шлагбаумов на маршруте.

val calories

Int

Количество калорий, которые будут потрачены на проход по маршруту.

val groundRoadsLength

Int

Суммарная протяжённость грунтовых дорог на маршруте в метрах.

val gravelRoadsLength

Int

Суммарная протяжённость гравийных дорог на маршруте в метрах.

val badRoadsLength

Int

Суммарная протяжённость участков плохой дороги на маршруте в метрах.

val elevationGainLength

Int

Суммарная высота подъёма на участках с подъёмами на маршруте в метрах.

val elevationLossLength

Int

Суммарная высота спуска на участках со спусками на маршруте в метрах.

val steps

Int

Количество шагов для прохода по маршруту.

val roadBlocks

Int

Суммарное количество пешеходных перекрытий на маршруте.

val defaultUserAverageSpeed

Float

Определяемая бэкендом средняя скорость пользователя в км/ч по умолчанию.

val personalizedUserAverageSpeed

Float?

Определяемая бэкендом персонализированная средняя скорость пользователя в км/ч.

PerformSearchHandler

Предложено поискать определенный набор объектов.

Extends: ru.dgis.sdk.NativeObject

Properties

val searchQuery

SearchQuery

Запрос для прогона через поисковик.

PointGeometry

Точка.

Extends: ru.dgis.sdk.geometry.Geometry

PointGeometry(point: GeoPoint)

Parameters

point

GeoPoint

PointGeometry(point: GeoPointWithElevation)

Parameters

point

GeoPointWithElevation

Properties

val point

PointGeometryData

PointGeometryData

Данные геометрии точечного объекта.

PointGeometryData(geoPoint: GeoPoint)

Parameters

geoPoint

GeoPoint

PointGeometryData(geoPointWithElevation: GeoPointWithElevation)

Parameters

geoPointWithElevation

GeoPointWithElevation

Methods

fun match(geoPoint: Function1, geoPointWithElevation: Function1): T

Parameters

geoPoint

(GeoPoint) -> T

geoPointWithElevation

(GeoPointWithElevation) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isGeoPoint

Boolean

val asGeoPoint

GeoPoint?

val isGeoPointWithElevation

Boolean

val asGeoPointWithElevation

GeoPointWithElevation?

val value

Any?

Polygon

Полигон на карте.

Extends: ru.dgis.sdk.map.SimpleMapObject

Polygon(options: PolygonOptions)

Создание полигона на основе параметров.

Parameters

options

PolygonOptions

Properties

var contours

List<List<GeoPoint>>

var color

Color

var strokeWidth

LogicalPixel

var strokeColor

Color

var dashedPolygonOptions

DashedPolygonOptions?

Получение параметров пунктирного контура полигона.

var elevation

Elevation?

PolygonGeometry

Полигон.

Extends: ru.dgis.sdk.geometry.Geometry

PolygonGeometry(contours: List<List<GeoPoint>>)

Parameters

contours

List<List<GeoPoint>>

Properties

val contours

List<List<GeoPoint>>

val elevation

Elevation?

PolygonOptions

Параметры полигона.

PolygonOptions(
	contours: List<List<GeoPoint>>,
	color: Color = Color(),
	strokeWidth: LogicalPixel = LogicalPixel(value = 0.0f),
	strokeColor: Color = Color(),
	dashedPolygonOptions: DashedPolygonOptions? = null,
	visible: Boolean = true,
	userData: Any? = null,
	zIndex: ZIndex = ZIndex(value = 0),
	levelId: LevelId? = null,
	elevation: Elevation? = null
)

Параметры полигона.

Parameters

contours

List<List<GeoPoint>>

color

Color

strokeWidth

LogicalPixel

strokeColor

Color

dashedPolygonOptions

DashedPolygonOptions?

visible

Boolean

userData

Any?

zIndex

ZIndex

levelId

LevelId?

elevation

Elevation?

Properties

val contours

List<List<GeoPoint>>

val color

Color

val strokeWidth

LogicalPixel

val strokeColor

Color

val dashedPolygonOptions

DashedPolygonOptions?

Параметры пунктирного контура полигона.

val visible

Boolean

val userData

Any?

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

val zIndex

ZIndex

Уровень отрисовки объекта.

val levelId

LevelId?

Привязка к поэтажному плану здания.

val elevation

Elevation?

Высота полигона над поверхностью в метрах.

Polyline

Ломаная линия на карте.

Extends: ru.dgis.sdk.map.SimpleMapObject

Polyline(options: PolylineOptions)

Parameters

options

PolylineOptions

Properties

var points

List<GeoPoint>

var width

LogicalPixel

var color

Color

var erasedPart

Double

var dashedPolylineOptions

DashedPolylineOptions?

Получение параметров пунктирной полилинии.

var gradientPolylineOptions

GradientPolylineOptions?

Получение параметров градиентной полилинии.

var elevation

Elevation?

PolylineGeometry

Ломаная линия.

Extends: ru.dgis.sdk.geometry.Geometry

PolylineGeometry(points: List<GeoPoint>)

Parameters

points

List<GeoPoint>

Properties

val points

List<GeoPoint>

val elevation

Elevation?

PolylineOptions

Параметры полилинии.

PolylineOptions(
	points: List<GeoPoint>,
	width: LogicalPixel = LogicalPixel(value = 1.0f),
	color: Color = Color(),
	erasedPart: Double = 0.0,
	dashedPolylineOptions: DashedPolylineOptions? = null,
	gradientPolylineOptions: GradientPolylineOptions? = null,
	visible: Boolean = true,
	userData: Any? = null,
	zIndex: ZIndex = ZIndex(value = 0),
	levelId: LevelId? = null,
	elevation: Elevation? = null
)

Параметры полилинии.

Parameters

points

List<GeoPoint>

width

LogicalPixel

color

Color

erasedPart

Double

dashedPolylineOptions

DashedPolylineOptions?

gradientPolylineOptions

GradientPolylineOptions?

visible

Boolean

userData

Any?

zIndex

ZIndex

levelId

LevelId?

elevation

Elevation?

Properties

val points

List<GeoPoint>

Точки полилинии.

val width

LogicalPixel

Ширина полилинии.

val color

Color

Основной цвет полилинии.

val erasedPart

Double

Доля стёртой части полилинии, должна быть в диапазоне 0;1

val dashedPolylineOptions

DashedPolylineOptions?

Параметры пунктирной полилинии.

Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.

val gradientPolylineOptions

GradientPolylineOptions?

Параметры градиентной полилинии.

Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.

val visible

Boolean

Видимость полилинии.

val userData

Any?

Пользовательские данные.

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

val zIndex

ZIndex

Уровень отрисовки объекта.

val levelId

LevelId?

Привязка к поэтажному плану здания.

val elevation

Elevation?

Высота полилинии над поверхностью в метрах.

Projection

Проекция.

Используется сферическая проекция Меркатора (EPSG:3857), зацикленная по долготе. Отображаемые данные ограничены по широте от -85.06° до 85.06°.

Extends: ru.dgis.sdk.NativeObject

Methods

fun screenToMap(point: ScreenPoint): GeoPoint?

Вычисление точки карты в указанной точке экрана.

Функция возвращает пустое значение, если указанная точка экрана за пределами проекции карты.

Parameters

point

ScreenPoint

Returns

GeoPoint?

fun mapToScreen(point: GeoPoint): ScreenPoint?

Вычисление точки экрана, соответствующей указанной точке карты.

Функция возвращает пустое значение:

• point имеет невалидное значение (latitude лежит вне диапазона -90;90 или longitude лежит вне диапазона -180;180).
• если указанная точка карты находится выше плоскости проекции карты на экран.
• если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.

Parameters

point

GeoPoint

Returns

ScreenPoint?

fun mapToScreen(point: GeoPointWithElevation): ScreenPoint?

Вычисление точки экрана, соответствующей указанной точке карты с высотой.

Функция возвращает пустое значение:

• point имеет невалидное значение (latitude лежит вне диапазона -90;90, longitude лежит вне диапазона -180;180 или elevation отрицателен).
• если указанная точка карты находится выше плоскости проекции карты на экран.
• если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.

Parameters

point

GeoPointWithElevation

Returns

ScreenPoint?

fun screenToMapClipped(point: ScreenPoint): GeoPoint

Вычисление ближайшей точки карты к проекции указанной точки экрана.

Parameters

point

ScreenPoint

Returns

GeoPoint

fun distanceOnMap(fromPoint: ScreenPoint, toPoint: ScreenPoint): Meter?

Вычисление расстояния между точками на карте, соответствующими указанным точкам на экране, в метрах.

Функция возвращает пустое значение, если одна или обе указанных точки экрана находятся за пределами проекции карты.

Parameters

fromPoint

ScreenPoint

toPoint

ScreenPoint

Returns

Meter?

fun distanceOnScreen(fromGeoPoint: GeoPoint, toGeoPoint: GeoPoint): LogicalPixel?

Вычисление расстояния между точками на экране, соответствующими указанным точкам на карте, в пикселях.

Функция возвращает пустое значение если одна или обе точки на карте:

• имеют невалидное значение (latitude лежит вне диапазона -90;90 или longitude лежит вне диапазона -180;180).
• находятся выше плоскости проекции карты на экран.
• находятся слишком далеко за пределами экрана и возникает переполнение типа.

Parameters

fromGeoPoint

GeoPoint

toGeoPoint

GeoPoint

Returns

LogicalPixel?

PublicBriefRouteInfo

Базовая информация о маршруте на общественном транспорте.

PublicBriefRouteInfo(publicTransportInfos: List<PublicBriefRouteTransportInfo>)

Базовая информация о маршруте на общественном транспорте.

Parameters

publicTransportInfos

List<PublicBriefRouteTransportInfo>

Properties

val publicTransportInfos

List<PublicBriefRouteTransportInfo>

Описание способов проезда на общественном транспорте.

PublicBriefRouteTransportInfo

Описание общественного транспортного средства.

PublicBriefRouteTransportInfo(
	type: PublicTransportType = PublicTransportType.BUS,
	names: List<String>,
	color: Int?,
	routeLogo: String
)

Описание общественного транспортного средства.

Parameters

type

PublicTransportType

names

List<String>

color

Int?

routeLogo

String

Properties

val type

PublicTransportType

Тип общественного транспортного средства.

val names

List<String>

Названия маршрутов общественного транспорта, на которых происходит проезд.

val color

Int?

Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.

val routeLogo

String

Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.

PublicRoutePart

Описание участка маршрута на общественном транспорте.

PublicRoutePart(transports: List<PublicTransportInfo>, intermediateStops: List<PublicTransportStop>)

Описание участка маршрута на общественном транспорте.

Parameters

transports

List<PublicTransportInfo>

intermediateStops

List<PublicTransportStop>

Properties

val transports

List<PublicTransportInfo>

Виды общественного транспорта, на котором можно проехать данный участок маршрута.

Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.

val intermediateStops

List<PublicTransportStop>

Промежуточные остановки, которые транспорт проедет прежде, чем доберется до точки пересадки.

Остановки отсортированы в порядке следования по маршруту.

На этих остановках не нужно выходить.

Начальная и конечная остановки не входят в этот список.

PublicTransportCard

Карточка, отображающая информацию о маршруте на общественном транспорте.

PublicTransportCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Карточка, отображающая информацию о маршруте на общественном транспорте.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

Properties

var model

PublicTransportCardModel?

PublicTransportCardModel

Модель для PublicTransportCard.

PublicTransportCardModel(
	route: TrafficRoute,
	context: Context,
	startName: String? = null,
	finishName: String? = null
)

Модель для PublicTransportCard.

Parameters

route

TrafficRoute

context

Context

startName

String?

finishName

String?

Properties

val briefModel

BriefPublicTransportCardModel

Краткая информация (отображаемая в "шапке" карточки).

val transfers

List<Transfer>

Точки пересадки.

PublicTransportCostInfo

Информация о стоимости проезда на общественном транспорте.

PublicTransportCostInfo(
	value: Int = 0,
	fraction: Int = 0,
	exponent: Int = 0,
	currencyCode: String
)

Информация о стоимости проезда на общественном транспорте.

Parameters

value

Int

fraction

Int

exponent

Int

currencyCode

String

Properties

val value

Int

Стоимость проезда на общественном транспорте в основных единицах валюты, (например, в рублях для РФ).

val fraction

Int

Добавочная стоимость проезда на общественном транспорте в наименьших единицах валюты (например, стоимость в копейках, добавляющаяся к стоимости в рублях для РФ).

val exponent

Int

Степень десятки, обозначающая, сколько наименьших единиц валюты содержится в одной основной единице валюты. Например, в 1 рубле 100 копеек, значит, для рублей значение exponent будет равно 2.

val currencyCode

String

Трёхбуквенный код валюты по ISO 4217.

PublicTransportDirectoryPlatformDepartureInfo

Справочная информация об отправлении с платформы.

PublicTransportDirectoryPlatformDepartureInfo(platformId: DgisObjectId, departureTime: DayTime = DayTime(hours = 0, minutes = 0))

Справочная информация об отправлении с платформы.

Parameters

platformId

DgisObjectId

departureTime

DayTime

Properties

val platformId

DgisObjectId

Идентификатор платформы.

val departureTime

DayTime

Точное время проезда транспорта в формате HH:MM (в локальном для объекта часовом поясе).

PublicTransportDirectoryRouteDirectionNamesInfo

Информация о наименованиях начальной и конечной остановках маршрута.

PublicTransportDirectoryRouteDirectionNamesInfo(fromName: String, toName: String)

Информация о наименованиях начальной и конечной остановках маршрута.

Parameters

fromName

String

toName

String

Properties

val fromName

String

Начальная остановка маршрута.

val toName

String

Конечная остановка маршрута.

PublicTransportDirectoryRouteInfo

Справочная информация о маршруте общественного транспорта.

PublicTransportDirectoryRouteInfo(
	id: DgisObjectId,
	name: String,
	routeType: PublicTransportRouteType,
	color: Color?,
	fromToStationNames: PublicTransportDirectoryRouteDirectionNamesInfo?,
	directions: List<PublicTransportRouteDirection>
)

Справочная информация о маршруте общественного транспорта.

Parameters

id

DgisObjectId

name

String

routeType

PublicTransportRouteType

color

Color?

fromToStationNames

PublicTransportDirectoryRouteDirectionNamesInfo?

directions

List<PublicTransportRouteDirection>

Properties

val id

DgisObjectId

Идентификатор маршрута.

val name

String

Название маршрута.

val routeType

PublicTransportRouteType

Тип маршрута.

val color

Color?

Цветовое кодирование маршрута.

val fromToStationNames

PublicTransportDirectoryRouteDirectionNamesInfo?

Информация о наименованиях начальной и конечной остановках маршрута.

val directions

List<PublicTransportRouteDirection>

Направления маршрута. Для остановочной платформы (тип ObjectType.StationPlatform) может не содержать информацию о направлениях, которые проходят через платформу. Для получения направлений необходимо сделать поисковой запрос с идентификатором маршрута.

PublicTransportDirectoryRouteScheduleInfo

Справочная информация о расписаниях платформ и направлений на маршруте.

PublicTransportDirectoryRouteScheduleInfo(
	fullDayPlatforms: Map,
	nearTrips: Map,
	intervalTrips: Map
)

Справочная информация о расписаниях платформ и направлений на маршруте.

Parameters

fullDayPlatforms

Map

nearTrips

Map

intervalTrips

Map

Properties

val fullDayPlatforms

Map

Расписания для платформ до конца дня.

val nearTrips

Map

Ближайшие рейсы для направлений до конечной платформы.

val intervalTrips

Map

Ближайшие интервальные расписания для направлений.

PublicTransportDirectoryScheduleInfo

Справочная информация о расписаниях платформ и направлений.

PublicTransportDirectoryScheduleInfo(
	routeSchedules: Map,
	fullDayPlatforms: Map,
	nearTrips: Map
)

Справочная информация о расписаниях платформ и направлений.

Parameters

routeSchedules

Map

fullDayPlatforms

Map

nearTrips

Map

Properties

val routeSchedules

Map

Справочная информация о расписаниях платформ и направлений для маршрутов.

val fullDayPlatforms

Map

Расписания для платформы по маршутам до конца дня. Поле будет заполнено для объекта типа ObjectType.StationPlatform.

Массив с объектами PublicTransportPlatformSchedule представляет последовательность расписаний, следующих друг за другом. Например:

Транспорт отправляется с периодом в 2 минуты (period) начиная с 1747353600 (start_time) и заканчивая 1747360800 (finish_time)

Далее отправляется по расписанию в 12:15 - precise_time, 12:30 и 13:00

val nearTrips

Map

Ближайшие рейсы для направлений по маршрутам до конечной платформы. Поле будет заполнено для объекта типа ObjectType.StationPlatform.

PublicTransportInfo

Описание общественного транспортного средства.

PublicTransportInfo(
	type: PublicTransportType = PublicTransportType.BUS,
	suggestedCarNumbers: List<Int>,
	boardingSuggest: String,
	color: Int?,
	routeLogo: String,
	routeInfos: List<PublicTransportRouteInfo>
)

Описание общественного транспортного средства.

Parameters

type

PublicTransportType

suggestedCarNumbers

List<Int>

boardingSuggest

String

color

Int?

routeLogo

String

routeInfos

List<PublicTransportRouteInfo>

Properties

val type

PublicTransportType

Тип общественного транспортного средства.

val suggestedCarNumbers

List<Int>

Номера вагонов, в которые рекомендуется посадка.

Если транспортное средство состоит из одного вагона или можно садиться в любой вагон, то этот список будет пустым.

val boardingSuggest

String

Текстовое описание вагонов, в которые рекомендуется посадка.

val color

Int?

Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.

val routeLogo

String

Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.

val routeInfos

List<PublicTransportRouteInfo>

Описания маршрутов общественного транспорта, на которых происходит проезд.

PublicTransportIntervalSchedule

Интервальное расписание.

PublicTransportIntervalSchedule(period: Byte = 0, workHours: PublicTransportIntervalWorkingHours?)

Интервальное расписание.

Parameters

period

Byte

workHours

PublicTransportIntervalWorkingHours?

Properties

val period

Byte

Период следования транспорта в минутах.

val workHours

PublicTransportIntervalWorkingHours?

Время действия интервального расписания.

PublicTransportIntervalWorkingHours

Время действия интервального расписания.

PublicTransportIntervalWorkingHours(
	startTime: Long = 0,
	startTimeUtc: Long = 0,
	finishTime: Long = 0,
	finishTimeUtc: Long = 0
)

Время действия интервального расписания.

Parameters

startTime

Long

startTimeUtc

Long

finishTime

Long

finishTimeUtc

Long

Properties

val startTime

Long

Время начала действия интервального расписания (в локальном для объекта часовом поясе) в системе UNIX.

val startTimeUtc

Long

Время начала действия интервального расписания в системе UNIX по UTC.

val finishTime

Long

Время окончания действия интервального расписания (в локальном для объекта часовом поясе) в системе UNIX.

val finishTimeUtc

Long

Время окончания действия интервального расписания в системе UNIX по UTC.

PublicTransportNearTripSchedule

Интервальное расписание.

PublicTransportNearTripSchedule(period: Byte?, platformTimes: List<PublicTransportDirectoryPlatformDepartureInfo>)

Интервальное расписание.

Parameters

period

Byte?

platformTimes

List<PublicTransportDirectoryPlatformDepartureInfo>

Properties

val period

Byte?

Период следования транспорта в минутах.

val platformTimes

List<PublicTransportDirectoryPlatformDepartureInfo>

Расписание отправлений для платформ.

PublicTransportPlatform

Справочная информация об остановочной платформе.

PublicTransportPlatform(
	id: DgisObjectId,
	stationId: DgisObjectId,
	name: String,
	description: String?,
	transitions: List<PublicTransportPlatformTransition>,
	position: GeoPoint?
)

Справочная информация об остановочной платформе.

Parameters

id

DgisObjectId

stationId

DgisObjectId

name

String

description

String?

transitions

List<PublicTransportPlatformTransition>

position

GeoPoint?

Properties

val id

DgisObjectId

Идентификатор остановочной платформы.

val stationId

DgisObjectId

Идентификатор остановки. Например, автобусная остановка или станция метро, на которой находится платформа, или любая другая остановка.

val name

String

Название остановки.

val description

String?

Краткое описание места расположения остановочной платформы.

val transitions

List<PublicTransportPlatformTransition>

Справочная информация о других маршрутах общественного транспорта, на которые можно пересесть на данной остановочной платформе.

val position

GeoPoint?

Позиция.

PublicTransportPlatformSchedule

Расписание платформы.

PublicTransportPlatformSchedule(
	schedule: PublicTransportSchedule,
	startTime: Long = 0,
	startTimeUtc: Long = 0
)

Расписание платформы.

Parameters

schedule

PublicTransportSchedule

startTime

Long

startTimeUtc

Long

Properties

val schedule

PublicTransportSchedule

Расписание следования транспорта.

val startTime

Long

Время наступления события (в локальном для объекта часовом поясе).

val startTimeUtc

Long

Время наступления события в UTC.

PublicTransportPlatformTransition

Справочная информация о маршруте общественного транспорта, на который можно пересесть на остановочной платформе.

PublicTransportPlatformTransition(
	routeId: DgisObjectId,
	routeName: String,
	routeType: PublicTransportRouteType,
	color: Color?,
	stationId: DgisObjectId,
	stationName: String
)

Справочная информация о маршруте общественного транспорта, на который можно пересесть на остановочной платформе.

Parameters

routeId

DgisObjectId

routeName

String

routeType

PublicTransportRouteType

color

Color?

stationId

DgisObjectId

stationName

String

Properties

val routeId

DgisObjectId

Идентификатор связанного маршрута.

val routeName

String

Название связанного маршрута.

val routeType

PublicTransportRouteType

Тип маршрута.

val color

Color?

Цветовое кодирование маршрута.

val stationId

DgisObjectId

Идентификатор остановки.

val stationName

String

Название остановки или станции.

PublicTransportPreciseSchedule

Точное расписание проезда общественного транспорта через платформу.

PublicTransportPreciseSchedule(
	preciseTime: DayTime,
	nextTrips: List<Long>,
	nextTripsUtc: List<Long>
)

Точное расписание проезда общественного транспорта через платформу.

Parameters

preciseTime

DayTime

nextTrips

List<Long>

nextTripsUtc

List<Long>

Properties

val preciseTime

DayTime

Точное время проезда транспорта в формате HH:MM (в локальном для объекта часовом поясе).

val nextTrips

List<Long>

Массив с временем следующих рейсов (в локальном для объекта часовом поясе).

val nextTripsUtc

List<Long>

Массив с временем следующих рейсов в UTC.

PublicTransportRouteDirection

Направление маршрута общественного транспорта.

PublicTransportRouteDirection(
	id: PublicTransportRouteDirectionId,
	type: PublicTransportRouteDirectionType,
	geometry: PublicTransportRouteGeometry?,
	platforms: List<PublicTransportPlatform>
)

Направление маршрута общественного транспорта.

Parameters

id

PublicTransportRouteDirectionId

type

PublicTransportRouteDirectionType

geometry

PublicTransportRouteGeometry?

platforms

List<PublicTransportPlatform>

Properties

val id

PublicTransportRouteDirectionId

Идентификатор направления маршрута.

val type

PublicTransportRouteDirectionType

Тип направления маршрута.

val geometry

PublicTransportRouteGeometry?

Геометрия направления маршрута.

val platforms

List<PublicTransportPlatform>

Последовательность остановочных платформ маршрута.

PublicTransportRouteDirectionId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

PublicTransportRouteDirectionId(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

PublicTransportRouteGeometry

Геометрия направления маршрута общественного транспорта.

PublicTransportRouteGeometry(line: PolylineGeometry, centroid: GeoPoint?)

Геометрия направления маршрута общественного транспорта.

Parameters

line

PolylineGeometry

centroid

GeoPoint?

Properties

val line

PolylineGeometry

Линия маршрута.

val centroid

GeoPoint?

Визуальный центр геометрии объекта.

PublicTransportRouteInfo

Описание маршрута общественного транспорта.

PublicTransportRouteInfo(
	name: String,
	directionName: String,
	lastPlatformName: String,
	costInfo: PublicTransportCostInfo?,
	traversalType: TraversalType?
)

Описание маршрута общественного транспорта.

Parameters

name

String

directionName

String

lastPlatformName

String

costInfo

PublicTransportCostInfo?

traversalType

TraversalType?

Properties

val name

String

Имя маршрута.

val directionName

String

Название направления (если есть).

val lastPlatformName

String

Название конечной остановки (если известно).

val costInfo

PublicTransportCostInfo?

Информация о стоимости проезда (если известна).

val traversalType

TraversalType?

Информация о направлении движения (если известна).

PublicTransportRouteSearchOptions

Параметры поиска маршрута на общественном транспорте.

PublicTransportRouteSearchOptions(
	startTime: TimePoint? = null,
	useSchedule: Boolean = false,
	transportTypes: EnumSet<PublicTransportType> = EnumSet.noneOf(PublicTransportType::class.java),
	quickFilter: PublicTransportQuickFilter? = null
)

Параметры поиска маршрута на общественном транспорте.

Parameters

startTime

TimePoint?

useSchedule

Boolean

transportTypes

EnumSet<PublicTransportType>

quickFilter

PublicTransportQuickFilter?

Properties

val startTime

TimePoint?

Время в UTC, на которое нужно построить маршрут. Если не задано, используется текущее время.

val useSchedule

Boolean

Учёт расписания движения общественного транспорта при построении маршрута.

val transportTypes

EnumSet<PublicTransportType>

Типы общественного транспорта. Если не заполнены, маршруты будут строиться для всех поддерживаемых типов общественного транспорта.

val quickFilter

PublicTransportQuickFilter?

Быстрый фильтр для общественного транспорта. Если заполнен, то при поиске маршрута имеет приоритет над другими параметрами поиска.

PublicTransportSchedule

Расписание следования транспорта.

PublicTransportSchedule(intervalSchedule: PublicTransportIntervalSchedule)

Parameters

intervalSchedule

PublicTransportIntervalSchedule

PublicTransportSchedule(preciseSchedule: PublicTransportPreciseSchedule)

Parameters

preciseSchedule

PublicTransportPreciseSchedule

Methods

fun match(intervalSchedule: Function1, preciseSchedule: Function1): T

Parameters

intervalSchedule

(PublicTransportIntervalSchedule) -> T

preciseSchedule

(PublicTransportPreciseSchedule) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isIntervalSchedule

Boolean

val asIntervalSchedule

PublicTransportIntervalSchedule?

val isPreciseSchedule

Boolean

val asPreciseSchedule

PublicTransportPreciseSchedule?

val value

Any?

PublicTransportStop

Описание остановки общественного транспорта.

PublicTransportStop(name: String, coordinates: GeoPoint)

Описание остановки общественного транспорта.

Parameters

name

String

coordinates

GeoPoint

Properties

val name

String

Название остановки.

val coordinates

GeoPoint

Географические координаты остановки.

PublicTransportTransfer

Описание способа добраться на общественном транспорте до следующей точки пересадки.

PublicTransportTransfer(
	startPointName: String,
	finishPointName: String,
	routeParts: List<PublicRoutePart>
)

Описание способа добраться на общественном транспорте до следующей точки пересадки.

Parameters

startPointName

String

finishPointName

String

routeParts

List<PublicRoutePart>

Properties

val startPointName

String

Название точки, из которой начинается движение для данного участка маршрута.

val finishPointName

String

Название точки назначения для данного участка маршрута.

val routeParts

List<PublicRoutePart>

Описание участка маршрута на общественном транспорте, по которому можно добраться до следующей точки пересадки.

Все участки маршрута из этого списка проходят по одной и той же линии геометрии.

Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.

PublicTransportTransferRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): PublicTransportTransferRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

PublicTransportTransferRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<PublicTransportTransferRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<PublicTransportTransferRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

PublicTransportTransferRouteLongEntry?

Первый элемент.

val last

PublicTransportTransferRouteLongEntry?

Последний элемент.

val entries

List<PublicTransportTransferRouteLongEntry>

Все элементы.

PublicTransportTransferRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

PublicTransportTransferRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: PublicTransportTransfer
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

PublicTransportTransfer

Properties

val point

RoutePoint

val length

RouteDistance

val value

PublicTransportTransfer

PurposeCode

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

PurposeCode(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

RadarApiSettings

Настройки для работы с Radar API

Sealed класс, представляющий два возможных состояния:

ON - Radar включен, с настройками

OFF - Radar выключен

RadarHttpResponse

Модель ответа от HTTP-запроса к Radar API

RadarHttpResponse(code: Int, body: String)

Модель ответа от HTTP-запроса к Radar API

Parameters

code

Int

body

String

Properties

val code

Int

HTTP-код ответа (например, 200, 404, 500)

val body

String

Тело ответа в виде строки (обычно JSON)

Range

Описывает набор непрерывных или дискретных упорядоченных значений.

Range(borders: Borders)

Parameters

borders

Borders

Range(orderedValues: OrderedValues)

Parameters

orderedValues

OrderedValues

Methods

fun match(borders: Function1, orderedValues: Function1): T

Parameters

borders

(Borders) -> T

orderedValues

(OrderedValues) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isBorders

Boolean

val asBorders

Borders?

val isOrderedValues

Boolean

val asOrderedValues

OrderedValues?

val value

Any?

RangeFilter

Фильтр диапазонов значений.

RangeFilter(
	tagName: String,
	displayName: String,
	minValue: Double,
	maxValue: Double
)

Фильтр диапазонов значений.

Parameters

tagName

String

displayName

String

minValue

Double

maxValue

Double

Properties

val tagName

String

Тэг фильтра.

val displayName

String

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

val minValue

Double

Минимальное значение диапазона.

val maxValue

Double

Максимальное значение диапазона.

RangeWidget

Виджет для представления непрерывного или дискретного набора упорядоченных значений.

Extends: ru.dgis.sdk.directory.Widget

Methods

fun setValues(min: Double, max: Double): Unit

Установка текущих выбранных значений.

Parameters

min

Double

текущее минимальное значение.

max

Double

текущее максимальное значение.

Returns

Unit

Properties

val range

Range

Получение набора упорядоченных значений.

RasterTileSource

Источник, получающий растровые тайлы.

Extends: ru.dgis.sdk.map.Source

RasterTileSource(
	context: Context,
	sublayerName: String,
	sourceTemplate: RasterUrlTemplate
)

Создание источника, получающего растровые тайлы.

Parameters

context

Context

контекст.

sublayerName

String

имя, которое будет использовано при генерации объектов. Это имя должно быть указано в стилях в условии filter слоя типа raster для атрибута db_sublayer. Пример: ["match", get,db_sublayer, NAME, true, false] Подробнее см. спецификацию: https://docs.2gis.com/ru/mapgl/stylespecification

sourceTemplate

RasterUrlTemplate

Шаблон для запроса тайлов.

Methods

fun setOpacity(opacity: Opacity): Unit

Установка значения прозрачности растрового тайла.

Parameters

opacity

Opacity

Returns

Unit

RasterUrlTemplate

RasterUrlTemplate(defaultSource: DefaultRasterUrlTemplate)

Parameters

defaultSource

DefaultRasterUrlTemplate

RasterUrlTemplate(wmsSource: WmsRasterUrlTemplate)

Parameters

wmsSource

WmsRasterUrlTemplate

Methods

fun match(defaultSource: Function1, wmsSource: Function1): T

Parameters

defaultSource

(DefaultRasterUrlTemplate) -> T

wmsSource

(WmsRasterUrlTemplate) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isDefaultSource

Boolean

val asDefaultSource

DefaultRasterUrlTemplate?

val isWmsSource

Boolean

val asWmsSource

WmsRasterUrlTemplate?

val value

Any?

RemainingRouteInfoControl

Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.

Extends: ru.dgis.sdk.navigation.NavigationControl

RemainingRouteInfoControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToManager(manager: NavigationManager): Unit

Parameters

manager

NavigationManager

Returns

Unit

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

fun detachFromManager(): Unit

Returns

Unit

Properties

var onAddRoadEventButtonClicked

() -> Unit

var onLeftSideActionButtonClicked

() -> Unit

val heightChannel

StatefulChannel<Int>

var expanded

Boolean

const MARGIN

Int

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

MapObject

source

Source

levelId

LevelId?

Properties

val item

MapObject

Объект карты.

val source

Source

Источник данных, содержащий объект карты.

val levelId

LevelId?

Идентификатор этажного плана здания, на котором расположен объект.

RenderedObjectInfo

Подробная информация об отображаемом объекте карты.

RenderedObjectInfo(
	closestViewportPoint: ScreenPoint,
	closestMapPoint: GeoPointWithElevation,
	item: RenderedObject
)

Подробная информация об отображаемом объекте карты.

Parameters

closestViewportPoint

ScreenPoint

closestMapPoint

GeoPointWithElevation

item

RenderedObject

Properties

val closestViewportPoint

ScreenPoint

Ближайшая точка объекта в координатах экрана.

val closestMapPoint

GeoPointWithElevation

Ближайшая точка объекта в координатах карты.

val item

RenderedObject

Отображаемый объект карты.

Reviews

Отзывы.

Reviews(
	rating: Float = 0.0f,
	count: Int = 0,
	countWithStars: Int = 0
)

Отзывы.

Parameters

rating

Float

count

Int

countWithStars

Int

Properties

val rating

Float

Рейтинг в диапазоне от 0 до 5.

val count

Int

Количество отзывов.

val countWithStars

Int

Общее количество оценок (включая отзывы без текста).

RoadCameraInfo

Информация о камере.

RoadCameraInfo(purposes: EnumSet<CameraPurpose>, speedLimit: Short?)

Информация о камере.

Parameters

purposes

EnumSet<CameraPurpose>

speedLimit

Short?

Properties

val purposes

EnumSet<CameraPurpose>

Назначения камеры.

Могут отсутствовать, если нет информации, или если камеру добавил пользователь.

val speedLimit

Short?

Ограничение скорости в км/ч.

На текущий момент доступно только для камер, контролирующих скорость и среднюю скорость на участке.

Может отсутствовать и для камер контроля скорости, если значение неизвестно.

RoadEvent

Дорожное событие.

Extends: ru.dgis.sdk.NativeObject

Methods

fun photos(): Future<List<RoadEventPhoto>>

Фотографии события.

Returns

Future<List<RoadEventPhoto>>

Properties

val type

RoadEventType

Тип события.

val id

String

Идентификатор события.

val name

String

Локализованное название события.

val author

AuthorInfo

Информация о пользователе, добавившем событие.

val timestamp

TimePoint?

Временная метка создания события.

val location

GeoPoint

Координаты события.

val elevation

Elevation

Высота дорожного события.

val description

String

Пользовательское описание дорожного события.

val cameraInfo

RoadCameraInfo?

Информация о камере.

Доступна только для событий типа "Camera".

val schedule

Schedule?

Расписание.

На текущий момент доступно только для перекрытий, и даже для них может отсутствовать.

val lanes

EnumSet<Lane>

Затронутые событием полосы.

На текущий момент могут быть проставлены только у пользовательских событий.

val availableActions

List<RoadEventAction>

Список доступных действий с событием.

val remover

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

RoadEventActionType

Тип действия.

val name

String

Локализованное название действия.

val infoChannel

StatefulChannel<RoadEventActionInfo>

Информация о действии.

val info

RoadEventActionInfo

Информация о действии.

RoadEventActionButton

Кнопка действия над дорожным событием (подтвердить, поставить "нравится" и т.д.).

RoadEventActionButton(model: RoadEventActionButtonModel, context: Context)

Кнопка действия над дорожным событием (подтвердить, поставить "нравится" и т.д.).

Parameters

model

RoadEventActionButtonModel

context

Context

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

Properties

val model

RoadEventActionButtonModel

RoadEventActionInfo

Информация о действии.

RoadEventActionInfo(state: RoadEventActionState, count: Int?)

Информация о действии.

Parameters

state

RoadEventActionState

count

Int?

Properties

val state

RoadEventActionState

Состояние действия.

val count

Int?

Количество действий, применённых к событию всеми пользователями (только для пользовательских событий).

RoadEventCard

Карточка, отображающая информацию о дорожном событии.

RoadEventCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Карточка, отображающая информацию о дорожном событии.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

Properties

var event

RoadEvent?

var onRemoveCompleted

(ActionResult) -> Unit

Уведомление о завершении удаления события.

var onActionCompleted

(RoadEventActionActionResult) -> Unit

Уведомление о завершении действия.

RoadEventCardModel

Модель карточки дорожного события.

RoadEventCardModel(
	event: RoadEvent,
	photoSize: StatefulChannel<ScreenSize>,
	context: Context
)

Модель карточки дорожного события.

Parameters

event

RoadEvent

photoSize

StatefulChannel<ScreenSize>

context

Context

Methods

fun close(): Unit

Returns

Unit

Properties

val name

String

Название, например, "Перекрытие".

val description

String?

Описание, например, "Ремонтные работы".

val lanes

String?

Затронутые событием полосы, например, "Левый ряд, средний ряд".

val schedule

String?

Расписание, например, "10 октября 08:00 – 15 октября 23:30".

val creationTime

String?

Время создания, например, "5 часов назад", "5 августа", "10 декабря 2020 г".

val author

String?

Автор, например, "2ГИС".

val photoChannel

StatefulChannel<Bitmap?>

Фотография.

val actionCompletedChannel

Channel<Pair>

Уведомление о завершении действия.

val removeCompletedChannel

Channel<ActionResult>

Уведомление о завершении удаления события.

val actions

List<RoadEventActionButtonModel>

Действия.

RoadEventFilterData

Данные о дорожном событии, используемые для фильтрации.

RoadEventFilterData(
	startTime: TimePoint?,
	finishTime: TimePoint?,
	type: RoadEventType
)

Данные о дорожном событии, используемые для фильтрации.

Parameters

startTime

TimePoint?

finishTime

TimePoint?

type

RoadEventType

Properties

val startTime

TimePoint?

Время начала.

val finishTime

TimePoint?

Время окончания.

val type

RoadEventType

Тип события.

RoadEventManager

Объект для создания транспортных событий.

Extends: ru.dgis.sdk.NativeObject

Methods

fun createAccident(
	location: GeoPoint,
	lanes: EnumSet<Lane>,
	description: String
): Future<AddEventResult>

Создание события "ДТП".

Parameters

location

GeoPoint

Местоположение события.

lanes

EnumSet<Lane>

Полосы дороги, затрагиваемые событием.

description

String

Пользовательское описание события.

Returns

Future<AddEventResult>

fun createCamera(location: GeoPoint, description: String): Future<AddEventResult>

Создание события "Камера".

Parameters

location

GeoPoint

Местоположение события.

description

String

Пользовательское описание события.

Returns

Future<AddEventResult>

fun createRoadRestriction(location: GeoPoint, description: String): Future<AddEventResult>

Создание события "Перекрытие дорожного движения".

Parameters

location

GeoPoint

Местоположение события.

description

String

Пользовательское описание события.

Returns

Future<AddEventResult>

fun createComment(location: GeoPoint, description: String): Future<AddEventResult>

Создание события "Комментарий".

Parameters

location

GeoPoint

Местоположение события.

description

String

Пользовательское описание события.

Returns

Future<AddEventResult>

fun createOther(
	location: GeoPoint,
	lanes: EnumSet<Lane>,
	description: String
): Future<AddEventResult>

Создание события "Другое".

Parameters

location

GeoPoint

Местоположение события.

lanes

EnumSet<Lane>

Полосы дороги, затрагиваемые событием.

description

String

Пользовательское описание события.

Returns

Future<AddEventResult>

fun createRoadWorks(
	location: GeoPoint,
	lanes: EnumSet<Lane>,
	description: String
): Future<AddEventResult>

Создание события "Дорожные работы".

Parameters

location

GeoPoint

Местоположение события.

lanes

EnumSet<Lane>

Полосы дороги, затрагиваемые событием.

description

String

Пользовательское описание события.

Returns

Future<AddEventResult>

@JvmStatic
fun instance(context: Context): RoadEventManager

Получение объекта для создания дорожных событий.

Parameters

context

Context

Returns

RoadEventManager

RoadEventMapObject

Объект карты "Дорожное событие".

Extends: ru.dgis.sdk.map.MapObject

Properties

val id

DgisObjectId

val event

RoadEvent

Получение дорожного события.

val animationSettings

AnimationSettings

Получение настроек анимации дорожных событий для чтения и изменения.

RoadEventMapObjectRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventMapObjectRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoadEventMapObjectRouteEntry>

fun findNearBackward(point: RoutePoint): RoadEventMapObjectRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RoadEventMapObjectRouteEntry?

fun findNearForward(point: RoutePoint): RoadEventMapObjectRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RoadEventMapObjectRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoadEventMapObjectRouteEntry?

Первый элемент.

val last

RoadEventMapObjectRouteEntry?

Последний элемент.

val entries

List<RoadEventMapObjectRouteEntry>

Все элементы.

RoadEventMapObjectRouteEntry

Элемент маршрута - точка и значение в ней.

RoadEventMapObjectRouteEntry(point: RoutePoint, value: RoadEventMapObject)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

RoadEventMapObject

Properties

val point

RoutePoint

val value

RoadEventMapObject

RoadEventPhoto

Фотография дорожного события.

Extends: ru.dgis.sdk.NativeObject

Methods

fun previewUrl(desiredSize: ScreenSize): String

URL превью фотографии.

Parameters

desiredSize

ScreenSize

Returns

String

fun report(): Future<ActionResult>

Отправка жалобы на фотографию.

жалоба на свою фотографию ни к чему не приведёт.

Returns

Future<ActionResult>

Properties

val photoUrl

String

URL полноразмерной фотографии.

val author

AuthorInfo

Информация о пользователе, добавившем фотографию.

val timestamp

TimePoint

Временная метка.

val remover

Remover?

Получение объекта для удаления фотографии.

RoadEventRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoadEventRouteEntry>

fun findNearBackward(point: RoutePoint): RoadEventRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RoadEventRouteEntry?

fun findNearForward(point: RoutePoint): RoadEventRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RoadEventRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoadEventRouteEntry?

Первый элемент.

val last

RoadEventRouteEntry?

Последний элемент.

val entries

List<RoadEventRouteEntry>

Все элементы.

RoadEventRouteEntry

Элемент маршрута - точка и значение в ней.

RoadEventRouteEntry(point: RoutePoint, value: BriefRoadEvent)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

BriefRoadEvent

Properties

val point

RoutePoint

val value

BriefRoadEvent

RoadEventSource

Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.

Extends: ru.dgis.sdk.map.Source

RoadEventSource(context: Context)

Создание источника, отображающего дорожные события на карте.

Parameters

context

Context

Methods

fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit

Установка или снятие выделения дорожных событий.

добавляет событию атрибут "selected", который можно использовать в стилях.

Parameters

directoryObjectIds

List<DgisObjectId>

Идентификаторы изменяемых событий. Можно получить из RoadEventMapObject.

highlighted

Boolean

Установка или снятие выделения.

Returns

Unit

Properties

var roadEventFilter

RoadEventFilter?

val highlightedObjectsChannel

StatefulChannel<List<DgisObjectId>>

Получение списка идентификаторов выделенных дорожных событий.

val highlightedObjects

List<DgisObjectId>

Получение списка идентификаторов выделенных дорожных событий.

RoadRuleRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): RoadRuleRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

RoadRuleRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<RoadRuleRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoadRuleRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoadRuleRouteLongEntry?

Первый элемент.

val last

RoadRuleRouteLongEntry?

Последний элемент.

val entries

List<RoadRuleRouteLongEntry>

Все элементы.

RoadRuleRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

RoadRuleRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadRule
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RoadRule

Properties

val point

RoutePoint

val length

RouteDistance

val value

RoadRule

RoadSubtypeRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): RoadSubtypeRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

RoadSubtypeRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSubtypeRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoadSubtypeRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoadSubtypeRouteLongEntry?

Первый элемент.

val last

RoadSubtypeRouteLongEntry?

Последний элемент.

val entries

List<RoadSubtypeRouteLongEntry>

Все элементы.

RoadSubtypeRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

RoadSubtypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadSubtype
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RoadSubtype

Properties

val point

RoutePoint

val length

RouteDistance

val value

RoadSubtype

RoadSurfaceRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): RoadSurfaceRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

RoadSurfaceRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSurfaceRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoadSurfaceRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoadSurfaceRouteLongEntry?

Первый элемент.

val last

RoadSurfaceRouteLongEntry?

Последний элемент.

val entries

List<RoadSurfaceRouteLongEntry>

Все элементы.

RoadSurfaceRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

RoadSurfaceRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadSurface
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RoadSurface

Properties

val point

RoutePoint

val length

RouteDistance

val value

RoadSurface

RoadTypeRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): RoadTypeRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

RoadTypeRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<RoadTypeRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoadTypeRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoadTypeRouteLongEntry?

Первый элемент.

val last

RoadTypeRouteLongEntry?

Последний элемент.

val entries

List<RoadTypeRouteLongEntry>

Все элементы.

RoadTypeRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

RoadTypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RoadType
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RoadType

Properties

val point

RoutePoint

val length

RouteDistance

val value

RoadType

RotateMapToNorthEvent

Событие поворота карты на север.

Extends: ru.dgis.sdk.map.Event

RotateMapToNorthEvent()

RotationGestureSettings

Настройки жеста вращения.

Extends: ru.dgis.sdk.NativeObject

Properties

var recognizeSettings

RotationRecognizeSettings

Настройки распознавания вращения.

var rotationCenter

GestureActionPoint

Точка, относительно которой производится вращение карты.

var kinematicSettings

RotationKinematicSettings

Настройки кинематики вращения.

RotationKinematicSettings

RotationKinematicSettings(
	enabled: Boolean = true,
	decelerationCoefficient: Float = 10.0f,
	maxInitialForwardAngularSpeed: Float = 5.0f,
	initialBackwardAngularSpeed: Float = 0.40000001f,
	angleThreshold: Float = 0.050000001f
)

Parameters

enabled

Boolean

decelerationCoefficient

Float

maxInitialForwardAngularSpeed

Float

initialBackwardAngularSpeed

Float

angleThreshold

Float

Properties

val enabled

Boolean

Включает или отключает кинематику вращения. Если установлено в false, вращение мгновенно останавливается после окончания жеста, все остальные параметры игнорируются.

val decelerationCoefficient

Float

Коэффициент затухания вращения после окончания жеста. Чем выше значение, тем быстрее замедляется вращение.

val maxInitialForwardAngularSpeed

Float

Максимальная начальная угловая скорость после окончания жеста (в радианах в секунду).

val initialBackwardAngularSpeed

Float

Начальная угловая скорость возврата карты в исходное положение (в радианах в секунду).

val angleThreshold

Float

Порог углового отклонения (в радианах), при превышении которого карта продолжает вращение в направлении жеста. Если меньше — движется в сторону исходного положения.

RotationRecognizeSettings

Настройки распознавания вращения.

RotationRecognizeSettings(rotationThreshold: RotationRecognizeThresholds, rotationThresholdInScaling: RotationRecognizeThresholds)

Настройки распознавания вращения.

Parameters

rotationThreshold

RotationRecognizeThresholds

rotationThresholdInScaling

RotationRecognizeThresholds

Properties

val rotationThreshold

RotationRecognizeThresholds

Пороги перехода к вращению, если масштабирование не активно.

val rotationThresholdInScaling

RotationRecognizeThresholds

Пороги перехода к вращению, если масштабирование активно.

RotationRecognizeThresholds

RotationRecognizeThresholds(angleDiffDeg: Float = 5.0f, distanceDiffMm: Float = 5.0f)

Parameters

angleDiffDeg

Float

distanceDiffMm

Float

Properties

val angleDiffDeg

Float

Порог изменения угла, в градусах, преодоление которого говорит о начале вращения.

val distanceDiffMm

Float

Порог среднего радиального сдвига точек, в миллиметрах, преодоление которого говорит о начале вращения.

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

GeoPointRouteAttribute

Геометрия маршрута.

Не гарантируется, что RoutePoint у точек геометрии будет совпадать с RoutePoint у элементов других атрибутов, поэтому для того, чтобы вычислить географическую координату у элемента атрибута, не нужно искать в геометрии элемент, RoutePoint которого совпадает с RoutePoint элемента атрибута, вместо этого нужно воспользоваться функцией calculate_geo_point.

val instructions

InstructionRouteAttribute

Инструкции, которые необходимо выполнить для движения по маршруту.

val intermediatePoints

GeoPointRouteAttribute

Промежуточные точки, через которые проходит маршрут. Маршрут может проходить не прямо через промежуточную точку, а рядом с ней. В значении атрибута хранится координата, в которую была установлена промежуточная точка, в ключе - координата проекции промежуточной точки на маршрут.

val altitudes

DoubleRouteAttribute

Высоты на маршруте.

val badRoads

BoolRouteLongAttribute

Плохая дорога (на дороге присутствуют кочки и ямы, которые препятствуют проезду).

val obstacles

ObstacleInfoRouteAttribute

Препятствия на маршруте.

val roadNames

StringRouteLongAttribute

Названия дорог/улиц.

val settlements

SettlementRouteLongAttribute

Признак того, что участок маршрута проходит по населённому пункту.

val transportTypes

TransportTypeRouteLongAttribute

Вид транспорта, для которого построен участок маршрута.

val crossingTypes

CrossingTypeRouteLongAttribute

val tollPaymentPointInfos

RouteTollPaymentPointInfoRouteAttribute

val cameras

CameraRouteAttribute

Дорожные камеры.

val carriagewaysWidth

DoubleRouteLongAttribute

Ширина проезжей части в метрах. 0 - ширина неизвестна.

val exitSigns

RouteExitSignRouteAttribute

Знаки съездов.

val humps

VoidRouteAttribute

Искусственные неровности.

val lanes

LaneSignRouteLongAttribute

Полосы движения.

val levels

RouteLevelInfoRouteLongAttribute

Этажи зданий.

val maxSpeedLimits

FloatRouteLongAttribute

Ограничения максимальной допустимой скорости.

0 - ограничение скорости неизвестно.

val roadRules

RoadRuleRouteLongAttribute

Сторона движения.

val roadSubtypes

RoadSubtypeRouteLongAttribute

Дополнительное описание типа дороги, по которой пролегает маршрут.

val roadSurfaces

RoadSurfaceRouteLongAttribute

Покрытие дороги.

val roadTypes

RoadTypeRouteLongAttribute

Тип дороги, по которой пролегает маршрут.

val tolls

BoolRouteLongAttribute

Участки маршрута, пролегающие по платным дорогам.

val truckData

BoolRouteLongAttribute

Признак наличия или отсутствия данных для грузовой навигации.

val truckPassZoneIds

TruckPassZoneIdRouteLongAttribute

Пропускные зоны для грузового транспорта.

val truckRestrictedAreas

BoolRouteLongAttribute

Признак действия знака запрета проезда грузового транспорта.

val vehicleRestrictedAreas

BoolRouteLongAttribute

Признак действия знака запрета проезда любого автотранспорта (перекрытия).

val bicycleLanes

BoolRouteLongAttribute

Признак наличия выделенной велополосы.

val trafficLights

StringRouteAttribute

Признак наличия светофоров.

val immersiveData

BoolRouteLongAttribute

Признак наличия данных для иммерсивных дорог (т.е. дорог, которые на карте могут быть отрисованы с широким дорожным полотном и разметкой).

val immersiveHeights

RouteImmersiveHeightsRouteLongAttribute

Иммерсивные высоты и уровни. Ожидается, что заполены и учитываются там, где есть иммерсивные дороги, см. immersive_data().

val publicTransportTransfers

PublicTransportTransferRouteLongAttribute

Описание способов перемещения на общественном транспорте между точками пересадок.

RouteAltitudeItem

Элемент высоты на маршруте для графика высот.

RouteAltitudeItem(altitude: Double = 0.0, altitudeChange: AltitudeChange = AltitudeChange.UNDEFINED)

Элемент высоты на маршруте для графика высот.

Parameters

altitude

Double

altitudeChange

AltitudeChange

Properties

val altitude

Double

Относительная высота.

val altitudeChange

AltitudeChange

Изменение высоты.

RouteBuildOptions

Структура, которая описывает параметры построения маршрута в навигаторе.

RouteBuildOptions(finishPoint: RouteSearchPoint, routeSearchOptions: RouteSearchOptions)

Структура, которая описывает параметры построения маршрута в навигаторе.

Parameters

finishPoint

RouteSearchPoint

routeSearchOptions

RouteSearchOptions

Properties

val finishPoint

RouteSearchPoint

Точка, к которой строится маршут.

val routeSearchOptions

RouteSearchOptions

Параметры поиска маршрута.

RouteCamera

Структура, описывающая дорожную камеру.

RouteCamera(
	purposes: EnumSet<RouteCameraPurpose>,
	rangeAgainst: RouteDistance,
	rangeAlong: RouteDistance,
	direction: RouteCameraDirection = RouteCameraDirection.AGAINST,
	maxSpeedLimit: Float?,
	mobility: Boolean = false
)

Структура, описывающая дорожную камеру.

Parameters

purposes

EnumSet<RouteCameraPurpose>

rangeAgainst

RouteDistance

rangeAlong

RouteDistance

direction

RouteCameraDirection

maxSpeedLimit

Float?

mobility

Boolean

Properties

val purposes

EnumSet<RouteCameraPurpose>

Назначения камеры.

val rangeAgainst

RouteDistance

Дальность действия камеры против хода движения.

val rangeAlong

RouteDistance

Дальность действия камеры по ходу движения.

val direction

RouteCameraDirection

Направление действия камеры.

val maxSpeedLimit

Float?

Скорость, превышение которое фиксируется камерой, в м/с. Отсутствует, если камера не фиксирует превышение скорости.

val mobility

Boolean

Флаг, указывающий на мобильность камеры.

RouteDistance

Расстояние вдоль маршрута.

RouteDistance(millimeters: Long = 0)

Расстояние вдоль маршрута.

Parameters

millimeters

Long

Methods

fun absoluteValue(): RouteDistance

Returns

RouteDistance

operator fun compareTo(other: RouteDistance): Int

Parameters

other

RouteDistance

Returns

Int

operator fun plus(other: RouteDistance): RouteDistance

Parameters

other

RouteDistance

Returns

RouteDistance

operator fun minus(other: RouteDistance): RouteDistance

Parameters

other

RouteDistance

Returns

RouteDistance

operator fun times(multiplier: Int): RouteDistance

Parameters

multiplier

Int

Returns

RouteDistance

operator fun div(divisor: Int): RouteDistance

Parameters

divisor

Int

Returns

RouteDistance

operator fun rem(divisor: Int): RouteDistance

Parameters

divisor

Int

Returns

RouteDistance

Properties

val millimeters

Long

val meters

Double

val kilometers

Double

RouteEditor

Интерфейс для редактора маршрута. Редактор маршрута получает точки начала и конца маршрута, строит маршруты и через каналы оповещает об их обновлениях и перестроениях.

Все методы этого интерфейса вызываются из одного потока.

Extends: ru.dgis.sdk.NativeObject

RouteEditor(context: Context, trafficRouter: TrafficRouter? = null)

Функция создания редактора маршрута.

Parameters

context

Context

Контекст.

trafficRouter

TrafficRouter?

Поисковик маршрута для использования внутри редактора маршрута. Если не задан, по умолчанию используется гибридный поисковик.

Methods

fun setRouteParams(routeParams: RouteEditorRouteParams): Unit

Установка параметров редактора маршрута. Запускает поиск нового маршрута согласно переданным параметрам.

Parameters

routeParams

RouteEditorRouteParams

Returns

Unit

fun setActiveRouteIndex(index: RouteIndex): Unit

Установка индекса активного маршрута.

Parameters

index

RouteIndex

Returns

Unit

Properties

val routesInfoChannel

StatefulChannel<RouteEditorRoutesInfo>

Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.

val routesInfo

RouteEditorRoutesInfo

Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.

val activeRouteIndexChannel

StatefulChannel<RouteIndex?>

Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается null.

val activeRouteIndex

RouteIndex?

Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается null.

RouteEditorRouteParams

Информация о параметрах маршрута.

RouteEditorRouteParams(
	startPoint: RouteSearchPoint,
	finishPoint: RouteSearchPoint,
	routeSearchOptions: RouteSearchOptions,
	intermediatePoints: List<RouteSearchPoint> = listOf()
)

Информация о параметрах маршрута.

Parameters

startPoint

RouteSearchPoint

finishPoint

RouteSearchPoint

routeSearchOptions

RouteSearchOptions

intermediatePoints

List<RouteSearchPoint>

Properties

val startPoint

RouteSearchPoint

val finishPoint

RouteSearchPoint

val routeSearchOptions

RouteSearchOptions

val intermediatePoints

List<RouteSearchPoint>

RouteEditorRoutesInfo

Информация о маршрутах, которыми оперирует редактор.

RouteEditorRoutesInfo(
	routes: List<TrafficRoute>,
	error: RouterErrorInfo?,
	routeParams: RouteEditorRouteParams,
	availablePublicTransportQuickFilters: EnumSet<PublicTransportQuickFilter>
)

Информация о маршрутах, которыми оперирует редактор.

Parameters

routes

List<TrafficRoute>

error

RouterErrorInfo?

routeParams

RouteEditorRouteParams

availablePublicTransportQuickFilters

EnumSet<PublicTransportQuickFilter>

Properties

val routes

List<TrafficRoute>

При обновлении списка маршрутов активным будет первый маршрут, если список маршрутов непустой.

val error

RouterErrorInfo?

Информация об ошибке поиска, если поиск маршрута завершается с ошибкой.

val routeParams

RouteEditorRouteParams

Параметры маршрута, для которых выполнялся поиск. Могут отличаться от параметров, переданных редактору, если маршруты были найдены уже после изменения параметров в редакторе.

val availablePublicTransportQuickFilters

EnumSet<PublicTransportQuickFilter>

Для маршрутов на общественном транспорте: список быстрых фильтров, применимых к текущему набору маршрутов.

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

Context

routeEditor

RouteEditor

activeDisplayFlags

EnumSet?<RouteMapObjectDisplayFlag>

inactiveDisplayFlags

EnumSet?<RouteMapObjectDisplayFlag>

activeCalloutLabelFlags

EnumSet?<RouteMapObjectCalloutLabelFlag>

inactiveCalloutLabelFlags

EnumSet?<RouteMapObjectCalloutLabelFlag>

calloutLabelDisplayMode

RouteMapObjectCalloutLabelDisplayMode

activePermanentDisplayFlags

EnumSet?<RouteMapObjectPermanentDisplayFlag>

inactivePermanentDisplayFlags

EnumSet?<RouteMapObjectPermanentDisplayFlag>

Methods

fun setRoutesVisible(visible: Boolean): Unit

Включить или выключить отображение маршрутов на карте.

Parameters

visible

Boolean

Returns

Unit

fun setShowOnlyActiveRoute(showOnlyActiveRoute: Boolean): Unit

Отображать на карте все маршруты (false) или только текущий активный маршрут (true).

Parameters

showOnlyActiveRoute

Boolean

Returns

Unit

fun setPassedDistanceVisualization(passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization): Unit

Изменить способ визуализации расстояния, пройденного вдоль маршрута.

Parameters

passedDistanceVisualization

RouteMapObjectPassedDistanceVisualization

Returns

Unit

Properties

val objects

List<RouteMapObject>

Объекты маршрута на карте.

val routeSourceSettings

RouteSourceSettings

Настройки отображения маневров на маршруте.

var activeDisplayFlags

EnumSet?<RouteMapObjectDisplayFlag>

Флаги отображения активного маршрута. См. IRouteMapObject::display_flags.

var inactiveDisplayFlags

EnumSet?<RouteMapObjectDisplayFlag>

Флаги отображения неактивных маршрутов. См. IRouteMapObject::display_flags.

var activeCalloutLabelFlags

EnumSet?<RouteMapObjectCalloutLabelFlag>

Флаги, включающие отображение содержимого в баблах активного маршрута. См. IRouteMapObject::callout_label_flags.

var inactiveCalloutLabelFlags

EnumSet?<RouteMapObjectCalloutLabelFlag>

Флаги, включающие отображение содержимого в баблах неактивных маршрутов. См. IRouteMapObject::callout_label_flags.

var calloutLabelDisplayMode

RouteMapObjectCalloutLabelDisplayMode

Режим отображения значений в баблах маршрутов. См. IRouteMapObject::callout_label_display_mode.

var activePermanentDisplayFlags

EnumSet?<RouteMapObjectPermanentDisplayFlag>

Флаги, исключающие скрытие компонентов активного маршрута с карты. См. IRouteMapObject::permanent_display_flags.

var inactivePermanentDisplayFlags

EnumSet?<RouteMapObjectPermanentDisplayFlag>

Флаги, исключающие скрытие компонентов неактивных маршрутов с карты. См. IRouteMapObject::permanent_display_flags.

RouteEnclosingRectsOptions

Параметры для получения набора прямоугольников, описанных вокруг упрощённой геометрии маршрута.

RouteEnclosingRectsOptions(
	offset: Double = 0.0,
	segmentSize: RouteDistance,
	maxSliceSize: Long? = null,
	maxArea: Double? = null
)

Параметры для получения набора прямоугольников, описанных вокруг упрощённой геометрии маршрута.

Parameters

offset

Double

segmentSize

RouteDistance

maxSliceSize

Long?

maxArea

Double?

Properties

val offset

Double

Отступ влево/вправо от линии, аппроксимирующей геометрию маршрута, в метрах. Должен быть ненулевой положительной величиной.

val segmentSize

RouteDistance

Размер одного сегмента ломаной линии, аппроксимирующей геометрию маршрута. Должен быть положительным.

val maxSliceSize

Long?

Максимальное количество прямоугольников входящих в одну геометрию.

val maxArea

Double?

Максимальная сумма площадей прямоугольников в квадратных километрах входящих в одну геометрию.

RouteExitSign

Информация о знаке съезда.

RouteExitSign(
	type: RouteExitSignType = RouteExitSignType.UNDEFINED,
	roadNameTable: RouteExitSignTable,
	roadNumberTable: RouteExitSignTable?
)

Информация о знаке съезда.

Parameters

type

RouteExitSignType

roadNameTable

RouteExitSignTable

roadNumberTable

RouteExitSignTable?

Properties

val type

RouteExitSignType

Тип съезда.

val roadNameTable

RouteExitSignTable

Табличка съезда с названием дороги.

val roadNumberTable

RouteExitSignTable?

Табличка съезда с номером дороги.

RouteExitSignRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<RouteExitSignRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RouteExitSignRouteEntry>

fun findNearBackward(point: RoutePoint): RouteExitSignRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RouteExitSignRouteEntry?

fun findNearForward(point: RoutePoint): RouteExitSignRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RouteExitSignRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RouteExitSignRouteEntry?

Первый элемент.

val last

RouteExitSignRouteEntry?

Последний элемент.

val entries

List<RouteExitSignRouteEntry>

Все элементы.

RouteExitSignRouteEntry

Элемент маршрута - точка и значение в ней.

RouteExitSignRouteEntry(point: RoutePoint, value: RouteExitSign)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

RouteExitSign

Properties

val point

RoutePoint

val value

RouteExitSign

RouteExitSignTable

Информация о табличке съезда.

RouteExitSignTable(backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.UNDEFINED, text: String)

Информация о табличке съезда.

Parameters

backgroundColor

RouteExitSignTableColor

text

String

Properties

val backgroundColor

RouteExitSignTableColor

Цвет фона таблички съезда.

val text

String

Текст на табличке съезда.

RouteImmersiveHeights

Значения высот и уровней для иммерсивных участков дорожного графа.

RouteImmersiveHeights(
	zLevelBegin: Int = 0,
	zLevelEnd: Int = 0,
	relativeHeightBegin: Double? = null,
	relativeHeightEnd: Double? = null
)

Значения высот и уровней для иммерсивных участков дорожного графа.

Parameters

zLevelBegin

Int

zLevelEnd

Int

relativeHeightBegin

Double?

relativeHeightEnd

Double?

Properties

val zLevelBegin

Int

Z-уровень начала участка.

val zLevelEnd

Int

Z-уровень конца участка.

val relativeHeightBegin

Double?

Относительная высота начала геометрии в метрах (относительно 0 Z-уровня).

val relativeHeightEnd

Double?

Относительный высота конца геометрии в метрах (относительно 0 Z-уровня).

RouteImmersiveHeightsRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): RouteImmersiveHeightsRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

RouteImmersiveHeightsRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<RouteImmersiveHeightsRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RouteImmersiveHeightsRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RouteImmersiveHeightsRouteLongEntry?

Первый элемент.

val last

RouteImmersiveHeightsRouteLongEntry?

Последний элемент.

val entries

List<RouteImmersiveHeightsRouteLongEntry>

Все элементы.

RouteImmersiveHeightsRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

RouteImmersiveHeightsRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RouteImmersiveHeights
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RouteImmersiveHeights

Properties

val point

RoutePoint

val length

RouteDistance

val value

RouteImmersiveHeights

RouteIndex

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

RouteIndex(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

RouteInfo

Описание маршрута с манёврами.

RouteInfo(
	route: Route,
	routeBuildOptions: RouteBuildOptions?,
	external: Boolean = false
)

Описание маршрута с манёврами.

Parameters

route

Route

routeBuildOptions

RouteBuildOptions?

external

Boolean

Properties

val route

Route

Маршрут.

val routeBuildOptions

RouteBuildOptions?

Параметры построения маршрута в навигаторе. Значение равное null означает, что у маршрута отсутствует конечная точка. В этом случае, на основании дорожного графа и параметров движения пользователя, вычисляется участок дороги, по которому предположительно движется пользователь и возвращается в виде маршрута в поле route. Следовательно, такой "маршрут" не может содержать инструкции и последняя точка в этом "маршруте" не является точкой назначения, в которую движется пользователь, а просто является точкой, до которой удалось предугадать движение пользователя. Куда он поедет дальше - неизвестно. Такой режим работы навигатора называется режим ведения без маршрута или free roam.

val external

Boolean

Источник маршрута. True - маршрут передан навигатору снаружи в методе start. False - маршрут сгенерирован самим навигатором.

RouteInfoCalloutMapObject

Объект бабла с информацией о длине и/или длительности маршрута на карте.

Extends: ru.dgis.sdk.map.MapObject

Properties

val route

TrafficRoute

Маршрут, часть которого представляет данный объект бабла.

val routeIndex

RouteIndex

Индекс маршрута.

val routePoint

RoutePoint

Позиция на маршруте, на которой расположен бабл.

RouteInstruction

Инструкция, которую необходимо выполнить для движения по маршруту.

RouteInstruction(
	roadName: String,
	range: RouteDistance,
	extraInstructionInfo: ExtraInstructionInfo
)

Инструкция, которую необходимо выполнить для движения по маршруту.

Parameters

roadName

String

range

RouteDistance

extraInstructionInfo

ExtraInstructionInfo

Properties

val roadName

String

Название дороги, на которой окажется пользователь после совершения манёвра.

val range

RouteDistance

Расстояние после точки инструкции, на протяжении которого считается, что пользователь находится в зоне действия инструкции.

val extraInstructionInfo

ExtraInstructionInfo

Специфичная для конкретного типа инструкции информация.

RouteLane

Структура, описывающая одну полосу движения.

RouteLane(
	routeManeuver: RouteLaneManeuver = RouteLaneManeuver.UNDEFINED,
	maneuvers: EnumSet<RouteLaneManeuver>,
	speedLimit: Float = 0.0f,
	prohibited: Boolean = false,
	onlyPublicTransport: Boolean = false
)

Структура, описывающая одну полосу движения.

Parameters

routeManeuver

RouteLaneManeuver

maneuvers

EnumSet<RouteLaneManeuver>

speedLimit

Float

prohibited

Boolean

onlyPublicTransport

Boolean

Properties

val routeManeuver

RouteLaneManeuver

Манёвр, который необходимо совершить для движения по маршруту.

val maneuvers

EnumSet<RouteLaneManeuver>

Допустимые манёвры на полосе.

val speedLimit

Float

Максимальная разрешенная скорость на полосе, м/с. 0 - ограничение скорости неизвестно.

val prohibited

Boolean

Проезд по полосе запрещён.

val onlyPublicTransport

Boolean

Полоса для общественного транспорта.

RouteLaneSign

Описание полос движения.

RouteLaneSign(
	lanes: List<RouteLane>,
	signStartPoint: RoutePoint?,
	signPoint: RoutePoint?,
	signEndPoint: RoutePoint?
)

Описание полос движения.

Parameters

lanes

List<RouteLane>

signStartPoint

RoutePoint?

signPoint

RoutePoint?

signEndPoint

RoutePoint?

Properties

val lanes

List<RouteLane>

Полосы движения для автомобилей на участке дороги. Перечислены в порядке следования от середины проезжей части к обочине.

Если количество полос неизвестно либо в направлении маршрута на дороге находится одна полоса движения, то этот массив будет пустым.

val signStartPoint

RoutePoint?

Точка на маршруте, в которой начинается действие знака, регулирующего движение по полосам. null, если положение начала действия знака неизвестно.

val signPoint

RoutePoint?

Точка на маршруте, в которой установлен знак, регулирующий движение по полосам. null, если положение знака неизвестно.

val signEndPoint

RoutePoint?

Точка на маршруте, в которой заканчивается действие знака, регулирующего движение по полосам. null, если положение окончания действия знака неизвестно.

RouteLevelInfo

Информация об этаже здания, соответствующая участку маршрута.

RouteLevelInfo(
	beginId: LevelId?,
	endId: LevelId?,
	name: String
)

Информация об этаже здания, соответствующая участку маршрута.

Parameters

beginId

LevelId?

endId

LevelId?

name

String

Properties

val beginId

LevelId?

Идентификатор этажного плана в начальной точке участка маршрута. Отсутствует, если точка не находится в здании.

val endId

LevelId?

Идентификатор этажного плана в конечной точке участка маршрута. Отсутствует, если точка не находится в здании.

val name

String

Название этажа. Пусто, если участок маршрута соединяет разные этажи.

RouteLevelInfoRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): RouteLevelInfoRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

RouteLevelInfoRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<RouteLevelInfoRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RouteLevelInfoRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RouteLevelInfoRouteLongEntry?

Первый элемент.

val last

RouteLevelInfoRouteLongEntry?

Последний элемент.

val entries

List<RouteLevelInfoRouteLongEntry>

Все элементы.

RouteLevelInfoRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

RouteLevelInfoRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: RouteLevelInfo
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

RouteLevelInfo

Properties

val point

RoutePoint

val length

RouteDistance

val value

RouteLevelInfo

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

TrafficRoute

isActive

Boolean

index

RouteIndex

displayFlags

EnumSet?<RouteMapObjectDisplayFlag>

calloutLabelFlags

EnumSet?<RouteMapObjectCalloutLabelFlag>

calloutLabelDisplayMode

RouteMapObjectCalloutLabelDisplayMode

permanentDisplayFlags

EnumSet?<RouteMapObjectPermanentDisplayFlag>

Properties

val displayFlagsChannel

StatefulChannel<EnumSet?<RouteMapObjectDisplayFlag>>

Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.

var displayFlags

EnumSet?<RouteMapObjectDisplayFlag>

Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.

val permanentDisplayFlagsChannel

StatefulChannel<EnumSet?<RouteMapObjectPermanentDisplayFlag>>

Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.

var permanentDisplayFlags

EnumSet?<RouteMapObjectPermanentDisplayFlag>

Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.

val isActiveChannel

StatefulChannel<Boolean>

Статус активности маршрута.

var isActive

Boolean

Статус активности маршрута.

val route

TrafficRoute

Маршрут.

val routeIndex

RouteIndex

Индекс маршрута в редакторе маршрута.

val passedDistanceChannel

StatefulChannel<RouteDistance>

Пройденное расстояние вдоль маршрута.

var passedDistance

RouteDistance

Пройденное расстояние вдоль маршрута.

val passedDistanceVisualizationChannel

StatefulChannel<RouteMapObjectPassedDistanceVisualization>

var passedDistanceVisualization

RouteMapObjectPassedDistanceVisualization

val calloutPositionChannel

StatefulChannel<List<CalloutMapPosition>>

Положение бабла маршрута.

val calloutPosition

List<CalloutMapPosition>

Положение бабла маршрута.

val calloutLabelFlagsChannel

StatefulChannel<EnumSet?<RouteMapObjectCalloutLabelFlag>>

Набор флагов для отображения содержимого баблов маршрута. Набор флагов для отображения содержимого баблов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.

var calloutLabelFlags

EnumSet?<RouteMapObjectCalloutLabelFlag>

Набор флагов для отображения содержимого баблов маршрута. Набор флагов для отображения содержимого баблов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.

val calloutLabelDisplayModeChannel

StatefulChannel<RouteMapObjectCalloutLabelDisplayMode>

Режим отображения значений в баблах маршрута. По умолчанию значения отображаются в виде абсолютных величин.

var calloutLabelDisplayMode

RouteMapObjectCalloutLabelDisplayMode

Режим отображения значений в баблах маршрута. По умолчанию значения отображаются в виде абсолютных величин.

val roadEventObjectsChannel

StatefulChannel<RoadEventMapObjectRouteAttribute>

Отображаемые на карте объекты дорожных событий вдоль маршрута.

val roadEventObjects

RoadEventMapObjectRouteAttribute

Отображаемые на карте объекты дорожных событий вдоль маршрута.

RouteMapObjectSource

Источник объектов маршрута на карте.

Extends: ru.dgis.sdk.map.Source

RouteMapObjectSource(context: Context, routeVisualizationType: RouteVisualizationType = RouteVisualizationType.NORMAL)

Функция создания IRouteMapObjectSource.

Parameters

context

Context

routeVisualizationType

RouteVisualizationType

Methods

fun addObject(item: RouteMapObject): Unit

Добавление объекта маршрута в источник.

Parameters

item

RouteMapObject

Returns

Unit

fun removeObject(item: RouteMapObject): Unit

Удаление объекта маршрута из источника.

Parameters

item

RouteMapObject

Returns

Unit

fun replaceObject(oldObject: RouteMapObject, newObject: RouteMapObject): Unit

Замена одного объекта маршрута в источнике на другой. В отличие от удаления и добавления объектов маршрута через последовательные вызовы remove_object и add_object замена одного маршрута на другой выполняется атомарно - старый маршрут удаляется, а новый появляется на карте одновременно.

Если старый маршрут не найден в источнике, то вызов эквивалентен вызову add_object.

Parameters

oldObject

RouteMapObject

newObject

RouteMapObject

Returns

Unit

fun clear(): Unit

Удаление всех объектов маршрута из источника.

Returns

Unit

fun replaceAllObjects(objects: List<RouteMapObject>): Unit

Замена всех ранее добавленных в источник объектов на передаваемый список объектов. В отличие от удаления и добавления объектов по одному замена выполняется атомарно - старые маршруты удаляются, а новые маршруты появляются на карте одновременно.

Parameters

objects

List<RouteMapObject>

Returns

Unit

Properties

val objects

List<RouteMapObject>

Объекты маршрута.

val routeSourceSettings

RouteSourceSettings

Настройка отображения объектов в источнике.

RouteMapObjectsProvider

Интерфейс для получения объектов маршрута на карте.

Extends: ru.dgis.sdk.NativeObject

Properties

val objectsChannel

StatefulChannel<List<RouteMapObject>>

Объекты маршрута на карте.

val objects

List<RouteMapObject>

Объекты маршрута на карте.

RouteMapSettings

Настройки отображения маршрута на карте.

Extends: ru.dgis.sdk.NativeObject

Properties

var onRouteDisplayFlags

EnumSet<RouteMapObjectDisplayFlag>

Флаги отображения маршрута на карте для режима ведения по маршруту. По умолчанию включены все флаги, за исключением флага InactiveFloors.

var freeRoamDisplayFlags

EnumSet<RouteMapObjectDisplayFlag>

Флаги отображения маршрута на карте для режима free roam. По умолчанию включены флаги Cameras, Humps, Accidents, RoadWorks, Comments, RoadRestrictions, OtherEvents.

var onRoutePermanentDisplayFlags

EnumSet<RouteMapObjectPermanentDisplayFlag>

Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима ведения по маршруту. По умолчанию скрываются все элементы маршрута.

var freeRoamPermanentDisplayFlags

EnumSet<RouteMapObjectPermanentDisplayFlag>

Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима free roam. По умолчанию скрываются все элементы маршрута.

RouteOverviewControl

UI-элемент, отображаемый в режиме просмотра маршрута.

Extends: ru.dgis.sdk.navigation.NavigationControl

RouteOverviewControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент, отображаемый в режиме просмотра маршрута.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

fun onVisibilityChanged(changedView: View, visibility: Int): Unit

Parameters

changedView

View

visibility

Int

Returns

Unit

RoutePoint

Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.

RoutePoint(distance: RouteDistance)

Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.

Parameters

distance

RouteDistance

Methods

operator fun compareTo(other: RoutePoint): Int

Parameters

other

RoutePoint

Returns

Int

operator fun plus(distance: RouteDistance): RoutePoint

Parameters

distance

RouteDistance

Returns

RoutePoint

operator fun minus(distance: RouteDistance): RoutePoint

Parameters

distance

RouteDistance

Returns

RoutePoint

operator fun minus(other: RoutePoint): RouteDistance

Parameters

other

RoutePoint

Returns

RouteDistance

Properties

val distance

RouteDistance

RoutePointMapObject

Точечный объект, являющийся частью маршрута на карте (например, точка начала или конца маршрута).

Extends: ru.dgis.sdk.map.MapObject

Properties

val route

TrafficRoute

Маршрут, часть которого представляет данный точечный объект.

val routeIndex

RouteIndex

Индекс маршрута.

val kind

RoutePointKind

Тип точечного объекта маршрута.

val routePoint

RoutePoint

Позиция на маршруте, соответствующая данному точечному объекту.

val pointChannel

StatefulChannel<GeoPoint>

Географические координаты, в которых находится данный точечный объект.

var point

GeoPoint

Географические координаты, в которых находится данный точечный объект.

RouteRebuilder

Контроллер поиска нового маршрута при сходе с текущего маршрута.

Extends: ru.dgis.sdk.NativeObject

Properties

var enabled

Boolean

RouterErrorInfo

Информация об ошибке поисковика маршрута.

RouterErrorInfo(source: RouterErrorSource = RouterErrorSource.HYBRID_ROUTER, code: RouterErrorCode = RouterErrorCode.INTERNAL_ERROR)

Информация об ошибке поисковика маршрута.

Parameters

source

RouterErrorSource

code

RouterErrorCode

Properties

val source

RouterErrorSource

Информация об источнике ошибки.

val code

RouterErrorCode

Код ошибки.

RouteSearchOptions

Параметры поиска маршрута.

RouteSearchOptions(bicycle: BicycleRouteSearchOptions)

Parameters

bicycle

BicycleRouteSearchOptions

RouteSearchOptions(car: CarRouteSearchOptions)

Parameters

car

CarRouteSearchOptions

RouteSearchOptions(motorcycle: MotorcycleRouteSearchOptions)

Parameters

motorcycle

MotorcycleRouteSearchOptions

RouteSearchOptions(pedestrian: PedestrianRouteSearchOptions)

Parameters

pedestrian

PedestrianRouteSearchOptions

RouteSearchOptions(publicTransport: PublicTransportRouteSearchOptions)

Parameters

publicTransport

PublicTransportRouteSearchOptions

RouteSearchOptions(scooter: ScooterRouteSearchOptions)

Parameters

scooter

ScooterRouteSearchOptions

RouteSearchOptions(taxi: TaxiRouteSearchOptions)

Parameters

taxi

TaxiRouteSearchOptions

RouteSearchOptions(truck: TruckRouteSearchOptions)

Parameters

truck

TruckRouteSearchOptions

Methods

fun match(
	bicycle: Function1,
	car: Function1,
	motorcycle: Function1,
	pedestrian: Function1,
	publicTransport: Function1,
	scooter: Function1,
	taxi: Function1,
	truck: Function1
): T

Parameters

bicycle

(BicycleRouteSearchOptions) -> T

car

(CarRouteSearchOptions) -> T

motorcycle

(MotorcycleRouteSearchOptions) -> T

pedestrian

(PedestrianRouteSearchOptions) -> T

publicTransport

(PublicTransportRouteSearchOptions) -> T

scooter

(ScooterRouteSearchOptions) -> T

taxi

(TaxiRouteSearchOptions) -> T

truck

(TruckRouteSearchOptions) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isBicycle

Boolean

val asBicycle

BicycleRouteSearchOptions?

val isCar

Boolean

val asCar

CarRouteSearchOptions?

val isMotorcycle

Boolean

val asMotorcycle

MotorcycleRouteSearchOptions?

val isPedestrian

Boolean

val asPedestrian

PedestrianRouteSearchOptions?

val isPublicTransport

Boolean

val asPublicTransport

PublicTransportRouteSearchOptions?

val isScooter

Boolean

val asScooter

ScooterRouteSearchOptions?

val isTaxi

Boolean

val asTaxi

TaxiRouteSearchOptions?

val isTruck

Boolean

val asTruck

TruckRouteSearchOptions?

val value

Any?

RouteSearchPoint

Описание точек, по которым строится маршрут.

RouteSearchPoint(
	coordinates: GeoPoint,
	course: Bearing? = null,
	objectId: DgisObjectId = DgisObjectId(objectId = 0, entranceId = 0),
	levelId: LevelId? = null
)

Описание точек, по которым строится маршрут.

Parameters

coordinates

GeoPoint

course

Bearing?

objectId

DgisObjectId

levelId

LevelId?

Properties

val coordinates

GeoPoint

Координаты, через которые нужно проложить маршрут.

val course

Bearing?

Направление, в котором нужно преодолеть точку.

val objectId

DgisObjectId

ID объекта, до которого будет проложена пешеходная часть маршрута.

val levelId

LevelId?

Идентификатор этажного плана (для пешеходных маршрутов).

RouteSourceSettings

Настройки источника маршрута.

Extends: ru.dgis.sdk.NativeObject

Methods

fun getLargeScaleMergeDistanceMeters(transportType: TransportType): Float

Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба. Если расстояние меньше заданного, то стрелки объединяются.

Parameters

transportType

TransportType

Тип транспорта, для которого запрашивается расстояние.

Returns

Float

fun setLargeScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit

Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба.

Parameters

distance

Float

Расстояние в метрах.

transportType

TransportType

Тип транспорта, для которого устанавливается расстояние.

Returns

Unit

fun getSmallScaleMergeDistanceMeters(transportType: TransportType): Float

Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба. Если расстояние меньше заданного, то стрелки объединяются.

Parameters

transportType

TransportType

Тип транспорта, для которого запрашивается расстояние.

Returns

Float

fun setSmallScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit

Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба.

Parameters

distance

Float

Расстояние в метрах.

transportType

TransportType

Тип транспорта, для которого устанавливается расстояние.

Returns

Unit

fun getLargeScaleCrossroadsOffsetMeters(transportType: TransportType): Float

Смещение в метрах от точки перекрестка до начала и конца стрелки манёвра для крупного масштаба.

Parameters

transportType

TransportType

Тип транспорта, для которого запрашивается смещение.

Returns

Float

fun setLargeScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit

Установить смещение в метрах от точки перекрестка до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.

Parameters

offset

Float

Смещение в метрах.

transportType

TransportType

Тип транспорта, для которого устанавливается смещение.

Returns

Unit

fun getSmallScaleCrossroadsOffsetMeters(transportType: TransportType): Float

Смещение от точки перекрестка до начала и конца стрелки манёвра для мелкого масштаба.

Parameters

transportType

TransportType

Тип транспорта, для которого запрашивается смещение.

Returns

Float

fun setSmallScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit

Установить смещение от точки перекрестка до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.

Parameters

offset

Float

Смещение в метрах.

transportType

TransportType

Тип транспорта, для которого устанавливается смещение.

Returns

Unit

Properties

var largeScaleRingroadOffsetMeters

Float

Смещение от точки съезда с кольца до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.

var smallScaleRingroadOffsetMeters

Float

Смещение от точки съезда с кольца до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.

var calloutVisualizationMode

CalloutVisualizationMode

Режим отображения баблов со временем и длиной маршрута.

RouteSummary

RouteSummary(bicycle: BicycleRouteSummary)

Parameters

bicycle

BicycleRouteSummary

RouteSummary(car: CarRouteSummary)

Parameters

car

CarRouteSummary

RouteSummary(motorcycle: MotorcycleRouteSummary)

Parameters

motorcycle

MotorcycleRouteSummary

RouteSummary(pedestrian: PedestrianRouteSummary)

Parameters

pedestrian

PedestrianRouteSummary

RouteSummary(scooter: ScooterRouteSummary)

Parameters

scooter

ScooterRouteSummary

Methods

fun match(
	bicycle: Function1,
	car: Function1,
	motorcycle: Function1,
	pedestrian: Function1,
	scooter: Function1
): T

Parameters

bicycle

(BicycleRouteSummary) -> T

car

(CarRouteSummary) -> T

motorcycle

(MotorcycleRouteSummary) -> T

pedestrian

(PedestrianRouteSummary) -> T

scooter

(ScooterRouteSummary) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isBicycle

Boolean

val asBicycle

BicycleRouteSummary?

val isCar

Boolean

val asCar

CarRouteSummary?

val isMotorcycle

Boolean

val asMotorcycle

MotorcycleRouteSummary?

val isPedestrian

Boolean

val asPedestrian

PedestrianRouteSummary?

val isScooter

Boolean

val asScooter

ScooterRouteSummary?

val value

Any?

RouteSummaryProvider

Провайдер сводной информации по маршруту.

Extends: ru.dgis.sdk.NativeObject

RouteSummaryProvider()

Создание объекта для получения сводной информации по маршруту.

Methods

fun routeSummary(trafficRoute: TrafficRoute): RouteSummary?

Получить сводную информацию по маршруту.

Parameters

trafficRoute

TrafficRoute

Маршрут, для которого требуется получить сводную информацию.

Returns

RouteSummary?

RouteTollPaymentInfo

Информация о стоимости проезда по платному участку маршрута.

RouteTollPaymentInfo(currencyCode: String, cost: Float = 0.0f)

Информация о стоимости проезда по платному участку маршрута.

Parameters

currencyCode

String

cost

Float

Properties

val currencyCode

String

Трёхбуквенный код валюты, в которой указана стоимость проезда, согласно ISO 4217.

val cost

Float

Стоимость проезда по платному участку маршрута.

RouteTollPaymentPointInfo

Информация о пункте оплаты проезда платной дороги.

RouteTollPaymentPointInfo(
	type: RouteTollPaymentPointType,
	payment: RouteTollPaymentInfo,
	untilTime: TimePoint?,
	name: String,
	description: String
)

Информация о пункте оплаты проезда платной дороги.

Parameters

type

RouteTollPaymentPointType

payment

RouteTollPaymentInfo

untilTime

TimePoint?

name

String

description

String

Properties

val type

RouteTollPaymentPointType

Тип оплаты проезда по платной дороге.

val payment

RouteTollPaymentInfo

Информация о стоимости проезда по платной дороге.

val untilTime

TimePoint?

Время, до которого действует указанная стоимость проезда по платной дороге, указывается только в случае, если это время достаточно близко ко времени получения маршрута.

val name

String

Название платной дороги, если известно.

val description

String

Текстовое описание платной дороги, если известно.

RouteTollPaymentPointInfoRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<RouteTollPaymentPointInfoRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RouteTollPaymentPointInfoRouteEntry>

fun findNearBackward(point: RoutePoint): RouteTollPaymentPointInfoRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RouteTollPaymentPointInfoRouteEntry?

fun findNearForward(point: RoutePoint): RouteTollPaymentPointInfoRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RouteTollPaymentPointInfoRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RouteTollPaymentPointInfoRouteEntry?

Первый элемент.

val last

RouteTollPaymentPointInfoRouteEntry?

Последний элемент.

val entries

List<RouteTollPaymentPointInfoRouteEntry>

Все элементы.

RouteTollPaymentPointInfoRouteEntry

Элемент маршрута - точка и значение в ней.

RouteTollPaymentPointInfoRouteEntry(point: RoutePoint, value: RouteTollPaymentPointInfo)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

RouteTollPaymentPointInfo

Properties

val point

RoutePoint

val value

RouteTollPaymentPointInfo

RubricId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

RubricId(value: Long = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Long

Properties

val value

Long

ScaleMapEvent

Событие изменения масштаба карты.

Extends: ru.dgis.sdk.map.Event

ScaleMapEvent(zoomDelta: Float, scalingCenter: ScreenPoint? = null)

Конструктор события изменения масштаба.

Parameters

zoomDelta

Float

Величина, на которую изменится текущее значение масштаба.

scalingCenter

ScreenPoint?

Точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.

Properties

val zoomDelta

Float

Величина, на которую изменится текущее значение масштаба.

val scalingCenter

ScreenPoint?

Точка на экране, относительно которой масштабируется карта.

ScalingGestureSettings

Настройки жеста масштабирования.

Extends: ru.dgis.sdk.NativeObject

Properties

var recognizeSettings

ScalingRecognizeSettings

Настройки распознавания масштабирования.

var scalingCenter

GestureActionPoint

Точка, относительно которой производится масштабирование карты.

var kinematicSettings

ScalingKinematicSettings

Настройки кинематики масштабирования.

ScalingKinematicSettings

ScalingKinematicSettings(
	enabled: Boolean = true,
	decelerationCoefficient: Float = 14.0f,
	maxInitialForwardZoomSpeed: Float = 14.0f,
	zoomThreshold: Float = 0.050000001f
)

Parameters

enabled

Boolean

decelerationCoefficient

Float

maxInitialForwardZoomSpeed

Float

zoomThreshold

Float

Properties

val enabled

Boolean

Включает или отключает кинематику масштабирования. Если установлено в false, масштабирование мгновенно останавливается после окончания жеста, и все остальные параметры игнорируются.

val decelerationCoefficient

Float

Коэффициент затухания масштабирования после окончания жеста. Чем выше значение, тем быстрее замедляется масштабирование.

val maxInitialForwardZoomSpeed

Float

Максимальная начальная скорость после окончания жеста (dgis::map::Zoom в секунду).

val zoomThreshold

Float

Порог отклонения dgis::map::Zoom, при превышении которого карта продолжает масштабирование в направлении жеста. Если меньше — движется в сторону исходного положения.

ScalingRecognizeSettings

Настройки распознавания масштабирования. Коэффициент масштабирования рассчитывается как отношения расстояния между точками после перемещения и исходным расстоянием.

ScalingRecognizeSettings(
	scaleRatioThreshold: Float = 1.1f,
	scaleRatioThresholdInRotation: Float = 1.2f,
	zoomScaleRatio: Float = 2.0f,
	scaleLogDiffPerMm: Float = 0.050000001f,
	disableZoom: Boolean = false
)

Настройки распознавания масштабирования. Коэффициент масштабирования рассчитывается как отношения расстояния между точками после перемещения и исходным расстоянием.

Parameters

scaleRatioThreshold

Float

scaleRatioThresholdInRotation

Float

zoomScaleRatio

Float

scaleLogDiffPerMm

Float

disableZoom

Boolean

Properties

val scaleRatioThreshold

Float

Порог коэффициента масштабирования, преодоление которого говорит о начале масштабирования. Используется, если вращение неактивно. Множитель должен выйти за пределы (1 / scale_ratio_threshold, scale_ratio_threshold).

val scaleRatioThresholdInRotation

Float

Порог коэффициента масштабирования, преодоление которого говорит о начале масштабирования. Используется, если вращение активно. Множитель должен выйти за пределы (1 / scale_ratio_threshold_in_rotation, scale_ratio_threshold_in_rotation).

val zoomScaleRatio

Float

Отношение логарифмов старого и нового масштабов при обработке мгновенного события изменения масштаба.

val scaleLogDiffPerMm

Float

Разница логарифмов масштабов при смещении на 1 мм. на экране.

val disableZoom

Boolean

Отключение жестов ZoomEvent и DirectMapScaleEvent.

Schedule

Расписание действия дорожного события.

Schedule(
	startTime: TimePoint?,
	finishTime: TimePoint?,
	weekTimeIntervals: List<WeekTimeInterval>
)

Расписание действия дорожного события.

Parameters

startTime

TimePoint?

finishTime

TimePoint?

weekTimeIntervals

List<WeekTimeInterval>

Properties

val startTime

TimePoint?

Время начала действия. Отсутствует, если неизвестно.

val finishTime

TimePoint?

Время начала действия. Отсутствует, если неизвестно.

val weekTimeIntervals

List<WeekTimeInterval>

Интервалы работы внутри недели.

Интервалы упорядочены по времени.

Первый интервал может начинаться с прошлой недели.

ScooterBriefRouteInfo

Базовая информация о маршруте на самокате.

ScooterBriefRouteInfo(length: RouteDistance, landmark: String)

Базовая информация о маршруте на самокате.

Parameters

length

RouteDistance

landmark

String

Properties

val length

RouteDistance

Длина маршрута.

val landmark

String

Ориентир.

ScooterInstructionCrossroad

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

ScooterInstructionCrossroad(landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.NONE, maneuvers: List<ScooterInstructionCrossroadManeuver>)

Описание манёвров при проходе через перекрёсток или по пешеходному переходу.

Parameters

landmark

ScooterInstructionCrossroadLandmark

maneuvers

List<ScooterInstructionCrossroadManeuver>

Properties

val landmark

ScooterInstructionCrossroadLandmark

Ориентир.

val maneuvers

List<ScooterInstructionCrossroadManeuver>

Цепочка идущих подряд манёвров.

ScooterInstructionCrossroadManeuver

ScooterInstructionCrossroadManeuver(direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)

Parameters

direction

ScooterInstructionCrossroadManeuverDirection

turnAngle

Int

Properties

val direction

ScooterInstructionCrossroadManeuverDirection

Направление движения.

val turnAngle

Int

Угол поворота в градусах -180,180.

ScooterInstructionFinish

Конец самокатной части маршрута.

ScooterInstructionFinish()

Конец самокатной части маршрута.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

ScooterInstructionStart

Начало самокатной части маршрута.

ScooterInstructionStart()

Начало самокатной части маршрута.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

ScooterRouteSearchOptions

Параметры поиска маршрута на самокате.

ScooterRouteSearchOptions(
	avoidCarRoads: Boolean = true,
	avoidStairways: Boolean = true,
	avoidUnderpassesAndOverpasses: Boolean = true,
	avoidUnpavedRoads: Boolean = true,
	avoidLockedRoads: Boolean = true,
	excludedAreas: List<ExcludedArea> = listOf()
)

Параметры поиска маршрута на самокате.

Parameters

avoidCarRoads

Boolean

avoidStairways

Boolean

avoidUnderpassesAndOverpasses

Boolean

avoidUnpavedRoads

Boolean

avoidLockedRoads

Boolean

excludedAreas

List<ExcludedArea>

Properties

val avoidCarRoads

Boolean

Избегать автомобильных дорог.

val avoidStairways

Boolean

Избегать лестниц.

val avoidUnderpassesAndOverpasses

Boolean

Избегать подземных и надземных переходов.

val avoidUnpavedRoads

Boolean

Избегать грунтовых дорог.

val avoidLockedRoads

Boolean

Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.

val excludedAreas

List<ExcludedArea>

Исключаемые области (не больше 25).

ScooterRouteSummary

Саммари информация для самокатного маршрута.

ScooterRouteSummary(
	routeType: ScooterSummaryRouteType = ScooterSummaryRouteType.UNKNOWN,
	stairways: Int = 0,
	gates: Int = 0,
	barriers: Int = 0,
	calories: Int = 0,
	carRoadsLength: Int = 0,
	groundRoadsLength: Int = 0,
	gravelRoadsLength: Int = 0,
	bicycleRoadsLength: Int = 0,
	bicycleLanesLength: Int = 0,
	badRoadsLength: Int = 0,
	roadBlocks: Int = 0
)

Саммари информация для самокатного маршрута.

Parameters

routeType

ScooterSummaryRouteType

stairways

Int

gates

Int

barriers

Int

calories

Int

carRoadsLength

Int

groundRoadsLength

Int

gravelRoadsLength

Int

bicycleRoadsLength

Int

bicycleLanesLength

Int

badRoadsLength

Int

roadBlocks

Int

Properties

val routeType

ScooterSummaryRouteType

Тип самокатного маршрута.

val stairways

Int

Количество лестниц на маршруте.

val gates

Int

Количество калиток на маршруте.

val barriers

Int

Количество шлагбаумов на маршруте.

val calories

Int

Количество калорий, которые будут потрачены на проезд по маршруту.

val carRoadsLength

Int

Суммарная протяжённость автомобильной дороги на маршруте в метрах.

val groundRoadsLength

Int

Суммарная протяжённость грунтовых дорог на маршруте в метрах.

val gravelRoadsLength

Int

Суммарная протяжённость гравийных дорог на маршруте в метрах.

val bicycleRoadsLength

Int

Суммарная протяжённость велодорожек на маршруте в метрах.

val bicycleLanesLength

Int

Суммарная протяжённость велосипедных полос на маршруте в метрах.

val badRoadsLength

Int

Суммарная протяжённость участков плохой дороги на маршруте в метрах.

val roadBlocks

Int

Суммарное количество пешеходных перекрытий на маршруте.

ScreenDistance

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

ScreenDistance(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

ScreenPoint

Точка в экранных координатах.

Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.

ScreenPoint(x: Float = 0.0f, y: Float = 0.0f)

Точка в экранных координатах.

Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.

Parameters

x

Float

y

Float

Properties

val x

Float

val y

Float

ScreenShift

Смещение карты по горизонтали и вертикали в координатном пространстве экрана.

Положительное направление смещения: dx - вправо, dy - вниз.

ScreenShift(dx: Float = 0.0f, dy: Float = 0.0f)

Смещение карты по горизонтали и вертикали в координатном пространстве экрана.

Положительное направление смещения: dx - вправо, dy - вниз.

Parameters

dx

Float

dy

Float

Properties

val dx

Float

val dy

Float

ScreenSize

Размер в пикселях.

ScreenSize(width: Int = 0, height: Int = 0)

Размер в пикселях.

Parameters

width

Int

height

Int

Properties

val width

Int

val height

Int

SearchCategoriesResult

Результат запроса категорий.

Extends: ru.dgis.sdk.NativeObject

Properties

val total

Int

Общее количество найденных категорий.

val firstPage

CategoriesPage?

Первая страница результатов запроса категорий.

SearchHistory

Extends: ru.dgis.sdk.NativeObject

Methods

fun items(page: SearchHistoryPage): Future<SearchHistoryResult>

Возвращает страницу истории поиска. Элементы возвращаются в упорядоченном виде по времени добавления (от самых свежих до самых поздних).

Parameters

page

SearchHistoryPage

Returns

Future<SearchHistoryResult>

fun addItem(item: SearchHistoryItem): Unit

Добавляет элемент в историю поиска. В случае, если уже существовал такой же элемент, ранний дубликат удаляется.

Parameters

item

SearchHistoryItem

Returns

Unit

fun addItems(items: List<SearchHistoryItem>): Unit

Добавляет список элементов в историю поиска. Считается, что порядок в списке хронологический. Все дубликаты будут убраны.

Parameters

items

List<SearchHistoryItem>

Returns

Unit

fun removeItem(item: SearchHistoryItem): Unit

Удаляет элемент из истории поиска.

Parameters

item

SearchHistoryItem

Returns

Unit

fun removeItems(items: List<SearchHistoryItem>): Unit

Удаляет список элементов из истории поиска.

Parameters

items

List<SearchHistoryItem>

Returns

Unit

fun clear(): Unit

Очищает историю поиска.

Returns

Unit

fun setKeyStrategy(keyStrategy: SearchHistoryKeyStrategy?): Unit

Устанавливает политику формирования ключей для истории поиска. Миграцию уже существующих записей, созданных с использованием другой политики key_strategy, необходимо выполнять вручную. Если параметр не задан — используется алгоритм по умолчанию.

Parameters

keyStrategy

SearchHistoryKeyStrategy?

Returns

Unit

@JvmStatic
fun instance(context: Context): SearchHistory

Parameters

context

Context

Returns

SearchHistory

Properties

val capacity

Long

Получает максимальный размер истории поиска.

val onHistoryChanged

Channel<ChangeType>

SearchHistoryItem

Тип данных для элемента поиска, сохраненного в истории поиска: может быть объект или поисковый запрос.

SearchHistoryItem(directoryObject: DirectoryObject)

Parameters

directoryObject

DirectoryObject

SearchHistoryItem(searchQuery: SearchQueryWithInfo)

Parameters

searchQuery

SearchQueryWithInfo

Methods

fun match(directoryObject: Function1, searchQuery: Function1): T

Parameters

directoryObject

(DirectoryObject) -> T

searchQuery

(SearchQueryWithInfo) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isDirectoryObject

Boolean

val asDirectoryObject

DirectoryObject?

val isSearchQuery

Boolean

val asSearchQuery

SearchQueryWithInfo?

val value

Any?

SearchHistoryPage

SearchHistoryPage(
	limit: Long = 100,
	offset: Long = 0,
	filter: EnumSet<SearchHistoryFilter> = EnumSet.noneOf(SearchHistoryFilter::class.java)
)

Parameters

limit

Long

offset

Long

filter

EnumSet<SearchHistoryFilter>

Properties

val limit

Long

val offset

Long

val filter

EnumSet<SearchHistoryFilter>

SearchHistoryResult

Результат работы истории поиска при запросе истории.

Extends: ru.dgis.sdk.NativeObject

Properties

val items

List<SearchHistoryItem>

Набор элементов истории поиска.

SearchLayout

UI-элемент, предоставлящий поисковую строку и отображение результатов поиска.

SearchLayout(context: Context)

Parameters

context

Context

SearchLayout(context: Context, attrs: AttributeSet)

Parameters

context

Context

attrs

AttributeSet

SearchLayout(context: Context, options: SearchOptions)

Parameters

context

Context

options

SearchOptions

Methods

fun onAttachedToWindow(): Unit

Returns

Unit

fun onDetachedFromWindow(): Unit

Returns

Unit

fun addSearchViewCallback(callback: SearchViewCallback): Unit

Метод, позволящий добавить SearchViewCallback для реагирования на разные состояния и результаты работы поиска и подсказчика.

Parameters

callback

SearchViewCallback

Returns

Unit

fun removeSearchViewCallback(callback: SearchViewCallback): Unit

Метод, позволящий удалить SearchViewCallback из списка.

Parameters

callback

SearchViewCallback

Returns

Unit

fun clearSearchViewCallbacks(): Unit

Метод, позволящий очистить список используемых SearchViewCallback.

Returns

Unit

fun configureSearchEngine(block: Function1): Unit

Метод, позволящий настроить работу поиска и подсказчика. Внутри блока доступны методы интерфeйсы SearchViewConfigurator

Parameters

block

SearchViewConfigurator.() -> Unit

Returns

Unit

fun hideResults(): Unit

Метод позволяет скрыть UI выдачи и оставить только поисковую строку. Работает только для текущего запроса, при его обновлении и появлении новых результатов, выдача снова отобразится.

Returns

Unit

fun setupSpeechRecognition(speechRecognizer: SpeechRecognizer?): Unit

Устанавливает и активирует функцию распознавания речи для поискового интерфейса.

ВАЖНО: Для работы голосового поиска необходимо явно вызвать этот метод. Без вызова данного метода функция голосового ввода будет отключена.

Parameters

speechRecognizer

SpeechRecognizer?

Реализация интерфейса SpeechRecognizer для распознавания речи. При передаче null голосовой ввод будет отключен.

Пример использования:

// Включение голосового ввода searchLayout.setupSpeechRecognition( DefaultSpeechRecognizer(activity, "Говорите") )

// Отключение голосового ввода searchLayout.setupSpeechRecognition(null)

Returns

Unit

SearchManager

Поисковик. Основная точка входа для справочного API.

Extends: ru.dgis.sdk.NativeObject

Methods

fun suggest(query: SuggestQuery): Future<SuggestResult>

Получить подсказки, соответствующие данному запросу.

Parameters

query

SuggestQuery

Returns

Future<SuggestResult>

future, резолвящаяся в ненулевой указатель на результат подбора подсказок или exceptional future, если произошла ошибка при получении подсказок

fun search(query: SearchQuery): Future<SearchResult>

Получить объекты справочника, соответствующие данному запросу.

Parameters

query

SearchQuery

Returns

Future<SearchResult>

future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска

fun search(suggest: Suggest, searchSettings: SearchSettings): Future<SearchResult>

Получить объекты справочника, соответствующие данному саджесту.

Parameters

suggest

Suggest

searchSettings

SearchSettings

Returns

Future<SearchResult>

future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска

fun searchCategories(query: CategoryQuery): Future<SearchCategoriesResult>

Получить категории, соответствующие данному запросу.

Parameters

query

CategoryQuery

Returns

Future<SearchCategoriesResult>

future, резолвящаяся в ненулевой указатель на результат получения категорий или exceptional future, если произошла ошибка при получении категорий

fun searchByIds(ids: List<String>, locale: Locale? = null): Future<List<DirectoryObject>>

Получить объекты справочника по строковым идентификаторам с указанной локалью. Для онлайна можно передать не более 100 идентификаторов.

Parameters

ids

List<String>

locale

Locale?

Returns

Future<List<DirectoryObject>>

future, резолвящаяся в список объектов справочника. Если объекты не найдены, то вернётся пустой список.

fun searchByDirectoryObjectIds(objectIds: List<DgisObjectId>, locale: Locale? = null): Future<List<DirectoryObject>>

Получить объекты справочника по идентификаторам с указанной локалью. Для онлайна можно передать не более 100 идентификаторов.

Parameters

objectIds

List<DgisObjectId>

locale

Locale?

Returns

Future<List<DirectoryObject>>

future, резолвящаяся в список объектов справочника. Если объекты не найдены, то вернётся пустой список.

@JvmStatic
fun createOnlineManager(context: Context): SearchManager

Создать поисковик, работающий онлайн.

Parameters

context

Context

Returns

SearchManager

@JvmStatic
fun createOfflineManager(context: Context): SearchManager

Создать поисковик, работающий с предзагруженными данными.

Parameters

context

Context

Returns

SearchManager

@JvmStatic
fun createSmartManager(context: Context): SearchManager

Создать поисковик, работающий онлайн или с предзагруженными данными в зависимости от наличия подключения к сети интернет.

Parameters

context

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

SearchType

pageSize

Int

sortingType

SortingType

suggestorType

SuggestorType

Properties

val searchType

SearchType

Тип поисковика. Возможные значения зависят от типа поставки SDK. Подробнее см. SearchType. Значение по умолчанию зависит от типа поставки SDK.

val pageSize

Int

Лимит на количество подсказок в suggest'e и результатов в выдаче. Допустимы значения от 1 до 50. По умолчанию: 10.

val sortingType

SortingType

Тип сортировки поисковой выдачи. По умолчанию: SortingType.BY_RELEVANCE.

val suggestorType

SuggestorType

Тип подсказчика. По умолчанию: SuggestorType.OBJECT.

SearchQuery

Поисковый запрос.

Extends: ru.dgis.sdk.NativeObject

SearchQueryBuilder

Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):

При указании прямоугольной области интереса (set_area_of_interest), поиск ведется в некоторой ее окрестности.

Если не указан вышестоящий параметр, то учитывается точка положения пользователя.

TODO: Данное условие пока не работает. Будет исправлено в ближайших релизах.

При упоминании в тексте запроса широко известного объекта (город, область или другой топоним) добавляется в поиск тот сегмент, в который попадает точка найденного объекта из глобального индекса.

Если не указано ничего из вышеперечисленного, то осуществляется поиск по глобальному индексу.

Extends: ru.dgis.sdk.NativeObject

SearchQueryBuilder()

Methods

fun setQueryText(queryText: String?): SearchQueryBuilder

Задать текст поискового запроса.

Parameters

queryText

String?

Returns

SearchQueryBuilder

fun setRubricIds(rubricIds: List<RubricId>): SearchQueryBuilder

Задать идентификаторы рубрик.

Parameters

rubricIds

List<RubricId>

Returns

SearchQueryBuilder

fun setOrgId(orgId: OrgId): SearchQueryBuilder

Задать фильтр по идентификаторам организаций, к которым относятся компании.

Parameters

orgId

OrgId

Returns

SearchQueryBuilder

fun setBuildingIds(buildingIds: List<BuildingId>): SearchQueryBuilder

Задать идентификаторы зданий для фильтрации объектов в зданиях.

Parameters

buildingIds

List<BuildingId>

Returns

SearchQueryBuilder

fun setRestrictionGeometry(restrictionGeometry: Geometry?): SearchQueryBuilder

Задать строгое ограничение области поиска геометрией. Для GeometryKind.Point будет выставлен центр строгого ограничения для поискового запроса. Радиус по умолчанию равен 250 метров.

GeometryKind.Polyline и GeometryKind.Polygon будут установлены как полигоны. Первая и последняя точки контура не обязаны совпадать.

Геометрия типа GeometryKind.Complex будет установлена как мулитиполигон. Для GeometryKind.Point внутри GeometryKind.Complex геометрия будет преобразована в контур полигона с радиусом из set_radius.

по умолчанию ограничение отсутствует.

Parameters

restrictionGeometry

Geometry?

Returns

SearchQueryBuilder

fun setAreaOfInterest(rect: GeoRect?): SearchQueryBuilder

Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.

Parameters

rect

GeoRect?

Returns

SearchQueryBuilder

fun setTerritoryOfInterest(territoryOfInterest: Geometry?): SearchQueryBuilder

Задать слабое ограничение области поиска: штраф за непопадание вместо строгого отбрасывания. Работает только с онлайн поиском. Будет проигнорировано при выставленном строгом ограничении поиска.

Parameters

territoryOfInterest

Geometry?

Returns

SearchQueryBuilder

fun setAllowedResultTypes(allowedResultTypes: List<ObjectType>): SearchQueryBuilder

Задать типы объектов, разрешенные в результате запроса.

по умолчанию все, кроме Route

Parameters

allowedResultTypes

List<ObjectType>

Returns

SearchQueryBuilder

fun setPageSize(pageSize: Int): SearchQueryBuilder

Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона 1;50

по умолчанию 10

Parameters

pageSize

Int

Returns

SearchQueryBuilder

fun setDirectoryFilter(filter: DirectoryFilter): SearchQueryBuilder

Задать фильтрацию для поискового запроса.

Parameters

filter

DirectoryFilter

Returns

SearchQueryBuilder

fun setSortingType(sortingType: SortingType): SearchQueryBuilder

Задать сортировку для поискового запроса.

Parameters

sortingType

SortingType

Returns

SearchQueryBuilder

fun setRadius(radius: Meter?): SearchQueryBuilder

Задать радиус поиска в метрах. Работает в сочетании с установленным geo_point. Радиус по умолчанию равен 250 метров. Для поискового запроса в точке ограничение от 0 до 2000. Для остальных запросов ограничение от 0 до 50000.

Parameters

radius

Meter?

Returns

SearchQueryBuilder

fun setLocale(locale: Locale?): SearchQueryBuilder

Задать локаль для поискового запроса.

Parameters

locale

Locale?

Returns

SearchQueryBuilder

fun setSearchNearby(searchNearby: Boolean): SearchQueryBuilder

Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.

Parameters

searchNearby

Boolean

Returns

SearchQueryBuilder

fun build(): SearchQuery

Сформировать поисковый запрос.

Returns

SearchQuery

@JvmStatic
fun fromQuery(query: SearchQuery): SearchQueryBuilder

Начать построение запроса на основе запроса #query для изменения части параметров.

Исходный запрос #query остается без изменений

Parameters

query

SearchQuery

Returns

SearchQueryBuilder

SearchQueryWithInfo

Класс с дополнительной информацией о поисковом запросе для вывода в UI-элементах.

Extends: ru.dgis.sdk.NativeObject

SearchQueryWithInfo(
	searchQuery: SearchQuery,
	title: String,
	subtitle: String
)

Parameters

searchQuery

SearchQuery

title

String

subtitle

String

Properties

val searchQuery

SearchQuery

Возвращает объект поискового запроса.

val title

String

Возвращает текст заголовка, который описывает объекты поискового запроса. Например, это может быть текст из поля title объекта ISuggest.

val subtitle

String

Возвращает текст подзаголовка. Например, это может быть текст из поля subtitle объекта ISuggest.

val rubrics

List<RubricId>

Возвращает список рубрик, по которым производится запрос.

SearchResult

Результат работы поисковика.

Extends: ru.dgis.sdk.NativeObject

Methods

fun markerTitles(objectIds: List<DgisObjectId>): List<Future<List<UIMarkerInfo>>>

Получение текстов маркеров по их идентификаторам. Возвращается vector <future

, так как в облако за запрос можно отправить не более 50 идентификаторов.

Parameters

objectIds

List<DgisObjectId>

Идентификаторы маркеров.

Returns

List<Future<List<UIMarkerInfo>>>

Properties

val firstPage

Page?

Первая страница результатов поиска.

val representativeArea

Geometry?

Прямоугольная область, подходящая для отображения результатов поиска.

val itemMarkerInfos

Future<List?<ItemMarkerInfo>>

Асинхронное получение маркеров.

val searchResultType

SearchResultType

Тип поискового запроса.

val dynamicFilters

List<DynamicFilter>

Динамические фильтры для этого запроса.

val actionWidgets

List<Widget>

Виджеты быстрых фильтров.

Это так называемые "быстрые фильтры" - фильтры, наиболее интересные пользователю. Их не больше 5.

val mainWidgets

List<Widget>

Виджеты фильтров.

val autoUseFirstResult

Boolean

Признак того, что первый результат пригоден для непосредственного использования.

val nearbyRequested

Boolean

Признак того, что запрошены объекты поблизости.

SearchSettings

SearchSettings(saveInHistory: Boolean = false)

Parameters

saveInHistory

Boolean

Properties

val saveInHistory

Boolean

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

GeoPoint

bearing

Bearing

Properties

val point

GeoPoint

val bearing

Bearing

SettlementRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): SettlementRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

SettlementRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<SettlementRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<SettlementRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

SettlementRouteLongEntry?

Первый элемент.

val last

SettlementRouteLongEntry?

Последний элемент.

val entries

List<SettlementRouteLongEntry>

Все элементы.

SettlementRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

SettlementRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: Settlement
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

Settlement

Properties

val point

RoutePoint

val length

RouteDistance

val value

Settlement

SharedRouteData

Информация о заранее построенном маршруте и параметрах его поиска.

SharedRouteData(
	routes: List<TrafficRoute>,
	routeSearchOptions: RouteSearchOptions,
	startPoint: RouteSearchPoint,
	finishPoint: RouteSearchPoint,
	intermediatePoints: List<RouteSearchPoint>
)

Информация о заранее построенном маршруте и параметрах его поиска.

Parameters

routes

List<TrafficRoute>

routeSearchOptions

RouteSearchOptions

startPoint

RouteSearchPoint

finishPoint

RouteSearchPoint

intermediatePoints

List<RouteSearchPoint>

Properties

val routes

List<TrafficRoute>

Набор маршрутов.

val routeSearchOptions

RouteSearchOptions

Параметры поиска, использованные при поиске маршрута.

val startPoint

RouteSearchPoint

Начальная точка маршрута.

val finishPoint

RouteSearchPoint

Конечная точка маршрута.

val intermediatePoints

List<RouteSearchPoint>

Промежуточные точки маршрута.

ShowRouteControl

UI-элемент управления перелетом карты к маршруту.

Extends: ru.dgis.sdk.map.MapControl

ShowRouteControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент управления перелетом карты к маршруту.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun showRoute(geometry: Geometry, styleZoomToTiltRelation: StyleZoomToTiltRelation?): Unit

Parameters

geometry

Geometry

styleZoomToTiltRelation

StyleZoomToTiltRelation?

Returns

Unit

fun cancelRouteOverview(): Unit

Returns

Unit

fun setRouteOverview(value: Boolean): Unit

Parameters

value

Boolean

Returns

Unit

Properties

val isRouteOverviewChannel

StatefulChannel<Boolean>

val isRouteOverview

Boolean

SimpleCheckableItem

Простой отмечаемый элемент из CheckableItemsGroup.

Extends: ru.dgis.sdk.directory.CheckableItem

Properties

val text

String

Получение текстового описания элемента.

val values

List<String>

Получение списка значений, по которым происходит фильтрация. Обычно одно значение.

var isChecked

Boolean

Получение состояния элемента.

SimpleClusterObject

Кластер простых (simple) объектов-маркеров.

Extends: ru.dgis.sdk.map.MapObject

Methods

fun setIcon(icon: Image?): Unit

Установка иконки кластера.

Parameters

icon

Image?

Returns

Unit

Properties

val position

GeoPointWithElevation

Получение позиции кластера на карте.

val objectCount

Int

Получение количества маркеров в кластере.

val objects

List<SimpleMapObject>

Получение списка маркеров в кластере.

var anchor

Anchor

Получение и установка точки привязки иконки кластера.

var iconOpacity

Opacity

Получение и установка прозрачности иконки кластера.

var text

String

Получение и установка подписи кластера.

var textStyle

TextStyle

Получение и установка стиля подписи кластера.

var iconWidth

LogicalPixel

Получение и установка целевой ширины кластера, используемой для масштабирования.

var iconMapDirection

MapDirection?

Получение и установка угла поворота кластера на карте относительно направления на север, по часовой стрелке.

var animatedAppearance

Boolean

Получение и установка флага анимируемости появления кластера.

var zIndex

ZIndex

Получение и установка уровня отрисовки объекта.

var suppressOnOverlap

Boolean

Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).

SimpleClusterOptions

Параметры маркера кластера простых (simple) объектов-маркеров.

SimpleClusterOptions(
	icon: Image?,
	iconMapDirection: MapDirection? = null,
	anchor: Anchor = Anchor(x = 0.5f, y = 0.5f),
	text: String? = null,
	textStyle: TextStyle? = null,
	iconOpacity: Opacity = Opacity(value = 1.0f),
	iconWidth: LogicalPixel = LogicalPixel(value = 0.0f),
	userData: Any? = null,
	zIndex: ZIndex = ZIndex(value = 0),
	labelingPriority: LabelingPriority = LabelingPriority(value = 0),
	animatedAppearance: Boolean = true,
	iconAnimationMode: AnimationMode = AnimationMode.NORMAL,
	suppressOnOverlap: Boolean = false
)

Параметры маркера кластера простых (simple) объектов-маркеров.

Parameters

icon

Image?

iconMapDirection

MapDirection?

anchor

Anchor

text

String?

textStyle

TextStyle?

iconOpacity

Opacity

iconWidth

LogicalPixel

userData

Any?

zIndex

ZIndex

labelingPriority

LabelingPriority

animatedAppearance

Boolean

iconAnimationMode

AnimationMode

suppressOnOverlap

Boolean

Properties

val icon

Image?

val iconMapDirection

MapDirection?

val anchor

Anchor

val text

String?

val textStyle

TextStyle?

val iconOpacity

Opacity

val iconWidth

LogicalPixel

Целевая ширина, используемая для масштабирования.

val userData

Any?

Preventing memory leaks: the native layer holds a strong reference to the object stored in this property. If it is a lambda or an inner class that implicitly captures the parent's this (e.g. Activity), the parent will not be garbage-collected while this object is alive. Store only plain data (e.g. an identifier) or a standalone class that wraps external references in WeakReference.

val zIndex

ZIndex

Уровень отрисовки объекта.

val labelingPriority

LabelingPriority

Приоритет лейблинга иконки маркера.

val animatedAppearance

Boolean

Анимировать ли появление.

val iconAnimationMode

AnimationMode

Режим анимации.

val suppressOnOverlap

Boolean

Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).

SimpleMapObject

Объект на карте, для которого можно задавать видимость.

Extends: ru.dgis.sdk.map.MapObject

Properties

var isVisible

Boolean

var zIndex

ZIndex

Получение уровня отрисовки объекта.

var levelId

LevelId?

Получение привязки объекта к этажу в здании.

val bounds

GeoRect

Прямоугольник минимального размера, содержащий геометрию.

SimulationAutoWithOverSpeed

Структура для задания режима движения с учетом максимальной скорости на ребре маршрута.

SimulationAutoWithOverSpeed(overSpeed: Double = 0.0)

Структура для задания режима движения с учетом максимальной скорости на ребре маршрута.

Parameters

overSpeed

Double

Properties

val overSpeed

Double

Используемое превышение скорости в м/с. Допустимы значения только >= 0.

SimulationConstantSpeed

Структура для задания режима движения с постоянной скоростью.

SimulationConstantSpeed(speed: Double = 0.0)

Структура для задания режима движения с постоянной скоростью.

Parameters

speed

Double

Properties

val speed

Double

Скорость движения в м/с. Допустимы значения только >= 0.

SimulationSettings

Настройки симуляции ведения по маршруту.

Extends: ru.dgis.sdk.NativeObject

Properties

var speedMode

SimulationSpeedMode

Режим работы симулятора.

SimulationSpeedMode

SimulationSpeedMode(speed: SimulationConstantSpeed)

Parameters

speed

SimulationConstantSpeed

SimulationSpeedMode(overSpeed: SimulationAutoWithOverSpeed)

Parameters

overSpeed

SimulationAutoWithOverSpeed

Methods

fun match(speed: Function1, overSpeed: Function1): T

Parameters

speed

(SimulationConstantSpeed) -> T

overSpeed

(SimulationAutoWithOverSpeed) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isSpeed

Boolean

val asSpeed

SimulationConstantSpeed?

val isOverSpeed

Boolean

val asOverSpeed

SimulationAutoWithOverSpeed?

val value

Any?

SnapToMapLayout

Layout that pins child views to points on the map.

A layout placed inside a MapView binds to its map automatically while attached to the window; the map view owns the binding and rebinds the layout on map changes. A layout placed outside a MapView is bound explicitly via bindToMap.

SnapToMapLayout(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Layout that pins child views to points on the map.

A layout placed inside a MapView binds to its map automatically while attached to the window; the map view owns the binding and rebinds the layout on map changes. A layout placed outside a MapView is bound explicitly via bindToMap.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun bindToMap(controller: MapController): Unit

Parameters

controller

MapController

Returns

Unit

fun bindToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun unbindFromMap(): Unit

Returns

Unit

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

Boolean

left

Int

top

Int

right

Int

bottom

Int

Returns

Unit

fun checkLayoutParams(p: LayoutParams?): Boolean

Parameters

p

LayoutParams?

Returns

Boolean

fun generateLayoutParams(attrs: AttributeSet?): LayoutParams?

Parameters

attrs

AttributeSet?

Returns

LayoutParams?

fun generateLayoutParams(p: LayoutParams?): LayoutParams?

Parameters

p

LayoutParams?

Returns

LayoutParams?

SortingFilter

Фильтр сортировки.

SortingFilter(tagName: String, displayName: String)

Фильтр сортировки.

Parameters

tagName

String

displayName

String

Properties

val tagName

String

Тэг фильтра.

val displayName

String

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

SoundNotificationSettings

Настройки звуковых оповещений в навигаторе По умолчанию все значения категорий звуков оповещений включены. Пользователь может менять значения во время работы с навигатором.

Extends: ru.dgis.sdk.NativeObject

Properties

var enabledSoundCategories

EnumSet<SoundCategory>

Набор флагов для звуковых оповещений.

var speedCameraNotification

SpeedCameraNotification

Настройка звукового оповещения камер на скорость. По умолчанию камеры на скорость озвучиваются только при превышении скорости.

var notificationVolume

Int

var mute

Boolean

Source

Источник данных на карте.

Это может быть источник пробочных данных, маршрутов, маркеров, произвольных геометрических или других объектов карты. У любого объекта карты могут быть свои свойства. Свойства объекта влияют на то, какие к нему применяются правила и параметры отображения, описаные в стилях карты. Стиль - набор параметров и правил отображения объектов карты, получаемый через редактор стилей и использующийся для отрисовки карты.

Свойства объекта могут быть заданы:

• непосредственно для объекта;
• источнику данных (все объекты, добавленные в источник, получают эти свойства);
• карте (все объекты, добавленные на карту, получают эти свойства);
• стилю (все объекты, к которым применён стиль, получают эти свойства). Список приведён в порядке понижения приоритета применения свойств. Даже если на карту не добавлен ни один источник данных, свойства стиля и карты всё равно повлияют на карту, т.к. есть специальные отображаемые объекты, например - фон.

Extends: ru.dgis.sdk.NativeObject

SpecialSpace

Особое место для парковки.

SpecialSpace(
	type: SpecialSpaceType,
	name: String,
	count: String?
)

Особое место для парковки.

Parameters

type

SpecialSpaceType

name

String

count

String?

Properties

val type

SpecialSpaceType

Тип.

val name

String

Локализованное название особого места.

val count

String?

Количество мест такого типа на парковке.

SpeedInfoControl

Extends: ru.dgis.sdk.navigation.NavigationControl

SpeedInfoControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

SpeedRange

Интервал скоростей. Скорости задаются в метрах в секунду.

SpeedRange(minSpeed: Double = 0.0, maxSpeed: Double = 0.0)

Интервал скоростей. Скорости задаются в метрах в секунду.

Parameters

minSpeed

Double

maxSpeed

Double

Properties

val minSpeed

Double

val maxSpeed

Double

SpeedRangeToStyleZoom

Соответствие интервала скоростей, класса дорог и стилевого уровня масштабирования.

SpeedRangeToStyleZoom(
	range: SpeedRange,
	minDistanceToManeuver: RouteDistance,
	maxDistanceToManeuver: RouteDistance,
	roadClassesStyleZooms: Map,
	roadClassesTilts: Map,
	styleZoom: StyleZoom,
	styleTilt: Tilt
)

Соответствие интервала скоростей, класса дорог и стилевого уровня масштабирования.

Parameters

range

SpeedRange

minDistanceToManeuver

RouteDistance

maxDistanceToManeuver

RouteDistance

roadClassesStyleZooms

Map

roadClassesTilts

Map

styleZoom

StyleZoom

styleTilt

Tilt

Properties

val range

SpeedRange

Интервал скоростей.

val minDistanceToManeuver

RouteDistance

Минимальное расстояние до манёвра, при котором должна включаться логика плавного увеличения уровня зума.

val maxDistanceToManeuver

RouteDistance

Максимальное расстояние после манёвра, при котором плавное уменьшение уровня зума должно завершиться.

val roadClassesStyleZooms

Map

Стилевой уровень масштабирования для определенного класса дорог. Переопределяет style_zoom значение по умолчанию.

val roadClassesTilts

Map

Стилевой наклон для определенного класса дорог. Переопределяет style_tilt значение по умолчанию.

val styleZoom

StyleZoom

Стилевой уровень масштабирования по умолчанию. Применяется для всех классов дорог.

val styleTilt

Tilt

Стилевой угол наклона по умолчанию. Применяется для всех классов дорог.

StorageOptions

Опции хранилища оффлайн данных.

StorageOptions(downloadStoragePath: String? = null)

Опции хранилища оффлайн данных.

Parameters

downloadStoragePath

String?

Properties

val downloadStoragePath

String?

Путь к каталогу верхнего уровня для основного хранилища загрузок. Файловое хранилище будет находиться в подкаталоге downloads в данном каталоге. Если путь не указан, будет использоваться директория по умолчанию.

StringRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<StringRouteEntry>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<StringRouteEntry>

fun findNearBackward(point: RoutePoint): StringRouteEntry?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

StringRouteEntry?

fun findNearForward(point: RoutePoint): StringRouteEntry?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

StringRouteEntry?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

StringRouteEntry?

Первый элемент.

val last

StringRouteEntry?

Последний элемент.

val entries

List<StringRouteEntry>

Все элементы.

StringRouteEntry

Элемент маршрута - точка и значение в ней.

StringRouteEntry(point: RoutePoint, value: String)

Элемент маршрута - точка и значение в ней.

Parameters

point

RoutePoint

value

String

Properties

val point

RoutePoint

val value

String

StringRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): StringRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

StringRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<StringRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<StringRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

StringRouteLongEntry?

Первый элемент.

val last

StringRouteLongEntry?

Последний элемент.

val entries

List<StringRouteLongEntry>

Все элементы.

StringRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

StringRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: String
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

String

Properties

val point

RoutePoint

val length

RouteDistance

val value

String

Style

Стиль с набором свойств объектов карты (cм. ISource).

Extends: ru.dgis.sdk.NativeObject

Properties

val styleAttributes

Attributes

Получение свойств по умолчанию для объектов, к которым применён указанный слой.

StyleBuilder

Конструктор стилей.

Extends: ru.dgis.sdk.NativeObject

StyleBuilder(context: Context)

Parameters

context

Context

Methods

fun setStyleAttribute(name: String, value: AttributeValue): StyleBuilder

Parameters

name

String

value

AttributeValue

Returns

StyleBuilder

fun getDefaultStyle(): Future<Style>

Получение предустановленного стиля.

Returns

Future<Style>

fun loadStyle(file: File): Future<Style>

Загрузка пользовательского стиля.

Parameters

file

File

Returns

Future<Style>

StyleLayerId

Идентификатор слоя стиля.

StyleLayerId(id: String)

Идентификатор слоя стиля.

Parameters

id

String

Properties

val id

String

StyleZoom

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

StyleZoom(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

StyleZoomFollowController

Контроллер слежения за стилевым уровнем масштабирования карты.

Extends: ru.dgis.sdk.map.FollowController

StyleZoomFollowController(animationDuration: Duration = Duration.ofMilliseconds(300))

Создание контроллера слежения за стилевым уровнем масштабирования карты.

Parameters

animationDuration

Duration

Methods

fun setStyleZoom(styleZoom: StyleZoom): Unit

Установка нового значения стилевого уровня масштабирования.

Parameters

styleZoom

StyleZoom

Returns

Unit

fun setStyleZoomRange(minStyleZoom: StyleZoom, maxStyleZoom: StyleZoom): Unit

Установка интервала допустимых значений стилевого уровня масштабирования.

Parameters

minStyleZoom

StyleZoom

maxStyleZoom

StyleZoom

Returns

Unit

Suggest

Поисковая подсказка.

Extends: ru.dgis.sdk.NativeObject

Properties

val handler

SuggestHandler

Обработчик выбора подсказки.

val suggestedType

SuggestedType

Тип подсказки.

val title

MarkedUpText

Заголовок подсказки.

val subtitle

MarkedUpText

Подзаголовок подсказки.

SuggestHandler

Обработчик выбора подсказки.

SuggestHandler(objectHandler: SuggestObjectHandler)

Parameters

objectHandler

SuggestObjectHandler

SuggestHandler(performSearchHandler: PerformSearchHandler)

Parameters

performSearchHandler

PerformSearchHandler

SuggestHandler(incompleteTextHandler: IncompleteTextHandler)

Parameters

incompleteTextHandler

IncompleteTextHandler

Methods

fun match(
	objectHandler: Function1,
	performSearchHandler: Function1,
	incompleteTextHandler: Function1
): T

Parameters

objectHandler

(SuggestObjectHandler) -> T

performSearchHandler

(PerformSearchHandler) -> T

incompleteTextHandler

(IncompleteTextHandler) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isObjectHandler

Boolean

val asObjectHandler

SuggestObjectHandler?

val isPerformSearchHandler

Boolean

val asPerformSearchHandler

PerformSearchHandler?

val isIncompleteTextHandler

Boolean

val asIncompleteTextHandler

IncompleteTextHandler?

val value

Any?

SuggestObjectHandler

Предложен конкретный объект справочника.

Extends: ru.dgis.sdk.NativeObject

Properties

val item

DirectoryObject

Подсказанный объект.

SuggestQuery

Запрос поисковой подсказки.

Extends: ru.dgis.sdk.NativeObject

SuggestQueryBuilder

Построитель запросов к подсказчику.

Extends: ru.dgis.sdk.NativeObject

SuggestQueryBuilder(queryText: String)

Начать построение запроса подсказки для заданного текста и области интереса.

Parameters

queryText

String

Methods

fun setRestrictionGeometry(restrictionGeometry: Geometry?): SuggestQueryBuilder

Задать строгое ограничение области поиска геометрией. Для GeometryKind.Point геометрия будет преобразована в контур полигона с радиусом 250 метров.

GeometryKind.Polyline и GeometryKind.Polygon будут установлены как полигоны. Первая и последняя точки контура не обязаны совпадать.

Геометрия типа GeometryKind.Complex будет установлена как мулитиполигон.

по умолчанию ограничение отсутствует.

Parameters

restrictionGeometry

Geometry?

Returns

SuggestQueryBuilder

fun setTerritoryOfInterest(territoryOfInterest: Geometry?): SuggestQueryBuilder

Задать слабое ограничение области поиска: штраф за непопадание вместо строгого отбрасывания. Работает только с онлайн поиском. Будет проигнорировано при выставленном строгом ограничении поиска.

Parameters

territoryOfInterest

Geometry?

Returns

SuggestQueryBuilder

fun setAreaOfInterest(rect: GeoRect?): SuggestQueryBuilder

Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.

Parameters

rect

GeoRect?

Returns

SuggestQueryBuilder

fun setAllowedResultTypes(allowedResultTypes: List<SuggestedType>): SuggestQueryBuilder

Задать типы объектов, разрешенные в результате запроса.

по умолчанию все, кроме Route

Parameters

allowedResultTypes

List<SuggestedType>

Returns

SuggestQueryBuilder

fun setSuggestorType(suggestorType: SuggestorType): SuggestQueryBuilder

Задать тип подсказчика.

по умолчанию #SuggestorType::Object

Parameters

suggestorType

SuggestorType

Returns

SuggestQueryBuilder

fun setLimit(limit: Int): SuggestQueryBuilder

Задать желаемое количество подсказок. Допустимы значения из диапазона 1;50

по умолчанию 10

Parameters

limit

Int

Returns

SuggestQueryBuilder

fun setLocale(locale: Locale?): SuggestQueryBuilder

Локаль, с которой производится запрос подсказки и отдаются результаты.

Parameters

locale

Locale?

Returns

SuggestQueryBuilder

fun setSearchNearby(searchNearby: Boolean): SuggestQueryBuilder

Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.

Parameters

searchNearby

Boolean

Returns

SuggestQueryBuilder

fun build(): SuggestQuery

Сформировать запрос к подсказчику.

Returns

SuggestQuery

@JvmStatic
fun fromQuery(query: SuggestQuery): SuggestQueryBuilder

Начать построение запроса подсказки на основе запроса #query для изменения части параметров.

Исходный запрос #query остается без изменений

Parameters

query

SuggestQuery

Returns

SuggestQueryBuilder

SuggestResult

Результат работы подсказчика.

Extends: ru.dgis.sdk.NativeObject

Properties

val suggests

List<Suggest>

Набор предложенных вариантов подсказок.

набор пуст, если подходящие подсказки не найдены

SystemCertificate

Системный SSL-сертификат.

SystemCertificate()

Системный SSL-сертификат.

Methods

fun toString(): String

Returns

String

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

fun hashCode(): Int

Returns

Int

SystemMemoryManager

Интерфейс управления использованием системной памяти.

Extends: ru.dgis.sdk.NativeObject

Methods

fun reduceMemoryUsage(): Unit

Уменьшение использования памяти путём очистки всевозможных кешей и буферов.

Returns

Unit

@JvmStatic
fun instance(context: Context): SystemMemoryManager

Получение объекта для управления использованием системной памяти.

Parameters

context

Context

Returns

SystemMemoryManager

TaxiRouteSearchOptions

Параметры поиска маршрута на такси.

TaxiRouteSearchOptions(car: CarRouteSearchOptions)

Параметры поиска маршрута на такси.

Parameters

car

CarRouteSearchOptions

Properties

val car

CarRouteSearchOptions

Параметры поиска маршрута, общие с прочими автомобильными.

TerritoriesAlongRouteProvider

Интерфейс для поиска маршрута с учетом пробочных данных.

Extends: ru.dgis.sdk.NativeObject

TerritoriesAlongRouteProvider(context: Context)

Создание объекта для получения списка территорий вдоль маршрута из контекста.

Parameters

context

Context

Methods

fun getTerritories(route: Route): Future<List<Territory>>

Возвращает минимально необходимый список офлайн-территорий в порядке следования маршрута.

Parameters

route

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

GeoPoint

Returns

List<Territory>

fun findByRect(rect: GeoRect): List<Territory>

Поиск территорий, которым принадлежит заданная геометрия. Бросает исключение в случае попытки использования неподдерживаемой геометрии. Возвращает пустой список, если геометрия находится за пределами проекции. Возвращает пустой список в случае внутренней ошибки при обработке списка территорий.

Parameters

rect

GeoRect

Returns

List<Territory>

fun pause(): Unit

Приостановка всех запущенных операций установки либо обновления территорий.

Returns

Unit

fun resume(): Unit

Возобновление всех приостановленных операций установки либо обновления территорий.

Returns

Unit

@JvmStatic
fun instance(context: Context): TerritoryManager

Получение объекта для работы с территориями из контекста.

Parameters

context

Context

Returns

TerritoryManager

Properties

val territoriesChannel

StatefulChannel<List<Territory>>

Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.

val territories

List<Territory>

Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.

TextStyle

Настройки внешнего вида текста.

TextStyle(
	fontSize: LogicalPixel = LogicalPixel(value = 8.0f),
	color: Color = Color(),
	strokeWidth: LogicalPixel = LogicalPixel(value = 0.34999999f),
	strokeColor: Color = Color(argb = 4294967295.toInt()),
	textHorizontalAlignment: TextHorizontalAlignment = TextHorizontalAlignment.AUTO,
	textPlacement: TextPlacement = TextPlacement.BOTTOM_CENTER,
	textOffset: LogicalPixel = LogicalPixel(value = 0.0f),
	fontName: String? = null,
	labelingPriority: LabelingPriority = LabelingPriority(value = 0),
	suppressOnOverlap: Boolean = true
)

Настройки внешнего вида текста.

Parameters

fontSize

LogicalPixel

color

Color

strokeWidth

LogicalPixel

strokeColor

Color

textHorizontalAlignment

TextHorizontalAlignment

textPlacement

TextPlacement

textOffset

LogicalPixel

fontName

String?

labelingPriority

LabelingPriority

suppressOnOverlap

Boolean

Properties

val fontSize

LogicalPixel

val color

Color

val strokeWidth

LogicalPixel

val strokeColor

Color

val textHorizontalAlignment

TextHorizontalAlignment

val textPlacement

TextPlacement

val textOffset

LogicalPixel

val fontName

String?

val labelingPriority

LabelingPriority

Приоритет лейблинга текста.

val suppressOnOverlap

Boolean

Скрывать ли текст при наложении с другими объектами (маркеры, подписи других объектов).

Tilt

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Tilt(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

TiltFollowController

Контроллер слежения за углом наклона карты.

Extends: ru.dgis.sdk.map.FollowController

TiltFollowController(styleZoomToTilt: StyleZoomToTiltRelation)

Создание контроллера слежения за углом наклона карты.

Parameters

styleZoomToTilt

StyleZoomToTiltRelation

зависимость угла наклона камеры от стилевого уровня масштабирования.

TiltGestureSettings

Настройки жеста наклона.

Extends: ru.dgis.sdk.NativeObject

Properties

var recognizeSettings

TiltRecognizeSettings

Настройки распознавания наклона.

var kinematicSettings

TiltKinematicSettings

Настройки кинематики наклона.

TiltKinematicSettings

TiltKinematicSettings(
	enabled: Boolean = true,
	decelerationCoefficient: Float = 7.0f,
	initialForwardSpeedMultiplier: Float = 0.69999999f,
	maxInitialForwardAngularSpeed: Float = 50.0f,
	minTiltAdditionalBorder: Tilt = Tilt(value = 0.0f),
	maxTiltAdditionalBorder: Tilt = Tilt(value = 3.0f),
	tiltThreshold: Float = 0.039999999f
)

Parameters

enabled

Boolean

decelerationCoefficient

Float

initialForwardSpeedMultiplier

Float

maxInitialForwardAngularSpeed

Float

minTiltAdditionalBorder

Tilt

maxTiltAdditionalBorder

Tilt

tiltThreshold

Float

Properties

val enabled

Boolean

Включает или отключает кинематику наклона. Если установлено в false, наклон мгновенно останавливается после окончания жеста, все остальные параметры игнорируются.

val decelerationCoefficient

Float

Коэффициент затухания наклона после окончания жеста. Чем выше значение, тем быстрее замедляется наклон.

val initialForwardSpeedMultiplier

Float

Множитель начальной скорости наклона.

val maxInitialForwardAngularSpeed

Float

Максимальная начальная угловая скорость наклона после окончания жеста (в радианах в секунду). При вычисоении скорости сначала производится умножение на initial_forward_speed_multiplier, а затем применяется ограничение.

val minTiltAdditionalBorder

Tilt

val maxTiltAdditionalBorder

Tilt

val tiltThreshold

Float

Порог углового отклонения (в радианах), при превышении которого карта продолжает наклоняться в направлении жеста. Если меньше — движется в сторону исходного положения.

TiltRecognizeSettings

Настройки распознавания наклона.

TiltRecognizeSettings(
	lenOnDegreeMm: Float = 1.0f,
	horizontalSwerveDeg: Float = 20.0f,
	verticalSwerveDeg: Float = 10.0f,
	thresholdMm: Float = 1.1f,
	maxParallelsDeviationDeg: Float = 16.0f
)

Настройки распознавания наклона.

Parameters

lenOnDegreeMm

Float

horizontalSwerveDeg

Float

verticalSwerveDeg

Float

thresholdMm

Float

maxParallelsDeviationDeg

Float

Properties

val lenOnDegreeMm

Float

Расстояние, в миллиметрах, на которое нужно сдвинуть пальцы по экрану, чтобы изменить угол наклона камеры на 1 градус. Отрицательное значение приведет к инверсии направления, значение 0 недопустимо.

val horizontalSwerveDeg

Float

Максимально допустимый угол, в градусах, отклонения линии постановки пальцев от горизонта для вертикального свайпа.

val verticalSwerveDeg

Float

Максимально допустимый угол, в градусах, отклонения направления свайпа от вертикальной линии.

val thresholdMm

Float

Порог сдвига взвешенного среднего точек в миллиметрах, преодоление которого говорит о начале наклона.

val maxParallelsDeviationDeg

Float

Максимально допустимый угол между векторами, в градусах, преодоление которого говорит о нарушении сонаправленности.

TimePoint

Класс, представляющий момент времени.

TimePoint(timeFromEpoch: Duration)

Класс, представляющий момент времени.

Parameters

timeFromEpoch

Duration

Methods

operator fun plus(duration: Duration): TimePoint

Parameters

duration

Duration

Returns

TimePoint

operator fun minus(duration: Duration): TimePoint

Parameters

duration

Duration

Returns

TimePoint

operator fun minus(other: TimePoint): Duration

Parameters

other

TimePoint

Returns

Duration

fun compareTo(other: TimePoint): Int

Parameters

other

TimePoint

Returns

Int

fun toString(): String

Returns

String

@JvmStatic
fun ofEpochMilliseconds(milliseconds: Long): TimePoint

Parameters

milliseconds

Long

Returns

TimePoint

@JvmStatic
fun ofEpochSeconds(seconds: Long): TimePoint

Parameters

seconds

Long

Returns

TimePoint

@JvmStatic
fun ofEpochMinutes(minutes: Long): TimePoint

Parameters

minutes

Long

Returns

TimePoint

@JvmStatic
fun ofEpochHours(hours: Long): TimePoint

Parameters

hours

Long

Returns

TimePoint

@JvmStatic
fun ofEpochDays(days: Long): TimePoint

Parameters

days

Long

Returns

TimePoint

@JvmStatic
fun now(): TimePoint

Время, прошедшее с 00:00:00 UTC 1 января 1970 года (Unix-время).

Returns

TimePoint

fun toUiString(locale: Locale = Locale.getDefault(), timeZone: TimeZone = TimeZone.getDefault()): String

Преобразование момента времени в строку для показа в UI-элементах.

Parameters

locale

Locale

timeZone

TimeZone

Returns

String

Properties

val timeFromEpoch

Duration

val EPOCH

TimePoint

val INFINITY

TimePoint

TradeLicense

Лицензия организации.

TradeLicense(
	type: String,
	license: String,
	legalForm: String,
	endDate: String
)

Лицензия организации.

Parameters

type

String

license

String

legalForm

String

endDate

String

Properties

val type

String

Тип.

Пустая строка означает отсутствие этого значения в данных.

val license

String

Номер.

val legalForm

String

Форма собственности компании.

Пустая строка означает отсутствие этого значения в данных.

val endDate

String

Дата, до которой действует лицензия.

Пустая строка означает отсутствие этого значения в данных.

Traffic

Описание пробочных данных.

Extends: ru.dgis.sdk.NativeObject

Properties

val durations

MillisecondsRouteAttribute

Длительности движения на участках маршрута. 0 - длительность движения на участке маршрута неизвестна.

val speedColors

TrafficSpeedColorRouteLongAttribute

Цветовое представление скоростей движения ТС на маршруте (протяженный атрибут).

TrafficAndParkingControl

Контейнер с UI-элементами отображения парковок и пробок.

TrafficAndParkingControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контейнер с UI-элементами отображения парковок и пробок.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

TrafficCollector

Интерфейс для управления сервисом сбора информации о транспортном трафике.

Этот интерфейс является потокобезопасным.

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun instance(context: Context): TrafficCollector

Функция получения сервиса сбора информации о транспортном трафике. Сервис сбора информации о транспортном трафике анализирует состояние трафика на дороге, по которой движется пользователь и отправляет результаты анализа в анонимизированном виде на сервер.

Parameters

context

Context

Контекст - окружение, необходимое для работы SDK.

Returns

TrafficCollector

Сервис сбора информации о дорожном движении.

Properties

var trafficCollectingAllowed

Boolean

Функция определения состояния разрешения/запрета отправки информации о дорожном движении на сервер.

TrafficControl

Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

Extends: ru.dgis.sdk.map.MapControl

TrafficControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

TrafficControl

Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

Extends: ru.dgis.sdk.map.MapControl

TrafficControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun processClick(): Unit

Returns

Unit

TrafficControlModel

Модель контрола пробок.

Этот интерфейс является потокобезопасным.

Extends: ru.dgis.sdk.NativeObject

TrafficControlModel(map: Map)

Функция создания модели элемента управления пробками.

Parameters

map

Map

карта.

Methods

fun onClicked(): Unit

Действие при нажатии на контрол. Переключает видимость пробок на карте.

Returns

Unit

Properties

val stateChannel

StatefulChannel<TrafficControlState>

Состояние элемента управления видимостью пробок.

val state

TrafficControlState

Состояние элемента управления видимостью пробок.

TrafficControlState

Состояние элемента управления видимостью пробок.

TrafficControlState(status: TrafficControlStatus = TrafficControlStatus.HIDDEN, score: Int?)

Состояние элемента управления видимостью пробок.

Parameters

status

TrafficControlStatus

score

Int?

Properties

val status

TrafficControlStatus

Статус, в зависимости от которого меняется внешний вид элемента управления.

val score

Int?

Балл пробок. Отображается в виде надписи на контроле. Если отсутствует, отображается иконка-заглушка.

TrafficJamDetector

Детектор, который определяет, находится ли пользователь вблизи пробки на маршруте.

Extends: ru.dgis.sdk.NativeObject

Properties

val trafficJamInfoChannel

StatefulChannel<TrafficJamInfo?>

Канал, который оповещает о пробке на маршруте.

val trafficJamInfo

TrafficJamInfo?

Канал, который оповещает о пробке на маршруте.

TrafficJamInfo

Информация о пробке.

TrafficJamInfo(
	startPoint: RoutePoint,
	finishPoint: RoutePoint,
	duration: Duration
)

Информация о пробке.

Parameters

startPoint

RoutePoint

finishPoint

RoutePoint

duration

Duration

Properties

val startPoint

RoutePoint

Точка на маршруте, в которой начинается пробка.

val finishPoint

RoutePoint

Точка на маршруте, в которой заканчивается пробка.

val duration

Duration

Ожидаемая длительность движения через пробку (оставшаяся длительность, если уже въехали в пробку).

TrafficLineColors

TrafficLineColors(
	emptyTrafficLineColor: Int,
	greenTrafficLineColor: Int,
	undefinedSpeedColor: Int,
	yellowSpeedColor: Int,
	redSpeedColor: Int,
	deepRedSpeedColor: Int,
	deepGreenSpeedColor: Int,
	orangeSpeedColor: Int
)

Parameters

emptyTrafficLineColor

Int

greenTrafficLineColor

Int

undefinedSpeedColor

Int

yellowSpeedColor

Int

redSpeedColor

Int

deepRedSpeedColor

Int

deepGreenSpeedColor

Int

orangeSpeedColor

Int

Properties

val emptyTrafficLineColor

Int

val greenTrafficLineColor

Int

val undefinedSpeedColor

Int

val yellowSpeedColor

Int

val redSpeedColor

Int

val deepRedSpeedColor

Int

val deepGreenSpeedColor

Int

val orangeSpeedColor

Int

TrafficLineControl

UI-элемент, отображающий уровень пробок вдоль маршрута.

Extends: ru.dgis.sdk.navigation.NavigationControl

TrafficLineControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

UI-элемент, отображающий уровень пробок вдоль маршрута.

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToModel(model: Model): Unit

Parameters

model

Model

Returns

Unit

Properties

var pointObjectsPosition

PointObjectsPosition

TrafficLinePointObject

TrafficLinePointObject(
	position: Float,
	type: Type,
	text: String? = null
)

Parameters

position

Float

type

Type

text

String?

Properties

val position

Float

val type

Type

val text

String?

TrafficLinePointObjectView

TrafficLinePointObjectView(
	context: Context,
	pointObject: TrafficLinePointObject,
	position: PointObjectsPosition
)

Parameters

context

Context

pointObject

TrafficLinePointObject

position

PointObjectsPosition

Methods

fun removeWithAnimation(): Unit

Returns

Unit

Properties

var isRemoved

Boolean

val pointObject

TrafficLinePointObject

const ANIMATION_DURATION

Long

TrafficRoute

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun fromNavigationState(navigationState: PackedNavigationState, context: Context): TrafficRoute

Создание маршрута из десериализованного состояния навигации с добавлением содержащихся в нём объектов в базу дорожных событий (необходимо для отображения событий на маршруте на карте при невозможности получить события онлайн).

Parameters

navigationState

PackedNavigationState

context

Context

Returns

TrafficRoute

Properties

val route

Route

Маршрут.

val traffic

Traffic

Пробочные данные.

val routeTollPaymentInfos

List<RouteTollPaymentInfo>

Информация о стоимости проезда по платным участкам маршрута.

TrafficRouter

Интерфейс для поиска маршрута с учетом пробочных данных.

Extends: ru.dgis.sdk.NativeObject

TrafficRouter(context: Context, routerType: RouterType = RouterType.HYBRID)

Parameters

context

Context

routerType

RouterType

Methods

fun findRoute(
	startPoint: RouteSearchPoint,
	finishPoint: RouteSearchPoint,
	routeSearchOptions: RouteSearchOptions,
	intermediatePoints: List<RouteSearchPoint> = listOf()
): Future<List<TrafficRoute>>

Ищет маршрут по заданным параметрам.

Parameters

startPoint

RouteSearchPoint

Начальная точка маршрута.

finishPoint

RouteSearchPoint

Конечная точка маршрута.

routeSearchOptions

RouteSearchOptions

Параметры поиска маршрута.

intermediatePoints

List<RouteSearchPoint>

Промежуточные точки для проезда в том же порядке, в котором точки заданы в векторе.

Returns

Future<List<TrafficRoute>>

Future с набором найденных маршрутов, либо с исключением NativeException в случае ошибки.

Пустой набор маршрутов является валидным результатом - это означает, что маршрут, соответствующий указанным критериям поиска, не может быть найден.

При поиске маршрутов для грузового транспорта возможен возврат маршрутов, проходящих через пропускные зоны, для которых не были предоставлены пропуска, в случае, если не удалось проложить маршрут только через пропускные зоны, для которых пропуска были предоставлены. Для проверки того, достаточен ли список пропусков для проезда по маршруту, следует использовать функцию route_matches_truck_pass_zone_passes.

fun requestRoute(request: ByteArray, serverEndpoint: String): Future<List<TrafficRoute>>

Ищет маршрут по ранее сериализованным параметрам.

Parameters

request

ByteArray

Сериализованные параметры запроса.

serverEndpoint

String

Тип искомого маршрута, выступает частью урла, по которому отсылается запрос: bicycle, carrouting, pedestrian, truck.

Returns

Future<List<TrafficRoute>>

Future с набором найденных маршрутов, либо с исключением NativeException в случае ошибки.

Не подходит для поиска маршрутов общественного транспорта.

При невозможности найти маршруты для грузового транспорта не пытается найти маршруты на легковом автомобиле без учёта грузовых данных.

fun fetchSharedRoute(requestId: String): Future<SharedRouteData>

Ищет ранее уже построенный маршрут и параметры его поиска по известному идентификатору поискового запроса маршрута.

Parameters

requestId

String

Известный идентификатор поискового запроса маршрута.

Returns

Future<SharedRouteData>

Future с набором маршрутов и параметрами, использованными для их поиска, либо с исключением NativeException в случае ошибки.

Получение ранее уже построенного маршрута работает только онлайн.

Получение ранее уже построенного маршрута не работает для ОТ.

fun findBriefRouteInfos(searchPoints: List<BriefRouteInfoSearchPoints>, routeSearchOptions: RouteSearchOptions): Future<List<BriefRouteInfo?>>

Ищет базовую информацию о маршрутах для соответствующего набора поисковых точек.

Parameters

searchPoints

List<BriefRouteInfoSearchPoints>

Набор точек для поиска базовой информации о маршруте.

routeSearchOptions

RouteSearchOptions

Параметры поиска маршрута.

Returns

Future<List<BriefRouteInfo?>>

Future с базовой информацией о наборе маршрутов, соответствующему набору точек поиска, либо исключением NativeException в случае ошибки.

Если базовая информация для каких-либо из пар точек не будет найдена, элемент с соответствующим индексом в возвращённом результате будет иметь значение null.

Properties

val truckPassZonePasses

Future<List<TruckPassZonePass>>

Возвращает список всех поддерживаемых пропусков, разрешающих движение грузового транспорта в пределах пропускных зон.

TrafficScore

Оценка пробок.

TrafficScore(state: TrafficScoreState = TrafficScoreState.PENDING, value: Int?)

Оценка пробок.

Parameters

state

TrafficScoreState

value

Int?

Properties

val state

TrafficScoreState

Актуальность значения.

val value

Int?

Значение в баллах. Как правило, значения находятся в диапазоне от 1 до 10. Пустое значение, если информация ещё не получена, либо уже устарела, либо недоступна для заданного местоположения.

TrafficScoreProvider

Подписка на обновления информации о величине пробок.

Этот интерфейс является потокобезопасным.

Extends: ru.dgis.sdk.NativeObject

TrafficScoreProvider(map: Map)

Функция создания объекта для слежения за баллом пробок в области видимости карты.

Parameters

map

Map

Карта, для которой будет отслеживаться область видимости.

TrafficScoreProvider(context: Context, point: GeoPoint)

Функция создания объекта для слежения за баллом пробок для заданного местоположения.

Parameters

context

Context

Контекст - окружение, необходимое для работы SDK.

point

GeoPoint

Геоточка, для которой необходимо получать балл пробок.

Properties

val scoreChannel

StatefulChannel<TrafficScore>

Текущее состояние пробок и их балл.

val score

TrafficScore

Текущее состояние пробок и их балл.

TrafficSource

Интерфейс класса, управляющего отображением пробок на карте.

Extends: ru.dgis.sdk.map.Source

TrafficSource(context: Context)

Parameters

context

Context

TrafficSpeedColorRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): TrafficSpeedColorRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

TrafficSpeedColorRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<TrafficSpeedColorRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<TrafficSpeedColorRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

TrafficSpeedColorRouteLongEntry?

Первый элемент.

val last

TrafficSpeedColorRouteLongEntry?

Последний элемент.

val entries

List<TrafficSpeedColorRouteLongEntry>

Все элементы.

TrafficSpeedColorRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

TrafficSpeedColorRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: TrafficSpeedColor
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

TrafficSpeedColor

Properties

val point

RoutePoint

val length

RouteDistance

val value

TrafficSpeedColor

TransportTypeRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): TransportTypeRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

TransportTypeRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<TransportTypeRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<TransportTypeRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

TransportTypeRouteLongEntry?

Первый элемент.

val last

TransportTypeRouteLongEntry?

Последний элемент.

val entries

List<TransportTypeRouteLongEntry>

Все элементы.

TransportTypeRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

TransportTypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: TransportType
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

TransportType

Properties

val point

RoutePoint

val length

RouteDistance

val value

TransportType

TraversalTypeRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): TraversalTypeRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

TraversalTypeRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<TraversalTypeRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<TraversalTypeRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

TraversalTypeRouteLongEntry?

Первый элемент.

val last

TraversalTypeRouteLongEntry?

Последний элемент.

val entries

List<TraversalTypeRouteLongEntry>

Все элементы.

TraversalTypeRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

TraversalTypeRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: TraversalType
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

TraversalType

Properties

val point

RoutePoint

val length

RouteDistance

val value

TraversalType

TripHighlights

Сводная информация о завершенной поездке

TripHighlights(
	tripDuration: Duration = Duration.ofMilliseconds(0),
	tripDistance: Int = 0,
	maxTripSpeed: Double = 0.0,
	trafficJamTimeWasted: Duration = Duration.ofMilliseconds(0),
	finishReached: Boolean = false,
	visitedRegionIds: List<Int>
)

Сводная информация о завершенной поездке

Parameters

tripDuration

Duration

tripDistance

Int

maxTripSpeed

Double

trafficJamTimeWasted

Duration

finishReached

Boolean

visitedRegionIds

List<Int>

Properties

val tripDuration

Duration

Длительность поездки

val tripDistance

Int

Фактически пройденное за время поездки расстояние, метры

val maxTripSpeed

Double

Максимальная скорость, достигнутая за время поездки, метры в секунду

val trafficJamTimeWasted

Duration

Время, проведенное в пробках

val finishReached

Boolean

Флаг, указвающий на то, достигнута финальная точка маршрута или нет Если нет, значит маршрут завершен вручную

val visitedRegionIds

List<Int>

Список ID регионов, посещенных за время поездки, в порядке посещения (могут повторяться)

TripHighlightsCollector

Коллектор информации о текущей поездке

Extends: ru.dgis.sdk.NativeObject

Properties

val tripHighlights

TripHighlights

Получить накопленные данные о текущей поездке.

TruckPassZoneId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

TruckPassZoneId(value: Int = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Int

Properties

val value

Int

TruckPassZoneIdRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entry(point: RoutePoint): TruckPassZoneIdRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

TruckPassZoneIdRouteLongEntry?

fun entries(begin: RoutePoint, end: RoutePoint): List<TruckPassZoneIdRouteLongEntry>

Элементы, частично или полностью покрываемые отрезком begin,end.

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<TruckPassZoneIdRouteLongEntry>

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

TruckPassZoneIdRouteLongEntry?

Первый элемент.

val last

TruckPassZoneIdRouteLongEntry?

Последний элемент.

val entries

List<TruckPassZoneIdRouteLongEntry>

Все элементы.

TruckPassZoneIdRouteLongEntry

Протяженный элемент маршрута - отрезок и значение на нем.

TruckPassZoneIdRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: TruckPassZoneId
)

Протяженный элемент маршрута - отрезок и значение на нем.

Parameters

point

RoutePoint

length

RouteDistance

value

TruckPassZoneId

Properties

val point

RoutePoint

val length

RouteDistance

val value

TruckPassZoneId

TruckPassZonePass

Пропуск, разрешающий движение грузового транспорта в пропускных зонах.

TruckPassZonePass(
	id: TruckPassZonePassId,
	name: String,
	passZoneIds: Set<TruckPassZoneId>
)

Пропуск, разрешающий движение грузового транспорта в пропускных зонах.

Parameters

id

TruckPassZonePassId

name

String

passZoneIds

Set<TruckPassZoneId>

Properties

val id

TruckPassZonePassId

Идентификатор пропуска.

val name

String

Название пропуска.

val passZoneIds

Set<TruckPassZoneId>

Идентификаторы пропускных зон, по которым разрешает движение данный пропуск

TruckPassZonePassId

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

TruckPassZonePassId(value: Int = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Int

Properties

val value

Int

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

CarRouteSearchOptions

truckLength

Int?

truckHeight

Int?

truckWidth

Int?

actualMass

Int?

maxPermittedMass

Int?

axleLoad

Int?

dangerousCargo

Boolean

explosiveCargo

Boolean

passIds

Set<TruckPassZonePassId>

fallbackOnCar

Boolean

Properties

val car

CarRouteSearchOptions

Параметры поиска маршрута, общие с прочими автомобильными.

val truckLength

Int?

Длина грузового транспортного средства в миллиметрах.

val truckHeight

Int?

Высота грузового транспортного средства в миллиметрах.

val truckWidth

Int?

Ширина грузового транспортного средства в миллиметрах.

val actualMass

Int?

Фактическая масса грузового транспортного средства в килограммах.

val maxPermittedMass

Int?

Разрешённая максимальная масса грузового транспортного средства в килограммах.

val axleLoad

Int?

Нагрузка на ось в килограммах.

val dangerousCargo

Boolean

Признак наличия опасного груза.

val explosiveCargo

Boolean

Признак наличия взрывчатых веществ в грузе.

val passIds

Set<TruckPassZonePassId>

Идентификаторы имеющихся у пользователя пропусков, требующихся для движения в пределах пропускных зон.

val fallbackOnCar

Boolean

Использование автоматического фоллбека с поиска грузового маршрута на поиск автомобильного маршрута при невозможности найти грузовой маршрут, удовлетворяющий параметрам поиска.

UIMarkerInfo

Идентификатор объекта с подписью.

UIMarkerInfo(objectId: DgisObjectId, label: String?)

Идентификатор объекта с подписью.

Parameters

objectId

DgisObjectId

label

String?

Properties

val objectId

DgisObjectId

val label

String?

VendorConfig

Переопределение конфигурации SDK.

VendorConfig()

VendorConfig(fromAsset: VendorConfigFromAsset)

Parameters

fromAsset

VendorConfigFromAsset

VendorConfig(fromFile: VendorConfigFromFile)

Parameters

fromFile

VendorConfigFromFile

VendorConfig(fromString: VendorConfigFromString)

Parameters

fromString

VendorConfigFromString

Methods

fun match(
	none: Function0<T>,
	fromAsset: Function1,
	fromFile: Function1,
	fromString: Function1
): T

Parameters

none

() -> T

fromAsset

(VendorConfigFromAsset) -> T

fromFile

(VendorConfigFromFile) -> T

fromString

(VendorConfigFromString) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isNone

Boolean

val isFromAsset

Boolean

val asFromAsset

VendorConfigFromAsset?

val isFromFile

Boolean

val asFromFile

VendorConfigFromFile?

val isFromString

Boolean

val asFromString

VendorConfigFromString?

val value

Any?

VendorConfigFromAsset

Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.

VendorConfigFromAsset(path: String)

Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.

Parameters

path

String

Properties

val path

String

Путь относительно корневой директории asset-ов.

VendorConfigFromFile

Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.

VendorConfigFromFile(path: String)

Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.

Parameters

path

String

Properties

val path

String

Путь к файлу.

VendorConfigFromString

Переопределение настроек SDK через указание содержимого файла.

VendorConfigFromString(contents: String)

Переопределение настроек SDK через указание содержимого файла.

Parameters

contents

String

Properties

val contents

String

Содержимое файла переопределения настроек.

Voice

Голосовой пакет с озвучкой навигатора.

Extends: ru.dgis.sdk.update.Package

Methods

fun playWelcome(): Future<Unit>

Воспроизвести образец голоса.

Returns

Future<Unit>

future, который становится готовым, когда проигрывание сэмпла завершается.

Properties

val navigationVoice

NavigationVoice

Получение голоса для использования в навигаторе.

val language

String

Язык озвучки в формате ISO 639-1.

VoiceManager

Интерфейс для взаимодействия со списком голосовых пакетов навигатора.

Extends: ru.dgis.sdk.NativeObject

Methods

@JvmStatic
fun instance(context: Context): VoiceManager

Получение объекта для управления голосами из контекста.

Parameters

context

Context

Returns

VoiceManager

Properties

val voicesChannel

StatefulChannel<List<Voice>>

Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.

val voices

List<Voice>

Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.

val defaultVoice

Voice?

Получение голоса на основании списка локалей, которые предоставляет платформа.

VoiceSelector

Управляет голосовыми пакетами в текущей сессии навигатора.

Extends: ru.dgis.sdk.NativeObject

Properties

var voice

NavigationVoice?

Голосовой пакет, с помощью которого воспроизводятся голосовые оповещения в текущей сессии навигатора.

VoidRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: ru.dgis.sdk.NativeObject

Methods

fun entries(begin: RoutePoint, end: RoutePoint): List<RoutePoint>

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

List<RoutePoint>

fun findNearBackward(point: RoutePoint): RoutePoint?

Найти ближайший элемент, позиция которого < = point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RoutePoint?

fun findNearForward(point: RoutePoint): RoutePoint?

Найти ближайший элемент, позиция которого >= point.

Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

RoutePoint?

Properties

val size

Long

Количество элементов.

val isEmpty

Boolean

Элементы отсутствуют.

val first

RoutePoint?

Первый элемент.

val last

RoutePoint?

Последний элемент.

val entries

List<RoutePoint>

Все элементы.

WeekTime

Момент времени внутри недели.

WeekTime(weekDay: WeekDay, time: DayTime)

Момент времени внутри недели.

Parameters

weekDay

WeekDay

time

DayTime

Properties

val weekDay

WeekDay

День недели.

val time

DayTime

Время.

WeekTimeInterval

Интервал времени в течение недели.

WeekTimeInterval(startTime: WeekTime, finishTime: WeekTime)

Интервал времени в течение недели.

Parameters

startTime

WeekTime

finishTime

WeekTime

Properties

val startTime

WeekTime

Время начала.

val finishTime

WeekTime

Время окончания.

Widget

Базовый класс, представляющий виджет для фильтрации поисковой выдачи.

Виджеты возвращаются в результате поиска и предназначены для фильтрации или сортировки результата по определенным параметрам. Виджеты генерируются динамически для каждого результата поиска и могут отсутствовать для некоторых запросов. Виджет представляет один конкретный фильтр или их группу, объединённую общим признаком. Например, тип кухни в результатах поиска по запросу "Поесть".

Extends: ru.dgis.sdk.NativeObject

Properties

val type

WidgetType

Получение типа виджета.

val caption

String?

Получение заголовка виджета. Может отсутствовать.

val filters

List<DynamicFilter>

Получение списка фильтров, описывающих текущее состояние виджета. Может быть использован при формировании поискового запроса.

WmsRasterUrlTemplate

WmsRasterUrlTemplate(urlTemplate: String)

Parameters

urlTemplate

String

Properties

val urlTemplate

String

WorkStatus

Статус работы.

WorkStatus(
	openStatus: OpenStatus,
	openStatusHint: String,
	scheduleHint: String?,
	breakHint: String?
)

Статус работы.

Parameters

openStatus

OpenStatus

openStatusHint

String

scheduleHint

String?

breakHint

String?

Properties

val openStatus

OpenStatus

Статус.

val openStatusHint

String

Тескотовое подсказка по текущему статусу. Например: "Откроется через 15 минут", "Сегодня 10:00–22:00", "Ежедневно 09:00–21:00", "Открыто", "Закроется через 15 минут", "Закрыто", "Обед до 14:00", "Перерыв до 16:15".

val scheduleHint

String?

Текстовая подсказка по расписанию работы. Например: "Сегодня 10:00–22:00", "Ежедневно 09:00–21:00", "Сегодня закрыто"

val breakHint

String?

Текстовая подсказка о текущем или ближайшем перерыве. Например: "Обед до 14:00", "Перерыв до 11:30".

WorkTimeFilter

Фильтр по времени работы объекта:

• Открыт на конкретные дату и время.
• Открыт сейчас.
• Работает круглосуточно в указанный день недели или сегодня, если день не указан.

WorkTimeFilter(workTime: WeekTime)

Parameters

workTime

WeekTime

WorkTimeFilter(isOpenNow: IsOpenNow)

Parameters

isOpenNow

IsOpenNow

WorkTimeFilter(isOpenAllDay: IsOpenAllDay)

Parameters

isOpenAllDay

IsOpenAllDay

Methods

fun match(
	workTime: Function1,
	isOpenNow: Function1,
	isOpenAllDay: Function1
): T

Parameters

workTime

(WeekTime) -> T

isOpenNow

(IsOpenNow) -> T

isOpenAllDay

(IsOpenAllDay) -> T

Returns

T

fun toString(): String

Returns

String

fun hashCode(): Int

Returns

Int

fun equals(other: Any?): Boolean

Parameters

other

Any?

Returns

Boolean

Properties

val isWorkTime

Boolean

val asWorkTime

WeekTime?

val isIsOpenNow

Boolean

val asIsOpenNow

IsOpenNow?

val isIsOpenAllDay

Boolean

val asIsOpenAllDay

IsOpenAllDay?

val value

Any?

ZIndex

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

ZIndex(value: Int = 0)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Int

Properties

val value

Int

Zoom

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Zoom(value: Float = 0.0f)

Отличия от BOOST_STRONG_TYPEDEF:

• может использоваться в constexpr контексте если тип T поддерживает это
• приводится к нижележащему типу только явно (и таким образом запрещает сравнение двух разных strong typedef'ов на один и тот же тип)

Parameters

value

Float

Properties

val value

Float

ZoomControl

Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

Extends: ru.dgis.sdk.map.MapControl

ZoomControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

ZoomControl

Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

Extends: ru.dgis.sdk.map.MapControl

ZoomControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Контейнер с UI-элементами управления уровнем масштабирования (увеличение/уменьшение).

Parameters

context

Context

attrs

AttributeSet?

defStyle

Int

Methods

fun attachToMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

fun detachFromMap(map: Map): Unit

Parameters

map

Map

Returns

Unit

ZoomControlModel

Модель контрола зумирования. Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты. При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной. Методы объекта необходимо вызывать на одном потоке.

Extends: ru.dgis.sdk.NativeObject

ZoomControlModel(map: Map)

Parameters

map

Map

Methods

fun isEnabled(button: ZoomControlButton): StatefulChannel<Boolean>

Parameters

button

ZoomControlButton

Returns

StatefulChannel<Boolean>

fun setPressed(button: ZoomControlButton, value: Boolean): Unit

Parameters

button

ZoomControlButton

value

Boolean

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. Если скорость вышла за пределы интервала, то происходит поиск соседнего интервала, в который попадает значение скорости, и запоминается его индекс.

Происходит проверка, не проезжаем ли мы маневр (только для определенных классов дорог). Считается, что мы проезжаем маневр, если есть маневр по ходу движения и дистанция до маневра не превышает указанной в поле min_distance_to_maneuver_m из SpeedRangeToStyleZoom, или мы проехали маневр, но не отдалились от него на дистанцию больше указанной в max_distance_to_maneuver_m из SpeedRangeToStyleZoom. Если мы проезжаем маневр, то выбирается масштаб, соответствующий элементу последовательности с index == 0, иначе выбирается масштаб, соответствующий элементу index.

При приближении к маневру на текущей скорости масштаб будет плавно увеличиваться. Время увеличения зависит от скорости и расстояния до манёвра. При увеличении скорости время анимации увеличивается, при снижении скорости - уменьшается. Увеличение уровня зума завершается на некотором расстоянии до манёвра.

После проезда манёвра уровень зума плавно уменьшается.

Extends: ru.dgis.sdk.NativeObject

Properties

var speedRangeToStyleZoomSequence

List<SpeedRangeToStyleZoom>

Последовательность интервалов скоростей и соответствующих им масштабов. Используется для автоматического изменения масштаба в навигаторе в зависимости от скорости.

var speedRangeToStyleZoomFreeRoamSequence

List<SpeedRangeToStyleZoom>

Последовательность интервалов скоростей и соответствующих им масштабов при ведении в режиме FreeRoam. Используется для автоматического изменения масштаба в навигаторе в зависимости от скорости.

var styleZoomSpeedRangesAnimationDuration

Duration

Длительность плавного изменения масштаба в режиме ведения при изменении скорости при отсутствии манёвров впереди/позади на достаточно близком расстоянии, либо на дорогах низкого значения.

var zoomInBeforeManeuverAnimationDuration

Duration

Длительность плавного увеличения уровня зума при приближении к манёвру. Используется только если скорость ниже, чем в get_min_speed_to_consider_in_zoom_in_before_maneuver_animation.

var zoomOutAfterManeuverAnimationDuration

Duration

Длительность плавного уменьшения уровня масштабирования после проезда манёвра.

var minSpeedToConsiderInZoomInBeforeManeuverAnimation

Double

Минимальная скорость движения в м/с, при которой длительность плавного изменения уровня зума будет рассчитываться с учётом не только близости к манёвру, но и с учётом текущей скорости. Должна быть не меньше 0.1 м/с, значения меньше будут игнорироваться.

var zoomInBeforeManeuverAnimationAcceleration

Double

Коэффициент ускорения анимации увеличения уровня зума при приближении к манёвру. Должен быть не меньше 1, значения меньше будут игнорироваться.

var distanceGapToManeuver

RouteDistance

Расстояние до манёвра, при достижении которого анимация плавного увеличения уровня зума должна быть завершена, чтобы во время манёвра зум не менялся. Например, если до маневра 300 м, то анимация с плавным увеличением уровня зума должна быть завершена за 50 м до начала маневра. Должно быть не меньше 1 м, значения меньше будут игнорироваться.

var minAnimationDuration

Duration

Минимальное время анимации. Используется для предотвращения резких изменений уровня зума при анимации. Должно быть не меньше 200, значения меньше будут игнорироваться.