Skip to main content

class

ActivityTracker​

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

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

Parameters

platformContext

Контекст.

model

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

speedBound

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

timeThreshold

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

Properties

val stopChannel​

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

val stop​

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

AddEventResult​

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

AddEventResult(event: RoadEvent)
Parameters

event

AddEventResult(error: AddEventError)
Parameters

error

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

event

error

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

other

Returns
Boolean
Properties

val isEvent​

val asEvent​

val isError​

val asError​

val value​

Address​

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

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

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

Parameters

drillDown

components

buildingName

postCode

buildingCode

addressComment

Properties

val drillDown​

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

val components​

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

val buildingName​

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

val postCode​

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

val buildingCode​

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

val addressComment​

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

AddressAdmDiv​

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

AddressAdmDiv(type: String, name: String)

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

Parameters

type

name

Properties

val type​

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

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

val name​

AddressComponent​

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

AddressComponent(streetAddress: AddressStreet)
Parameters

streetAddress

AddressComponent(number: AddressNumber)
Parameters

number

AddressComponent(location: AddressLocation)
Parameters

location

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

streetAddress

number

location

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

other

Returns
Boolean
Properties

val isStreetAddress​

val asStreetAddress​

val isNumber​

val asNumber​

val isLocation​

val asLocation​

val value​

AddressLocation​

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

AddressLocation(comment: String)

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

Parameters

comment

Properties

val comment​

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

AddressNumber​

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

AddressNumber(number: String)

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

Parameters

number

Properties

val number​

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

AddressStreet​

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

AddressStreet(street: String, number: String)

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

Parameters

street

number

Properties

val street​

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

val number​

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

AddRoadEventButton​

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

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

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit

AddRoadEventCard​

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

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

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
Properties

const MAX_DESCRIPTION_LENGTH​

AddRoadEventCardModel​

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

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

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

Parameters

roadEventManager

map

Methods
fun onEventTypeClicked(type: RoadEventType): Unit

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

Parameters

type

Returns
Unit
fun onLaneClicked(lane: Lane): Unit

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

Parameters

lane

Returns
Unit
fun onDescriptionEntered(description: String): Unit

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

Parameters

description

Returns
Unit
fun onSendClicked(): Unit

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

Returns
Unit
fun close(): Unit
Returns
Unit
Properties

val eventTypeChannel​

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

val lanesChannel​

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

val canSelectLanesChannel​

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

val descriptionChannel​

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

val markerPositionChannel​

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

val canSendChannel​

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

val resultChannel​

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

AddRoadEventControl​

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

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

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

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

var model​

val closeables​

AddRoadEventControls​

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

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

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

Parameters

context

attrs

defStyle

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

map

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

map

Returns
Unit
Properties

val cardHeightChannel​

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

AddRoadEventMarker​

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

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

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
fun detachFromModel(): Unit
Returns
Unit

AlternativeRoutesProviderSettings​

Extends: ru.dgis.sdk.NativeObject
Properties

var alternativeRoutesEnabled​

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

var betterRouteEnabled​

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

var routeSearchDelay​

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

var betterRouteTimeCostThreshold​

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

var betterRouteLengthThreshold​

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

Anchor​

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

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

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

Parameters

x

y

Properties

val x​

val y​

ApartmentRange​

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

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

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

Parameters

start

end

Properties

val start​

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

val end​

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

Attribute​

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

Attribute(tag: String, value: String)

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

Parameters

tag

value

Properties

val tag​

Тег.

val value​

Значение.

Attributes​

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

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

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

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

Parameters

name

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

value

значение.

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

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

Parameters

values

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

attributesToRemove

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

Returns
Unit
fun removeAttribute(name: String): Unit

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

Parameters

name

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

Returns
Unit
fun getAttributeValue(name: String): AttributeValue

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

Parameters

name

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

Returns
AttributeValue
Properties

val attributeNames​

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

val changed​

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

AttributeValue​

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

AttributeValue()
AttributeValue(boolean: Boolean)
Parameters

boolean

AttributeValue(number: Double)
Parameters

