dgis
library
Classes
AddEventResult
Результат добавления события (объект события или ошибка).
Address
Адрес в виде набора отдельных компонентов.
AddressAdmDiv
Объект административного деления.
AddressComponent
Компонент адреса: улица, номер дома или словесное описание местоположения.
AddressLocation
Применяется для компонентов, которые тяжело описать конкретным адресом.
AddressNumber
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
AddressStreet
Обычный адрес, есть улица и номер дома.
Aggregate
Обобщенное описание станции зарядки автомобилей.
Anchor
Точка привязки изображения
(0, 0) - левый верхний угол, (1, 1) - правый нижний
AnimationSettings
Настройки анимаций объектов карты.
Применяются для слоев стилей, в которых указан источник модели.
Например, такими слоями являются слои с типами "3D model" и "Directional model".
ApartmentRange
Диапазон квартир.
Attribute
Дополнительный атрибут.
Пример:
{
tag: "hotel_room_internet",
name: "Бесплатный интернет в номерах"
}
Attributes
Интерфейс для управления свойствами объекта карты.
AttributeValue
Свойства объектов карты.
AuthorInfo
Информация об авторе события или фотографии.
AutomaticAppearance
Использовать автоматически переключающуюся светлую и тёмную тему.
BaseCamera
Камера.
BaseMapWidgetState <T extends StatefulWidget >
Базовый класс для реализации стейта виджетов управления картой.
Предоставляет доступ к объекту карты sdk.Map .
Виджет, использующий этот класс как базовый для своего State , должен быть помещен
в child виджета MapWidget , в ином случае будет брошено исключение при использовании.
Bearing
Угол между направлением на один объект и на другой объект, либо между направлением на объект и север.
Угол отсчитывается по часовой стрелке. Диапазон значений 0°, 360°
.
BearingFollowController
Контроллер слежения за направлением карты.
Borders
Описывает набор непрерывного упорядоченных значений.
BuildingId
Идентификатор здания.
BuildingInfo
Информация о здании.
BuildingLevels
Информация об этажных планах здания.
Camera
Камера для запуска перемещения карты и настроек слежения.
CameraBehaviour
Режим слежения камеры.
CameraBehaviourChange
Изменение режима слежения.
CameraMoveController
Класс, позволяющий управлять положением камеры для нужд анимации
CameraPosition
Позиция камеры.
CameraPositionChange
Описание изменения части параметров позиции камеры.
CameraPositionPoint
Относительная экранная позиция точки, к которой привязана камера.
CameraPurposeEnumSet
CameraZoomRestrictions
Допустимый диапазон изменения уровня масштабирования.
CancelEvent
Событие отмены текущего действия.
ChargingStation
Аттрибуты для электрозаправок.
CheckableGroupedItem
Единичный элемент из GroupCheckableItem.
CheckableItem
Базовое представление отмечаемого элемента из CheckableItemsGroup.
CheckableItemsGroup
Виджет для представления группы отмечаемых элементов.
Checkbox
Виджет-чекбокс.
Circle
Окружность.
CircleOptions
Параметры для создания геометрического объекта карты типа "Окружность".
ClusterObject
Кластер объектов.
ClusterOptions
Параметры маркера кластера.
Color
Цвет
CompassControlModel
Модель контрола компаса.
Контрол состоит из кнопки компаса, при нажатии на которую
камера карты меняет угол в направлении севера.
Если камера карты смотрит на сервер, то контрол необходимо скрывать.
Потокобезопасно.
CompassWidget
Виджет управления компасом.
CompassWidgetColorScheme
ComplexGeometry
Составная геометрия, состоит из набора простых или составных геометрий.
Connector
ContactInfo
Способ связаться с организацией.
Context
Контекст - окружение, необходимое для работы SDK.
CoordinatesFollowController
Контроллер слежения за координатами позиции карты.
CustomFollowController
Интерфейс, который можно реализовать на платформе для создания собственного контроллера слежения за параметрами
Для добавления контроллера в камеру, нужно реализовать этот интерфейс и создать объект FollowController'а передав
в качестве аргумента объект, реализующий данные интерфейс.
DashedPolylineOptions
Параметры пунктирной полилинии.
DashedStrokeCircleOptions
DayTime
Момент времени внутри дня.
DefaultAppearance
Использовать тему по умолчанию.
DefaultRasterUrlTemplate
DeviceDensity
Множитель, который вычисляется как отношение DPI к базовому DPI устройства.
DevicePpi
Разрешающая способность дисплея устройства, в пикселях на дюйм.
DGis
Точка входа в 2GIS SDK.
На старте работы необходимо вызвать initialize.
DgisMapObject
Объект карты 2GIS.
DgisObjectId
DgisSearchWidget
Виджет, представляющий собой поисковую строку и лист выдачи объектов
или подсказок.
DgisSource
Основной интерфейс источников данных 2ГИС.
DirectMapControlBeginEvent
Событие начала прямого управления картой.
Сообщает карте, что необходимо обрабатывать события прямого управления картой.
События прямого управления работают только от DirectMapControlBeginEvent до DirectMapControlEndEvent.
После завершения последовательности событий прямого управления может запуститься кинематика.
Кинематика использует время возникновения события, поэтому лучше использовать время, полученное от системы,
а не заполнять значение при обработке.
Пока кинематика работает только для перемещения карты, но не для вращения и масштабирования.
DirectMapControlEndEvent
Событие окончания прямого управления картой.
Завершает прямое управление картой, начатое после получения события DirectMapControlBeginEvent.
О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapRotationEvent
Событие прямого вращения карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
DirectMapScalingEvent
Событие прямого масштабирования карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
DirectMapShiftEvent
Событие прямого сдвига карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
DirectMapTiltEvent
Событие прямого наклона камеры. События прямого управления картой описаны в DirectMapControlBeginEvent.
DirectoryFilter
Фильтры для справочника.
DirectoryObject
Объект справочника.
DragBeginData
Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.
DynamicFilter
Динамические фильтры поисковой выдачи.
Either <L , R >
Elevation
Неотрицательная высота точки над поверхностью в метрах.
EntranceGeometry
Геометрии для отображения входа на карте.
EntranceInfo
Информация о входе в здание.
Event
Базовый класс для всех обрабатываемых событий.
EventsProcessingSettings
File
Идентификатор файла.
FlagFilter
Фильтр - флаг.
FloorInfo
Информация об этажном плане для маркера - элемента поисковой выдачи.
FollowController
Класс, позволяющий управлять положением камеры.
Реализации всех его методов должны быть потокобезопасны. У большинства
методов есть тривиальные реализации по умолчанию (таким образом
FollowController, отвечающий за масштаб, не обязан переопределять методы
coordinates() и т.п.).
Один контроллер может быть единомоментно добавлен только в одну карту.
FollowPosition
Настройки слежения за позицией.
FollowValueEnumSet
FormattedAddress
Человекочитаемое представление адреса.
Fps
Frames per second, частота кадров.
Geometry
Объект геометрии.
GeometryMapObject
Геометрический объект карты.
GeometryMapObjectBuilder
Класс для установки свойств и последующего создания геометрических объектов.
GeometryMapObjectSource
Источник геометрических объектов карты.
GeometryMapObjectSourceBuilder
GeoPoint
Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84)
указывает на точку на поверхности Земли.
Данная структура не привязана к конкретной геодезической системе координат.
Но данный модуль содержит свободные функции, которые оперируют данной структурой уже
в конкретной в системе координат (в какой именно см. в документации к функциям).
GeoPointWithElevation
Точка в географической системе координат (широта, долгота, возвышение).
GeoRect
Прямоугольная область в сферической системе координат (например, WGS84).
Данная структура не привязана к конкретной геодезической системе координат.
GestureEnumSet
GestureManager
Класс для управления обработкой жестов.
GradientPolylineOptions
Параметры градиентной полилинии.
GroupCheckableItem
Набор отмечаемых элементов, работающих как радио-группа.
HeadingAvailableNotifier
Интерфейс объекта, который сообщает об изменении доступности источника направления.
HeadingNotifier
Интерфейс объекта на обновление текущего направления.
HeadingProvider
Интерфейс, предоставляющий направление устройства относительно направления на север,
который реализуется на платформе.
HttpCacheManager
Интерфейс управления HTTP-кешем.
HttpOptions
Опции Http-клиента.
Image
Изображение.
ImageData
Данные изображения: размер, формат и бинарные данные.
ImageLoader
Класс для загрузки изображений.
IncompleteTextHandler
Предложено автодополнение для введенного пользователем текста.
IndoorBuilding
Здание с этажными планами.
IndoorControlModel
Модель элемента управления этажами.
IndoorManager
Класс для получения текущего здания с этажными планами.
IndoorWidget
IndoorWidgetColorScheme
InputEvent
Событие пользовательского ввода.
IsOpenNow
Открыто сейчас.
ItemMarkerInfo
Идентификатор объекта и его координаты.
KeyFromAsset
Ключ из asset-а.
Для Android это директория assets.
Для iOS это директория Bundle.main.
KeyFromFile
Ключ из файла.
KeyFromString
Ключ из строки.
KeySource
Источник ключа.
LaneEnumSet
Latitude
Географическая широта.
Left <L , R >
LevelId
Идентификатор этажного плана.
LevelInfo
Информация об этаже здания.
Locale
Локаль.
LocaleManager
Менеджер региональных настроек приложения.
Location
Геопозиция.
LocationAvailableNotifier
Интерфейс объекта, который сообщает об изменении доступности источника геопозиции.
LocationCoordinates
LocationCourse
LocationFuzzyDouble
LocationNotifier
Интерфейс объекта, который сообщает об обновлении геопозиции.
LocationProvider
Интерфейс источника геопозиции, который реализуется пользователем на платформе.
LocationService
Класс для работы с установленным при инициализации SDK источником.
LogicalPixel
Пиксель, размер которого не зависит от плотности экрана.
LogMessage
Сообщение, записываемое в лог.
LogOptions
Настройки логирования.
LogSink
Приемник логирования.
Longitude
Географическая долгота.
Map
Карта.
MapAppearance
Внешний вид карты в зависимости от окружения.
MapDirection
Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.
MapId
Идентификатор экземпляра карты, уникальный в рамках процесса.
MapObject
Объект на карте.
MapObjectManager
MapOptions
Параметры карты.
MapRotationBeginEvent
Событие начала вращения карты вокруг точки.
MapRotationEndEvent
Событие окончания вращения карты вокруг точки.
MapScalingBeginEvent
Событие начала изменения масштаба.
MapScalingEndEvent
Событие окончания изменения масштаба.
MapShiftBeginEvent
Событие начала сдвига карты.
MapShiftEndEvent
Событие окончания смещения карты.
MapTheme
Тема для использования в карте.
MapWidget
Widget для работы с картой.
MapWidgetColorScheme
Класс позволяет задать цветовую схему виджета карты.
Может иметь любые поля и их значения, необходимые контролу для определения
своей цветовой схемы.
MapWidgetController
Контроллер для работы с картой.
MarkedUpText
Размеченный текст.
MarkedUpTextSpan
Описывает поднабор байтов строки text.
Marker
Точечная отметка на карте, представляющая интерес для пользователя.
MarkerOptions
Параметры маркера.
Meter
Длина/расстояние в метрах.
MultiTouchShiftSettings
Настройки обработки сдвига при касании несколькими пальцами.
MyLocationControllerSettings
Настройки контроллера перемещения маркера геопозиции.
MyLocationControlModel
Модель контрола перелета к местоположению пользователя.
Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя.
Если местоположение не определено, ничего не происходит.
Методы объекта необходимо вызывать на одном потоке.
MyLocationMapObject
Маркер геопозиции.
MyLocationMapObjectSource
Источник, содержащий маркер геопозиции.
MyLocationWidget
Виджет для изменения режима слежения за геопозицией,
направлением (bearing), и осуществления перелета к текущему местоположению.
MyLocationWidgetColorScheme
NewValuesNotifier
Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.
Opacity
Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность).
OpeningHours
Часы работы организации.
OrderedValue
Описывает одно значение из набора.
OrderedValues
Описывает набор дискретных упорядоченных значений.
PackedMapState
Сериализованное состояние карты.
PackedSearchQuery
Вспомогательный объект для сериализации и десериализации поискового запроса.
Padding
Отступы от краёв камеры.
Page
Страница результатов поиска.
ParkingCapacity
Вместимость парковки.
ParkingControlModel
Модель контрола парковок.
ParkingInfo
Общая информация о парковке.
PerformSearchHandler
Предложено поискать определенный набор объектов.
PlatformHeading
Информация о направлении устройста, которую отдает платформа.
PointGeometry
Точка.
PointGeometryData
Данные геометрии точечного объекта.
Polygon
Полигон на карте.
PolygonGeometry
Полигон.
PolygonOptions
Параметры полигона.
Polyline
Ломаная линия на карте.
PolylineGeometry
Ломаная линия.
PolylineOptions
Параметры полилинии.
Projection
Проекция.
PurposeCode
Код назначения здания.
Range
Описывает набор непрерывных или дискретных упорядоченных значений.
RangeFilter
Фильтр диапазонов значений.
RangeWidget
Виджет для представления непрерывного или дискретного набора упорядоченных значений.
RasterTileSource
Источник, получающий растровые тайлы.
RasterUrlTemplate
Remover
Объект для удаления пользовательского контента.
RenderedObject
Отображаемый объект карты.
RenderedObjectInfo
Подробная информация об отображаемом объекте карты.
Reviews
Отзывы.
Right <L , R >
RoadCameraInfo
Информация о камере.
RoadEvent
Дорожное событие.
RoadEventAction
Действие события.
RoadEventActionInfo
Информация о действии.
RoadEventDisplayCategoryEnumSet
RoadEventManager
Объект для создания транспортных событий.
RoadEventMapObject
Объект карты "Дорожное событие".
RoadEventPhoto
Фотография дорожного события.
RoadEventSource
Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.
RotateMapToNorthEvent
Событие поворота карты на север.
RotationSettings
Настройки обработки вращения карты.
RoundedCorners
RubricId
Идентификатор рубрики.
ScaleMapEvent
Событие изменения масштаба карты.
ScalingSettings
Schedule
Расписание действия дорожного события.
ScreenDistance
Расстояние между объектами на экране в миллиметрах.
ScreenPoint
Точка в экранных координатах.
ScreenShift
Смещение карты по горизонтали и вертикали в координатном пространстве экрана.
ScreenSize
Размер в пикселях.
SearchManager
Поисковик.
Основная точка входа для справочного API.
SearchQuery
Поисковый запрос.
SearchQueryBuilder
Построитель поисковых запросов.
Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов,
где сегмент - это некоторый кусок разбиения глобальной карты.
Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):
SearchResult
Результат работы поисковика.
SimpleCheckableItem
Простой отмечаемый элемент из CheckableItemsGroup.
SimpleClusterObject
Кластер простых (simple) объектов-маркеров.
SimpleClusterOptions
Параметры маркера кластера простых (simple) объектов-маркеров.
SimpleClusterRenderer
Класс для кастомизации внешнего вида кластера в IMapObjectManager.
SimpleMapObject
Объект на карте, для которого можно задавать видимость.
SortingFilter
Фильтр сортировки.
Source
Источник данных на карте.
SpecialSpace
Особое место для парковки.
Style
Стиль с набором свойств объектов карты (cм. ISource).
StyleBuilder
Конструктор стилей.
StyleLayerId
Идентификатор слоя стиля.
StyleZoom
Стилевой уровень масштабирования.
StyleZoomFollowController
Контроллер слежения за стилевым уровнем масштабирования карты.
StyleZoomToTiltRelation
Объект для описания зависимости угла наклона камеры от стилевого уровня масштабирования.
Suggest
Поисковая подсказка.
SuggestHandler
Обработчик выбора подсказки.
SuggestObjectHandler
Предложен конкретный объект справочника.
SuggestQuery
Запрос поисковой подсказки.
SuggestQueryBuilder
Построитель запросов к подсказчику.
SuggestResult
Результат работы подсказчика.
SystemMemoryManager
Интерфейс управления использованием системной памяти.
TextStyle
Настройки внешнего вида текста.
ThemedMapControllingWidget <T extends MapWidgetColorScheme >
Базовый класс для реализации виджетов карты, способных изменять цветовую схему
в зависимости от признака colorMode темы карты MapTheme.
Должен использоваться совместно с ThemedMapControllingWidgetState.
ThemedMapControllingWidgetState <T extends ThemedMapControllingWidget <S > , S extends MapWidgetColorScheme >
Базовый класс для реализации стейта виджетов управления картой, подверженным
изменениям цветовой схемы в течение жизненного цикла.
Помимо объекта sdk.Map, предоставляет доступ к теме карты MapTheme , а также реагирует на
ее изменения для того, чтобы синхронно обновлять цветовую схему.
Виджет, использующий этот класс как базовый для своего State, должен быть помещен
в child виджета MapWidget . В ином случае будет брошено исключение при использовании.
Tilt
Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.
TiltFollowController
Контроллер слежения за углом наклона карты.
TiltSettings
TouchEventsObserver
Класс для обработки жестов карты.
TradeLicense
Лицензия организации.
TrafficControlModel
Модель контрола пробок.
TrafficControlState
Состояние элемента управления видимостью пробок.
TrafficScore
Оценка пробок.
TrafficScoreProvider
Подписка на обновления информации о величине пробок.
TrafficSource
Интерфейс класса, управляющего отображением пробок на карте.
TrafficWidget
Виджет, отображающий пробочный балл в регионе и переключающий отображение
пробок на карте.
Может использоваться только как child в MapWidget на любом уровне вложенности.
TrafficWidgetColorScheme
UIMarkerInfo
Идентификатор объекта с подписью.
UniversalAppearance
Использовать единую тему текущего стиля в любом окружении.
VendorConfig
Переопределение конфигурации SDK.
VendorConfigFromAsset
Переопределение настроек SDK через указание пути к asset-у приложения.
Для Android это директория assets.
Для iOS это директория Bundle.main.
VendorConfigFromFile
Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.
VendorConfigFromString
Переопределение настроек SDK через указание содержимого файла.
WeekTime
Момент времени внутри недели.
WeekTimeInterval
Интервал времени в течение недели.
Widget
Базовый класс, представляющий виджет для фильтрации поисковой выдачи.
WidgetShadows
WmsRasterUrlTemplate
WorkStatus
Статус работы.
WorkTimeFilter
Фильтр по времени работы объекта.
Либо открыт сейчас, либо открыт на конкретные дата и время.
ZIndex
Индекс, задающий порядок отрисовки объектов в рамках слоя.
Zoom
Уровень масштабирования.
ZoomControlModel
Модель контрола зумирования.
Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты.
При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной.
Методы объекта необходимо вызывать на одном потоке.
ZoomWidget
Виджет карты, предоставлящий элементы для управления зумом.
Может использоваться только как child в MapWidget на любом уровне вложенности.
ZoomWidgetColorScheme
Цветовая схема для ZoomWidget .
Functions
calcPositionForGeometry (BaseCamera camera , Geometry geometry , StyleZoomToTiltRelation ? styleZoomToTiltRelation , Padding ? screenArea , Tilt ? tilt , Bearing ? bearing , ScreenSize ? size )
→ CameraPosition
calcPositionForObjects (BaseCamera camera , List <SimpleMapObject > objects , StyleZoomToTiltRelation ? styleZoomToTiltRelation , Padding ? screenArea , Tilt ? tilt , Bearing ? bearing , ScreenSize ? size )
→ CameraPosition
containsPoint (GeoRect rect , GeoPoint point )
→ bool
containsRect (GeoRect rect1 , GeoRect rect2 )
→ bool
createDefaultMaxTiltRestriction ()
→ StyleZoomToTiltRelation
Получаем стандартную зависимость максимального угла наклона от стилевого уровня масштабирования.
createDefaultStyleZoomToTiltRelation ()
→ StyleZoomToTiltRelation
Получение зависимости угла наклона камеры от стилевого уровня масштабирования
для стандартного контроллера слежения за наклоном.
createStyleZoomToTiltRelation (Map <StyleZoom , Tilt > points )
→ StyleZoomToTiltRelation
Создаем зависимость угла наклона камеры от стилевого уровня масштабирования.
expandPoint (GeoRect rect , GeoPoint point )
→ GeoRect
expandRect (GeoRect rect1 , GeoRect rect2 )
→ GeoRect
getHttpCacheManager (Context context )
→ HttpCacheManager ?
Интерфейс управления HTTP-кешем. Null, если HTTP кэш не используется.
getLocaleManager (Context context )
→ LocaleManager
Интерфейс управления локалями приложения.
getSystemMemoryManager (Context context )
→ SystemMemoryManager
Получение объекта для управления использованием системной памяти.
isGeoPointValid (GeoPoint geoPoint )
→ bool
isGeoRectValid (GeoRect geoRect )
→ bool
parseGeoJson (String geoJsonData )
→ List <GeometryMapObject >
parseGeoJsonFile (String fsPath )
→ List <GeometryMapObject >
projectionZToStyleZ (Zoom projectionZ , Latitude latitude )
→ StyleZoom
styleZToProjectionZ (StyleZoom styleZ , Latitude latitude )
→ Zoom
zoomOutToFitForGeometry (BaseCamera camera , Geometry geometry , [StyleZoomToTiltRelation ? styleZoomToTiltRelation = null , ScreenSize ? size = null ])
→ CameraPosition
zoomOutToFitForObjects (BaseCamera camera , List <SimpleMapObject > objects , [StyleZoomToTiltRelation ? styleZoomToTiltRelation = null , ScreenSize ? size = null ])
→ CameraPosition
dgis_mobile_sdk_map 12.2.0