class
ActivityTracker
ActivityTracker(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: Duration = Duration.ofMilliseconds(20000)
)
Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал, когда пользователь перестал пользоваться навигатором и его можно выключить.
Контекст.
Модель навигатора, состояние которого отслеживается.
Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается, что навигатор активен, т.е. движение продолжается.
Время, в течение которого в состоянии Finished навигатора отслеживается скорость движения ниже пороговой для определения состояния неактивности навигатора. Если в течение этого времени скорость движения меньше установленного порога или нет данных о локации и скорости, навигатор считается неактивным.
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
AddEventResult
Результат добавления события (объект события или ошибка).
fun match(event: Function1, error: Function1): T
fun toString(): String
fun hashCode(): Int
Address
Адрес в виде набора отдельных компонент.
Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
postCode: String?,
buildingCode: String?,
addressComment: String?
)
Адрес в виде набора отдельных компонент.
Набор объектов административного деления, в которых находится описываемый объект.
Полный адрес объекта может содержать несколько отдельных адресных компонент.
Название здания.
Почтовый индекс.
Уникальный почтовый код здания.
Комментарий к адресу. Пример: "301 офис; 9 этаж"
AddressAdmDiv
Объект административного деления.
AddressComponent
Компонент адреса: улица, номер дома или словесное описание местоположения.
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
fun toString(): String
fun hashCode(): Int
AddressLocation
Применяется для компонентов, которые тяжело описать конкретным адресом.
AddressLocation(comment: String)
Применяется для компонентов, которые тяжело описать конкретным адресом.
Словесное описание местоположения строения.
AddressNumber
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
AddressNumber(number: String)
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
Номер дома, включая дроби и буквенные обозначения. Возможно, имя собственное, если так принято.
AddressStreet
Обычный адрес, есть улица и номер дома.
AddRoadEventButton
Кнопка добавления дорожного события.
AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Кнопка добавления дорожного события.
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCard
Карточка добавления дорожного события.
AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка добавления дорожного события.
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCardModel
Модель карточки добавления дорожного события.
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)
Модель карточки добавления дорожного события.
fun onEventTypeClicked(type: RoadEventType): Unit
Действие при нажатии контрола выбора типа события.
fun onLaneClicked(lane: Lane): Unit
Действие при нажатии контрола выбора полосы.
fun onDescriptionEntered(description: String): Unit
Действие при вводе описания.
fun close(): Unit
Выбранный тип события.
Выбранные полосы.
Есть ли возможность задать полосы.
Введенное описание.
Позиция маркера на экране.
Есть ли возможность отправить событие.
Результат отправки события.
AddRoadEventControl
Базовый класс для контролов добавления дорожных событий.
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для контролов добавления дорожных событий.
fun attachToModel(model: AddRoadEventCardModel): Unit
@CallSuper
fun detachFromModel(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
AddRoadEventControls
Набор контролов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.
AddRoadEventControls(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Набор контролов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.
fun show(): Unit
fun hide(): Unit
Высота в пикселях, на которую раскрыта карточка.
AddRoadEventMarker
Маркер добавления дорожного события.
AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Маркер добавления дорожного события.
fun attachToModel(model: AddRoadEventCardModel): Unit
fun detachFromModel(): Unit
AlternativeRoutesProviderSettings
Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.
Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.
Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.
Минимальная разница во времени движения между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
Anchor
Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний
ApartmentRange
Диапазон квартир.
Начало диапазона/Хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.
Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1.
Attribute
Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }
Attributes
Интерфейс для управления свойствами объекта карты.
Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты, для стиля и для источника (подробнее см. ISource).
fun setAttributeValue(name: String, value: AttributeValue): Unit
Установка свойства.
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit
Установка набора свойств.
набор пар "имя":"значение" для добавляемых свойства
список имён свойств, которые нужно удалить
fun removeAttribute(name: String): Unit
Удаление свойства.
fun getAttributeValue(name: String): AttributeValue
Получение свойства.
Получение списка свойств.
Получение канала, уведомляющего об изменении свойств.
AttributeValue
Свойства объектов карты.
AttributeValue()
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
fun toString(): String
fun hashCode(): Int
AuthorInfo
Информация об авторе события или фотографии.
AuthorInfo(type: AuthorType, name: String)
Информация об авторе события или фотографии.
Категория автора контента.
Строка, содержащая имя пользователя, добавившего событие или фотографию.
- Имя пользователя в случае, если автор является авторизированным пользователем и согласился на отображение своего имени.
- Пустая строка для анонимного пользователя или пользователя, отказавшегося от отображения своего имени.
BaseCamera
Камера.
Задаёт параметры проецирования карты на экран.
Проекция.
Используется для получения точки экрана по точке карты и точки карты по точке экрана. Параметры камеры фиксируются в момент вызова.
Получение текущей позиции камеры.
Получение текущей позиции камеры.
Получение актуальных ограничений zoom-уровня.
Получение актуальных ограничений zoom-уровня.
Получение отношения DPI к базовому DPI устройства.
Получение отношения DPI к базовому DPI устройства.
Получение размера области просмотра.
Получение размера области просмотра.
Получение текущих отступов от краёв экрана.
Получение текущих отступов от краёв экрана.
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
Область пересечения пирамиды видимости камеры и поверхности карты.
Объемлющий прямоугольник видимой области карты.
Объемлющий прямоугольник видимой области карты.
Получение текущей функции зависимости угла наклона камеры от стилевого zoom-уровня.
Получение текущей функции зависимости угла наклона камеры от стилевого zoom-уровня.
Получение текущей функции зависимости максимального угла наклона камеры от стилевого zoom-уровня.
Получение текущей функции зависимости максимального угла наклона камеры от стилевого zoom-уровня.
Bearing
Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений 0°,360°.
BetterRouteInfo
Информация о доступном альтернативном маршруте
BetterRouteInfo(trafficRoute: TrafficRoute, startPoint: RoutePoint)
Информация о доступном альтернативном маршруте
Альтернативный маршрут
Точка на альтернативном маршруте, с которой начнётся движение в случае перехода на этот маршрут
BetterRoutePromptControl
Диалог, предлагающий перейти на ведение по маршруту с меньшим ожидаемым временем прибытия.
BetterRoutePromptControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Диалог, предлагающий перейти на ведение по маршруту с меньшим ожидаемым временем прибытия.
BicycleBriefRouteInfo
Базовая информация о велосипедном маршруте.
BicycleBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о велосипедном маршруте.
BicycleInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
BicycleInstructionCrossroad(landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.NONE, maneuvers: List<BicycleInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
Ориентир.
Цепочка идущих подряд манёвров.
BicycleInstructionCrossroadManeuver
BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Направление движения.
BicycleInstructionFinish
Конец велосипедной части маршрута.
BicycleInstructionFinish()
Конец велосипедной части маршрута.
BicycleInstructionStart
Начало велосипедной части маршрута.
BicycleInstructionStart()
Начало велосипедной части маршрута.
BicycleRouteSearchOptions
Параметры поиска маршрута на велосипеде.
BicycleRouteSearchOptions(
avoidCarRoads: Boolean = false,
avoidStairways: Boolean = false,
avoidUnderpassesAndOverpasses: Boolean = false,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на велосипеде.
Избегать автомобильных дорог.
Избегать лестниц.
Избегать подземных и надземных переходов.
Исключаемые области (не больше 25).
BoolRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): BoolRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<BoolRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
BoolRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
BoolRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Boolean
)
Протяженный элемент маршрута - отрезок и значение на нем.
BriefExtraRouteInfo
Дополнительная информация о маршруте для конкретного типа транспорта.
BriefExtraRouteInfo(pedestrian: PedestrianBriefRouteInfo)
BriefExtraRouteInfo(publicTransport: PublicBriefRouteInfo)
fun match(
bicycle: Function1,
car: Function1,
pedestrian: Function1,
publicTransport: Function1,
scooter: Function1
): T
fun toString(): String
fun hashCode(): Int
BriefPublicTransportCard
Краткая карточка, отображающая информацию о маршруте на общественном транспорте. В отличии от PublicTransportCard не содержит информацию о пересадках.
BriefPublicTransportCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Краткая карточка, отображающая информацию о маршруте на общественном транспорте. В отличии от PublicTransportCard не содержит информацию о пересадках.
fun onAttachedToWindow(): Unit
BriefPublicTransportCardModel
Модель для BriefPublicTransportCard.
BriefPublicTransportCardModel(route: TrafficRoute, context: Context)
Модель для BriefPublicTransportCard.
Заголовок. Предполагаемое время проезда, например, "1 ч 42 мин."
Информация о транспорте.
Описание. Количество пересадок и время пешком, например, 1пересадка,Пешком15мин.
BriefRoadEvent
BriefRoadEvent(
id: Long = 0,
eventType: RoadEventType = RoadEventType.OTHER,
lanes: EnumSet<Lane>
)
BriefRouteInfo
Базовая информация о маршруте.
BriefRouteInfo(duration: Duration, extraInfo: BriefExtraRouteInfo)
Базовая информация о маршруте.
Время движения по маршруту.
Дополнительная информация о маршруте для конкретного типа транспорта.
BriefRouteInfoSearchPoints
Точки для запроса поиска базовой информации о маршруте.
BriefRouteInfoSearchPoints(startPoint: RouteSearchPoint, finishPoint: RouteSearchPoint)
Точки для запроса поиска базовой информации о маршруте.
Начальная точка маршрута.
Конечная точка маршрута.
BuildingId
Идентификатор здания.
BuildingLevels
Информация об этажных планах здания.
BuildingLevels(defaultLevelId: LevelId, levels: List<LevelInfo>)
Информация об этажных планах здания.
Идентификатор этажного плана по умолчанию.
Все этажные планы здания.
CalloutMapPosition
Положение баблика маршрута.
CalloutMapPosition(
mapId: MapId,
calloutPosition: GeoPoint?,
routePoint: RoutePoint?
)
Положение баблика маршрута.
Идентификатор карты, для которой приведена позиция.
Позиция на карте.
Позиция бабла полосности на маршруте.
Camera
Камера для запуска перемещения карты и настройки слежения.
fun move(moveController: CameraMoveController): Future<CameraAnimatedMoveResult>
Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.
контроллер анимированного перемещения камеры.
fun move(
position: CameraPosition,
time: Duration = Duration.ofMilliseconds(300),
animationType: CameraAnimationType = CameraAnimationType.DEFAULT
): Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.
конечная позиция камеры
время, выделенное на пермещение карты
тип анимации при перемещении камеры
fun processMovementAndStop(): Unit
Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает режим слежения.
fun addFollowController(followController: FollowController): Unit
Добавление контроллера слежения.
Их может быть несколько разных, например контроллер слежения за масштабом, за углом наклона карты, за геолокацией и т.д.
fun removeFollowController(followController: FollowController): Unit
Удаление контроллера слежения.
fun setCustomFollowController(followController: CustomFollowController): Unit
Добавление контроллера слежения реализованного на платформе.
Можно установить только один такой контроллер. Если установить несколько контроллеров, то будет использоваться только последний установленный.
fun removeCustomFollowController(): Unit
Удаление контроллера слежения реализованного на платформе.
Получение актуального состояния камеры.
Получение актуального состояния камеры.
Режим слежения камеры.
Режим слежения камеры.
CameraBehaviour
Режим слежения камеры.
Режимы камеры деградируются по следующим правилам:
- смещение карты сбрасывает в None события: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent с указанием центра события, DirectMapScalingEvent с указанием центра события, ScaleMapEvent с указанием центра события
- поворот карты относительно точки позиции отбрасывает Bearing события: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent без центра события
- изменение масштаба относительно точки позиции отбрасывает StyleZoom события: MapScalingBeginEvent, DirectMapScalingEvent без центра события, ScaleMapEvent без центра события
- наклон отбрасывает Tilt события: DirectMapTiltEvent
CameraBehaviour(position: FollowPosition?, transitionType: TransitionType = TransitionType.SMOOTH)
Режим слежения камеры.
Режимы камеры деградируются по следующим правилам:
- смещение карты сбрасывает в None события: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent с указанием центра события, DirectMapScalingEvent с указанием центра события, ScaleMapEvent с указанием центра события
- поворот карты относительно точки позиции отбрасывает Bearing события: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent без центра события
- изменение масштаба относительно точки позиции отбрасывает StyleZoom события: MapScalingBeginEvent, DirectMapScalingEvent без центра события, ScaleMapEvent без центра события
- наклон отбрасывает Tilt события: DirectMapTiltEvent
CameraBehaviourChange
Изменение режима слежения.
CameraBehaviourChange(newBehaviour: CameraBehaviour, changeReason: CameraBehaviourChangeReason)
Изменение режима слежения.
Новый режим слежения.
Причина изменения режима слежения.
CameraNotifier
Предупреждает о попадании в зону действия дорожной камеры.
CameraNotifier(model: Model)
Расширение навигатора, которое предупреждает о попадании в зону действия дорожной камеры.
Модель навигатора, состояние которого отслеживается.
Прогресс прохождения зоны действия дорожной камеры.
Прогресс прохождения зоны действия дорожной камеры.
CameraPosition
Позиция камеры.
Точка местности, которая находится в точке позиции камеры (см. ICamera::position_point()).
Zoom-уровень. 0 - это весь мир, вписанный в квадрат 256x256 логических пикселей (см. LogicalPixel)
Угол наклона направления взгляда по вертикали.
0 - надир (смотрим вертикально вниз), максимальное значение - 60 градусов.
Угол поворота направления взгляда по горизонтали относительно направления на север. Отсчитывается по часовой стрелке, в градусах.
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 - правый нижний
CameraProgressInfo
Информация о прогрессе прохождения зоны камеры.
CameraProgressInfo(
camera: RouteCamera,
position: RoutePoint,
progress: Float = 0.0f
)
Информация о прогрессе прохождения зоны камеры.
Камера, для зоны действия которой отслеживается прогресс.
Позиция камеры на маршруте.
CameraRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<CameraRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): CameraRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): CameraRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
CameraRouteEntry
Элемент маршрута - точка и значение в ней.
CameraRouteEntry(point: RoutePoint, value: RouteCamera)
Элемент маршрута - точка и значение в ней.
CameraZoomRestrictions
Допустимый диапазон изменения zoom-уровня.
CancelEvent
Событие отмены текущего действия.
Вызывается, например, при отмене жеста, потере фокуса окна или при потере захвата мыши. Также может быть вызван изнутри карты при смене ограничений zoom-уровня, некоторых изменениях режима слежения и установке интерактивного режима карты.
CancelEvent()
CarBriefRouteInfo
Базовая информация об автомобильном маршруте.
CarBriefRouteInfo(
length: RouteDistance,
landmark: String,
trafficSpeed: CarBriefRouteInfoTrafficSpeed
)
Базовая информация об автомобильном маршруте.
Длина маршрута.
Ориентир.
Скорость движения.
CarInstructionCrossroad
Описание манёвров на перекрёстке.
CarInstructionCrossroad(
direction: CarInstructionCrossroadDirection = CarInstructionCrossroadDirection.STRAIGHT,
turnAngle: Int = 0,
landmark: CarInstructionCrossroadLandmark = CarInstructionCrossroadLandmark.NONE,
exitName: String
)
Описание манёвров на перекрёстке.
Направление движения на перекрёстке.
Ориентир.
Название съезда.
CarInstructionFinish
Конец автомобильной части маршрута.
CarInstructionFinish()
Конец автомобильной части маршрута.
CarInstructionRoundabout
Описание маневров на перекрёстке с круговым движением.
CarInstructionRoundabout(
type: CarInstructionRoundaboutType = CarInstructionRoundaboutType.ENTRY,
turnAngle: Int = 0,
exitNumber: Int = 0,
exitName: String
)
Описание маневров на перекрёстке с круговым движением.
CarInstructionStart
Начало автомобильной части маршрута.
CarInstructionStart()
Начало автомобильной части маршрута.
CarInstructionUTurn
Разворот на дороге (не на перекрёстке).
Разворот на перекрестке описывается инструкцией Crossroad.
CarInstructionUTurn(exitName: String)
Разворот на дороге (не на перекрёстке).
Разворот на перекрестке описывается инструкцией Crossroad.
Название съезда.
CarRouteSearchOptions
Параметры поиска маршрута на легковом автомобиле.
CarRouteSearchOptions(
avoidTollRoads: Boolean = false,
avoidUnpavedRoads: Boolean = false,
avoidFerries: Boolean = false,
avoidLockedRoads: Boolean = true,
routeSearchType: RouteSearchType = RouteSearchType.JAM,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на легковом автомобиле.
Избегать платных дорог.
Избегать грунтовых дорог.
Избегать паромных переправ.
Избегать закрытых для проезда дорог. При значении true поиск маршрута не будет учитывать перекрытые для проезда участки дорог. При значении false маршрут может быть проложен через перекрытые для проезда участки дорог, если невозможно построить маршрут без проезда через перекрытые участки.
Тип поиска маршрута.
Исключаемые области (не больше 25).
Certificate
SSL-сертификат.
fun match(
system: Function1,
fromFile: Function1,
fromAsset: Function1
): T
fun toString(): String
fun hashCode(): Int
Сертификаты, используемые по умолчанию. Системные + российские, поставляемые вместе с SDK.
CertificateFromAsset
SSL-сертификат из Android asset-а.
Путь относительно корневой директории asset-ов.
CertificateFromFile
SSL-сертификат из файла.
Путь к файлу.
Circle
Окружность.
Местоположение центра окружности.
Радиус окружности.
Цвет заливки окружности.
Ширина линии границы окружности.
Цвет границы окружности.
CircleOptions
Параметры для создания геометрического объекта карты типа "Окружность".
CircleOptions(
position: GeoPoint,
radius: Meter,
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value = 0.0f),
strokeColor: Color = Color(),
visible: Boolean = true,
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
levelId: LevelId? = null
)
Параметры для создания геометрического объекта карты типа "Окружность".
Географическая позиция.
Радиус в метрах.
Цвет заливки.
Ширина линии границы окружности.
Цвет линии границы окружности.
Флаг видимости.
Пользовательские данные (не используются внутри SDK, нужны только для пользователя API).
Уровень отрисовки объекта.
Привязка к поэтажному плану здания.
ClusterObject
Кластер объектов.
Получение позиции кластера на карте.
Получение количества маркеров в кластере.
Получение списка маркеров в кластере.
Получение геометрического объекта кластера.
ClusterOptions
Параметры маркера кластера.
Color
Цвет
CompassControl
Контрол компаса.
CompassControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0,
layout: Int = R.layout.dgis_compass_control
)
Контрол компаса.
CompassControl
CompassControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
CompassControlModel
Модель контрола компаса. Контрол состоит из кнопки компаса, при нажатии на которую камера карты меняет угол в направлении севера. Если камера карты смотрит на сервер, то контрол необходимо скрывать. Потокобезопасно.
fun onClicked(): Unit
ComplexGeometry
Составная геометрия, состоит из набора простых или составных геометрий.
Поддерживается произвольный уровень вложенности составных геометрий в наборе.
ContactInfo
Способ связаться с организацией.
Тип контакта. Один из следующих:
- email — электронная почта
- website — сайт
- phone — телефон
- fax — факс
- pobox — абонентский ящик
- icq
- jabber
- skype
- vkontakte
- odnoklassniki
- youtube
- googleplus
- viber
- telegram
Значение контакта для вывода на экран.
Техническое значение контакта. В зависимости от типа контакта имеет следующую семантику:
- 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
Уточняющая информация о контакте.
Context
Контекст - окружение, необходимое для работы SDK.
DashboardControl
DashboardControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
fun onAttachedToWindow(): Unit
fun toggleExpandedState(): Unit
DashedPolylineOptions
Параметры пунктирной полилинии
DashedPolylineOptions(dashLength: LogicalPixel = LogicalPixel(value = 5.0f), dashSpaceLength: LogicalPixel = LogicalPixel(value = 2.0f))
Параметры пунктирной полилинии
Длина пунктира
Длина межпунктирного расстояния
DayTime
Временной момент внутри дня.
DefaultLocationSource
Реализация источника геопозиции, которую рекомендуется использовать по умолчанию. При наличии GMS использует их, иначе - LocationManager.
DefaultLocationSource(context: Context)
Реализация источника геопозиции, которую рекомендуется использовать по умолчанию. При наличии GMS использует их, иначе - LocationManager.
@Synchronized
fun activate(listener: LocationChangeListener): Unit
@Synchronized
fun deactivate(): Unit
@Synchronized
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit
fun onPermissionGranted(): Unit
Метод необходимо вызвать после получения разрешений на использование геопозиции.
@Synchronized
fun onProvidersChanged(): Unit
Наилучшая известная на текущий момент геопозиция. Если известная на текущий момент геопозиция отсутствует, возвращается null. Возвращаемая геопозиция может быть недостоверной, например являться устаревшей и/или не соответствовать требуемой точности
Использовать ли GMS.
DefaultNavigationControls
UI контролы навигатора, предлагаемые к использованию по умолчанию: полосность, ограничение скорости, обозначение следующего манёвра и т.д. Пользователи SDK также могут создать свои собственные UI контролы и использовать UI модель навигатора для получения оповещений о событиях при ведении по маршруту.
DefaultNavigationControls(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
UI контролы навигатора, предлагаемые к использованию по умолчанию: полосность, ограничение скорости, обозначение следующего манёвра и т.д. Пользователи SDK также могут создать свои собственные UI контролы и использовать UI модель навигатора для получения оповещений о событиях при ведении по маршруту.
fun onConfigurationChanged(newConfig: Configuration): Unit
fun onAttachedToWindow(): Unit
Состояние контрола навигатора по умолчанию. Нужно для установки корректного начального состояния контролов. Данное свойство допускает возможность задания только до момента отображения контрола.
DeviceDensity
Множитель, который вычисляется как отношение DPI к базовому DPI устройства.
В Android соответствует resources.displayMetrics.density В iOS соответствует nativeScale
должен быть положительным.
DeviceDensity(value: Float = 0.0f)
Множитель, который вычисляется как отношение DPI к базовому DPI устройства.
В Android соответствует resources.displayMetrics.density В iOS соответствует nativeScale
должен быть положительным.
DevicePpi
Разрешающая способность дисплея устройства, в пикселях на дюйм.
должна быть положительной.
DevicePpi(value: Float = 0.0f)
Разрешающая способность дисплея устройства, в пикселях на дюйм.
должна быть положительной.
DGis
Точка входа в 2GIS SDK. На старте работы необходимо вызвать initialize
@JvmStatic
@JvmOverloads
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
): Context
Необходимо вызвать этот метод до начала работы с SDK
контекст android приложения
согласие на сбор данных и обработку данных
sdkContext необходимый для работы сервисов SDK
@JvmStatic
fun context(): Context
DgisMapObject
Объект карты 2GIS.
информацию об объекте можно получить через справочник (directory)
Стабильный числовой идентификатор объекта.
DgisObjectId
DgisSource
Основной интерфейс источников данных 2GIS
fun setHighlighted(directoryObjectIds: List<DgisObjectId>, highlighted: Boolean): Unit
Установка или снятие выделения объектов.
добавляет объекту атрибут "selected", который можно использовать в стилях.
идентификаторы изменяемых объектов.
установка или снятие выделения.
@JvmStatic
fun createDgisSource(context: Context, workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.ONLINE): Source
Создание источника, получающего данные с серверов 2ГИС или использующего в работе предварительно загруженные данные.
Получение списка идентификаторов выделенных объектов.
Получение списка идентификаторов выделенных объектов.
DirectMapControlBeginEvent
Событие начала прямого управления картой. Сообщает карте, что необходимо обрабатывать события прямого управления картой. События прямого управления работают только от DirectMapControlBeginEvent до DirectMapControlEndEvent. После завершения последовательности событий прямого управления может запуститься кинематика. Кинематика использует время возникновения события, поэтому лучше использовать время, полученное от системы, а не заполнять значение при обработке. Пока кинематика работает только для перемещения карты, но не для вращения и масштабирования.
DirectMapControlBeginEvent()
DirectMapControlEndEvent
Событие окончания прямого управления картой. Завершает прямое управление картой, начатое после получения события DirectMapControlBeginEvent. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapRotationEvent
Событие прямого вращения карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapRotationEvent(
bearingDelta: Bearing,
timestamp: Duration,
rotationCenter: ScreenPoint? = null
)
изменение угла поворота карты, в градусах. Положительные значения соответствуют направлению вращения против часовой стрелки
время генерации системного события.
точка на экране, вокруг которой вращается карта. Если точка не задана, то вращение происходит относительно точки позиции карты.
Изменение угла поворота карты.
Точка на экране, вокруг которой вращается карта.
DirectMapScalingEvent
Событие прямого масштабирования карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapScalingEvent(
zoomDelta: Float,
timestamp: Duration,
scalingCenter: ScreenPoint? = null
)
величина, на которую изменится текущее значение масштаба.
время генерации системного события.
точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.
Величина, на которую изменится текущее значение масштаба.
Точка на экране, относительно которой масштабируется карта.
DirectMapShiftEvent
Событие прямого сдвига карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapShiftEvent(
screenShift: ScreenShift,
shiftedPoint: ScreenPoint,
timestamp: Duration
)
изменение экранной позиции карты относительно предыдущей, в пикселях.
центральная точка, от которой производится смещение карты.
время генерации системного события.
Изменение экранной позиции карты.
Центральная точка, от которой производится смещение карты.
DirectMapTiltEvent
Событие прямого наклона камеры. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
Изменение угла наклона в градусах.
DirectoryFilter
Фильтры для справочника.
DirectoryFilter(workTime: WorkTimeFilter?, dynamic: List<DynamicFilter>)
Фильтры для справочника.
Фильтр по времени работы.
Динамические фильтры.
DirectoryObject
Объект справочника.
fun formattedAddress(type: FormattingType): FormattedAddress?
Отформатированное в соответствии с указанным требованием к длине строковое представление адреса.
Тип объекта. Может быть несколько, например, ТЦ Сан Сити - филиал организации и здание одновременно. Первый тип в этом списке - основной.
Заголовок объекта.
Дополнительная информация заголовка Пример: "(кв. 1-12)"
Подзаголовок объекта.
при отсутствии может быть пустой строкой
Стабильный числовой идентификатор объекта.
Точка объекта, где следует разместить маркер.
Адрес объекта в виде набора компонент.
Доп. атрибуты объекта.
Контекстные доп. атрибуты объекта.
Сдвиг локального времени объекта относительно UTC в секундах в текущий момент.
Время работы объекта.
Контакты объекта.
Отзывы.
Дополнительная информация о парковке.
Статус работы.
Идентификатор этажа, на котором расположен объект.
Информация об этажных планах здания.
Информация о входах.
Данные о лицензии организации.
DoubleRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<DoubleRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): DoubleRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): DoubleRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
DoubleRouteEntry
Элемент маршрута - точка и значение в ней.
DoubleRouteEntry(point: RoutePoint, value: Double)
Элемент маршрута - точка и значение в ней.
DragBeginData
Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.
DragBeginData(point: ScreenPoint, item: RenderedObject)
Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.
Duration
Класс, представляющий период времени.
operator fun unaryMinus(): Duration
fun toString(): String
DynamicFilter
Динамические фильтры поисковой выдачи.
fun match(flagFilter: Function1, rangeFilter: Function1): T
fun toString(): String
fun hashCode(): Int
DynamicRouteInfo
DynamicRouteInfo(roadEvents: RoadEventRouteAttribute, traffic: Traffic)
DynamicRouteInfoSettings
Настройки получения динамических данных о маршруте.
Периодичность, с которой должны обновляться динамические данные о маршруте.
Elevation
Неотрицательная высота точки над поверхностью в метрах.
Elevation(value: Float = 0.0f)
Неотрицательная высота точки над поверхностью в метрах.
EmptyFollowController
Базовый класс для пользовательских контроллеров. Можно использовать как основу для реализации контроллера на платформе.
EmptyFollowController()
Базовый класс для пользовательских контроллеров. Можно использовать как основу для реализации контроллера на платформе.
fun availableValues(): EnumSet<FollowValue>
Набор видов значений, которыми умеет управлять данный контроллер.
fun requestValues(values: EnumSet<FollowValue>): Unit
С помощью этого метода в контроллер сообщается, какие из предоставляемых им значений используются. Это позволяет освободить ресурсы, связанные с вычислением неиспользуемых значений. Метод может вызываться многократно с разными значениями, в этом случае актуальным является последнее из них.
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit
Установка нотифаера, который оповещает о новых значениях. Нотифаер нужно сохранить в реализуемом контроллере
EntranceGeometry
Геометрии для отображения входа на карте.
EntranceGeometry(entrancePoints: List<GeoPoint>, entrancePolylines: List<List<GeoPoint>>)
Геометрии для отображения входа на карте.
Местоположение входа
Геометрии стрелок, указывающих на вход
EntranceInfo
Информация о входе в здание.
EntranceInfo(
id: DgisObjectId,
buildingNumber: String?,
porchName: String?,
porchNumber: String?,
apartmentRanges: List<ApartmentRange>,
geometry: EntranceGeometry?
)
Информация о входе в здание.
Идентификатор объекта входа.
Номер дома, к которому относится вход.
Непустое имя подъезда. Заполняется только для подъездов. Может принимать значения имени подъезда (например "Подъезд 1") или номера здания, если подъезд имеет собственный адрес.
Непустой номер подъезда. Заполняется только для подъездов. Может принимать значения номера подъезда (например "1") или номера здания, если подъезд имеет собственный адрес.
Номера квартир, относящихся к подъезду.
Геометрии для отображения входа на карте.
Event
Базовый класс для всех обрабатываемых событий
EventsProcessingSettings
EventsProcessingSettings(rotationCenter: RotationCenter, scalingCenter: ScalingCenter)
Точка, относительно которой производится вращение карты.
Точка, относительно которой производится масштабирование карты.
ExceedSpeedLimitSettings
Настройки детектирования превышения максимальной разрешённой скорости.
ExcludedArea
Исключаемая область, которую следует избегать при построении маршрута.
ExcludedArea(
type: ExcludedAreaType = ExcludedAreaType.POINT,
severity: ExcludedAreaSeverity = ExcludedAreaSeverity.SOFT,
extent: RouteDistance,
points: List<GeoPoint>
)
Исключаемая область, которую следует избегать при построении маршрута.
Тип исключаемой области.
Приоритет исключения области.
Размер исключаемой области (не больше 25 км).
Координаты точек исключаемой области (не больше 500).
ExtraInstructionInfo
ExtraInstructionInfo(bicycleStart: BicycleInstructionStart)
ExtraInstructionInfo(bicycleFinish: BicycleInstructionFinish)
ExtraInstructionInfo(bicycleCrossroad: BicycleInstructionCrossroad)
ExtraInstructionInfo(carCrossroad: CarInstructionCrossroad)
ExtraInstructionInfo(carRoundabout: CarInstructionRoundabout)
ExtraInstructionInfo(pedestrianStart: PedestrianInstructionStart)
ExtraInstructionInfo(pedestrianFinish: PedestrianInstructionFinish)
ExtraInstructionInfo(pedestrianCrossroad: PedestrianInstructionCrossroad)
ExtraInstructionInfo(pedestrianIndoorFloorChange: PedestrianInstructionIndoorFloorChange)
ExtraInstructionInfo(pedestrianIndoorEnter: PedestrianInstructionIndoorEnter)
ExtraInstructionInfo(pedestrianIndoorExit: PedestrianInstructionIndoorExit)
ExtraInstructionInfo(scooterStart: ScooterInstructionStart)
ExtraInstructionInfo(scooterFinish: ScooterInstructionFinish)
ExtraInstructionInfo(scooterCrossroad: ScooterInstructionCrossroad)
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
fun toString(): String
fun hashCode(): Int
File
Идентификатор файла.
Может являться не только файлом на файловой системе, но и произвольным источником данных.
@JvmStatic
fun fromString(contents: String): File
Файл с содержимым из заданной строки.
FinishRouteControl
FinishRouteControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
fun onAttachedToWindow(): Unit
fun expand(): Unit
FlagFilter
Фильтр - флаг.
FloatRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): FloatRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<FloatRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
FloatRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
FloatRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Float
)
Протяженный элемент маршрута - отрезок и значение на нем.
FloorInfo
Информация об этажном плане для маркера - элемента поисковой выдачи.
FloorInfo(levelId: LevelId, buildingId: BuildingId)
Информация об этажном плане для маркера - элемента поисковой выдачи.
FollowControl
Контрол включения слежения за маркером местоположения.
FollowControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол включения слежения за маркером местоположения.
FollowController
Класс, позволяющий управлять положением камеры и маркера геопозиции. Реализации всех его методов должны быть потокобезопасны. У большинства методов есть тривиальные реализации по умолчанию (таким образом FollowController, отвечающий за масштаб, не обязан переопределять методы coordinates() и т.п.).
fun requestValues(values: EnumSet<FollowValue>): Unit
С помощью этого метода в FollowController сообщается, какие из предоставляемых им значений используются. Это позволяет освободить ресурсы, связанные с вычислением неиспользуемых значений. Метод может вызываться многократно с разными значениями, в этом случае актуальным является последнее из них.
fun setClock(clock: FollowControllerClock?): Unit
С помощью этого метода в FollowController передаётся источник времени. Значения времени, которые возвращаются из next_timestamp(), должны быть вычислены относительно значений, полученных из clock. Этот метод повторно не вызывается чтобы заменить ранее установленное с помощью него ненулевое значение на отличное от него ненулевое значение.
fun setThresholds(shiftMeters: Double, rotation: Double): Unit
Пороговые значения для смещения позиции и угла поворота. Считается, что смещения на меньшее расстояние и повороты на меньший угол визуально не различимы.
fun updateValues(): Unit
Запрос на вычисление всех предоставляемых значений. Непосредственно после вызова этого метода, все значения (coordinates(), satellite_bearing(), и т.д.) считаются актуальными.
Набор видов значений, которыми умеет управлять данный FollowController. Например, один FollowController может управлять только координатами, а другой только наклоном карты.
Канал, сообщающий подписчикам о времени следующего видимого изменения значений. О времени изменения значений, отсутствующих среди запрошенных с помощью request_values(), может не сообщаться. Значения времени интерпретируются относительно источника, переданного в set_clock().
Канал, сообщающий подписчикам о времени следующего видимого изменения значений. О времени изменения значений, отсутствующих среди запрошенных с помощью request_values(), может не сообщаться. Значения времени интерпретируются относительно источника, переданного в set_clock().
Географические координаты.
Направление движения.
Направление на магнитный север.
Наклон карты.
Стилевой zoom-уровень карты.
Радиус круга точности (метры).
FollowControllerClock
Часы, используемые для измерения времени в FollowController.
FollowPosition
Настройки слежения за направлением, наклоном и уровнем зума.
FollowPosition(
bearing: FollowBearing = FollowBearing.OFF,
tilt: FollowTilt = FollowTilt.OFF,
styleZoom: FollowStyleZoom = FollowStyleZoom.OFF
)
Настройки слежения за направлением, наклоном и уровнем зума.
FormattedAddress
Человекочитаемое представление адреса.
Адрес из дриллдауна. Пример: "Новосибирск, Кировский район".
Адрес внутри населённого пункта. Пример: "Николаева, 11".
Комментарий к адресу. Пример: "301 офис; 9 этаж".
Почтовый индекс объекта с кодом здания, если есть. Пример: "630088", "630007/XBVJF8".
Fps
Frames per second, частота кадров.
FreeRoamSettings
Тайлы дорожного графа загружаются в http-кэш во время ведения по маршруту, если они соответствуют участку маршрута от текущей позиции до указанного расстояния. Значение по умолчанию - 5 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
При кэшировании тайлов дорожного графа во время ведения по маршруту тайлы загружаются в http-кэш, если оказываются ближе заданного расстояния в метрах от линии маршрута. Значение по умолчанию - 1 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
Тайлы дорожного графа загружаются в http-кэш если оказываются ближе заданного расстояния в метрах от текущей позиции. Значение по умолчанию - 2 км.
Загрузка тайлов в http-кэш не выполняется, если параметр соответствует нулевому или отрицательному расстоянию.
Geometry
Объект геометрии
fun intersects(geometry: Geometry): Boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
Прямоугольник минимального размера, содержащий геометрию.
Минимальнная точка ограничивающего прямоугольника.
Максимальная точка ограничивающего прямоугольника.
GeometryMapObject
Геометрический объект карты.
методы потокобезопасны
объект будет отображаться на карте при выполнении следующих условий:
- объект видимый;
- объект добавлен в источник данных;
- источник данных, содержащий объект, добавлен в карту;
- в стилях, установленных в карту, есть параметры отображения, применимые к этому объекту. Подробнее про отображение на карте - см. ISource.
Геометрия объекта.
Геометрия объекта.
Получение свойств объекта карты для чтения и изменения.
Текущий флаг видимости объекта.
Текущий флаг видимости объекта.
Текущий флаг перемещаемости объекта.
Текущий флаг перемещаемости объекта.
Прямоугольник минимального размера, содержащий геометрию.
GeometryMapObjectBuilder
Класс для установки свойств и последующего создания геометрических объектов.
GeometryMapObjectBuilder()
fun setObjectAttribute(name: String, value: AttributeValue): GeometryMapObjectBuilder
Установка свойства объекта карты.
имя свойства объекта карты
значение свойства объекта карты
fun setObjectAttributes(values: Map): GeometryMapObjectBuilder
Установка свойств объекта карты.
набор пар "имя":"значение" для добавляемых свойства объекта карты
метод не заменяет весь набор свойств объекта, т.е. если свойство в values отсутствует, но уже добавлено в объект ранее, оно не будет изменено.
fun setGeometry(geometry: Geometry): GeometryMapObjectBuilder
Установка геометрии объекта карты.
fun setVisible(visible: Boolean): GeometryMapObjectBuilder
Установка видимости объекта карты.
fun setDraggable(draggable: Boolean): GeometryMapObjectBuilder
Установка возможности перетаскивания объекта карты.
fun setUserData(userData: Any?): GeometryMapObjectBuilder
Установка пользовательских данных.
пользовательские данные никак не используются в SDK и нужны только чтобы возвращать их пользователю.
fun createObject(): GeometryMapObject
Конструирование объекта карты.
у объекта обязательно должна быть установлена геометрия
после вызова этой функции GeometryMapObjectBuilder непригоден для задания параметров объекта карты или для его создания
fun setObjectAttribute(name: String, value: Boolean): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Long): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Int): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Double): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Float): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: String): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: ByteArray): GeometryMapObjectBuilder
fun setObjectAttribute(name: String, value: Color): GeometryMapObjectBuilder
GeometryMapObjectSource
Источник геометрических объектов карты.
fun clusteringObjects(position: CameraPosition): List<MapObject>
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и геометрические объекты.
fun addObject(item: GeometryMapObject): Unit
Добавление объекта в источник.
Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.
Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.
Для источника с кластеризацией добавление пока не реализовано, будет выброшено исключение.
fun addObjects(objects: List<GeometryMapObject>): Unit
Добавление нескольких объектов в источник.
Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.
Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.
Для источника с кластеризацией добавление пока не реализовано, будет выброшено исключение.
fun removeObject(item: GeometryMapObject): Unit
Удаление объекта из источника.
Удаление асинхронное, потокобезопасное, метод можно использовать из любого потока.
fun removeObjects(objects: List<GeometryMapObject>): Unit
Удаление объектов из источника.
fun removeAndAddObjects(objectsToRemove: List<GeometryMapObject>, objectsToAdd: List<GeometryMapObject>): Unit
Удаление и добавление объектов у источника.
Получить все объекты, добавленные в источник.
Получение значений свойств по умолчанию для всех объектов, добавленных в источник (см. IAttributes).
GeometryMapObjectSourceBuilder
fun setSourceAttribute(name: String, value: AttributeValue): GeometryMapObjectSourceBuilder
Установка свойства объектов карты, общего для всего источника (см. ISource).
fun setSourceAttributes(values: Map): GeometryMapObjectSourceBuilder
Установка свойств объектов карты, общих для всего источника.
fun addObject(item: GeometryMapObject): GeometryMapObjectSourceBuilder
добавление геометрического объекта карты в источник
fun addObjects(objects: List<GeometryMapObject>): GeometryMapObjectSourceBuilder
добавление нескольких геометрических объектов карты в источник
fun createSource(): GeometryMapObjectSource
Создание источника геометрических объектов.
после вызова этой функции использовать GeometryMapObjectSourceBuilder для создания источника данных или для задания параметров источника данных нельзя
GeoPoint
Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).
GeoPoint(latitude: Latitude, longitude: Longitude)
Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).
fun move(bearing: Bearing, meter: Meter): GeoPoint
Вычисляет точку, полученную перемещением исходной точки в указанном направлении на указанное расстояние.
fun withElevation(elevation: Elevation = Elevation(0.0f)): GeoPointWithElevation
fun bearing(point: GeoPoint): Bearing
Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) между двумя точками.
GeoPointRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<GeoPointRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): GeoPointRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): GeoPointRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
fun calculateGeoPoint(routePoint: RoutePoint): SegmentGeoPoint?
Вычисляет GeoPoint по известной RoutePoint.
Вычисленные географические координаты и направление сегмента, на который указывает параметр route_point. Если маршрут пустой или route_point выходит за пределы маршрута, то возвращается null.
Сложность операции O(log2(N)), где N = route_geometry.size()
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
Длина маршрута.
GeoPointRouteEntry
Элемент маршрута - точка и значение в ней.
GeoPointRouteEntry(point: RoutePoint, value: GeoPoint)
Элемент маршрута - точка и значение в ней.
GeoPointWithElevation
Точка в географической системе координат (широта, долгота, возвышение).
возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.
GeoPointWithElevation(
latitude: Latitude,
longitude: Longitude,
elevation: Elevation = Elevation(value = 0.0f)
)
Точка в географической системе координат (широта, долгота, возвышение).
возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.
fun bearing(point: GeoPoint): Bearing
Вычисляет направление (путевой угол, т.е. угол между направлением на географический север и направлением движения, отсчитываемый по часовой стрелке) для проекции точки на карту и заданной точкой.
fun distance(point: GeoPoint): Meter
Вычисляет минимальное (по ортодромии) расстояние между проекцией точки на карту и заданной точкой.
fun move(bearing: Bearing, meter: Meter): GeoPointWithElevation
Вычисляет точку, полученную перемещением проекции исходной точки в указанном направлении на указанное расстояние.
GeoRect
Прямоугольная область в сферической системе координат (например, WGS84). Данная структура не привязана к конкретной геодезической системе координат.
fun contains(rect2: GeoRect): Boolean
Содержится ли rect2 внутри rect1, т.е. все его точки находятся внутри.
fun contains(point: GeoPoint): Boolean
Содержит ли прямоугольник точку. Точки, расположенные на границе, так же считаются принадлежащими прямоугольнику.
fun intersects(rect2: GeoRect): Boolean
Пересекаются ли прямоугольники, т.е. имеют общие точки. Прямогольники, с общими точками лишь на границе, так же считаются пересекающимися.
fun expand(rect2: GeoRect): GeoRect
Расширить прямоугольник. Вернуть прямоугольник минимального размера, содержащий оба переданных прямоугольника.
Проверяет прямоугольник на корректность.
Проверяет прямоугольник на вырожденность. Если точки в прямоугольнике равны, то он вырождается в точку. Вырожденный прямоугольник является корректным прямоугольником. Некорректный прямоугольник не является вырожденным.
Юго-западная точка, левая нижняя граница прямоугольника.
Северо-восточная точка, правая верхняя граница прямоугольника.
GestureManager
Класс для управления обработкой жестов.
fun setSettingsAboutMapPositionPoint(settings: EventsProcessingSettings): Unit
Настраиваем точку, относительно которой происходит масштабирование и поворот.
настройки обработки событий.
при вызове функции происходит пересоздание инструментов распознавания жестов.
fun setMutuallyExclusiveGestures(rules: List<EnumSet<Gesture>>): Unit
Установка списка правил исключения одновременного срабатывания нескольких жестов.
К переданному списку правил добавляются правила по умолчанию, которые не позволяют жесту управления наклоном срабатывать одновременно с другими жестами. Каждое правило представляет собой перечень жестов, которые не могут срабатывать одновременно Например, если в правиле указать жесты Scaling и Rotation то эти жесты не будут работать одновременно В случае одновременного выполнения жестов из правила, сработает жест с большим приоритетом Порядок приоритета жестов (по убыванию): (Shift ->) Tilt -> Scaling -> Rotation -> MultiTouchShift
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
)
Параметры градиентной полилинии
Ширина границы линии
Ширина второй границы линии
Длина градиентной линии
Цвет окантовки
Цвет второй окантовки
Палитра цветов градиентной полилинии
Индексы цветов градиентной полилинии. Количество индексов должно быть на 1 меньше количества точек полилинии.
HttpCacheManager
HttpOptions
Опции Http-клиента
HttpOptions(
certificates: List?<Certificate> = null,
timeout: Duration = Duration.ofMilliseconds(15000),
useCache: Boolean = true,
cacheStoragePath: String? = null,
cacheMaxSize: Long? = null,
proxy: HttpProxyOptions? = null
)
Опции Http-клиента
Сертификаты в PEM-формате. Если не заданы, используются системные + поставляемые вместе с SDK.
Таймаут для HTTP-запросов
Использовать HTTP кэш.
Путь к каталогу верхнего уровня для основного файлового хранилища HTTP кэша. Файловое хранилище будет находиться в подкаталоге http_cache в данном каталоге. Если путь не указан, будет использоваться каталог, возвращаемый context.getCacheDir().
Максимальный размер HTTP кэша в байтах. Если не указан, по умолчанию максимальный размер HTTP кэша составляет 300 Мб.
Настройки proxy
HttpProxyOptions
Настройки proxy.
Image
Изображение.
ImageData
Данные изображения: размер, формат и бинарные данные.
ImageData(
size: ScreenSize,
format: ImageFormat,
data: ByteArray
)
Данные изображения: размер, формат и бинарные данные.
fun toBitmap(): Bitmap
IncompleteTextHandler
Предложено автодополнение для введенного пользователем текста.
Нужно подставить в строку поиска этот текст и дать пользователю продолжить вводить запрос.
IndoorBuilding
Здание с этажными планами.
Идентификатор здания с этажными планами.
Индекс этажа по умолчанию.
Информация обо всех этажах.
Индекс активного этажа.
Индекс активного этажа.
IndoorControl
Контрол этажей.
Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.
IndoorControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол этажей.
Представляет из себя колонку с названиями этажей, из которых активное подсвечено. При нажатии на название переключается этажный план. Одновременно отображается не более 5-ти название, непоместившиеся скролятся.
Этажи, на которых отображаются пометки.
IndoorControlModel
Модель контрола этажей.
Индекс активного этажа.
Индекс активного этажа.
Этажи, на которых отображаются пометки.
Названия этажей. Пусто, если на карте не отображается здание с этажными планами, или у здания всего один этаж.
Названия этажей. Пусто, если на карте не отображается здание с этажными планами, или у здания всего один этаж.
IndoorDetector
Канал, который оповещает о нахождении пользователя в помещении.
Канал, который оповещает о нахождении пользователя в помещении.
IndoorManager
Класс для получения текущего здания с этажными планами.
Получение текущего здания с этажными планами.
Получение текущего здания с этажными планами.
IndoorRouteLevelsGetter
Позволяет получать множество этажей, через которые проходят маршруты, отображаемые на карте.
InputEvent
Событие пользовательского ввода.
Получение времени регистрации события ввода.
InstructionRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<InstructionRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): InstructionRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): InstructionRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
InstructionRouteEntry
Элемент маршрута - точка и значение в ней.
InstructionRouteEntry(point: RoutePoint, value: RouteInstruction)
Элемент маршрута - точка и значение в ней.
IntRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<IntRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): IntRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): IntRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
IntRouteEntry
Элемент маршрута - точка и значение в ней.
IntRouteEntry(point: RoutePoint, value: Int)
Элемент маршрута - точка и значение в ней.
IsOpenNow
Открыто сейчас.
IsOpenNow()
Открыто сейчас.
ItemMarkerInfo
KeyFromAsset
Ключ из asset-а.
Путь относительно корневой директории asset-ов.
KeyFromFile
Ключ из файла.
Путь к файлу.
KeyFromString
Ключ из строки.
Содержимое.
KeySource
Источник ключа.
fun match(
fromAsset: Function1,
fromFile: Function1,
fromString: Function1
): T
fun toString(): String
fun hashCode(): Int
LanesCalloutMapPosition
Положение бабла полосности для маршрута.
LanesCalloutMapPosition(
mapId: MapId,
routePoint: RoutePoint,
geoPoint: GeoPoint
)
Положение бабла полосности для маршрута.
Идентификатор карты, для которой приведена позиция.
Позиция бабла полосности на маршруте.
Позиция бабла полосности на карте.
LaneSignRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): LaneSignRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<LaneSignRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
LaneSignRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
LaneSignRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RouteLaneSign
)
Протяженный элемент маршрута - отрезок и значение на нем.
Latitude
Географическая широта.
LevelId
Идентификатор этажного плана.
LevelInfo
Информация об этаже здания.
LocaleManager
Location
Геопозиция.
Location(
coordinates: LocationCoordinates,
altitude: LocationFuzzyDouble?,
course: LocationCourse?,
groundSpeed: LocationFuzzyDouble?,
source: String,
timestamp: Duration
)
Геопозиция.
coordinates::value - координаты геопозиции. coordinates::accuracy - горизонтальная точность определения координат геопозиции (DRMS), м. https://en.wikipedia.org/wiki/Circular_error_probable Область значений: >= 0.
altitude::value - высота над референсным эллипсоидом WGS84, м. altitude::accuracy - стандартное отклонение ошибки измерения высоты, м. null означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (null, > 0).
course::value - путевой угол (направление движения вдоль поверхности Земли). Угол измеряется относительно географического севера). course::accuracy - стандартное отклонение ошибки измерения путевого угла. null означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Standard_deviation Область значений: (null, > 0).
ground_speed - скорость движения вдоль поверхности Земли, м/с. Область значений: >= 0. ground_speed::accuracy - среднеквадратичное отклонение ошибки измерения скорости, м/с. null означает, что платформа не предоставляет данное поле. https://en.wikipedia.org/wiki/Rayleigh_distribution Область значений: (null, > 0).
Название источника геопозиции.
timestamp'ы между разными источниками геопозиции не синхронизированы, поэтому сравнивать timestamp'ы у геопозиций, которые получены из разных источников нельзя.
Временная точка, в которой была определена геопозиция. Эта точка не привязана ни к какой конкретной дате и используется исключительно для того, чтобы вычислить время между двумя измерениями геопозиции, полученными от одного источника геопозиции в одной сессии. Это поле должно монотонно возрастать (даже когда система находится в спящем режиме).
LocationCoordinates
LocationCourse
LocationFuzzyDouble
LogicalPixel
Пиксель, размер которого не зависит от плотности экрана.
1 логический пиксель соответствует 1 / (базовый ppi) дюйма. Базовый PPI зависит от устройства и вычисляется из отношения DevicePpi/DeviceDensity. DevicePpi и DeviceDensity, в свою очередь, задаются с ОС через интерфейс карты. Для Android LogicalPixel соответствует dp, для iOS - point'у.
LogicalPixel(value: Float = 0.0f)
Пиксель, размер которого не зависит от плотности экрана.
1 логический пиксель соответствует 1 / (базовый ppi) дюйма. Базовый PPI зависит от устройства и вычисляется из отношения DevicePpi/DeviceDensity. DevicePpi и DeviceDensity, в свою очередь, задаются с ОС через интерфейс карты. Для Android LogicalPixel соответствует dp, для iOS - point'у.
LogMessage
Сообщение, записываемое в лог.
LogOptions
Настройки логирования.
Longitude
Географическая долгота.
MagneticChangeListener
Класс, отслеживающий изменения направления компаса и его доступность.
ManeuverControl
ManeuverControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Map
Карта.
fun addSource(source: Source): Unit
Добавление источника данных на карту.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
fun removeSource(source: Source): Unit
Удаление источника данных из карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
fun getRenderedObjects(centerPoint: ScreenPoint, radius: ScreenDistance = ScreenDistance(value = 1.0f)): Future<List<RenderedObjectInfo>>
Получение отображаемых объектов карты, проецирующихся на окружность на экране.
центр окружности.
радиус окружности.
Список объектов формируется в порядке отрисовки от поздних к ранним.
fun setAttribute(name: String, value: AttributeValue): Unit
Идентификатор экземпляра карты, уникальный в рамках процесса.
Получение камеры.
Получение менеджера этажных планов.
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
Получение текущих стилей карты.
Получение текущих стилей карты.
Множитель размера иконок и шрифтов, полученный из приложения.
Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.
Множитель размера иконок и шрифтов, полученный из приложения.
Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.
Получение источников данных карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
Получение атрибутов.
должны быть указаны свойства: "theme"="day|night" "navigatorOn"="true|false"
TODO: стилевые свойства для пробок
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
MapControl
Базовый класс для UI контролов карты.
MapControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для UI контролов карты.
MapControls
Контролы управления картой во время навигации.
MapControls(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контролы управления картой во время навигации.
fun onLayout(
changed: Boolean,
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
MapDirection
Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.
MapDirection(value: Double = 0.0)
Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.
MapId
Идентификатор экземпляра карты, уникальный в рамках процесса.
MapId(value: Int = 0)
Идентификатор экземпляра карты, уникальный в рамках процесса.
MapManager
Интерфейс, позволяющий добавлять карты в навигатор и убирать их из него
MapObject
Объект на карте.
Произвольные пользовательские данные, прикрепленные к объекту.
MapObjectManager
MapObjectManager(map: Map, layerId: String? = null)
Создать IMapObjectManager.
fun addObjects(objects: List<SimpleMapObject>): Unit
Добавить объекты
fun removeObjects(objects: List<SimpleMapObject>): Unit
Удалить объекты
fun removeAndAddObjects(objectsToRemove: List<SimpleMapObject>, objectsToAdd: List<SimpleMapObject>): Unit
Удалить и добавить объекты
fun removeAll(): Unit
fun clusteringObjects(position: CameraPosition): 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 объекты.
минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает кластеризация.
уровень, начиная с которого видны все маркеры.
интерфейс для задания параметров отображения кластера.
уровень, начиная с которого формируются кластеры.
ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
@JvmStatic
fun withGeneralization(
map: Map,
logicalPixel: LogicalPixel,
maxZoom: Zoom,
minZoom: Zoom = Zoom(value = 0.0f),
layerId: String? = null
): MapObjectManager
Создать IMapObjectManager с генерализацией данных. Генерализуются только IMarker объекты.
минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает генерализация.
уровень, начиная с которого видны все маркеры.
уровень, начиная с которого работает генерализация.
ID слоя в стиле типа "Динамический объект". Создаваемые объекты будут размещены на этом слое, тем самым можно задать их порядок относительно других слоев. Если не задан, объекты размещаются поверх остальных слоев.
Переопределение видимости всех объектов, добавленных в экземпляр менеджера. Значение false здесь имеет приоритет над видимостью отдельного объекта.
MapOptions
Параметры карты.
MapOptions()
Параметры карты.
@JvmStatic
fun fromAttributes(context: Context, attrs: AttributeSet): MapOptions
MapPaddingControl
Контрол, задающий padding карты.
MapPaddingControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол, задающий padding карты.
MapRotationBeginEvent
MapRotationEndEvent
MapScalingBeginEvent
MapScalingEndEvent
MapShiftBeginEvent
MapShiftEndEvent
MapView
Контейнер, содержащий карту и дополнительные контролы.
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
fun setTouchEventsObserver(observer: TouchEventsObserver?): Unit
fun addObjectTappedCallback(callback: MapObjectTappedCallback): Unit
fun removeObjectTappedCallback(callback: MapObjectTappedCallback): Unit
fun addObjectLongTouchCallback(callback: MapObjectTappedCallback): Unit
fun removeLongTouchCallback(callback: MapObjectTappedCallback): Unit
fun setCopyrightMargins(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
fun onConfigurationChanged(newConfig: Configuration): Unit
fun onSaveInstanceState(): Parcelable?
fun onVisibilityChanged(changedView: View, visibility: Int): Unit
fun takeSnapshot(copyrightPosition: Alignment = Alignment.BOTTOM_RIGHT): Future<ImageData>
fun useDefaultGestureRecognitionEngine(): Unit
Использовать встроенный распознаватель жестов.
fun useCustomGestureRecognitionEngine(customGestureRecognitionEngine: MapGestureRecognitionEngine): Unit
Использовать пользовательский распознаватель жестов.
Максимально допустимая частота обновления карты. Если не задана, равна частоте обновления экрана.
Максимально допустимая частота обновления карты в режиме сохранения энергии. Если не задана, равна maxFps.
Частота обновления карты. Для получения корректного значения необходимо держать подписку на канал. Перед вызовом метода карта должна быть проинициализирована (завершен getMapAsync).
Returns the View used for rendering OpenGL.
MarkedByRouteIndoorControl
Контрол этажей, на котором отмечены этажи, через которые на карте проходят маршруты.
MarkedByRouteIndoorControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол этажей, на котором отмечены этажи, через которые на карте проходят маршруты.
MarkedUpText
Размеченный текст.
MarkedUpText(text: String, matchedParts: List<MarkedUpTextSpan>)
Размеченный текст.
Текст.
Набор непересекающихся Span в порядке их расположения в строке text, описывающих части, совпадающие с пользовательским запросом.
MarkedUpTextSpan
Описывает поднабор байтов строки text.
Marker
Точечная отметка на карте, представляющая интерес для пользователя.
Получение местоположения маркера.
Получение иконки маркера.
Получение точки привязки иконки маркера.
Получение прозрачности иконки маркера.
Получение подписи маркера.
Получение стиля подписи маркера.
Получение флага перемещаемости маркера.
Получение целевой ширины маркера, используемой для масштабирования.
Угол поворота маркера на карте относительно направления на север, по часовой стрелке.
Анимировать ли появление.
MarkerOptions
Параметры маркера.
MarkerOptions(
position: GeoPointWithElevation,
icon: Image?,
iconMapDirection: MapDirection? = null,
anchor: Anchor = Anchor(x = 0.5f, y = 0.5f),
text: String? = null,
textStyle: TextStyle? = null,
iconOpacity: Opacity = Opacity(value = 1.0f),
visible: Boolean = true,
draggable: Boolean = false,
iconWidth: LogicalPixel = LogicalPixel(value = 0.0f),
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
animatedAppearance: Boolean = true,
levelId: LevelId? = null
)
Параметры маркера.
целевая ширина, используемая для масштабирования
Уровень отрисовки объекта.
Анимировать ли появление
Привязка к поэтажному плану здания.
MessageControl
MessageControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Meter
Длина/расстояние в метрах
MillisecondsRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<MillisecondsRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): MillisecondsRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): MillisecondsRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
fun calculateDuration(routePoint: RoutePoint): Duration
Вычисляет ожидаемое время движения до конца маршрута.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
MillisecondsRouteEntry
Элемент маршрута - точка и значение в ней.
MillisecondsRouteEntry(point: RoutePoint, value: Duration)
Элемент маршрута - точка и значение в ней.
Model
Модель навигатора, предназначенная для отображения в UI.
fun betterRouteResponse(response: BetterRouteResponse): Unit
Ответ пользователя о применении предложенного маршрута лучше
Состояние навигатора.
Состояние навигатора.
Текущая геопозиция, с которой работает навигатор.
see location_available_channel
Текущая геопозиция, с которой работает навигатор.
see location_available_channel
Флаг, который указывает используется ли текущая геопозия для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.
Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.
see location_channel
Флаг, который указывает используется ли текущая геопозия для навигации. После получения геопозиции навигатор решает пригодна ли она для того, чтобы использовать её для навигации (например, если у геопозиции слишком большая погрешность, навигатор может решить, что она не пригодна для навигации) Если геопозиция пригодна для навигации, навигатор выставляет в этом канале значение true, если не пригодна - false.
Даже если значение в данном канале равно false, в канале location_channel геопозиция может обновляться.
see location_channel
Маршрут с манёврами.
В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.
Маршрут с манёврами.
В режиме свободной езды (StateChannel::FreeRoam) отсутствует маршрут по которому движется пользователь. Поэтому участок дороги, по которой в данный момент движется пользователь, навигатор представляет в виде маршрута и отдает его как текущий маршрут. Такое описание дороги не является полноценным маршрутом, т.к. у него нет финиша и манёвров.
Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.
Дорожные события и пробочные данные на маршруте или на прогнозируемой части маршрута для режима FreeRoam.
Текущая позиция пользователя на маршруте.
Текущая позиция пользователя на маршруте.
Флаг превышения максимальной разрешенной скорости.
Флаг превышения максимальной разрешенной скорости.
Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно null, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.
Сигнал о нахождении альтернативного маршрута с меньшей ожидаемой длительностью движения. Если значение в канале равно null, это значит, что альтернативный маршрут не найден, либо перестал быть актуальным.
MultiTouchShiftSettings
Настройки обработки сдвига при касании несколькими пальцами.
MultiTouchShiftSettings(thresholdMm: Float)
Настройки обработки сдвига при касании несколькими пальцами.
Порог сдвига взвешенного среднего точек постановки пальцев, в миллиметрах, по достижению которого начинают генерироваться события смещения несколькими пальцами
MyLocationControl
Контрол перелёта к текущему местоположению пользователя.
MyLocationControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол перелёта к текущему местоположению пользователя.
MyLocationController
Класс, контролирующий отображение маркера текущего положения.
MyLocationControlModel
Модель контрола перелета к местоположению пользователя. Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя. Если местоположение не определено, ничего не происходит. Методы объекта необходимо вызывать на одном потоке.
MyLocationControlModel(map: Map, transitionType: TransitionType = TransitionType.SMOOTH)
fun onClicked(): Unit
MyLocationMapObject
Маркер геопозиции.
MyLocationMapObjectSource
Источник, содержащий маркер геопозиции.
MyLocationMapObjectSource(context: Context, directionBehaviour: MyLocationDirectionBehaviour)
Создать источник маркера геопозиции, использующий данные карты с плавным изменением.
MyLocationMapObjectSource(
context: Context,
directionBehaviour: MyLocationDirectionBehaviour,
controller: MyLocationController
)
Создать источник маркера геопозиции.
fun setDirectionBehaviour(directionBehaviour: MyLocationDirectionBehaviour): Unit
Выбрать поведение направления маркера.
Получить маркер геопозиции.
NativeException
Исключение, преобразованное из исключения, брошенного в нативном коде.
NativeObject
Базовый класс для объектов, представляющих собой обёртки над объектами в нативном коде.
NativeProxy
Технический класс, инкапсулирующий в себе слабый указатель на объект в нативном коде.
fun finalize(): Unit
NavigationControl
Контейнер с контролами уровня зума и перелёта к текущему местоположению пользователя.
NavigationControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контейнер с контролами уровня зума и перелёта к текущему местоположению пользователя.
NavigationControl
Базовый класс для UI контролов навигатора.
NavigationControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для UI контролов навигатора.
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
fun detachFromManager(): Unit
NavigationFollowController
Интерфейс для управления слежением карты за маркером геопозиции в навигаторе.
Таймаут, через который карта автоматически вернется в режим слежения за маркером геопозиции после того, как пользователь подвигал её. 0 - автоматический возврат в режим слежения за маркером геопозиции отключен.
NavigationManager
Корневой публичный интерфейс навигатора.
NavigationManager(platformContext: Context)
Точка входа в API навигатора, используемая в SDK по умолчанию.
fun start(): Unit
Запускает ведение в режиме без маршрута (free roam). В этом режиме маршрут отсутствует, а навигатор сообщает об объектах, находящихся на дороге рядом с пользователем.
fun start(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute? = null): Unit
Запускает ведение по маршруту.
Параметры, с которыми навигатор будет перестраивать маршрут.
Маршрут, по которому запускается ведение. Если значение не задано, то навигатор построит маршрут от текущей геопозиции.
fun startSimulation(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute): Unit
Запускает симуляцию ведения по маршруту.
Параметры, с которыми навигатор будет перестраивать маршрут.
Маршрут, по которому запускается симуляция.
Модель навигатора, предназначенная для отображения в UI.
Навигация внутри помещений.
Управление автоматическим возвратом карты к слежению за маркером геопозиции.
Менеджер карт навигатора.
Настройки масштабирования карты во время режима ведения.
Настройки отображения маршрута на карте.
Настройки источника, используемого для отображения маршрута на карте.
Настройки симуляции ведения по маршруту.
Управление голосовыми пакетами в текущей сессии навигатора.
Настройки детектирования превышения скорости.
Настройки получения и обновления динамических данных о маршруте.
Настройки звуковых оповещений в текущей сессии навигатора.
Настройки ведения без маршрута в режиме free roam.
Настройки поиска альтернативных маршрутов в режиме ведения.
NavigationView
UI элемент, отображающий состояние навигации на карте.
Добавление его в MapView приводит к отображению на ней маршрута, маркера геопозиции, транспортных событий, слежению за камерой. Внутри NavigationView можно размещать навигационные контролы - наследники NavigationControl, в частности готовый к использованию набор контролов DefaultNavigationControls.
NavigationView(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
UI элемент, отображающий состояние навигации на карте.
Добавление его в MapView приводит к отображению на ней маршрута, маркера геопозиции, транспортных событий, слежению за камерой. Внутри NavigationView можно размещать навигационные контролы - наследники NavigationControl, в частности готовый к использованию набор контролов DefaultNavigationControls.
NavigationVoice
Голос для использования в навигаторе.
NewValuesNotifier
Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.
fun sendNotification(): Unit
Необходимо вызывать для того, чтобы сообщить об обновлении параметров.
ObstacleInfo
Информация о препятствии на маршруте.
ObstacleInfo(type: Obstacle = Obstacle.OTHER, limitation: ObstaclePassLimitation = ObstaclePassLimitation.UNLIMITED)
Информация о препятствии на маршруте.
ObstacleInfoRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): ObstacleInfoRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): ObstacleInfoRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
ObstacleInfoRouteEntry
Элемент маршрута - точка и значение в ней.
ObstacleInfoRouteEntry(point: RoutePoint, value: ObstacleInfo)
Элемент маршрута - точка и значение в ней.
ObstacleInfoRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): ObstacleInfoRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<ObstacleInfoRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
ObstacleInfoRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
ObstacleInfoRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: ObstacleInfo
)
Протяженный элемент маршрута - отрезок и значение на нем.
Opacity
Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность)
Opacity(value: Float = 0.0f)
Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность)
OpeningHours
Часы работы организации.
OpeningHours(weekOpeningHours: List<List<WeekTimeInterval>>, isOpen24x7: Boolean)
Часы работы организации.
Часы работы для каждого дня недели, начиная с понедельника.
Package
Пакет. Для удобства работы с данными (установки, обновления, удаления), данные в 2ГИС SDK группируются в наборы по функционально-логическому назначению. Набор сгруппированных данных называется пакетом. В пределах одного пакета функциональное назначение данных уникально. Однако, множества данных пакетов с единым функциональным назначением могут пересекаться, то есть, возможна ситуация, когда данные нескольких пакетов имеют общие файлы. При операциях с группой таких пакетов общие данные будут обрабатываться (скачиваться, распаковываться, удаляться) только один раз.
Стабильный технический идентификатор пакета.
Информация о пакете.
Информация о пакете.
Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне 0,100.
Прогресс операции установки или обновления пакета в процентах. Если пакет не установлен локально, канал содержит значение 0. Если пакет установлен локально, независимо от актуальности данных и их совместимости с текущей версией SDK, канал содержит значение 100. Если пакет находится на этапе установки или обновления, канал содержит обновляемое значение в диапазоне 0,100.
PackageInfo
Информация о пакете. См. IPackage.
PackageInfo(
name: String,
installed: Boolean = false,
incomplete: Boolean = false,
preinstalled: Boolean = false,
compatible: Boolean = true,
hasUpdate: Boolean = false,
updateStatus: PackageUpdateStatus
)
Информация о пакете. См. IPackage.
Локализованное название пакета.
Признак установки - true в случае, если пакет был выбран для установки.
Признак незавершенности установки - true, если нет полностью загруженной версии пакета (возможно, несовместимой с текущей версией SDK).
Признак предустановленных пакетов. Предустановленные пакеты всегда установлены и полностью загружены, и их нельзя удалить.
Признак совместимости - true в случае, если загруженный пакет совместим с текущей версией SDK.
Признак наличия обновления - true в случае наличия обновления для загруженного пакета. Возможна ситуация, когда во время процесса обновления до новой версии на сервере стала доступна ещё более новая версия пакета. В этом случае значение будет true как во время обновления, так и по его окончании.
Статус обновления пакета.
PackageManager
Интерфейс для централизованной работы с пакетами:
- Управления автообновлением и получением его статуса;
- Принудительной проверкой обновлений;
- Запуском и остановкой установки/обновления всех доступных пакетов.
- Подпиской на изменения информации о пакетах;
- Подпиской на изменения информации о всеобщем прогрессе установки пакетов.
Статус (включено/выключено) автообновления.
Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.
Канал со списком всех известных пакетов. Обновляется в случае изменения информации о хотя бы об одном из пакетов, либо при изменении состава списка.
PackedMapState
Сериализованное состояние карты.
fun toBytes(): ByteArray
Представление состояния карты в виде последовательности байт.
@JvmStatic
fun of(position: CameraPosition, showTraffic: Boolean): PackedMapState
Получение состояния карты.
позиция камеры.
состояние отображения пробок на карте.
сериализованное состояние карты.
@JvmStatic
fun fromBytes(data: ByteArray): PackedMapState
Получение состояния карты.
состояние карты в виде последовательности байт.
сериализованное состояние карты.
@JvmStatic
fun fromMap(map: Map): PackedMapState
Получение состояния карты.
карта, состояние которой необходимо получить.
сериализованное состояние карты.
Получение состояния отображения пробок на карте.
Получение позиции камеры.
PackedNavigationState
Вспомогательный объект для сериализации и десериализации состояния навигации.
@JvmStatic
fun of(
trafficRoute: TrafficRoute,
routeSearchOptions: RouteSearchOptions? = null,
finishPoint: RouteSearchPoint? = null,
routePosition: RoutePoint? = null,
state: State = State.DISABLED
): PackedNavigationState
Создание объекта из перечисленных элементов.
@JvmStatic
fun fromBytes(data: ByteArray): PackedNavigationState
Десериализация состояния навигации. Недопустимые элементы в сохранённом состоянии пропускаются либо заменяются значениями по умолчанию.
@JvmStatic
fun fromModel(model: Model): PackedNavigationState
Создание объекта из модели навигатора.
Маршрут.
Конечная точка маршрута.
Опции построения маршрута.
Позиция на маршруте.
Текущее состояние навигации.
PackedSearchQuery
Вспомогательный объект для сериализации и десериализации поискового запроса.
fun toBytes(): ByteArray
fun toSearchQuery(): SearchQuery
@JvmStatic
fun fromBytes(data: ByteArray): PackedSearchQuery
Десериализация запроса поиска.
@JvmStatic
fun fromSearchQuery(searchQuery: SearchQuery): PackedSearchQuery
Текст запроса. Для некоторых запросов (например, раскрытие рубрики из suggest'а) текст отсутствует, т.к. в запросе хранятся идентификаторы, и поведение отличается от поиска по тексту элемента suggest'а.
Геометрия, ограничивающая область поиска.
Прямоугольная область интереса.
Ограничение по возвращаемым поиском типам объектов.
Размер страницы выдачи.
Информация об активных фильтрах.
Тип сортировки результатов.
Padding
Отступы от краёв камеры.
Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:
- точку позиции;
- анимированное перемещение карты;
- расположение динамических объектов карты (например баблики маршрутов).
Padding(
left: Int = 0,
top: Int = 0,
right: Int = 0,
bottom: Int = 0
)
Отступы от краёв камеры.
Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:
- точку позиции;
- анимированное перемещение карты;
- расположение динамических объектов карты (например баблики маршрутов).
Page
Страница результатов поиска.
fun fetchPrevPage(): Future<Page?>
Получить предыдущую страницу результатов.
future, резолвящаяся в ненулевой указатель на предыдущую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если предыдущая страница отсутствует exceptional future, если произошла ошибка при получении страницы
fun fetchNextPage(): Future<Page?>
Получить следующую страницу результатов.
future, резолвящаяся в ненулевой указатель на следующую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если следующая страница отсутствует exceptional future, если произошла ошибка при получении страницы
Непустой набор объектов справочника этой страницы.
ParkingCapacity
Вместимость парковки.
ParkingCapacity(total: String?, specialSpaces: List<SpecialSpace>)
Вместимость парковки.
Общая вместимость парковки, машиномест.
Описание особых мест для парковки.
ParkingInfo
Общая информация о парковке.
ParkingInfo(
type: ParkingType?,
purpose: ParkingPurpose,
access: ParkingAccess,
pavingType: ParkingPavingType?,
isPaid: Boolean,
isIncentive: Boolean,
forTrucks: Boolean,
levelCount: Short?,
capacity: ParkingCapacity?
)
Общая информация о парковке.
Тип.
Назначение.
Тип доступа.
Тип покрытия.
Является ли парковка платной.
Является ли парковка перехватывающей.
Есть места для грузовиков.
Количество уровней.
Вместимость.
PedestrianBriefRouteInfo
Базовая информация о пешеходном маршруте.
PedestrianBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о пешеходном маршруте.
PedestrianInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
PedestrianInstructionCrossroad(landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.NONE, maneuvers: List<PedestrianInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
Цепочка идущих подряд манёвров.
PedestrianInstructionCrossroadManeuver
PedestrianInstructionCrossroadManeuver(direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Направление движения.
PedestrianInstructionFinish
Конец пешеходной части маршрута.
PedestrianInstructionFinish()
Конец пешеходной части маршрута.
PedestrianInstructionIndoorEnter
Вход в здание.
PedestrianInstructionIndoorEnter(levelId: LevelId = LevelId())
Вход в здание.
Идентификатор этажа после входа в здание.
PedestrianInstructionIndoorExit
Выход из здания.
PedestrianInstructionIndoorExit()
Выход из здания.
PedestrianInstructionIndoorFloorChange
Смена этажа в здании.
PedestrianInstructionIndoorFloorChange(
type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.UNDEFINED,
beginId: LevelId = LevelId(),
endId: LevelId = LevelId()
)
Смена этажа в здании.
Тип смены этажа.
Идентификатор этажа до смены.
Идентификатор этажа после смены.
PedestrianInstructionStart
Начало пешеходной части маршрута.
PedestrianInstructionStart()
Начало пешеходной части маршрута.
PedestrianRouteSearchOptions
Параметры поиска пешеходного маршрута.
PedestrianRouteSearchOptions(
avoidStairways: Boolean = false,
useIndoor: Boolean = true,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска пешеходного маршрута.
Избегать лестниц.
Строить маршруты внутри зданий.
Исключаемые области (не больше 25).
PerformSearchHandler
Предложено поискать определенный набор объектов.
Запрос для прогона через поисковик.
PlatformLocationFollowController
Контроллер слежения за геопозицией и компасом.
PlatformLocationFollowController(map: Map)
Создание контроллера слежения за геопозицией и компасом.
PointGeometry
PointGeometryData
Данные геометрии точечного объекта.
PointGeometryData(geoPointWithElevation: GeoPointWithElevation)
fun match(geoPoint: Function1, geoPointWithElevation: Function1): T
fun toString(): String
fun hashCode(): Int
Polygon
Полигон на карте.
Polygon(options: PolygonOptions)
Cоздание полигона на основе параметров.
PolygonGeometry
PolygonOptions
Параметры полигона.
PolygonOptions(
contours: List<List<GeoPoint>>,
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value = 0.0f),
strokeColor: Color = Color(),
visible: Boolean = true,
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
levelId: LevelId? = null
)
Параметры полигона.
Уровень отрисовки объекта.
Привязка к поэтажному плану здания.
Polyline
Ломаная линия на карте.
Получение параметров пунктирной полилинии.
Получение параметров градиентной полилинии.
PolylineGeometry
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
)
Параметры полилинии
Точки полилинии
Ширина полилинии
Основной цвет полилинии
Параметры пунктирной полилинии
Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.
Параметры градиентной полилинии
Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.
Видимость полилинии
Пользовательские данные
Уровень отрисовки объекта.
Привязка к поэтажному плану здания.
Projection
Проекция.
Используется сферическая проекция Меркатора (EPSG:3857), зацикленная по долготе. Отображаемые данные ограничены по широте от -85.06° до 85.06°.
fun screenToMap(point: ScreenPoint): GeoPoint?
Вычисление точки карты в указанной точке экрана.
Функция возвращает пустое значение, если указанная точка экрана за пределами проекции карты.
fun mapToScreen(point: GeoPoint): ScreenPoint?
Вычисление точки экрана, соответствующей указанной точке карты.
Функция возвращает пустое значение:
fun mapToScreen(point: GeoPointWithElevation): ScreenPoint?
Вычисление точки экрана, соответствующей указанной точке карты с высотой.
Функция возвращает пустое значение:
- point имеет невалидное значение (latitude лежит вне диапазона -90;90, longitude лежит вне диапазона -180;180 или elevation отрицателен).
- если указанная точка карты находится выше плоскости проекции карты на экран.
- если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.
fun screenToMapClipped(point: ScreenPoint): GeoPoint
Вычисление ближайшей точки карты к проекции указанной точки экрана.
PublicBriefRouteInfo
Базовая информация о маршруте на общественном транспорте.
PublicBriefRouteInfo(publicTransportInfos: List<PublicBriefRouteTransportInfo>)
Базовая информация о маршруте на общественном транспорте.
Описание способов проезда на общественном транспорте.
PublicBriefRouteTransportInfo
Описание общественного транспортного средства.
PublicBriefRouteTransportInfo(
type: PublicTransportType = PublicTransportType.BUS,
names: List<String>,
color: Int?,
routeLogo: String
)
Описание общественного транспортного средства.
Тип общественного транспортного средства.
Названия маршрутов общественного транспорта, на которых происходит проезд.
Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.
Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.
PublicRoutePart
Описание участка маршрута на общественном транспорте.
PublicRoutePart(transports: List<PublicTransportInfo>, intermediateStops: List<PublicTransportStop>)
Описание участка маршрута на общественном транспорте.
Виды общественного транспорта, на котором можно проехать данный участок маршрута.
Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.
Промежуточные остановки, которые транспорт проедет прежде, чем доберется до точки пересадки.
Остановки отсортированы в порядке следования по маршруту.
На этих остановках не нужно выходить.
Начальная и конечная остановки не входят в этот список.
PublicTransportCard
Карточка, отображающая информацию о маршруте на общественном транспорте.
PublicTransportCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка, отображающая информацию о маршруте на общественном транспорте.
fun onAttachedToWindow(): Unit
PublicTransportCardModel
Модель для PublicTransportCard.
PublicTransportCardModel(
route: TrafficRoute,
context: Context,
startName: String? = null,
finishName: String? = null
)
Модель для PublicTransportCard.
Краткая информация (отображаемая в "шапке" карточки).
Точки пересадки.
PublicTransportInfo
Описание общественного транспортного средства.
PublicTransportInfo(
type: PublicTransportType = PublicTransportType.BUS,
names: List<String>,
suggestedCarNumbers: List<Int>,
boardingSuggest: String,
color: Int?,
routeLogo: String
)
Описание общественного транспортного средства.
Тип общественного транспортного средства.
Названия маршрутов общественного транспорта, на которых происходит проезд.
Номера вагонов, в которые рекомендуется посадка.
Если транспортное средство состоит из одного вагона или можно садиться в любой вагон, то этот список будет пустым.
Текстовое описание вагонов, в которые рекомендуется посадка.
Argb представление цвета, ассоциированного с данным видом общественного транспорта, например, цвет линии метро. При отсутствии информации о цвете в поле будет значение null.
Идентификатор иконки для остановок маршрута. Пустая строка, если информация недоступна. Техническое поле.
PublicTransportRouteSearchOptions
Параметры поиска маршрута на общественном транспорте.
PublicTransportRouteSearchOptions(
startTime: TimePoint? = null,
useSchedule: Boolean = false,
transportTypes: EnumSet<PublicTransportType> = EnumSet.noneOf(PublicTransportType::class.java)
)
Параметры поиска маршрута на общественном транспорте.
Время в UTC, на которое нужно построить маршрут. Если не задано, используется текущее время.
Учёт расписания движения общественного транспорта при построении маршрута.
Типы общественного транспорта. Если не заполнены, маршруты будут строиться для всех поддерживаемых типов общественного транспорта.
PublicTransportStop
Описание остановки общественного транспорта.
PublicTransportTransfer
Описание способа добраться на общественном транспорте до следующей точки пересадки.
PublicTransportTransfer(
startPointName: String,
finishPointName: String,
routeParts: List<PublicRoutePart>
)
Описание способа добраться на общественном транспорте до следующей точки пересадки.
Название точки, из которой начинается движение для данного участка маршрута.
Название точки назначения для данного участка маршрута.
Описание участка маршрута на общественном транспорте, по которому можно добраться до следующей точки пересадки.
Все участки маршрута из этого списка проходят по одной и той же линии геометрии.
Если список пустой, то данный участок маршрута предлагается преодолеть на личном или арендуемом транспорте либо пешком.
PublicTransportTransferRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): PublicTransportTransferRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<PublicTransportTransferRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
PublicTransportTransferRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
PublicTransportTransferRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: PublicTransportTransfer
)
Протяженный элемент маршрута - отрезок и значение на нем.
RangeFilter
Фильтр диапазонов значений.
RemainingRouteInfoControl
Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.
RemainingRouteInfoControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол UI навигатора, отображающий информацию об оставшемся расстоянии до конца маршрута и об оставшемся времени движения по маршруту.
fun detachFromManager(): Unit
Remover
Объект для удаления пользовательского контента.
fun remove(): Future<ActionResult>
Удаление контента.
действие доступно для контента, автором которого является пользователь.
RenderedObject
Отображаемый объект карты.
RenderedObjectInfo
Подробная информация об отображаемом объекте карты.
RenderedObjectInfo(
closestViewportPoint: ScreenPoint,
closestMapPoint: GeoPointWithElevation,
item: RenderedObject
)
Подробная информация об отображаемом объекте карты.
Ближайшая точка объекта в координатах экрана.
Ближайшая точка объекта в координатах карты.
Отображаемый объект карты
Reviews
Отзывы.
RoadCameraInfo
Информация о камере.
RoadCameraInfo(purposes: EnumSet<CameraPurpose>, speedLimit: Short?)
Информация о камере.
Назначения камеры.
Могут отсутствовать, если нет информации, или если камеру добавил пользователь.
Ограничение скорости в км/ч.
На текущий момент доступно только для камер, контролирующих скорость и среднюю скорость на участке.
Может отсутствовать и для камер контроля скорости, если значение неизвестно.
RoadEvent
Дорожное событие.
Тип события.
Локализованное название события.
Информация о пользователе, добавившем событие.
Временная метка создания события.
Координаты события.
Пользовательское описание дорожного события.
Информация о камере.
Доступна только для событий типа "Camera".
Расписание.
На текущий момент доступно только для перекрытий, и даже для них может отсутствовать.
Затронутые событием полосы.
На текущий момент могут быть проставлены только у пользовательских событий.
Список доступных действий с событием.
Получение объекта для удаления события.
RoadEventAction
Действие события.
fun set(): Future<ActionResult>
Применение действия (например, добавление отметки "нравится", подтверждение события).
Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода сбрасывает применение противоположного - невозможно одновременно поставить "нравится" и "не нравится".
fun reset(): Future<ActionResult>
Отмена действия (например, сброс отметки "нравится", сброс подтверждения события).
Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода не вызывает применение противоположного действия.
Тип действия.
Локализованное название действия.
Информация о действии.
Информация о действии.
RoadEventActionButton
Кнопка действия над дорожным событием (подтвердить, поставить like и т.д.).
RoadEventActionButton(model: RoadEventActionButtonModel, context: Context)
Кнопка действия над дорожным событием (подтвердить, поставить like и т.д.).
RoadEventActionInfo
Информация о действии.
RoadEventActionInfo(state: RoadEventActionState, count: Int?)
Информация о действии.
Состояние действия.
Количество действий, применённых к событию всеми пользователями (только для пользовательских событий).
RoadEventCard
Карточка, отображающая информацию о дорожном событии.
RoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка, отображающая информацию о дорожном событии.
Нотификация о завершении удаления события.
Нотификация о завершении действия.
RoadEventCardModel
Модель карточки дорожного события.
RoadEventCardModel(
event: RoadEvent,
photoSize: StatefulChannel<ScreenSize>,
context: Context
)
Модель карточки дорожного события.
fun close(): Unit
Название, например, "Перекрытие".
Описание, например, "Ремонтные работы".
Затронутые событием полосы, например, "Левый ряд, средний ряд".
Расписание, например, "10 октября 08:00 – 15 октября 23:30".
Время создания, например, "5 часов назад", "5 августа", "10 декабря 2020 г".
Автор, например, "2ГИС".
Фотография.
Нотификация о завершении действия.
Нотификация о завершении удаления события.
Действия.
RoadEventManager
Объект для создания транспортных событий.
RoadEventManager(context: Context)
Получение объекта для создания дорожных событий.
fun createAccident(
location: GeoPoint,
lanes: EnumSet<Lane>,
description: String
): Future<AddEventResult>
Создание события "Дтп".
местоположение события.
полосы дороги, затрагиваемые событием.
пользовательское описание события.
fun createCamera(location: GeoPoint, description: String): Future<AddEventResult>
Создание события "Камера".
местоположение события.
пользовательское описание события.
fun createRoadRestriction(location: GeoPoint, description: String): Future<AddEventResult>
Создание события "Перекрытие дорожного движения".
местоположение события.
пользовательское описание события.
fun createComment(location: GeoPoint, description: String): Future<AddEventResult>
Создание события "Комментарий".
местоположение события.
пользовательское описание события.
fun createOther(
location: GeoPoint,
lanes: EnumSet<Lane>,
description: String
): Future<AddEventResult>
Создание события "Другое".
местоположение события.
полосы дороги, затрагиваемые событием.
пользовательское описание события.
fun createRoadWorks(
location: GeoPoint,
lanes: EnumSet<Lane>,
description: String
): Future<AddEventResult>
Создание события "Дорожные работы".
местоположение события.
полосы дороги, затрагиваемые событием.
пользовательское описание события.
RoadEventMapObject
Объект карты "Дорожное событие".
Получение дорожного события.
RoadEventPhoto
Фотография дорожного события.
fun previewUrl(desiredSize: ScreenSize): String
URL превью фотографии.
fun report(): Future<ActionResult>
Отправка жалобы на фотографию.
жалоба на свою фотографию ни к чему не приведёт.
URL полноразмерной фотографии.
Информация о пользователе, добавившем фотографию.
Временная метка.
Получение объекта для удаления фотографии.
RoadEventRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadEventRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RoadEventRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RoadEventRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RoadEventRouteEntry
Элемент маршрута - точка и значение в ней.
RoadEventRouteEntry(point: RoutePoint, value: BriefRoadEvent)
Элемент маршрута - точка и значение в ней.
RoadEventSource
Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.
RoadEventSource(context: Context)
Создание источника, отображающего дорожные события на карте.
Получение текущих категорий событий, предоставляемых данным источником.
RoadMacroGraph
Пакет глобального дорожного графа, используется для построения проезда между двумя загруженными offline-территориями
RoadRuleRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadRuleRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadRuleRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RoadRuleRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadRuleRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadRule
)
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSubtypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadSubtypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSubtypeRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RoadSubtypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSubtypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadSubtype
)
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSurfaceRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadSurfaceRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadSurfaceRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RoadSurfaceRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadSurfaceRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadSurface
)
Протяженный элемент маршрута - отрезок и значение на нем.
RoadTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RoadTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoadTypeRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RoadTypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RoadTypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RoadType
)
Протяженный элемент маршрута - отрезок и значение на нем.
RotateMapToNorthEvent
RotationSettings
Настройки обработки вращения карты.
Порог изменения угла, в градусах, по достижению которого начнёт отправлять сообщения вращения. Используется, если масштабирование неактивно.
Порог среднего радиального сдвига точек, в миллиметрах, по достижению которого начнёт отправлять сообщения вращения. Используется, если масштабирование неактивно.
Порог изменения угла, в градусах, по достижению которого начнёт отправлять сообщения вращения. Используется, если масштабирование активно.
Порог среднего радиального сдвига точек, в миллиметрах, по достижению которого начнёт отправлять сообщения вращения. Используется, если масштабирование активно.
Route
Класс, описывающий маршрут. Маршрут представляет собой набор атрибутов, каждый из которых представляет собой контейнер типа RouteAttribute или RouteLongAttribute, в котором хранятся элементы атрибутов маршрута. Атрибуты маршрута делятся на точечные и протяженные. Точечные атрибуты (например, точки геометрии или лежачие полицейские) задаются в виде пары из RoutePoint и значения атрибута. Протяженные атрибуты (например, ширина проезжей части или ограничение скорости) задаются в виде пары из RoutePoint, которая указывает на начало действия атрибута и значения атрибута. В конце маршрута ставится терминатор. Например, пусть ширина проезжей части задана в виде набора пар {{0m, 3m}, {10m, 7m}, {20m, 5m}, {30m, 0m}}, тогда первые 10 метров маршрута проезжая часть имеет ширину 3 метра, на интервале [10м., 20м.) - 7м., с 20м. до конца маршрута - 5м.
Геометрия маршрута.
Не гарантируется, что RoutePoint у точек геометрии будет совпадать с RoutePoint у элементов других атрибутов, поэтому для того, чтобы вычислить географическую координату у элемента атрибута, не нужно искать в геометрии элемент, RoutePoint которого совпадает с RoutePoint элемента атрибута, вместо этого нужно воспользоваться функцией calculate_geo_point.
Инструкции, которые необходимо выполнить для движения по маршруту.
Промежуточные точки, через которые проходит маршрут. Маршрут может проходить не прямо через промежуточную точку, а рядом с ней. В значении атрибута хранится координата, в которую была установлена промежуточная точка, в ключе - координата проекции промежуточной точки на маршрут.
Высоты на маршруте.
Плохая дорога (на дороге присутствуют кочки и ямы, которые препятствуют проезду).
Препятствия на маршруте.
Названия дорог/улиц.
Признак того, что участок маршрута проходит по населённому пункту.
Вид транспорта, для которого построен участок маршрута.
Дорожные камеры.
Ширина проезжей части в метрах. 0 - ширина неизвестна.
Знаки съездов.
Искусственные неровности.
Полосы движения.
Этажи зданий.
Ограничения максимальной допустимой скорости.
0 - ограничение скорости неизвестно.
Сторона движения.
Дополнительное описание к типу дороги, по которой пролегает маршрут.
Покрытие дороги.
Тип дороги, по которой пролегает маршрут.
Участки маршрута, пролегающие по платным дорогам.
Признак наличия или отсутствия данных для грузовой навигации.
Пропускные зоны для грузового транспорта.
Признак действия знака запрета проезда грузового транспорта.
Признак действия знака запрета проезда любого автотранспорта (перекрытия).
Описание способов перемещения на общественном транспорте между точками пересадок.
RouteBuildOptions
Структура, которая описывает параметры построения маршрута в навигаторе.
RouteBuildOptions(finishPoint: RouteSearchPoint, routeSearchOptions: RouteSearchOptions)
Структура, которая описывает параметры построения маршрута в навигаторе.
Точка, к которой строится маршут.
Параметры поиска маршрута.
RouteCamera
Структура, описывающая дорожную камеру.
RouteCamera(
purposes: EnumSet<RouteCameraPurpose>,
rangeAgainst: RouteDistance,
rangeAlong: RouteDistance,
direction: RouteCameraDirection
)
Структура, описывающая дорожную камеру.
Назначения камеры.
Дальность действия камеры против хода движения.
Дальность действия камеры по ходу движения.
Направление действия камеры.
RouteDistance
Расстояние вдоль маршрута.
fun absoluteValue(): RouteDistance
operator fun plus(other: RouteDistance): RouteDistance
operator fun minus(other: RouteDistance): RouteDistance
RouteEditor
Интерфейс для редактора маршрута. Редактор маршрута получает точки начала и конца маршрута, строит маршруты и через каналы оповещает об их обновлениях и перестроениях.
Все методы этого интерфейса вызываются из одного потока.
fun setRouteParams(routeParams: RouteEditorRouteParams): Unit
Установка параметров редактора маршрута. Запускает поиск нового маршрута согласно переданным параметрам.
fun setActiveRouteIndex(index: RouteIndex): Unit
Установка индекса активного маршрута.
Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.
Канал, через который можно следить за обновлениями информации о маршрутах, которыми оперирует редактор.
Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается null.
Канал, через который можно следить за обновлениями индекса активного маршрута. В случае отсутствия маршрутов в этот канал помещается null.
RouteEditorRouteParams
Информация о параметрах маршрута.
RouteEditorRouteParams(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: List<RouteSearchPoint> = listOf()
)
Информация о параметрах маршрута.
RouteEditorRoutesInfo
Информация о маршрутах, которыми оперирует редактор.
RouteEditorRoutesInfo(routes: List<TrafficRoute>, routeParams: RouteEditorRouteParams)
Информация о маршрутах, которыми оперирует редактор.
При обновлении списка маршрутов активным будет первый маршрут, если список маршрутов непустой.
Параметры маршрута, для которых выполнялся поиск. Могут отличаться от параметров, переданных редактору, если маршруты были найдены уже после изменения параметров в редакторе.
RouteEditorSource
Интерфейс класса, управляющего отображением маршрутов на карте.
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
fun setRoutesVisible(visible: Boolean): Unit
Включить или выключить отображение маршрутов на карте.
fun setShowOnlyActiveRoute(showOnlyActiveRoute: Boolean): Unit
Отображать на карте все маршруты (false) или только текущий активный маршрут (true).
fun setPassedDistanceVisualization(passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization): Unit
Изменить способ визуализации пройденного вдоль маршрута расстояния.
Объекты маршрута на карте.
Настройки отображения маневров на маршруте.
Флаги отображения активного маршрута. См. IRouteMapObject::display_flags.
Флаги отображения неактивных маршрутов. См. IRouteMapObject::display_flags.
Флаги, включающие отображение содержимого в бабликах активного маршрута. См. IRouteMapObject::callout_label_flags.
Флаги, включающие отображение содержимого в бабликах неактивных маршрутов. См. IRouteMapObject::callout_label_flags.
Режим отображения значений в бабликах маршрутов. См. IRouteMapObject::callout_label_display_mode.
Флаги, исключающие скрытие компонентов активного маршрута с карты. См. IRouteMapObject::permanent_display_flags.
Флаги, исключающие скрытие компонентов неактивных маршрутов с карты. См. IRouteMapObject::permanent_display_flags.
RouteExitSign
Информация о знаке съезда.
RouteExitSign(
type: RouteExitSignType = RouteExitSignType.UNDEFINED,
roadNameTable: RouteExitSignTable,
roadNumberTable: RouteExitSignTable?
)
Информация о знаке съезда.
Тип съезда.
Табличка съезда с названием дороги.
Табличка съезда с номером дороги.
RouteExitSignRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteExitSignRouteEntry>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RouteExitSignRouteEntry?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RouteExitSignRouteEntry?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RouteExitSignRouteEntry
Элемент маршрута - точка и значение в ней.
RouteExitSignRouteEntry(point: RoutePoint, value: RouteExitSign)
Элемент маршрута - точка и значение в ней.
RouteExitSignTable
Информация о табличке съезда.
RouteExitSignTable(backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.UNDEFINED, text: String)
Информация о табличке съезда.
Цвет фона таблички съезда.
Текст на табличке съезда.
RouteIndex
Индекс активного маршрута.
RouteInfo
Описание маршрута с манёврами.
RouteInfo(route: Route, routeBuildOptions: RouteBuildOptions?)
Описание маршрута с манёврами.
Маршрут.
Параметры построения маршрута в навигаторе. Значение равное null означает, что у маршрута отсутствует конечная точка. В этом случае, на основании дорожного графа и параметров движения пользователя, вычисляется участок дороги, по которому предположительно движется пользователь и возвращается в виде маршрута в поле route. Следовательно, такой "маршрут" не может содержать инструкции и последняя точка в этом "маршруте" не является точкой назначения, в которую движется пользователь, а просто является точкой, до которой удалось предугадать движение пользователя. Куда он поедет дальше - неизвестно. Такой режим работы навигатора называется режим ведения без маршрута или free roam.
RouteInfoCalloutMapObject
Объект бабла с информацией о длине и/или длительности маршрута на карте.
Маршрут, часть которого представляет данный объект бабла.
Индекс маршрута.
Позиция на маршруте, на которой расположен бабл.
RouteInstruction
Инструкция, которую необходимо выполнить для движения по маршруту.
RouteInstruction(
roadName: String,
range: RouteDistance,
extraInstructionInfo: ExtraInstructionInfo
)
Инструкция, которую необходимо выполнить для движения по маршруту.
Название дороги, на которой окажется пользователь после совершения манёвра.
Расстояние после точки инструкции, на протяжении которого считается, что пользователь находится в зоне действия инструкции.
Специфичная для конкретного типа инструкции информация.
RouteLane
Структура, описывающая одну полосу движения.
RouteLane(
routeManeuver: RouteLaneManeuver = RouteLaneManeuver.UNDEFINED,
maneuvers: EnumSet<RouteLaneManeuver>,
speedLimit: Float = 0.0f,
prohibited: Boolean = false,
onlyPublicTransport: Boolean = false
)
Структура, описывающая одну полосу движения.
Манёвр, который необходимо совершить для движения по маршруту.
Допустимые манёвры на полосе.
Максимальная разрешенная скорость на полосе м/с. 0 - ограничение скорости неизвестно.
Проезд по полосе запрещён.
Полоса для общественного транспорта.
RouteLaneSign
Описание полос движения.
RouteLaneSign(
lanes: List<RouteLane>,
signStartPoint: RoutePoint?,
signPoint: RoutePoint?,
signEndPoint: RoutePoint?
)
Описание полос движения.
Полосы движения для автомобилей на участке дороги. Перечислены в порядке следования от обочины к середине проезжей части.
Если количество полос неизвестно либо в направлении маршрута на дороге находится одна полоса движения, то этот массив будет пустым.
Точка на маршруте, в которой начинается действие знака, регулирующего движение по полосам. null, если положение начала действия знака неизвестно.
Точка на маршруте, в которой установлен знак, регулирующий движение по полосам. null, если положение знака неизвестно.
Точка на маршруте, в которой заканчивается действие знака, регулирующего движение по полосам. null, если положение окончания действия знака неизвестно.
RouteLevelInfo
Информация об этаже здания, соответствующая участку маршрута.
Идентификатор этажного плана в начальной точке участка маршрута. Отсутствует, если точка не находится в здании.
Идентификатор этажного плана в конечной точке участка маршрута. Отсутствует, если точка не находится в здании.
Название этажа. Пусто, если участок маршрута соединяет разные этажи.
RouteLevelInfoRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): RouteLevelInfoRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<RouteLevelInfoRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
RouteLevelInfoRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
RouteLevelInfoRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: RouteLevelInfo
)
Протяженный элемент маршрута - отрезок и значение на нем.
RouteMapObject
Объект маршрута на карте.
RouteMapObject(
route: TrafficRoute,
isActive: Boolean,
index: RouteIndex,
displayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
calloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.ABSOLUTE_VALUES,
permanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null
)
Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.
Набор флагов для отображения различных частей маршрута. Если не задан, используется логика отображения на основе статуса активности маршрута.
Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.
Набор флагов для предотвращения скрытия различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния. Если не задан, то при обновлении пройденного вдоль маршрута расстояния с карты скрываются все элементы маршрута, попадающие в неотображаемую часть маршрута.
Статус активности маршрута.
Статус активности маршрута.
Маршрут.
Индекс маршрута в редакторе маршрута.
Пройденное расстояние вдоль маршрута.
Пройденное расстояние вдоль маршрута.
Положение баблика маршрута.
Положение баблика маршрута.
Набор флагов для отображения содержимого бабликов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.
Набор флагов для отображения содержимого бабликов маршрута. Если не задан, то для активного маршрута отображается и время движения по маршруту, и его длина, а для неактивных маршрутов - только время движения.
Режим отображения значений в бабликах маршрута. По умолчанию значения отображаются в виде абсолютных величин.
Режим отображения значений в бабликах маршрута. По умолчанию значения отображаются в виде абсолютных величин.
Положения баблов полосности. Возвращаются только актуальные положения для текущего пройденного расстояния по маршруту и только если источник, в который помещён объект, работает в режиме навигации.
Положения баблов полосности. Возвращаются только актуальные положения для текущего пройденного расстояния по маршруту и только если источник, в который помещён объект, работает в режиме навигации.
RouteMapObjectSource
Источник объектов маршрута на карте.
RouteMapObjectSource(context: Context, routeVisualizationType: RouteVisualizationType = RouteVisualizationType.NORMAL)
Функция создания IRouteMapObjectSource.
fun addObject(item: RouteMapObject): Unit
Добавление объекта маршрута в источник.
fun removeObject(item: RouteMapObject): Unit
Удаление объекта маршрута из источника.
fun replaceAllObjects(objects: List<RouteMapObject>): Unit
Замена всех ранее добавленных в источник объектов на передаваемый список объектов. В отличие от удаления и добавления объектов по одному замена выполняется атомарно - старые маршруты удаляются, а новые маршруты появляются на карте одновременно.
Объекты маршрута.
Настройка отображения объектов в источнике.
RouteMapSettings
Настройки отображения маршрута на карте.
Флаги отображения маршрута на карте для режима ведения по маршруту. По умолчанию включены все флаги, за исключением флага InactiveFloors.
Флаги отображения маршрута на карте для режима free roam. По умолчанию включены флаги Cameras, Humps, Accidents, RoadWorks, Comments, RoadRestrictions, OtherEvents.
Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима ведения по маршруту. По умолчанию скрываются все элементы маршрута.
Флаги, исключающие скрытие различных составных частей маршрута с карты при обновлении пройденного вдоль маршрута расстояния для режима free roam. По умолчанию скрываются все элементы маршрута.
RouteOverviewControl
Контрол, отображаемый в режиме просмотра маршрута.
RouteOverviewControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол, отображаемый в режиме просмотра маршрута.
RoutePoint
Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.
RoutePoint(distance: RouteDistance)
Точка на маршруте, задается как расстояние вдоль маршрута относительно начала маршрута.
operator fun plus(distance: RouteDistance): RoutePoint
operator fun minus(distance: RouteDistance): RoutePoint
RoutePointMapObject
Точечный объект, являющийся частью маршрута на карте (например, точка начала или конца маршрута).
Маршрут, часть которого представляет данный точечный объект.
Индекс маршрута.
Тип точечного объекта маршрута.
Позиция на маршруте, соответствующая данному точечному объекту.
Географические координаты, в которых находится данный точечный объект.
Географические координаты, в которых находится данный точечный объект.
RouteSearchOptions
Параметры поиска маршрута.
RouteSearchOptions(pedestrian: PedestrianRouteSearchOptions)
RouteSearchOptions(publicTransport: PublicTransportRouteSearchOptions)
fun match(
bicycle: Function1,
car: Function1,
pedestrian: Function1,
publicTransport: Function1,
scooter: Function1,
taxi: Function1,
truck: Function1
): T
fun toString(): String
fun hashCode(): Int
RouteSearchPoint
Описание точек, по которым строится маршрут.
RouteSearchPoint(
coordinates: GeoPoint,
course: Bearing? = null,
objectId: DgisObjectId = DgisObjectId(objectId = 0, entranceId = 0),
levelId: LevelId? = null
)
Описание точек, по которым строится маршрут.
Координаты, через которые нужно проложить маршрут.
Направление, в котором нужно преодолеть точку.
ID объекта, до которого будет проложена пешеходная часть маршрута.
Идентификатор этажного плана (для пешеходных маршрутов).
RouteSourceSettings
Настройки источника маршрута
fun getLargeScaleMergeDistanceMeters(transportType: TransportType): Float
Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба. Если расстояние меньше заданного, то стрелки объединяются.
fun setLargeScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit
Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для крупного масштаба.
Расстояние в метрах.
Тип транспорта, для которого устанавливается расстояние.
fun getSmallScaleMergeDistanceMeters(transportType: TransportType): Float
Минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба. Если расстояние меньше заданного, то стрелки объединяются.
fun setSmallScaleMergeDistanceMeters(distance: Float, transportType: TransportType): Unit
Установить минимально допустимое расстояние в метрах между последовательными стрелками манёвров для мелкого масштаба.
Расстояние в метрах.
Тип транспорта, для которого устанавливается расстояние.
fun getLargeScaleCrossroadsOffsetMeters(transportType: TransportType): Float
Смещение в метрах от точки перекрестка до начала и конца стрелки маневра для крупного масштаба.
fun setLargeScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit
Установить смещение в метрах от точки перекрестка до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.
Смещение в метрах.
Тип транспорта, для которого устанавливается смещение.
fun getSmallScaleCrossroadsOffsetMeters(transportType: TransportType): Float
Смещение от точки перекрестка до начала и конца стрелки маневра для мелкого масштаба.
fun setSmallScaleCrossroadsOffsetMeters(offset: Float, transportType: TransportType): Unit
Установить смещение от точки перекрестка до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.
Смещение в метрах.
Тип транспорта, для которого устанавливается смещение.
Смещение от точки съезда с кольца до начала и конца стрелки маневра для крупного масштаба. Позволяет задать размер стрелки маневра.
Смещение от точки съезда с кольца до начала и конца стрелки маневра для мелкого масштаба. Позволяет задать размер стрелки маневра.
Режим отображения бабликов со временем и длиной маршрута.
RubricId
Идентификатор рубрики.
ScaleMapEvent
Событие изменения масштаба карты.
ScaleMapEvent(zoomDelta: Float, scalingCenter: ScreenPoint? = null)
Конструктор события изменения масштаба.
величина, на которую изменится текущее значение масштаба.
точка на экране, относительно которой масштабируется карта. Если точка не задана, то масштабирование происходит относительно точки позиции карты.
Величина, на которую изменится текущее значение масштаба.
Точка на экране, относительно которой масштабируется карта.
ScalingSettings
Порог коэффицента масштабирования, по достижению которого начнёт отправляться событие масштабирования. Используется, если вращение неактивно. Множитель должен выйти за пределы (1 / scale_ratio_threshold, scale_ratio_threshold).
Порог коэффицента масштабирования, по достижению которого начнёт отправляться сообщения масштабирования. Используется, если вращение активно. Множитель должен выйти за пределы (1 / scale_ratio_threshold_in_rotation, scale_ratio_threshold_in_rotation).
Schedule
Расписание действия дорожного события.
Schedule(
startTime: TimePoint?,
finishTime: TimePoint?,
weekTimeIntervals: List<WeekTimeInterval>
)
Расписание действия дорожного события.
Время начала действия. Отсутствует, если неизвестно.
Время начала действия. Отсутствует, если неизвестно.
Интервалы работы внутри недели.
Интервалы упорядочены по времени.
Первый интервал может начинаться с прошлой недели.
ScooterBriefRouteInfo
Базовая информация о маршруте на самокате.
ScooterBriefRouteInfo(length: RouteDistance, landmark: String)
Базовая информация о маршруте на самокате.
ScooterInstructionCrossroad
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
ScooterInstructionCrossroad(landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.NONE, maneuvers: List<ScooterInstructionCrossroadManeuver>)
Описание манёвров при проходе через перекрёсток или по пешеходному переходу.
Ориентир.
Цепочка идущих подряд манёвров.
ScooterInstructionCrossroadManeuver
ScooterInstructionCrossroadManeuver(direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Направление движения.
ScooterInstructionFinish
Конец самокатной части маршрута.
ScooterInstructionFinish()
Конец самокатной части маршрута.
ScooterInstructionStart
Начало самокатной части маршрута.
ScooterInstructionStart()
Начало самокатной части маршрута.
ScooterRouteSearchOptions
Параметры поиска маршрута на самокате.
ScooterRouteSearchOptions(
avoidCarRoads: Boolean = true,
avoidStairways: Boolean = true,
avoidUnderpassesAndOverpasses: Boolean = true,
excludedAreas: List<ExcludedArea> = listOf()
)
Параметры поиска маршрута на самокате.
Избегать автомобильных дорог.
Избегать лестниц.
Избегать подземных и надземных переходов.
Исключаемые области (не больше 25).
ScreenDistance
Расстояние между объектами на экране в миллиметрах.
не может быть отрицательным
ScreenDistance(value: Float = 0.0f)
Расстояние между объектами на экране в миллиметрах.
не может быть отрицательным
ScreenPoint
Точка в экранных координатах.
Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.
ScreenShift
Смещение карты по горизонтали и вертикали в координатном пространстве экрана.
Положительное направление смещения: dx - вправо, dy - вниз.
ScreenSize
Размер в пикселях.
SearchManager
Поисковик. Основная точка входа для справочного API.
fun suggest(query: SuggestQuery): Future<SuggestResult>
Получить подсказки, соответствующие данному запросу.
future, резолвящаяся в ненулевой указатель на результат подбора подсказок или exceptional future, если произошла ошибка при получении подсказок
fun search(query: SearchQuery): Future<SearchResult>
Получить объекты справочника, соответствующие данному запросу.
future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска
fun searchById(id: String): Future<DirectoryObject?>
Получить объект справочника по строковому идентификатору.
future, резолвящаяся в указатель на объект справочника. Если объект не найден, то вернется пустой указатель
fun searchByDirectoryObjectId(objectId: DgisObjectId): Future<DirectoryObject?>
Получить объект справочника по идентификатору.
future, резолвящаяся в указатель на объект справочника. Если объект не найден, то вернется пустой указатель
@JvmStatic
fun createOnlineManager(context: Context): SearchManager
Создать поисковик, работающий онлайн.
@JvmStatic
fun createOfflineManager(context: Context): SearchManager
Создать поисковик, работающий с предзагруженными данными.
@JvmStatic
fun createSmartManager(context: Context): SearchManager
Создать поисковик, работающий онлайн или с предзагруженными данными в зависимости от наличия подключения к сети интернет.
SearchQuery
Поисковый запрос.
SearchQueryBuilder
Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):
TODO: Данное условие пока не работает. Будет исправлено в ближайших релизах.
fun setSpatialRestriction(spatialRestriction: List?<GeoPoint>): SearchQueryBuilder
Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.
по умолчанию ограничение отсутствует
fun setAreaOfInterest(rect: GeoRect?): SearchQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
fun setAllowedResultTypes(allowedResultTypes: List<ObjectType>): SearchQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
fun setPageSize(pageSize: Int): SearchQueryBuilder
Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона 1;50
по умолчанию 10
fun setDirectoryFilter(filter: DirectoryFilter): SearchQueryBuilder
Задать фильтрацию для поискового запроса.
fun setSortingType(sortingType: SortingType): SearchQueryBuilder
Задать сортировку для поискового запроса.
@JvmStatic
fun fromQueryText(queryText: String): SearchQueryBuilder
Начать построение текстового поискового запроса c указанным текстом.
@JvmStatic
fun fromRubriсIds(rubricIds: List<RubricId>): SearchQueryBuilder
Начать построение поискового запроса на основе идентификаторов рубрик.
@JvmStatic
fun fromQueryTextAndRubriсIds(queryText: String, rubricIds: List<RubricId>): SearchQueryBuilder
Начать построение текстового поискового запроса с фильтрацией по идентификаторам рубрик.
@JvmStatic
fun fromQuery(query: SearchQuery): SearchQueryBuilder
Начать построение запроса на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
SearchResult
Результат работы поисковика.
fun markerTitles(objectIds: List<DgisObjectId>): List<Future<List<UIMarkerInfo>>>
Получение текстов маркеров по их идентификаторам. Возвращается vector <future
, так как в облако за запрос можно отправить не более 50 идентификаторов.
Первая страница результатов поиска.
Прямоугольная область, подходящая для отображения результатов поиска.
Асинхронное получение маркеров.
Тип поискового запроса.
Динамические фильтры для этого запроса.
Признак того, что первый результат пригоден для непосредственного использования.
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 не определено.
SettlementRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): SettlementRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<SettlementRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
SettlementRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
SettlementRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Settlement
)
Протяженный элемент маршрута - отрезок и значение на нем.
ShowRouteControl
Контрол, управляющий перелетом карты к маршруту.
ShowRouteControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол, управляющий перелетом карты к маршруту.
fun cancelRouteOverview(): Unit
SimpleClusterObject
Кластер simple объектов-маркеров.
Получение позиции кластера на карте.
Получение количества маркеров в кластере.
Получение списка маркеров в кластере.
Получение и установка точки привязки иконки кластера.
Получение и установка прозрачности иконки кластера.
Получение и установка подписи кластера.
Получение и установка стиля подписи кластера.
Получение и установка целевой ширины кластера, используемой для масштабирования.
Получение и установка угла поворота кластера на карте относительно направления на север, по часовой стрелке.
Получение и установка флага анимируемости появления кластера.
Получение и установка уровня отрисовки объекта.
SimpleClusterOptions
Параметры маркера кластера simple объектов-маркеров.
SimpleClusterOptions(
icon: Image?,
iconMapDirection: MapDirection? = null,
anchor: Anchor = Anchor(x = 0.5f, y = 0.5f),
text: String? = null,
textStyle: TextStyle? = null,
iconOpacity: Opacity = Opacity(value = 1.0f),
iconWidth: LogicalPixel = LogicalPixel(value = 0.0f),
userData: Any? = null,
zIndex: ZIndex = ZIndex(value = 0),
animatedAppearance: Boolean = true
)
Параметры маркера кластера simple объектов-маркеров.
целевая ширина, используемая для масштабирования
Уровень отрисовки объекта.
Анимировать ли появление
SimpleMapObject
Объект на карте, для которого можно задавать видимость.
SimulationAutoWithOverSpeed
Структура для задания режима движения с учетом максимальной скорости на ребре маршрута
SimulationAutoWithOverSpeed(overSpeed: Double = 0.0)
Структура для задания режима движения с учетом максимальной скорости на ребре маршрута
Используемое превышение скорости в м/с. Допустимы значения только >= 0
SimulationConstantSpeed
Структура для задания режима движения с постоянной скоростью
SimulationConstantSpeed(speed: Double = 0.0)
Структура для задания режима движения с постоянной скоростью
Скорость движения в м/с. Допустимы значения только >= 0
SimulationSettings
Настройки симуляции ведения по маршруту
Режим работы симулятора
SimulationSpeedMode
SimulationSpeedMode(overSpeed: SimulationAutoWithOverSpeed)
fun match(speed: Function1, overSpeed: Function1): T
fun toString(): String
fun hashCode(): Int
SnapToMapLayout
Layout, позволяющий привязать View к точке на карте.
SnapToMapLayout(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Layout, позволяющий привязать View к точке на карте.
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
fun onLayout(
changed: Boolean,
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
fun generateLayoutParams(attrs: AttributeSet?): LayoutParams?
fun generateLayoutParams(p: LayoutParams?): LayoutParams?
SoundNotificationSettings
Настройки звуковых оповещений в навигаторе По умолчанию все значения категорий звуков оповещений включены. Пользователь может менять значения во время работы с навигатором.
Набор флагов для звуковых оповещений.
Source
Источник данных на карте.
Это может быть источник пробочных данных, маршрутов, маркеров, произвольных геометрических или других объектов карты. У любого объекта карты могут быть свои свойства. Свойства объекта влияют на то, какие к нему применяются правила и параметры отображения, описаные в стилях карты. Стиль - набор параметров и правил отображения объектов карты, получаемый через редактор стилей и использующийся для отрисовки карты.
Свойства объекта могут быть заданы:
- непосредственно для объекта;
- источнику данных (все объекты, добавленные в источник, получают эти свойства);
- карте (все объекты, добавленные на карту, получают эти свойства);
- стилю (все объекты, к которым применён стиль, получают эти свойства). Список приведён в порядке понижения приоритета применения свойств. Даже если на карту не добавлен ни один источник данных, свойства стиля и карты всё равно повлияют на карту, т.к. есть специальные отображаемые объекты, например - фон.
SpecialSpace
Особое место для парковки.
SpecialSpace(
type: SpecialSpaceType,
name: String,
count: String?
)
Особое место для парковки.
Тип.
Локализованное название особого места.
Количество мест такого типа на парковке.
SpeedInfoControl
SpeedInfoControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
SpeedRange
Интервал скоростей. Скорости задаются в метрах в секунду.
SpeedRangeToStyleZoom
Соответствие интервала скоростей и стилевого зума.
SpeedRangeToStyleZoom(
range: SpeedRange,
minDistanceToManeuver: RouteDistance,
maxDistanceToManeuver: RouteDistance,
styleZoom: StyleZoom
)
Соответствие интервала скоростей и стилевого зума.
Интервал скоростей.
Минимальное расстояние до манёвра, при котором должна включаться логика плавного увеличения уровня зума.
Максимальное расстояние после манёвра, при котором плавное уменьшение уровня зума должно завершиться.
Стилевой зум.
StringRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): StringRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<StringRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
StringRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
StringRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: String
)
Протяженный элемент маршрута - отрезок и значение на нем.
Style
Стиль с набором свойств объектов карты (cм. ISource).
Получение свойств по умолчанию для объектов, к которым применён указанный слой.
StyleBuilder
Конструктор стилей.
fun setStyleAttribute(name: String, value: AttributeValue): StyleBuilder
fun loadStyle(file: File): Future<Style>
Загрузка пользовательского стиля
StyleLayerId
Идентификатор слоя стиля.
StyleZoom
Стилевой zoom-уровень.
Задаётся в редакторе стилей и отличается от обычного zoom-уровня тем, что для одного StyleZoom масштаб карты одинаков независимо от широты. Однако, при Zoom < 9 или при latitude > 60 градусов StyleZoom == Zoom и масштаб карты на разных широтах отличается.
StyleZoom не может быть отрицательным.
StyleZoom(value: Float = 0.0f)
Стилевой zoom-уровень.
Задаётся в редакторе стилей и отличается от обычного zoom-уровня тем, что для одного StyleZoom масштаб карты одинаков независимо от широты. Однако, при Zoom < 9 или при latitude > 60 градусов StyleZoom == Zoom и масштаб карты на разных широтах отличается.
StyleZoom не может быть отрицательным.
StyleZoomFollowController
Контроллер слежения за стилевым zoom-уровнем карты.
StyleZoomFollowController(map: Map)
Создание контроллера слежения за стилевым zoom-уровнем карты.
fun setStyleZoom(styleZoom: StyleZoom): Unit
Установка нового значения стилевого zoom-уровня.
fun setStyleZoomRange(minStyleZoom: StyleZoom, maxStyleZoom: StyleZoom): Unit
Установка интервала допустимых значений стилевого zoom-уровня.
Suggest
Поисковая подсказка.
Обработчик выбора подсказки.
Тип подсказки.
Заголовок подсказки.
Подзаголовок подсказки.
SuggestHandler
Обработчик выбора подсказки.
SuggestHandler(performSearchHandler: PerformSearchHandler?)
SuggestHandler(incompleteTextHandler: IncompleteTextHandler?)
fun match(
objectHandler: Function1,
performSearchHandler: Function1,
incompleteTextHandler: Function1
): T
fun toString(): String
fun hashCode(): Int
SuggestObjectHandler
Предложен конкретный объект справочника.
Подсказанный объект.
SuggestQuery
Запрос поисковой подсказки.
SuggestQueryBuilder
Построитель запросов к подсказчику.
fun setSpatialRestriction(spatialRestriction: List?<GeoPoint>): SuggestQueryBuilder
Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.
по умолчанию ограничение отсутствует
fun setAreaOfInterest(rect: GeoRect?): SuggestQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
fun setAllowedResultTypes(allowedResultTypes: List<SuggestedType>): SuggestQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
fun setSuggestorType(suggestorType: SuggestorType): SuggestQueryBuilder
Задать тип подсказчика.
по умолчанию #SuggestorType::General
fun setLimit(limit: Int): SuggestQueryBuilder
Задать желаемое количество подсказок. Допустимы значения из диапазона 1;50
по умолчанию 10
@JvmStatic
fun fromQueryText(queryText: String): SuggestQueryBuilder
Начать построение запроса подсказки для заданного текста и области интереса.
@JvmStatic
fun fromQuery(query: SuggestQuery): SuggestQueryBuilder
Начать построение запроса подсказки на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
SuggestResult
Результат работы подсказчика.
Набор предложенных вариантов подсказок.
набор пуст, если подходящие подсказки не найдены
SystemCertificate
Системный SSL-сертификат.
SystemCertificate()
Системный SSL-сертификат.
SystemMemoryManager
Интерфейс управления использованием системной памяти.
fun reduceMemoryUsage(): Unit
Уменьшение использования памяти путём очистки всевозможных кэшей и буферов.
TaxiRouteSearchOptions
Параметры поиска маршрута на такси.
TaxiRouteSearchOptions(car: CarRouteSearchOptions)
Параметры поиска маршрута на такси.
Параметры поиска маршрута, общие с прочими автомобильными.
TerritoriesAlongRouteProvider
Интерфейс для поиска маршрута с учетом пробочных данных.
fun getTerritories(route: Route): Future<List<Territory>>
Возвращает минимально необходимый список офлайн-территорий в порядке следования маршрута.
Territory
Территория. Данные в 2ГИС нарезаны на некоторые неделимые единицы, называемые сегментами. Но для более удобной и гибкой работы с данными для обновления используются не сами сегменты, а их наборы, называемые территориями. Наборы сегментов в двух территориях могут пересекаться, в том числе одна территория может быть целиком вложена в другую.
TerritoryManager
Интерфейс для взаимодействия со списком территорий: Подписки на изменения информации о территориях; Поиска территорий по координатам и геометриям; Подписки на изменения информации о всеобщем прогрессе установки/обновления территорий; Приостановки и возобновления процесса установки/обновления территорий.
fun pause(): Unit
Приостановка всех запущенных операций установки либо обновления территорий.
fun resume(): Unit
Возобновление всех приостановленных операций установки либо обновления территорий.
Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из IPackageManager::packages. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
Канал со списком всех известных территорий. Обновляется при изменении информации о хотя бы одной из территорий, либо при изменении состава списка. Содержимое канала является подмножеством общего списка пакетов, получаемого из 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()),
textPlacement: TextPlacement = TextPlacement.BOTTOM_CENTER,
textOffset: LogicalPixel = LogicalPixel(value = 0.0f),
fontName: String? = null
)
Настройки внешнего вида текста
Tilt
Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.
Допустимыми считаются значения в интервале от 0 до 60 градусов. В случаях, когда точка позиции камеры расположена ближе к нижнему краю экрана, значение может быть дополнительно уменьшено.
Tilt(value: Float = 0.0f)
Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.
Допустимыми считаются значения в интервале от 0 до 60 градусов. В случаях, когда точка позиции камеры расположена ближе к нижнему краю экрана, значение может быть дополнительно уменьшено.
TiltFollowController
Контроллер слежения за углом наклона карты.
TiltFollowController()
Создание контроллера слежения за углом наклона карты.
TiltSettings
Расстояние, в мм, на которое нужно сдвинуть пальцы по экрану, чтобы изменить угол наклона камеры на 1 градус. Отрицательное значение прведет к инверсии направления. значение 0 недопустимо.
Максимальный допустимый угол отклонения линии постановки пальцев от горизонта для вертикального свайпа. В градусах.
Максимальный допустимый угол отклонения направления свайпа от вертикальной линии. В градусах
Порог сдвига взвешенного среднего точек, в миллиметрах, если сдвиг не привысит порог, то событие не отправляется
TimePoint
Класс, представляющий момент времени.
TimePoint(timeFromEpoch: Duration)
Класс, представляющий момент времени.
fun toString(): String
@JvmStatic
fun ofEpochMilliseconds(milliseconds: Long): TimePoint
@JvmStatic
fun now(): TimePoint
Время, прошедшее с 00:00:00 UTC 1 января 1970 года (Unix-время).
TradeLicense
Лицензия организации.
Traffic
Описание пробочных данных.
Длительности движения на участках маршрута. 0 - длительность движения на участке маршрута неизвестна.
Цветовое представление скоростей движения ТС на маршруте (протяженный атрибут).
TrafficAndParkingControl
Контейнер контролами отображения парковок и пробок.
TrafficAndParkingControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контейнер контролами отображения парковок и пробок.
TrafficCollector
Интерфейс для управления сервисом сбора информации о транспортном трафике.
Этот интерфейс является потокобезопасным.
TrafficCollector(context: Context)
Функция создания сервиса сбора информации о транспортном трафике. Сервис сбора информации о транспортном трафике анализирует состояние трафика на дороге, по которой движется пользователь и отправляет результаты анализа в анонимизированном виде на сервер.
контекст - окружение, необходимое для работы SDK.
Функция определения состояния разрешения/запрета отправки информации о транспортном трафике на сервер.
TrafficControl
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
TrafficControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
TrafficControl
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
TrafficControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол пробок. Представляет из себя кнопку, при нажатии на которую переключается видимость пробок на карте. На контроле в виде текста отображается пробочный бал, который так же влияет на цвет: зеленый - низкий уровень пробок, желтный - средний, красный - высокий. В зависимости от состояние меняется внешний вид контрола, подробнее см. TrafficControlStatus.
TrafficControlModel
Модель контрола пробок.
Этот интерфейс является потокобезопасным.
fun onClicked(): Unit
Действие при нажатии на контрол. Переключает видимость пробок на карте.
Состояние контрола пробок.
Состояние контрола пробок.
TrafficControlState
Состояние контрола пробок.
TrafficControlState(status: TrafficControlStatus = TrafficControlStatus.HIDDEN, score: Int?)
Состояние контрола пробок.
Статус, в зависимости от которого меняется внешний вид контрола.
Балл пробок. Отображается в виде надписи на контроле. Если отсутствует, отображается иконка-заглушка.
TrafficLineControl
Контрол, отображающий уровень пробок вдоль маршрута.
TrafficLineControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контрол, отображающий уровень пробок вдоль маршрута.
TrafficLinePointObject
TrafficLinePointObjectView
TrafficLinePointObjectView(
context: Context,
pointObject: TrafficLinePointObject,
position: PointObjectsPosition
)
fun removeWithAnimation(): Unit
TrafficRoute
TrafficRouter
Интерфейс для поиска маршрута с учетом пробочных данных.
fun findRoute(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: List<RouteSearchPoint> = listOf()
): Future<List<TrafficRoute>>
Ищет маршрут по заданным параметрам.
Начальная точка маршрута
Конечная точка маршрута
Параметры поиска маршрута
Промежуточные точки для проезда в том же порядке, в котором точки заданы в векторе
Future с набором найденных маршрутов, либо исключением NativeException в случае ошибки.
Пустой набор маршрутов является валидным результатом - это означает, что маршрут, соответствующий указанным критериям поиска, не может быть найден.
При поиске маршрутов для грузового транспорта возможен возврат маршрутов, проходящих через пропускные зоны, для которых не были предоставлены пропуска, в случае, если не удалось проложить маршрут только через пропускные зоны, для которых пропуска были предоставлены. Для проверки того, достаточен ли список пропусков для проезда по маршруту, следует использовать функцию route_matches_truck_pass_zone_passes.
fun findBriefRouteInfos(searchPoints: List<BriefRouteInfoSearchPoints>, routeSearchOptions: RouteSearchOptions): Future<List<BriefRouteInfo?>>
Ищет базовую информацию о маршрутах для соответствующего набора поисковых точек.
Набор точек для поиска базовой информации о маршруте.
Future с базовой информацией о наборе маршрутов, соответствующему набору точек поиска, либо исключением NativeException в случае ошибки.
Если базовая информация для каких-либо из пар точек не будет найдена, элемент с соответствующим индексом в возвращённом результате будет иметь значение null.
Возвращает список всех поддерживаемых пропусков, разрешающих движение грузового транспорта в пределах пропускных зон.
TrafficScore
Величина пробок.
TrafficScore(state: TrafficScoreState = TrafficScoreState.PENDING, value: Int?)
Величина пробок.
Актуальность значения.
Значение в баллах. Как правило, значения находятся в диапазоне от 1 до 10. Пустое значение, если информация ещё не получена, либо уже устарела, либо недоступна для заданного местоположения.
TrafficScoreProvider
Подписка на обновления информации о величине пробок.
Этот интерфейс является потокобезопасным.
TrafficScoreProvider(map: Map)
Функция создания объекта для слежения за величиной пробок в области видимости карты.
карта для которой будет отслеживаться область видимости.
Текущее состояние и величина пробок.
Текущее состояние и величина пробок.
TrafficSource
TrafficSpeedColorRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TrafficSpeedColorRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TrafficSpeedColorRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
TrafficSpeedColorRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TrafficSpeedColorRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TrafficSpeedColor
)
Протяженный элемент маршрута - отрезок и значение на нем.
TransportTypeRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TransportTypeRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TransportTypeRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
TransportTypeRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TransportTypeRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TransportType
)
Протяженный элемент маршрута - отрезок и значение на нем.
TruckPassZoneId
Идентификатор пропускной зоны для грузовиков. Значение 0 соответствует отсутствию пропускной зоны.
TruckPassZoneId(value: Int = 0)
Идентификатор пропускной зоны для грузовиков. Значение 0 соответствует отсутствию пропускной зоны.
TruckPassZoneIdRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): TruckPassZoneIdRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<TruckPassZoneIdRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
TruckPassZoneIdRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
TruckPassZoneIdRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: TruckPassZoneId
)
Протяженный элемент маршрута - отрезок и значение на нем.
TruckPassZonePass
Пропуск, разрешающий движение грузового транспорта в пропускных зонах
TruckPassZonePass(
id: TruckPassZonePassId,
name: String,
passZoneIds: Set<TruckPassZoneId>
)
Пропуск, разрешающий движение грузового транспорта в пропускных зонах
Идентификатор пропуска
Название пропуска
Идентификаторы пропускных зон, по которым разрешает движение данный пропуск
TruckPassZonePassId
Идентификатор пропуска, разрешающего движение грузового транспорта в пропускных зонах.
TruckPassZonePassId(value: Int = 0)
Идентификатор пропуска, разрешающего движение грузового транспорта в пропускных зонах.
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
)
Параметры поиска маршрута на грузовом транспорте. При поиске маршрута учитываются только заполненные параметры.
Параметры поиска маршрута, общие с прочими автомобильными.
Длина грузового транспортного средства в миллиметрах.
Высота грузового транспортного средства в миллиметрах.
Ширина грузового транспортного средства в миллиметрах.
Фактическая масса грузового транспортного средства в килограммах.
Разрешённая максимальная масса грузового транспортного средства в килограммах.
Нагрузка на ось в килограммах.
Признак наличия опасного груза.
Признак наличия взрывчатых веществ в грузе.
Идентификаторы имеющихся у пользователя пропусков, требующихся для движения в пределах пропускных зон.
Использование автоматического фоллбека с поиска грузового маршрута на поиск автомобильного маршрута при невозможности найти грузовой маршрут, удовлетворяющий параметрам поиска.
UIMarkerInfo
Идентификатор объекта с подписью.
UIMarkerInfo(objectId: DgisObjectId, label: String?)
Идентификатор объекта с подписью.
UIntRouteLongAttribute
Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.
fun entry(point: RoutePoint): UIntRouteLongEntry?
Элемент, в который попадает заданная точка.
fun entries(begin: RoutePoint, end: RoutePoint): List<UIntRouteLongEntry>
Элементы, чистично или полностью покрываемые отрезком begin,end.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
UIntRouteLongEntry
Протяженный элемент маршрута - отрезок и значение на нем.
UIntRouteLongEntry(
point: RoutePoint,
length: RouteDistance,
value: Int
)
Протяженный элемент маршрута - отрезок и значение на нем.
VendorConfig
Переопределение конфигурации SDK.
VendorConfig()
fun match(
none: Function0<T>,
fromAsset: Function1,
fromFile: Function1,
fromString: Function1
): T
fun toString(): String
fun hashCode(): Int
VendorConfigFromAsset
Переопределение настроек SDK через указание пути к ассету Android-приложения.
VendorConfigFromAsset(path: String)
Переопределение настроек SDK через указание пути к ассету Android-приложения.
Путь относительно корневой директории asset-ов.
VendorConfigFromFile
Переопределение настроек SDK через указание пути к файлу на файловой системе устройства.
VendorConfigFromFile(path: String)
Переопределение настроек SDK через указание пути к файлу на файловой системе устройства.
Путь к файлу.
VendorConfigFromString
Переопределение настроек SDK через указание содержимого файла.
VendorConfigFromString(contents: String)
Переопределение настроек SDK через указание содержимого файла.
Содержимое файла переопределения настроек.
Voice
Голосовой пакет с озвучкой навигатора.
Получение голоса для использования в навигаторе.
Язык озвучки в формате ISO 639-1.
VoiceManager
Интерфейс для взаимодействия со списком голосовых пакетов навигатора.
Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
Канал со списком всех известных голосовых пакетов. Обновляется в случае изменения информации о хотя бы об одном из голосов, либо об изменении состава списка. Содержимое канала является подмножеством общего списка пакетов. Во избежание рассинхронизации описаний пакетов, не следует использовать данные, получаемые одновременно из нескольких каналов, содержащих подмножества общего списка пакетов.
VoiceSelector
Управляет голосовыми пакетами в текущей сессии навигатора.
Голосовой пакет, с помощью которого воспроизводятся голосовые оповещения в текущей сессии навигатора.
VoidRouteAttribute
Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.
fun entries(begin: RoutePoint, end: RoutePoint): List<RoutePoint>
Элементы, попадающие в отрезок [begin, end).
fun findNearBackward(point: RoutePoint): RoutePoint?
Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.
fun findNearForward(point: RoutePoint): RoutePoint?
Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.
Количество элементов.
Элементы отсутсвуют.
Первый элемент.
Последний элемент.
Все элементы.
WeekTime
Временной момент внутри недели.
WeekTimeInterval
Интервал времени в течение недели.
WorkStatus
Статус работы.
WorkTimeFilter
Фильтр по времени работы объекта. Либо открыт сейчас, либо открыт на конкретные дата и время.
fun match(workTime: Function1, isOpenNow: Function1): T
fun toString(): String
fun hashCode(): Int
ZIndex
Индекс, задающий порядок отрисовки объектов в рамках слоя.
Zoom
Zoom-уровень.
Zoom = 0 это такой масштаб, при котором весь мир вписан в квадрат 256x256 логических пикселей (см. LogicalPixel) Zoom = 1 это такой масштаб, при котором весь мир вписан в квадрат 512x512 логических пикселей Масштаб пропорционален величине 2^Zoom.
Zoom не может быть отрицательным.
Zoom(value: Float = 0.0f)
Zoom-уровень.
Zoom = 0 это такой масштаб, при котором весь мир вписан в квадрат 256x256 логических пикселей (см. LogicalPixel) Zoom = 1 это такой масштаб, при котором весь мир вписан в квадрат 512x512 логических пикселей Масштаб пропорционален величине 2^Zoom.
Zoom не может быть отрицательным.
ZoomControl
Контейнер с контролами увеличения и уменьшения уровня масштабирования.
ZoomControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контейнер с контролами увеличения и уменьшения уровня масштабирования.
ZoomControl
Контейнер с контролами увеличения и уменьшения уровня масштабирования.
ZoomControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Контейнер с контролами увеличения и уменьшения уровня масштабирования.
ZoomControlModel
Модель контрола зумирования. Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты. При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной. Методы объекта необходимо вызывать на одном потоке.
fun isEnabled(button: ZoomControlButton): StatefulChannel<Boolean>
fun setPressed(button: ZoomControlButton, value: Boolean): Unit
ZoomFollowSettings
Интерфейс, позволяющий управлять настройками масштабирования карты во время ведения.
Во время ведения масштаб зависит от скорости движения, от наличия манёвров впереди и позади на маршруте и от типа дороги.
При отсутствии манёвров впереди и позади, либо на дорогах низкого значения (неглавные улицы населённых пунктов, шоссе, междугородние или федеральные трассы) значение масштаба выбирается на основании значений SpeedRangeToStyleZoom, которые хранятся в последовательности speed_range_to_style_zoom_sequence. Последовательность speed_range_to_style_zoom_sequence должна содержать интервалы скоростей, отсортированные по возрастанию значений min_speed, при этом должны выполняться условия: max_speedi > min_speedi+1
max_speedi < max_speedi+1. То есть интервалы скоростей должны соприкасаться или даже пересекаться, но значение скорости не должно попадать более чем в два интервала. При этом минимальное значение скорости не считается попадающим в интервал, т.е. одно и то же значение скорости может находиться быть максимальной скоростью для одного интервала, минимальной скоростью для другого и находиться внутри интервала для третьего интервала. Исключение - первый интервал скоростей, который должен содержать значение min_speed == 0.
Масштаб карты выбирается из последовательности speed_range_to_style_zoom_sequence по алгоритму:
При приближении к маневру на текущей скорости масштаб будет плавно увеличиваться. Время увеличения зависит от скорости и расстояния до манёвра. При увеличении скорости время анимации увеличивается, при снижении скорости - уменьшается. Увеличение уровня зума завершается на некотором расстоянии до манёвра.
После проезда манёвра уровень зума плавно уменьшается.
Последовательность интервалов скоростей и соответствующих им масштабов. Используется для автоматического изменения масштаба в навигаторе в зависимости от скорости.
Длительность плавного изменения масштаба в режиме ведения при изменении скорости при отсутствии манёвров впереди/позади на достаточно близком расстоянии, либо на дорогах низкого значения.
Длительность плавного увеличения уровня зума при приближении к манёвру. Используется только если скорость ниже, чем в get_min_speed_to_consider_in_zoom_in_before_maneuver_animation.
Длительность плавного уменьшения уровня зума после проезда манёвра.
Минимальная скорость движения в м/с, при которой длительность плавного изменения уровня зума будет рассчитываться с учётом не только близости к манёвру, но и с учётом текущей скорости. Должна быть не меньше 0.1 м/с, значения меньше будут игнорироваться.
Коэффициент ускорения анимации увеличения уровня зума при приближении к манёвру. Должен быть не меньше 1, значения меньше будут игнорироваться.
Расстояние до манёвра, при достижении которого анимация плавного увеличения уровня зума должна быть завершена, чтобы во время манёвра зум не менялся. Например, если до маневра 300 м, то анимация с плавным увеличением уровня зума должна быть завершена за 50 м до начала маневра. Должно быть не меньше 1 м, значения меньше будут игнорироваться.
Минимальное время анимации. Используется для предотвращения резких изменений уровня зума при анимации. Должно быть не меньше 200, значения меньше будут игнорироваться.