number

AttributeValue(integer: Long)
Parameters

integer

AttributeValue(string: String)
Parameters

string

AttributeValue(data: ByteArray)
Parameters

data

AttributeValue(array: List<AttributeValue>)
Parameters

array

AttributeValue(item: Map)
Parameters

item

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

empty

boolean

number

integer

string

data

array

item

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

other

Returns
Boolean
Properties

val isEmpty​

val isBoolean​

val asBoolean​

val isNumber​

val asNumber​

val isInteger​

val asInteger​

val isString​

val asString​

val isData​

val asData​

val isArray​

val asArray​

val isObject​

val asObject​

val value​

AuthorInfo​

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

AuthorInfo(type: AuthorType, name: String)

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

Parameters

type

name

Properties

val type​

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

val name​

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

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

BaseCamera​

Камера.

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

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

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

Returns
BaseCamera
Properties

val projection​

Проекция.

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

val positionChannel​

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

var position​

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

val zoomRestrictionsChannel​

Получение актуальных ограничений zoom-уровня.

var zoomRestrictions​

Получение актуальных ограничений zoom-уровня.

val deviceDensityChannel​

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

val deviceDensity​

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

val sizeChannel​

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

var size​

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

val paddingChannel​

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

var padding​

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

val positionPointChannel​

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

var positionPoint​

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

val visibleArea​

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

val visibleRectChannel​

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

val visibleRect​

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

val styleZoomToTiltRelationChannel​

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

var styleZoomToTiltRelation​

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

val maxTiltRestrictionChannel​

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

var maxTiltRestriction​

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

Bearing​

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

Bearing(value: Double = 0.0)

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

Parameters

value

Properties

val value​

BetterRouteInfo​

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

BetterRouteInfo(trafficRoute: TrafficRoute, startPoint: RoutePoint)

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

Parameters

trafficRoute

startPoint

Properties

val trafficRoute​

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

val startPoint​

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

BetterRoutePromptControl​

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

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

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

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
Properties

val visibilityChannel​

BicycleBriefRouteInfo​

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

BicycleBriefRouteInfo(length: RouteDistance, landmark: String)

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

Parameters

length

landmark

Properties

val length​

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

val landmark​

Ориентир.

BicycleInstructionCrossroad​

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

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

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

Parameters

landmark

maneuvers

Properties

val landmark​

Ориентир.

val maneuvers​

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

BicycleInstructionCrossroadManeuver​

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

direction

turnAngle

Properties

val direction​

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

val turnAngle​

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

BicycleInstructionFinish​

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

BicycleInstructionFinish()

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

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

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

BicycleInstructionStart​

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

BicycleInstructionStart()

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

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

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

BicycleRouteSearchOptions​

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

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

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

Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

val avoidCarRoads​

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

val avoidStairways​

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

val avoidUnderpassesAndOverpasses​

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

val excludedAreas​

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

BoolRouteLongAttribute​

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

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

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

Parameters

point

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

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

Parameters

begin

end

Returns
List<BoolRouteLongEntry>
Properties

val size​

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

val isEmpty​

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

val first​

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

val last​

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

val entries​

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

BoolRouteLongEntry​

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

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

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

Parameters

point

length

value

Properties

val point​

val length​

val value​

BriefExtraRouteInfo​

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

BriefExtraRouteInfo(bicycle: BicycleBriefRouteInfo)
Parameters

bicycle

BriefExtraRouteInfo(car: CarBriefRouteInfo)
Parameters

car

BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)
Parameters

pedestrian

BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)
Parameters

publicTransport

BriefExtraRouteInfo(scooter: ScooterBriefRouteInfo)
Parameters

scooter

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

bicycle

car

pedestrian

publicTransport

scooter

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

other

Returns
Boolean
Properties

val isBicycle​

val asBicycle​

val isCar​

val asCar​

val isPedestrian​

val asPedestrian​

val isPublicTransport​

val asPublicTransport​

val isScooter​

val asScooter​

val value​

BriefPublicTransportCard​

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

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

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

Parameters

context