interface
AudioDriver
Интерфейс для реализации аудио драйвера на платформе.
available(): boolean
Доступно ли на текущий момент аудиоустройство приложению.
play(): void
Запускает воспроизведение звукового потока.
После вызова этого метода должна начать вызываться функция обратного вызова, если она установлена в методе set_reader.
Если функция обратного вызова вернет 0 записанных байт, воспроизведение звукового потока можно остановить.
setAvailableCallback(callback: AvailableCallback): void
Устанавливает функцию обратного вызова на сигнал о смене доступности аудиоустройства приложению.
Повторный вызов данного метода перезаписывает сохраненную ранее функцию обратного вызова.
setReader(reader: AudioStreamReader): void
Устанавливает функцию обратного вызова, которую вызывает аудиодрайвер для загрузки данных.
Повторный вызов данного метода перезаписывает сохраненную ранее функцию обратного вызова.
CameraMoveController
Класс, позволяющий управлять положением камеры для нужд анимации
Класс должен быть потокобезопасным.
animationTime(): Duration
Продолжительность анимации в миллисекундах.
Продолжительность анимации в миллисекундах.
position(time: Duration): CameraPosition
Позиция области просмотра в конкретный момент времени. Контроллер должен быть готов к тому, что время анимации будет передаваться в любом порядке, не обязательно в неубывающем.
time
Время от начала анимации в миллисекундах.
Положение области просмотра в указанный момент времени.
CompassControlColors
Colors for the compass control.
backgroundColor— semi-transparent circle behind the arrow
backgroundColor
CompassControlProps
CompassControlState
CompassControlViewProps
CopyrightControlProps
alignment?
Position of the copyright logo within the map bounds. Default: 'bottomRight'.
edgeInsets?
Margins (dp) from the safe-area edges. Default: 0 on all sides.
On iOS the logo is automatically offset by safeAreaInsets, so it never
sits under a notch or home indicator; these margins are added on top of
that, the same way native iOS adds copyrightInsets inside the safe-area
frame and Android adds copyrightMargins on top of system-bar insets.
map
Map instance from mapController.map.
uriOpener?
Custom URI opener. Default: opens the URL via Linking.openURL.
CopyrightEdgeInsets
CustomFollowController
Интерфейс, который можно реализовать на платформе для создания собственного контроллера слежения за параметрами Для добавления контроллера в камеру, нужно реализовать этот интерфейс и создать объект FollowController'а передав в качестве аргумента объект, реализующий данные интерфейс.
availableValues(): EnumSet<FollowValue>
Набор видов значений, которыми умеет управлять данный контроллер.
bearing(): Bearing | null
Направление. Метод вызывается только после вызова request_values с соответствующими параметрами.
coordinates(): GeoPoint | null
Географические координаты. Метод вызывается только после вызова request_values с соответствующими параметрами.
requestValues(values: EnumSet<FollowValue>): void
С помощью этого метода в контроллер сообщается, какие из предоставляемых им значений используются. Это позволяет освободить ресурсы, связанные с вычислением неиспользуемых значений. Метод может вызываться многократно с разными значениями, в этом случае актуальным является последнее из них.
setNewValuesNotifier(notifier: NewValuesNotifier | null): void
Установка нотифаера, который оповещает о новых значениях. Нотифаер нужно сохранить в реализуемом контроллере
styleZoom(): StyleZoom | null
Стилевой уровень масштабирования карты. Метод вызывается только после вызова request_values с соответствующими параметрами.
tilt(): Tilt | null
Наклон карты. Метод вызывается только после вызова request_values с соответствующими параметрами.
HeadingProvider
Интерфейс, предоставляющий направление устройства относительно направления на север, который реализуется на платформе.
Все методы данного интерфейса должны вызываться из одного потока.
setNotifiers(headingNotifier: HeadingNotifier | null, availableNotifier: HeadingAvailableNotifier | null): void
См. методы QCompass::readingChanged для Qt, константу Sensor.TYPE_ROTATION_VECTOR и метод SensorManager.getOrientation для Android, CLLocationManagerDelegate.locationManager(didUpdateHeading) для iOS, Compass.ReadingChanged для Windows RT.
headingNotifier
availableNotifier
Интерфейс для обратного вызова на изменение доступности источника направления.
Даже если слежение за изменением направления недоступно, provider может присылать новое направление, но оно будет считаться недостоверным.
См. методы QCompass::activeChanged и QCompass::sensorError для Qt, SensorManager.registerListener для Android, CLLocationManagerDelegate.locationManager(didFailWithError) для iOS, Compass.ReadingChanged для Windows RT.
HttpClient
Интерфейс для реализации сетевого клиента на платформе.
sendRequest(request: HttpRequest, callback: HttpResponseCallback): void
Метод для обработки запроса из SDK.
request
запрос для отправки.
callback
объект с обратными вызовами для отправки и получения данных.
IndoorControlColors
Colors for the indoor levels control.
IndoorControlProps
IndoorControlState
activeLevelIndex
Index of the active floor, or null (roof / overview selected).
isLevelMarked
Whether a given floor index has a route marker.
levelNames
Floor names (empty = no indoor building visible).
onLevelSelect
Select a floor by index, or null for roof/overview.
IndoorControlViewProps
activeLevelIndex
Index of the active floor, or null (roof selected).
colors?
Override default colors.
isLevelMarked
Whether a given floor index has a route marker.
levelNames
Floor names (empty = not rendered).
onLevelSelect
Select a floor by index, or null for roof/overview.
showOverview?
Show the roof/building overview button at the top. Default: true.
LocationProvider
Интерфейс источника геопозиции, который реализуется на платформе.
Все методы данного интерфейса должны вызываться из одного потока.
lastLocation(): Location | null
Наилучшая известная на текущий момент геопозиция. Если известная на текущий момент геопозиция отсутствует или не предоставляется API платформы - метод вернет null.
Возвращаемая данным методом геопозиция может быть недостоверной (см. set_notifiers()).
Этот метод должен запросить у системы наилучшую известную на текущий момент геопозицию и вернуть её даже если она является устаревшей и/или не соответствует требуемой точности.
Если API платформы не предоставляет аналогичный по функциональности метод, то данный метод всегда должен возвращать null.
См. методы QGeoPositionInfoSource::lastKnownPosition для Qt, LocationManager.getLastKnownLocation и FusedLocationProviderClient.getLastLocation для Android, CLLocationManager.location для iOS, Geolocator.GetGeopositionAsync для Windows RT.
setDesiredAccuracy(desiredAccuracy: DesiredAccuracy): void
Задает желаемую точность определения местоположения.
Если устройство не может вернуть местоположение с желаемой точностью, то оно может вернуть местоположение с меньшей точностью.
Если API платформы не предоставляет аналогичный по функциональности метод, то данный метод должен иметь пустую реализацию.
См. методы QGeoPositionInfoSource::setPreferredPositioningMethods( для Qt, LocationManager.requestLocationUpdates и FusedLocationProviderClient.requestLocationUpdates для Android, CLLocationManager.desiredAccuracy и CLLocationManager.activityType для iOS, Geolocator.DesiredAccuracy для Windows RT.
setNotifiers(locationNotifier: LocationNotifier | null, availableNotifier: LocationAvailableNotifier | null): void
Устанавливает интерфейсы для обратного вызова на обновление текущей гепозиции и изменение доступности источника геопозиции.
Повторный вызов данного метода перезаписывает предыдущие интерфейсы.
Если оба параметра равны null, то слежение за обновлением геопозиции нужно отключить.
locationNotifier
Интерфейс для обратного вызова на обновление текущей гепозиции.
Если провайдер доступен (был вызван available_notifier со значением true), то данный канал всегда возвращает достоверную геопозицию. Достоверная геопозиция - это геопозиция, в которой все поля имеют актуальное значение на момент ее отправки в этот канал (т.е. если accuracy геопозиции >= половине длины экватора Земли, то геопозиция является достоверной для любых от указанных в ней корректных координат).
Если location.coordinates.accuracy < = 0, то позиция считается недостоверной даже если available == true.
См. методы QGeoPositionInfoSource::positionUpdated для Qt, LocationManager.requestLocationUpdates и FusedLocationProviderClient.requestLocationUpdates для Android, CLLocationManagerDelegate.locationManager(didUpdateLocations) для iOS, Geolocator.PositionChanged для Windows RT.
availableNotifier
Интерфейс для обратного вызова на изменение доступности источника геопозиции. Если вызвана эта функция со значением true, то все последующие вызовы location_notifier будут содержать достоверную (актуальную) геопозицию.
Даже если слежение за изменением геопозиции недоступно, LocationProvider может присылать новую геопозицию, но она будет считаться недостоверной.
См. методы QGeoPositionInfoSource::error для Qt, LocationManager.requestLocationUpdates и FusedLocationProviderClient.requestLocationUpdates для Android, CLLocationManagerDelegate.locationManager(didFailWithError) для iOS, Geolocator.StatusChanged для Windows RT.
LogSink
Приемник логирования.
write(message: LogMessage): void
Запись в лог. Метод может вызываться на произвольном потоке.
MapControlsColors
Base color palette used to derive per-control color sets.
activeContent
Active/accent content (enabled controls). Light: #0059D6
background
Button background. Light: #FFFFFF, Dark: #141414
highAlert
High traffic score (7–10). Light: #F5373C
lowAlert
Low traffic score (1–3). Light: #1BA136
mediumAlert
Medium traffic score (4–6). Light: #EFA701
primaryContent
Enabled icon / primary content. Light: #141414, Dark: #FFFFFF
quaternaryContent
Separator / divider. Light: #DBDBDB, Dark: #373737
tertiaryContent
Disabled icon. Light: #B8B8B8, Dark: #A5A5A5
transparentBackground
Semi-transparent background (compass). Light: rgba(255,255,255,0.5)
MapViewProps
controllerState
Snapshot of the map controller lifecycle. Produce it with
useMapController(context, options) for a hook-created controller, with
readyMapController(controller) for a controller created elsewhere, or
from any state container of your own.
While the snapshot is creating, the view shows a cover painted with the
loading background of the appearance from the creation options.
copyrightAlignment?
Position of the copyright logo. Default: 'bottomRight'.
copyrightEdgeInsets?
Margins (dp) around the copyright logo, on top of safe-area insets. Default: 0 on all sides.
copyrightUriOpener?
Custom copyright URI opener. Default: opens the URL via Linking.openURL.
renderMode?
Render mode for the map on Android. Ignored on iOS. Default: 'surface'.
style?
MyLocationControlColors
Colors for the my-location control.
activeIconColor
Icon color when camera is following the user's location.
backgroundColor
backgroundIconColor
Background layer of the follow-direction icon.
disabledIconColor
Icon color when the control is disabled.
inactiveIconColor
Icon color when follow mode is off.
pressedOverlayColor
MyLocationControlProps
MyLocationControlState
MyLocationControlViewProps
RoadEventFilter
Фильтр отображаемых дорожных событий.
SearchHistoryKeyStrategy
Интерфейс, предоставляющий реализовать стратегию создания ключа для элемента истории поиска. Ключ используется для определения уникальности элемента истории поиска.
create(item: SearchHistoryItem): string
Возвращает ключ для элемента истории поиска.
SimpleClusterRenderer
Класс для кастомизации внешнего вида кластера в IMapObjectManager.
renderCluster(cluster: SimpleClusterObject): SimpleClusterOptions
Получение маркера для кластера.
StyleZoomToTiltRelation
Объект для описания зависимости угла наклона камеры от стилевого уровня масштабирования.
TrafficControlColors
Colors for the traffic control.
backgroundColor
disabledIconColor
disabledScoreColor
Score text color when traffic is disabled.
enabledIconColor
enabledScoreColor
Score text color when traffic is enabled (white on colored circle).
highScoreColor
loadingArcColor
lowScoreColor
mediumScoreColor
pressedOverlayColor
TrafficControlProps
TrafficControlStateResult
TrafficControlViewProps
ZoomControlColors
Colors for the zoom control.
backgroundColor— button backgroundseparatorColor— divider between + and −enabledIconColor— icon tint when the button is activedisabledIconColor— icon tint when zooming further is not possiblepressedOverlayColor— semi-transparent overlay shown while button is pressed