class
AnimationSettings
Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами "3D model" и "Directional model". Индекс анимации должен быть обязательно указан для анимированной модели.
new AnimationSettings()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
animationIndex
Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.
animationName
Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.
animationRepeatCount
Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.
animationSpeed
Скорость проигрывания анимации модели. Если null, то используется значение из стилей. Значения больше единицы ускоряют проигрывание, меньше замедляют. Если в стилях значение не задано, используется скорость по умолчанию.
sceneIndex
Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.
sceneName
Название текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано, используется сцена по умолчанию, которая определена в самой модели.
Attributes
Интерфейс для управления свойствами объекта карты.
Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты, для стиля и для источника (подробнее см. ISource).
new Attributes()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
getAttributeValue(name: string): AttributeValue
Получение свойства.
removeAttribute(name: string): void
Удаление свойства.
name
Имя свойства для удаления.
setAttributeValue(name: string, value: AttributeValue): void
Установка свойства.
setAttributeValues(values: [string, AttributeValue][], attributesToRemove?: string[]): void
Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.
values
Набор пар "имя":"значение" для добавляемых свойства.
attributesToRemove?
Список имён свойств, которые нужно удалить. Default: []
AudioStreamReader
new AudioStreamReader()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
read(): number[]
Описание типа функции обратного вызова, которую вызывает аудиодрайвер для чтения потока аудиоданных.
буфер, в который записывается аудиопоток.
Описание формата данных аудиопотока: Кодировка: LPCM (https://en.wikipedia.org/wiki/Pulse-code_modulation). Количество фреймов в пакете: 1. Количество семплов в фрейме: 1. Формат сэмпла: знаковое целое. Размер сэмпла: 16 бит. Количество каналов: 1. Частота дискретизации (Sample rate): 22050 семплов в секунду.
AvailableCallback
new AvailableCallback()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setAvailable(available: boolean): void
Доступность аудиоустройства приложению.
available
Признак доступности аудиоустройства приложению.
BaseCamera
Камера.
Задаёт параметры проецирования карты на экран.
new BaseCamera()
changePosition(positionChange: CameraPositionChange): void
Изменение только части параметров позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за изменёнными параметрами, а при изменении координат также и слежение за стилевым уровнем масштабирования и направлением.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
changed
Получение причин изменения состояния камеры.
Измененные свойства доступны в соответствующих каналах.
deviceDensity
Получение отношения DPI к базовому DPI устройства.
maxTiltRestriction
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
padding
Получение текущих отступов от краёв экрана.
position
Получение текущей позиции камеры.
positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
projection
Проекция.
Используется для получения точки экрана по точке карты и точки карты по точке экрана. Параметры камеры фиксируются в момент вызова.
size
Получение размера области просмотра.
viewPoint
Точка взгляда относительно полного размера вьюпорта.
viewportRestriction
Получение ограничения на область видимости.
visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
visibleRect
Объемлющий прямоугольник видимой области карты.
zoomRestrictions
Получение актуальных ограничений уровня масштабирования.
BearingFollowController
Контроллер слежения за направлением карты.
new BearingFollowController(bearingSource: BearingSource, animationDuration?: Duration, valueThreshold?: Bearing)
Создание контроллера слежения за направлением карты.
bearingSource
источник информации о направлении.
animationDuration?
неотрицательная длительность изменения реального направления. Default: Duration.ofMilliseconds(1000)
valueThreshold?
неотрицательное пороговое значение учитываемого изменения реального направления. Default: new Bearing({ value: 1.0 })
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
BufferedChannel
Channel with a buffered value. The value is null until the channel receives its first value.
new BufferedChannel()
subscribe(callback: (value: T) => void): Connection
Subscribes to the channel events.
value
Current value of the channel, or null if no value has been received yet.
Camera
Камера для запуска перемещения карты и настроек слежения.
new Camera()
addFollowController(followController: FollowController): void
Добавление контроллера слежения.
Их может быть несколько разных, например контроллер слежения за масштабом, за углом наклона карты, за геолокацией и т.д.
changePosition(positionChange: CameraPositionChange): void
Изменение только части параметров позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за изменёнными параметрами, а при изменении координат также и слежение за стилевым уровнем масштабирования и направлением.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
move(point: GeoPoint, zoom: Zoom, tilt: Tilt | null, bearing: Bearing, time?: Duration, animationType?: CameraAnimationType): Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает слежение за позицией, уровнем масштабирования и направлением и прерывает обработку жестов.
Если tilt задан, то сбрасывается слежение за наклоном.
Если tilt не задан и слежения за наклоном нет, то используется текущее значение наклона.
point
точка конечной позиции камеры
zoom
уровень масштабирования в конечной позиции камеры
tilt
наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller'а или текущее значение
bearing
поворот в конечной позиции камеры
time?
время, выделенное на перемещение карты Default: Duration.ofMilliseconds(300)
animationType?
тип анимации при перемещении камеры Default: CameraAnimationType.Default
moveToCameraPosition(position: CameraPosition, time?: Duration, animationType?: CameraAnimationType): Future<CameraAnimatedMoveResult>
Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает слежение за позицией, уровнем масштабирования, наклоном и направлением и прерывает обработку жестов.
position
Конечная позиция камеры.
time?
Время, выделенное на перемещение карты. Default: Duration.ofMilliseconds(300)
animationType?
Тип анимации при перемещении камеры. Default: CameraAnimationType.Default
moveWithController(moveController: CameraMoveController): Future<CameraAnimatedMoveResult>
Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.
moveController
Контроллер анимированного перемещения камеры.
processMovementAndStop(): void
Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, уровнем масштабирования и направлением.
removeCustomFollowController(): void
Удаление контроллера слежения, реализованного на платформе.
removeFollowController(followController: FollowController): void
Удаление контроллера слежения.
setBehaviour(behaviour: CameraBehaviour): void
Смена режима слежения камеры. Если новый режим более ограниченный, чем текущий, вызов прервёт перелёт и обработку жестов.
setCustomFollowController(followController: CustomFollowController): void
Добавление контроллера слежения, реализованного на платформе.
Можно установить только один такой контроллер. Если установить несколько контроллеров, то будет использоваться только последний установленный.
behaviour
Режим слежения камеры.
changed
Получение причин изменения состояния камеры.
Измененные свойства доступны в соответствующих каналах.
deviceDensity
Получение отношения DPI к базовому DPI устройства.
maxTiltRestriction
Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.
padding
Получение текущих отступов от краёв экрана.
position
Получение текущей позиции камеры.
positionPoint
Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).
projection
Проекция.
Используется для получения точки экрана по точке карты и точки карты по точке экрана. Параметры камеры фиксируются в момент вызова.
size
Получение размера области просмотра.
state
Получение актуального состояния камеры.
viewPoint
Точка взгляда относительно полного размера вьюпорта.
viewportRestriction
Получение ограничения на область видимости.
visibleArea
Область пересечения пирамиды видимости камеры и поверхности карты.
visibleRect
Объемлющий прямоугольник видимой области карты.
zoomRestrictions
Получение актуальных ограничений уровня масштабирования.
CameraTransactionGuard
new CameraTransactionGuard()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CancelEvent
Событие отмены текущего действия.
Вызывается, например, при отмене жеста, потере фокуса окна или при потере захвата мыши. Также может быть вызван изнутри карты при смене ограничений уровня масштабирования, некоторых изменениях режима слежения и установке интерактивного режима карты.
new CancelEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CategoriesPage
Страница результатов запроса категорий.
new CategoriesPage()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
fetchNextPage(): Future<CategoriesPage | null>
Получить следующую страницу результатов.
future, резолвящаяся в ненулевой указатель на следующую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если следующая страница отсутствует exceptional future, если произошла ошибка при получении страницы
fetchPrevPage(): Future<CategoriesPage | null>
Получить предыдущую страницу результатов.
future, резолвящаяся в ненулевой указатель на предыдущую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если предыдущая страница отсутствует exceptional future, если произошла ошибка при получении страницы
items
Категории этой страницы.
Category
Категория справочника.
new Category()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
alias
Транслитерированное название категории.
при отсутствии может быть пустой строкой.
branchCount
Количество филиалов организаций в данной категории.
caption
Короткая подпись к иконке для отображения в UI.
при отсутствии может быть пустой строкой.
children
Дочерние категории.
geoCount
Количество геообъектов в данной категории.
iconUrl
Ссылка на изображение.
при отсутствии может быть пустой строкой.
id
Идентификатор категории.
isReviewableOnFlamp
Разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.
keyword
Ключевое слово, по которому была найдена категория.
при отсутствии может быть пустой строкой.
name
Название категории.
orgCount
Количество организаций в данной категории.
parentId
Идентификатор родительской категории.
при отсутствии может быть пустой строкой.
seoName
SEO-синоним.
при отсутствии может быть пустой строкой.
suggestIcon
Иконка категории для выдачи suggest.
при отсутствии может быть пустой строкой.
tag
Уникальное имя, которое можно использовать как часть имени файла-иконки.
при отсутствии может быть пустой строкой.
title
Заголовок для отображения в UI.
при отсутствии может быть пустой строкой.
type
Тип категории.
CategoryGetByIdsQueryBuilder
Построитель запроса получения категорий по идентификаторам.
new CategoryGetByIdsQueryBuilder(ids: RubricId[])
Начать построение запроса получения категорий по идентификаторам.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setGeoContext(geoContext: CategoryGeoContext | null): CategoryGetByIdsQueryBuilder
Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.
setLocale(locale: Locale | null): CategoryGetByIdsQueryBuilder
Задать локаль для запроса категорий.
CategoryListQueryBuilder
Построитель запроса списка категорий.
new CategoryListQueryBuilder()
Начать построение запроса списка категорий.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setGeoContext(geoContext: CategoryGeoContext | null): CategoryListQueryBuilder
Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.
setLocale(locale: Locale | null): CategoryListQueryBuilder
Задать локаль для запроса категорий.
setPageSize(pageSize: number): CategoryListQueryBuilder
Задать размер страницы.
setParentId(parentId: RubricId | null): CategoryListQueryBuilder
Задать родителя для запроса списка категорий.
setSortType(sortType: CategorySortType): CategoryListQueryBuilder
Задать сортировку для запроса списка категорий.
CategoryQuery
Запрос категорий.
new CategoryQuery()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CategorySearchQueryBuilder
Построитель запроса поиска категорий по тексту.
new CategorySearchQueryBuilder(queryText: string)
Начать построение запроса поиска категорий по тексту.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setGeoContext(geoContext: CategoryGeoContext | null): CategorySearchQueryBuilder
Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.
setLocale(locale: Locale | null): CategorySearchQueryBuilder
Задать локаль для запроса категорий.
setPageSize(pageSize: number): CategorySearchQueryBuilder
Задать размер страницы.
Channel
Reactive stream of values from the C++ SDK. Subscribe with subscribe, unsubscribe with Connection.disconnect().
new Channel()
subscribe(callback: (value: T) => void): Connection
Subscribes to the channel events.
CheckableGroupedItem
Единичный элемент из GroupCheckableItem.
new CheckableGroupedItem()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CheckableItem
Базовое представление отмечаемого элемента из CheckableItemsGroup.
new CheckableItem()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CheckableItemsGroup
Виджет для представления группы отмечаемых элементов.
new CheckableItemsGroup()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
Checkbox
Виджет-чекбокс.
new Checkbox()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
caption
Получение заголовка виджета. Может отсутствовать.
checkedText
Получение текста подписи для "отмеченного" чекбокса.
filters
Получение списка фильтров, описывающих текущее состояние виджета. Может быть использован при формировании поискового запроса.
filterType
Получение типа фильтра, который представляет виджет.
isChecked
Получение состояния виджета.
type
Получение типа виджета.
uncheckedText
Получение текста подписи для "неотмеченного" чекбокса.
values
Получение списка значений, по которым происходит фильтрация. Обычно одно значение.
Circle
Окружность.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
bounds
Прямоугольник минимального размера, содержащий геометрию.
color
Цвет заливки окружности.
dashedStrokeOptions
Получение параметров пунктирной обводки
isVisible
levelId
Получение привязки объекта к этажу в здании.
position
Местоположение центра окружности.
radius
Радиус окружности.
strokeColor
Цвет границы окружности.
strokeWidth
Ширина линии границы окружности.
userData
Произвольные пользовательские данные, прикрепленные к объекту.
zIndex
Получение уровня отрисовки объекта.
ClusterObject
Кластер объектов.
new ClusterObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CommonGestureSettings
new CommonGestureSettings()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
recognizeSettings
Общие настройки распознавания жестов.
CompassControlModel
Модель контрола компаса. Контрол состоит из кнопки компаса, при нажатии на которую камера карты меняет угол в направлении севера. Если камера карты смотрит на сервер, то контрол необходимо скрывать. Потокобезопасно.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
onClicked(): void
ComplexGeometry
Составная геометрия, состоит из набора простых или составных геометрий.
Поддерживается произвольный уровень вложенности составных геометрий в наборе.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
intersects(geometry: Geometry): boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
geometry
объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется
Connection
Subscription to a channel. Call disconnect() to unsubscribe.
Important: keep a reference to the Connection for as long as the subscription is needed. If the reference is lost, the GC may collect the object and the subscription will be disconnected.
new Connection()
disconnect(): void
Unsubscribes from the channel. Idempotent: a repeated call is safe.
Context
Контекст - окружение, необходимое для работы SDK.
new Context()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
CoordinatesFollowController
Контроллер слежения за координатами позиции карты.
new CoordinatesFollowController(animationDuration?: Duration, valueThreshold?: Meter)
Создание контроллера слежения за координатами позиции карты.
animationDuration?
длительность изменения реальной позиции. Default: Duration.ofMilliseconds(1000)
valueThreshold?
неотрицательное пороговое значение учитываемого изменения реальной позиции. Default: new Meter({ value: 0.1 })
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DefaultRoadEventFilter
Фабрика для создания стандартных временных фильтров дорожных событий.
new DefaultRoadEventFilter()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
create(context: Context, displayCategories: EnumSet<RoadEventDisplayCategory> | null, startTimeCutoff: Duration | null): RoadEventFilter
Создает фильтр отображаемых дорожных событий на карте.
context
Контекст.
displayCategories
Категории событий, которые нужно отображать на карте. Если не задано — фильтрация по категориям не применяется.
startTimeCutoff
Максимально допустимое время начала события относительно текущего момента. События с start_time позже этого порога будут скрыты. Например, +1d — скрыть события, которые начнутся позже чем через сутки. События без start_time не фильтруются. Если не задано — фильтрация по времени начала не применяется.
DGis
new DGis()
createContext(httpOptions?: HttpOptions, logOptions?: LogOptions, vendorConfig?: VendorConfig, keySource?: KeySource, dataCollectionConsent?: PersonalDataCollectionConsent, locationProvider?: LocationProvider | null, headingProvider?: HeadingProvider | null): Context
Must be called before using any SDK service.
httpOptions?
HTTP client settings.
logOptions?
logging parameters.
vendorConfig?
SDK configuration override.
keySource?
SDK key source. Defaults to asset dgissdk.key.
dataCollectionConsent?
user consent for data collection and processing.
locationProvider?
optional custom location provider implementation.
headingProvider?
optional custom heading provider implementation.
SDK context required by SDK services.
releaseContext(context: Context): void
Releases the SDK context and its resources.
Before calling, ensure all SDK objects (maps, markers, data sources, etc.) are released. After a successful call, the previously created context becomes invalid. To create a new context, call createContext again.
DgisMapObject
Объект карты 2GIS.
информацию об объекте можно получить через справочник (directory)
new DgisMapObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DgisSource
Основной интерфейс источников данных 2ГИС.
new DgisSource()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setHighlighted(directoryObjectIds: DgisObjectId[], highlighted: boolean): void
Установка или снятие выделения объектов.
добавляет объекту атрибут "selected", который можно использовать в стилях.
directoryObjectIds
Идентификаторы изменяемых объектов.
highlighted
Установка или снятие выделения.
createDgisSource(context: Context): Source
Создание источника, получающего данные с серверов 2ГИС.
DirectMapControlBeginEvent
Событие начала прямого управления картой. Сообщает карте, что необходимо обрабатывать события прямого управления картой. События прямого управления работают только от DirectMapControlBeginEvent до DirectMapControlEndEvent. После завершения последовательности событий прямого управления может запуститься кинематика. Кинематика использует время возникновения события, поэтому лучше использовать время, полученное от системы, а не заполнять значение при обработке. Пока кинематика работает только для перемещения карты, но не для вращения и масштабирования.
new DirectMapControlBeginEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DirectMapControlEndEvent
Событие окончания прямого управления картой. Завершает прямое управление картой, начатое после получения события DirectMapControlBeginEvent. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
new DirectMapControlEndEvent(timestamp: Duration)
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DirectMapRotationEvent
Событие прямого вращения карты. О событиях прямого управления картой описано в DirectMapControlBeginEvent.
new DirectMapRotationEvent(bearingDelta: Bearing, timestamp: Duration, rotationCenter?: ScreenPoint | null)
bearingDelta
изменение угла поворота карты, в градусах. Положительные значения соответствуют направлению вращения против часовой стрелки
timestamp
Время генерации системного события.
rotationCenter?
Точка на экране, вокруг которой вращается карта. Если точка не задана,
то вращение происходит относительно точки позиции карты. Default: null
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DirectMapScalingEvent
Событие прямого масштабирования карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
new DirectMapScalingEvent(zoomDelta: number, timestamp: Duration, scalingCenter?: ScreenPoint | null)
zoomDelta
Величина, на которую изменится текущее значение масштаба.
timestamp
Время генерации системного события.
scalingCenter?
Точка на экране, относительно которой масштабируется карта. Если точка не задана,
то масштабирование происходит относительно точки позиции карты. Default: null
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DirectMapShiftEvent
Событие прямого сдвига карты. События прямого управления картой описаны в DirectMapControlBeginEvent.
new DirectMapShiftEvent(screenShift: ScreenShift, shiftedPoint: ScreenPoint, timestamp: Duration)
screenShift
Изменение экранной позиции карты относительно предыдущей, в пикселях.
shiftedPoint
Центральная точка, от которой производится смещение карты.
timestamp
Время генерации системного события.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DirectMapTiltEvent
Событие прямого наклона камеры. События прямого управления картой описаны в DirectMapControlBeginEvent.
new DirectMapTiltEvent(delta: number, timestamp: Duration)
delta
Изменение угла наклона в градусах.
timestamp
Время генерации системного события.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
DirectoryObject
Объект справочника.
new DirectoryObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
formattedAddress(type: FormattingType): FormattedAddress | null
Cтроковое представление адреса, отформатированное в соответствии с указанным требованием к длине.
publicTransportScheduleInfo(departureTimeUtc: bigint): Future<PublicTransportDirectoryScheduleInfo | null>
Информация о расписаниях платформ и направлений.
departureTimeUtc
Время в системе UNIX по UTC, на которое необходимо получить расписание.
address
Адрес объекта в виде набора компонент.
attributes
Дополнительные атрибуты объекта.
branchesInfo
Информация о связанных организациях.
buildingInfo
Информация о здании.
chargingStation
Атрибуты для электрозаправки.
contactInfos
Контакты объекта.
contextAttributes
Контекстные дополнительные атрибуты объекта.
description
Описание объекта.
entrances
Информация о входах.
Для получения данной информации запросите дополнительную настройку ключа.
group
Связанные в объединённую карточку объекты.
Для получения данной информации запросите дополнительную настройку ключа.
id
Стабильный числовой идентификатор объекта.
levelId
Идентификатор этажа, на котором расположен объект.
Для получения данной информации запросите дополнительную настройку ключа.
markerPosition
Точка объекта, где следует разместить маркер.
nearestParkingIds
Ближайшие парковки.
nearestPlatforms
Ближайшие остановочные платформы.
nearestStations
Ближайшие остановки.
openingHours
Время работы объекта.
orgInfo
Информация об организации.
parkingInfo
Дополнительная информация о парковке.
platformIds
Справочная информация о идентификаторах платформ общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.
Для входа на станцию (тип ObjectType.StationEntrance) и станции метро (тип ObjectType.StationMetro) содержит информацию обо всех идентификаторах платформ.
reviews
Отзывы.
routeInfos
Справочная информация о маршрутах общественного транспорта. Поле заполняется только при поиске по идентификатору объекта.
Для маршрута (тип ObjectType.Route) содержит информацию только об одном маршруте. Для остановочной платформы (тип ObjectType.StationPlatform), станции метро (тип ObjectType.StationMetro) и входа на станцию (тип ObjectType.StationEntrance) содержит информацию обо всех маршрутах, которые проходят через объект.
rubricIds
Идентификаторы рубрик.
subtitle
Подзаголовок объекта.
при отсутствии может быть пустой строкой
timeZoneOffset
Сдвиг локального времени объекта относительно UTC в секундах в текущий момент.
title
Заголовок объекта.
titleAddition
Дополнительная информация заголовка Пример: "(кв. 1-12)"
Для получения данной информации запросите дополнительную настройку ключа.
tradeLicense
Данные о лицензии организации.
Для получения данной информации запросите дополнительную настройку ключа.
types
Тип объекта. Может быть несколько, например, ТЦ Сан Сити - филиал организации и здание одновременно. Первый тип в этом списке - основной.
workStatus
Статус работы.
Duration
Duration stored in milliseconds. Created with the factory methods ofMilliseconds, ofSeconds, ofMinutes.
EnumSet
Set of flags (bitmask) for an enum type. Created with the factory method of(). Supports iteration, adding, removing and checking individual flags.
[iterator](): Iterator<T>
Iterates over the flags that are set.
addAll(values: Iterable<T>): EnumSet<T>
Adds several flags to the set.
addAllFrom(other: EnumSet<T>): EnumSet<T>
Adds all flags of the other set.
clear(): void
Clears the set.
containsAll(values: Iterable<T>): boolean
Checks that the set contains all the listed flags.
values
flags to check
containsAllFrom(other: EnumSet<T>): boolean
Checks that this set contains all flags of the other set.
difference(other: EnumSet<T>): EnumSet<T>
Difference: flags present in this set but not in the other.
equals(other: EnumSet<T>): boolean
Compares two sets by mask.
has(value: T): boolean
Checks whether the set contains the flag.
value
flag to check
intersection(other: EnumSet<T>): EnumSet<T>
Intersection: flags present in both sets.
remove(value: T): EnumSet<T>
Removes a flag from the set.
removeAll(values: Iterable<T>): EnumSet<T>
Removes several flags from the set.
removeAllFrom(other: EnumSet<T>): EnumSet<T>
Removes all flags that are present in the other set.
toSet(): Set<T>
Converts to a JS Set.
Set with the flags that are set
union(other: EnumSet<T>): EnumSet<T>
Union: flags present in at least one of the sets.
of(enumObj: Record<string, T | string>, values: T[]): EnumSet<T>
Creates an EnumSet from the listed values.
enumObj
enum object (for example, Permission)
values
values to include in the set
Event
Базовый класс для всех обрабатываемых событий.
new Event()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
File
Идентификатор файла.
Может являться не только файлом на файловой системе, но и произвольным источником данных.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
fromString(contents: string): File
Файл с содержимым из заданной строки.
FollowController
Класс, позволяющий управлять положением камеры. Реализации всех его методов должны быть потокобезопасны. У большинства методов есть тривиальные реализации по умолчанию (таким образом FollowController, отвечающий за масштаб, не обязан переопределять методы coordinates() и т.п.). Один контроллер может быть единомоментно добавлен только в одну карту.
new FollowController()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
Future
Wrapper around a C++ future: an asynchronous result that arrives later.
Important: keep a reference to the Future until the result arrives. If the reference is lost, the GC may collect the object and the callback will never be called.
Lifecycle:
- Get a Future from an SDK method and keep a reference to it
- Call onComplete to subscribe to the result
- Call destroy to release the native resources
A Future is single-use: onComplete can be called only once. After destroy any call throws an error.
new Future()
destroy(): void
Releases the native resources. Idempotent: a repeated call is safe.
onComplete(onResult: (result: T) => void, onError: (error: string) => void): void
Subscribes to the result of the future. Can be called only once: a repeated call throws an error.
onResult
called with the result on successful completion
onError
called with an error message on failure
toPromise(): Promise<T>
Converts the future into a Promise. The future is destroyed automatically after it settles.
Geometry
Объект геометрии.
new Geometry()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
intersects(geometry: Geometry): boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
geometry
объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется
GeometryMapObject
Геометрический объект карты.
методы потокобезопасны
объект будет отображаться на карте при выполнении следующих условий:
- объект видимый;
- объект добавлен в источник данных;
- источник данных, содержащий объект, добавлен в карту;
- в стилях, установленных в карту, есть параметры отображения, применимые к этому объекту. Подробнее про отображение на карте - см. ISource.
new GeometryMapObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
animationSettings
Получение настроек анимации. Применяется для объектов с типом "3D model" или "Directional model".
bounds
Прямоугольник минимального размера, содержащий геометрию.
geometry
Геометрия объекта.
geometryChannel
Геометрия объекта.
isDraggable
Текущий флаг перемещаемости объекта.
isDraggableChannel
Текущий флаг перемещаемости объекта.
isVisible
Текущий флаг видимости объекта.
isVisibleChannel
Текущий флаг видимости объекта.
objectAttributes
Получение свойств объекта карты для чтения и изменения.
userData
Произвольные пользовательские данные, прикрепленные к объекту.
GeometryMapObjectBuilder
Класс для установки свойств и последующего создания геометрических объектов.
new GeometryMapObjectBuilder()
createObject(): GeometryMapObject
Конструирование объекта карты.
у объекта обязательно должна быть установлена геометрия
после вызова этой функции GeometryMapObjectBuilder непригоден для задания параметров объекта карты или для его создания
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setDraggable(draggable: boolean): GeometryMapObjectBuilder
Установка возможности перетаскивания объекта карты.
setGeometry(geometry: Geometry): GeometryMapObjectBuilder
Установка геометрии объекта карты.
setObjectAttribute(name: string, value: AttributeValue): GeometryMapObjectBuilder
Установка свойства объекта карты.
name
Имя свойства объекта карты.
value
Значение свойства объекта карты.
setObjectAttributes(values: [string, AttributeValue][]): GeometryMapObjectBuilder
Установка свойств объекта карты.
values
набор пар "имя":"значение" для добавляемых свойства объекта карты
метод не заменяет весь набор свойств объекта, т.е. если свойство в values отсутствует, но уже добавлено в объект ранее, оно не будет изменено.
setUserData(userData: object | null): GeometryMapObjectBuilder
Установка пользовательских данных.
пользовательские данные никак не используются в SDK и нужны только чтобы возвращать их пользователю.
setVisible(visible: boolean): GeometryMapObjectBuilder
Установка видимости объекта карты.
GeometryMapObjectSource
Источник геометрических объектов карты.
new GeometryMapObjectSource()
addObject(item: GeometryMapObject): void
Добавление объекта в источник.
Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.
Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.
Для источника с кластеризацией добавление пока не реализовано, будет выброшено исключение.
addObjects(objects: GeometryMapObject[]): void
Добавление нескольких объектов в источник.
Добавление объектов по группой эффективнее, чем добавление по одному, особенно в случае, когда источник уже добавлен в одну или несколько карт.
Добавление асинхронное, потокобезопасное, метод можно использовать из любого потока.
Для источника с кластеризацией добавление пока не реализовано, будет выброшено исключение.
clear(): void
Удаление всех объектов из источника.
clusteringObjects(position: CameraPosition): MapObject[]
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и геометрические объекты.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
removeAndAddObjects(objectsToRemove: GeometryMapObject[], objectsToAdd: GeometryMapObject[]): void
Удаление и добавление объектов в источник.
removeObject(item: GeometryMapObject): void
Удаление объекта из источника.
Удаление асинхронное, потокобезопасное, метод можно использовать из любого потока.
removeObjects(objects: GeometryMapObject[]): void
Удаление объектов из источника.
GeometryMapObjectSourceBuilder
new GeometryMapObjectSourceBuilder(context: Context)
addObject(item: GeometryMapObject): GeometryMapObjectSourceBuilder
Добавление геометрического объекта карты в источник.
addObjects(objects: GeometryMapObject[]): GeometryMapObjectSourceBuilder
Добавление нескольких геометрических объектов карты в источник.
createSource(): GeometryMapObjectSource
Создание источника геометрических объектов.
после вызова этой функции использовать GeometryMapObjectSourceBuilder для создания источника данных или для задания параметров источника данных нельзя
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setSourceAttribute(name: string, value: AttributeValue): GeometryMapObjectSourceBuilder
Установка свойства объектов карты, общего для всего источника (см. ISource).
setSourceAttributes(values: [string, AttributeValue][]): GeometryMapObjectSourceBuilder
Установка свойств объектов карты, общих для всего источника.
values
набор пар "имя":"значение" свойств
GestureManager
Класс для управления обработкой жестов.
new GestureManager()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setMutuallyExclusiveGestures(rules: EnumSet<TransformGesture>[]): void
Установка списка правил исключения одновременного срабатывания нескольких жестов.
К переданному списку правил добавляются правила по умолчанию, которые не позволяют жесту управления наклоном срабатывать одновременно с другими жестами. Каждое правило представляет собой перечень жестов, которые не могут срабатывать одновременно Например, если в правиле указать жесты Scaling и Rotation то эти жесты не будут работать одновременно В случае одновременного выполнения жестов из правила, сработает жест с большим приоритетом Порядок приоритета жестов (по убыванию): (Shift ->) Tilt -> Scaling -> Rotation -> MultiTouchShift
GroupCheckableItem
Набор отмечаемых элементов, работающих как радио-группа.
new GroupCheckableItem()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
HeadingAvailableNotifier
Интерфейс для реализации функционала обратного вызова, который оповещает о доступности источника направления. Источник направления считается доступным, если он в состоянии отслеживать текущее направление и оповещать об ее изменении.
new HeadingAvailableNotifier()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
send(available: boolean): void
available
HeadingNotifier
Интерфейс для реализации функционала обратного вызова, который возвращает измеренное платформой направление.
new HeadingNotifier()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
HttpCacheManager
Интерфейс управления HTTP-кешем.
new HttpCacheManager()
clear(): void
Очистка содержимого HTTP-кеша.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
get(context: Context): HttpCacheManager | null
Интерфейс управления HTTP-кешем. Null, если HTTP кэш не используется.
HttpResponseCallback
Объект с обратными вызовами для обработки отправки и получения данных.
new HttpResponseCallback()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
onFinished(): void
Метод, оповещающий об окончании обработки запроса. Необходимо вызывать в конце процесса обработки. Даже если запрос был отменен на стороне SDK.
Отсутствие вызова метода может привести к отказу работы сети в SDK.
onReceive(body: number[], size: number): boolean
Метод, обрабатывающий получение тела ответа. Обработка может вестись по частям.
body
тело (или его часть) ответа от сервера.
size
размер данных в байтах.
возвращает false если SDK отменил отправку/обработку запроса.
При обработке присутствует копирование данных для передачи из Java в с++. Рекомендуется передавать данные небольшими кусками.
onResponse(response: HttpResponse): boolean
Метод, обрабатывающий получение ответа от сервера.
response
ответ от сервера.
возвращает false если SDK отменил отправку/обработку запроса.
Image
Изображение.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
ImageLoader
Класс для загрузки изображений.
loadLottieFromAsset(source: AssetSource): Promise<Image>
Загрузить Lottie JSON из assets.
loadLottieFromByteData(data: ByteDataLike): Image
Загрузить Lottie JSON из бинарных данных.
loadLottieFromFile(source: FileSource): Promise<Image>
Загрузить Lottie JSON из файла.
loadPngFromAsset(source: AssetSource, height: number, width: number): Promise<Image>
Загрузить PNG изображение из assets.
loadPngFromByteData(data: ByteDataLike, height: number, width: number): Image
Загрузить PNG изображение из бинарных данных.
loadPngFromFile(source: FileSource, height: number, width: number): Promise<Image>
Загрузить PNG изображение из файла.
loadSVGFromAsset(source: AssetSource): Promise<Image>
Загрузить SVG изображение из assets.
loadSVGFromByteData(data: ByteDataLike): Image
Загрузить SVG изображение из бинарных данных.
loadSVGFromFile(source: FileSource): Promise<Image>
Загрузить SVG изображение из файла.
IncompleteTextHandler
Предложено автодополнение для введенного пользователем текста.
new IncompleteTextHandler()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
IndoorBuilding
Здание с этажными планами.
new IndoorBuilding()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
linkedWith(other: IndoorBuilding): boolean
Признак того, что текущее здание и other связаны.
Несколько зданий с этажными планами могут быть связаны между собой. Группа связанных зданий ведёт себя как единое целое:
- метод levels() выдаёт объединённый список этажей по всей группе;
- активный режим отображения меняется согласованно у всей группы.
activeLevelIndex
Порядковый индекс активного этажа в levels.
activeLevelIndexChannel
Порядковый индекс активного этажа в levels.
defaultLevelIndex
Индекс этажа по умолчанию.
id
Идентификатор здания с этажными планами.
levels
Информация обо всех этажах.
mode
Активный режим. Если ActiveLevelMode, то index указывает порядковый индекс активного этажа в levels. Если OverviewMode, значит, активен обзорный вид на здание.
modeChannel
Активный режим. Если ActiveLevelMode, то index указывает порядковый индекс активного этажа в levels. Если OverviewMode, значит, активен обзорный вид на здание.
IndoorControlModel
Модель элемента управления этажами.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
isLevelMarked(index: bigint): boolean
Нужно ли отображать пометку у этажа с указанным индексом.
index
activeLevelIndex
Индекс активного этажа.
activeLevelIndexChannel
Индекс активного этажа.
levelNames
Названия этажей. Пусто, если на карте не отображается здание с этажными планами.
levelNamesChannel
Названия этажей. Пусто, если на карте не отображается здание с этажными планами.
markedLevels
Этажи, на которых отображаются пометки.
IndoorManager
Класс для получения текущего здания с этажными планами.
new IndoorManager()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setIndoorState(newState: IndoorManagerState): void
Переключение включенности/выключенности менеджера этажных планов
InputEvent
Событие пользовательского ввода.
new InputEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
ItemMarkerInfo
Идентификатор объекта и его координаты.
new ItemMarkerInfo()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
LocaleManager
Менеджер региональных настроек приложения.
new LocaleManager()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
overrideLocales(locales: Locale[]): void
Установка списка локалей приложения
instance(context: Context): LocaleManager
Интерфейс управления локалями приложения.
locales
Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.
localesChannel
Локали приложения, если заданы, иначе - локали, заданные пользователем в ОС.
systemLocales
Получение локалей, предоставляемых ОС.
Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).
systemLocalesChannel
Получение локалей, предоставляемых ОС.
Локали ОС в порядке, заданном пользователем (в порядке от более приоритетной к менее приоритетной).
LocationAvailableNotifier
Интерфейс для реализации функционала обратного вызова, который оповещает о доступности источника геопозиции. Источник геопозиции считается доступным, если он в состоянии отслеживать текущую геопозицию и оповещать об ее изменении.
new LocationAvailableNotifier()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
send(available: boolean): void
available
LocationNotifier
Интерфейс для реализации функционала обратного вызова, который возвращает измеренный платформой вектор геопозиций. Геопозиции должны быть отсортированы в порядке от старой к новой, т.е. в конце массива должна храниться самая свежая геопозиция. В случае, если ОС пришлет пустой список геопозиций, его нужно пробросить в виде пустого вектора.
new LocationNotifier()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
LocationService
Класс для работы с установленным при инициализации SDK источником геопозиции.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
onPermissionGranted(): void
Метод необходимо вызвать после получения разрешений на использование геопозиции.
Этот метод актуален только для источника геопозиции по умолчанию.
withDesiredAccuracy(context: Context, desiredAccuracy: DesiredAccuracy): LocationService
lastLocation
Канал, который оповещает об изменении геопозиции.
Возвращаемая в канале геопозиция может быть недостоверной.
Если API платформы не предоставляет аналогичный по функциональности метод, то в канале всегда будет null.
lastLocationChannel
Канал, который оповещает об изменении геопозиции.
Возвращаемая в канале геопозиция может быть недостоверной.
Если API платформы не предоставляет аналогичный по функциональности метод, то в канале всегда будет null.
Map
Карта.
new Map()
addSource(source: Source): void
Добавление источника данных на карту.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
getRenderedObjects(centerPoint: ScreenPoint, radius?: ScreenDistance): Future<RenderedObjectInfo[]>
Получение отображаемых объектов карты, проецирующихся на окружность на экране.
centerPoint
центр окружности.
radius?
радиус окружности. Default: new ScreenDistance({ value: 1.0 })
Список объектов формируется в порядке отрисовки от поздних к ранним.
removeSource(source: Source): void
Удаление источника данных из карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
resetFontIconSizeMultiplier(): void
Сбросить множитель размера для иконок.
sublayerAttributes(sublayerName: string): Attributes
Получение атрибутов подслоя.
sublayerName
Название подслоя.
Полученные атрибуты содержат только добавленные туда ранее (явно).
appearance
Текущий внешний вид карты.
attributes
Получение атрибутов.
должны быть указаны свойства: "theme"="day|night" "navigatorOn"="true|false"
TODO: стилевые свойства для пробок
camera
Получение камеры.
dataLoadingState
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
dataLoadingStateChannel
Нотификация о состоянии загружаемых в карту данных.
При слежении за позицией камеры состояние карты всегда будет MapDataLoadingState::Loading.
fontIconSizeMultiplier
Множитель размера иконок и шрифтов, полученный из приложения.
Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.
fontIconSizeMultiplierChannel
Множитель размера иконок и шрифтов, полученный из приложения.
Размер иконок и шрифтов задаётся в логических пикселях (см. LogicalPixel) и умножается на множитель размера шрифтов и иконок.
graphicsPreset
Получение режима графики. В случае null используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.
graphicsPresetChannel
Получение режима графики. В случае null используется рекомендуемый режим. Если определить рекомендуемый режим не удалось, то используется Normal.
graphicsPresetHint
Получение рекомендуемого режима графики для данного устройства.
graphicsPresetHintChannel
Получение рекомендуемого режима графики для данного устройства.
id
Идентификатор экземпляра карты, уникальный в рамках процесса.
indoorManager
Получение менеджера этажных планов.
interactive
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
interactiveChannel
Интерактивность карты. Под интерактивностью понимается наличие у пользователя возможности взаимодействия с картой. При отключении интерактивности карта перестанет реагировать на события ввода, пришедшие от пользователя. Также перестанут работать контролы для работы с картой (приближения и перехода к текущему положению). При этом остаётся возможность работать с картой через set_position/move. При переходе в неинтерактивное состояние незавершённые жесты будут сброшены. По умолчанию карта интерактивна (interactive == true).
функция может быть вызвана из любого потока.
mapVisibilityState
mapVisibilityStateChannel
sources
Получение источников данных карты.
Происходит асинхронно. Метод может вызываться из любого потока, потокобезопасен.
style
Получение текущих стилей карты.
styleChannel
Получение текущих стилей карты.
theme
Текущая тема, установленная в соответствии с appearance.
themeChannel
Текущая тема, установленная в соответствии с appearance.
universeDrawingMode
Режим отображения Universe.
universeDrawingModeChannel
Режим отображения Universe.
MapController
Готовая к показу карта вместе с рендерером и распознавателем жестов.
new MapController()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
create(context: Context, options: MapControllerOptions): Future<MapController>
Создаёт карту с параметрами из options.
context
контекст SDK. Должен быть валиден на время создания карты.
options
параметры начального состояния карты.
future с готовым MapController либо с ошибкой создания.
MapGestureRecognizer
Принимает информацию о нажатиях и преобразует их в жесты карты. Обработка происходит в два этапа:
- Добавляется несколько точек - add_touch_point
- Точки обрабатываются - process_touch_event
new MapGestureRecognizer()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
MapObject
Объект на карте.
new MapObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
userData
Произвольные пользовательские данные, прикрепленные к объекту.
MapObjectManager
new MapObjectManager(map: Map, layerId?: string | null)
Создать IMapObjectManager.
map
layerId?
ID слоя в стиле типа "Динамический объект".
Создаваемые объекты будут размещены на этом слое,
тем самым можно задать их порядок относительно других слоев.
Если не задан, объекты размещаются поверх остальных слоев. Default: null
addObjects(objects: SimpleMapObject[]): void
Добавить объекты.
clusteringObjects(position: CameraPosition): MapObject[]
Получить список объектов, участвующих в кластеризации при переданной позиции камеры. В списке будут присутствовать как кластеры, так и маркеры.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
removeAll(): void
removeAndAddObjects(objectsToRemove: SimpleMapObject[], objectsToAdd: SimpleMapObject[]): void
Удалить и добавить объекты.
removeObjects(objects: SimpleMapObject[]): void
Удалить объекты.
withClustering(map: Map, logicalPixel: LogicalPixel, maxZoom: Zoom, clusterRenderer: SimpleClusterRenderer, minZoom?: Zoom, layerId?: string | null): MapObjectManager
Создать IMapObjectManager с кластеризацией данных. Кластеризуются только IMarker объекты.
map
logicalPixel
Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает кластеризация.
maxZoom
Уровень, начиная с которого видны все маркеры.
clusterRenderer
Интерфейс для задания параметров отображения кластера.
minZoom?
Уровень, начиная с которого формируются кластеры. Default: new Zoom({ value: 0.0 })
layerId?
ID слоя в стиле типа "Динамический объект".
Создаваемые объекты будут размещены на этом слое,
тем самым можно задать их порядок относительно других слоев.
Если не задан, объекты размещаются поверх остальных слоев. Default: null
withGeneralization(map: Map, logicalPixel: LogicalPixel, maxZoom: Zoom, minZoom?: Zoom, layerId?: string | null): MapObjectManager
Создать IMapObjectManager с генерализацией данных. Генерализуются только IMarker объекты.
map
logicalPixel
Минимально возможное расстояние на экране между точками привязки маркеров на уровнях, где работает генерализация.
maxZoom
Уровень, начиная с которого видны все маркеры.
minZoom?
Уровень, начиная с которого работает генерализация. Default: new Zoom({ value: 0.0 })
layerId?
ID слоя в стиле типа "Динамический объект".
Создаваемые объекты будут размещены на этом слое,
тем самым можно задать их порядок относительно других слоев.
Если не задан, объекты размещаются поверх остальных слоев. Default: null
isVisible
Переопределение видимости всех объектов, добавленных в экземпляр менеджера. Значение false здесь имеет приоритет над видимостью отдельного объекта.
MapRenderedObjectObserver
Наблюдатель за взаимодействиями с рендеренными объектами на карте.
Этот интерфейс предоставляет каналы для прослушивания событий взаимодействия пользователя с рендеренными объектами на карте, такими как касания и долгие нажатия.
new MapRenderedObjectObserver()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
objectLongTouched
Канал, который возвращает список RenderedObjectInfo при долгом нажатии пользователем на рендеренный объект. Может быть пустым, при долгом нажатии мимо объекта.
objectTapped
Канал, который возвращает список RenderedObjectInfo при касании пользователем рендеренного объекта. Может быть пустым, при тапе мимо объекта.
MapRenderer
Создание этого объекта приводит к началу рисования карты.
new MapRenderer()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setMaxFps(maxFps: Fps | null, powerSavingMaxFps: Fps | null): void
takeSnapshot(copyrightAlign: Alignment): Future<ImageData>
takeSnapshotAsDataUri(copyrightAlign: Alignment): Future<string | null>
Делает снимок карты и сразу конвертирует его в data:-URI, готовый для
использования в <Image source={{ uri }} />.
SDK может вернуть снимок в формате PNG или в виде сырых пикселей
RGBA8888 — оба случая обрабатываются здесь, вызывающему коду не нужно
знать о формате снимка. Результат — Future, как и у takeSnapshot:
его нужно дождаться через onComplete и освободить через destroy.
copyrightAlign
null в колбэке onComplete, если формат снимка не поддерживается.
MapRotationBeginEvent
Событие начала вращения карты вокруг точки.
new MapRotationBeginEvent(direction: MapRotationDirection)
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
direction
Направление вращения карты.
MapRotationEndEvent
Событие окончания вращения карты вокруг точки.
new MapRotationEndEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
MapScalingBeginEvent
Событие начала изменения масштаба.
new MapScalingBeginEvent(direction: MapScalingDirection)
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
direction
Направление изменения масштаба карты.
MapScalingEndEvent
Событие окончания изменения масштаба.
new MapScalingEndEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
MapShiftBeginEvent
Событие начала сдвига карты.
new MapShiftBeginEvent(direction: MapShiftDirection)
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
direction
Направление смещения карты.
MapShiftEndEvent
Событие окончания смещения карты.
new MapShiftEndEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
Marker
Точечная отметка на карте, представляющая интерес для пользователя.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
anchor
Получение точки привязки иконки маркера.
animatedAppearance
Анимировать ли появление.
bounds
Прямоугольник минимального размера, содержащий геометрию.
icon
Получение иконки маркера.
iconAnimationMode
Получение режима анимации анимированного маркера.
iconMapDirection
Угол поворота маркера на карте относительно направления на север, по часовой стрелке.
iconOpacity
Получение прозрачности иконки маркера.
iconWidth
Получение целевой ширины маркера, используемой для масштабирования.
isDraggable
Получение флага перемещаемости маркера.
isVisible
labelingPriority
Получение приоритета лейблинга маркера.
levelId
Получение привязки объекта к этажу в здании.
position
Получение местоположения маркера.
suppressOnOverlap
Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).
text
Получение подписи маркера.
textStyle
Получение стиля подписи маркера.
userData
Произвольные пользовательские данные, прикрепленные к объекту.
zIndex
Получение уровня отрисовки объекта.
ModelData
Данные модели.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
ModelLoader
Класс для загрузки объемных моделей.
loadFromAsset(source: AssetSource): Promise<ModelData>
Загрузить модель из assets.
loadFromByteData(data: ByteDataLike): ModelData
Загрузить модель из бинарных данных.
loadFromFile(source: FileSource): Promise<ModelData>
Загрузить модель из файла.
ModelMapObject
Модель на карте.
new ModelMapObject(options: ModelMapObjectOptions)
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
animationSettings
Настройки анимации.
bounds
Прямоугольник минимального размера, содержащий геометрию.
isVisible
levelId
Получение привязки объекта к этажу в здании.
mapDirection
Угол поворота модели на карте относительно направления на север, по часовой стрелке.
modelData
Данные модели.
opacity
Прозрачность модели.
position
Местоположения модели.
size
Размер модели.
userData
Произвольные пользовательские данные, прикрепленные к объекту.
zIndex
Получение уровня отрисовки объекта.
MultiTouchGestureSettings
Настройки жеста касания несколькими пальцами.
new MultiTouchGestureSettings()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
recognizeSettings
Настройки распознавания касания несколькими пальцами.
MyLocationControlModel
Модель контрола перелета к местоположению пользователя. Контрол состоит из кнопки, при нажатии на которую камера перелетает к местоположению пользователя. Если местоположение не определено, ничего не происходит. Методы объекта необходимо вызывать на одном потоке.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
onClicked(): void
followState
Состояние слежения камеры за текущим местоположением пользователя.
followStateChannel
Состояние слежения камеры за текущим местоположением пользователя.
isEnabled
Состояние элемента перелета к местоположению пользователя.
isEnabledChannel
Состояние элемента перелета к местоположению пользователя.
locationQuality
Качество определения текущего местоположения.
locationQualityChannel
Качество определения текущего местоположения.
MyLocationMapObject
Маркер геопозиции.
new MyLocationMapObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setModelData(data: ModelData | null): void
Установить данные модели.
MyLocationMapObjectSource
Источник, содержащий маркер геопозиции.
new MyLocationMapObjectSource(context: Context, controllerSettings?: MyLocationControllerSettings, markerType?: MyLocationMapObjectMarkerType)
Создать источник маркера геопозиции.
context
controllerSettings?
Default: new MyLocationControllerSettings({ })
markerType?
Default: MyLocationMapObjectMarkerType.Model
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
item
Получить маркер геопозиции.
NewValuesNotifier
Интерфейс объекта, который сообщает о том, что есть изменения в каком-либо из параметров.
new NewValuesNotifier()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
sendNotification(): void
Необходимо вызывать, чтобы сообщить об обновлении параметров.
PackedMapState
Сериализованное состояние карты.
new PackedMapState()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
toBytes(): number[]
Представление состояния карты в виде последовательности байтов.
fromBytes(data: number[]): PackedMapState
Получение состояния карты.
data
Состояние карты в виде последовательности байтов.
Сериализованное состояние карты.
fromMap(map: Map): PackedMapState
Получение состояния карты.
map
Карта, состояние которой необходимо получить.
Сериализованное состояние карты.
of(position: CameraPosition, showTraffic: boolean, behaviour: CameraBehaviour): PackedMapState
Получение состояния карты.
position
Позиция камеры.
showTraffic
Состояние отображения пробок на карте.
behaviour
Режим слежения камеры.
Сериализованное состояние карты.
PackedSearchQuery
Вспомогательный объект для сериализации и десериализации поискового запроса.
new PackedSearchQuery()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
toBytes(): number[]
toSearchQuery(): SearchQuery
fromBytes(data: number[]): PackedSearchQuery
Десериализация запроса поиска.
fromSearchQuery(searchQuery: SearchQuery): PackedSearchQuery
allowedResultTypes
Ограничение по возвращаемым поиском типам объектов.
areaOfInterest
Прямоугольная область интереса.
buildingIds
Идентификаторы зданий.
directoryFilter
Информация об активных фильтрах.
geometryRestriction
Геометрия, ограничивающая область поиска.
locale
Локаль поискового запроса.
objectIds
Идентификаторы объектов.
orgIds
Идентификаторы организаций.
pageSize
Размер страницы выдачи.
queryText
Текст запроса. Для некоторых запросов (например, раскрытие рубрики из suggest'а) текст отсутствует, т.к. в запросе хранятся идентификаторы, и поведение отличается от поиска по тексту элемента suggest'а.
radius
Радиус поиска в метрах.
rubricIds
Идентификаторы рубрик.
searchNearby
Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
sortingType
Тип сортировки результатов.
territoryOfInterest
Слабое ограничение области поиска объектов: штраф за непопадание вместо строгого отбрасывания.
Page
Страница результатов поиска.
new Page()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
fetchNextPage(): Future<Page | null>
Получить следующую страницу результатов.
future, резолвящаяся в ненулевой указатель на следующую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если следующая страница отсутствует exceptional future, если произошла ошибка при получении страницы
fetchPrevPage(): Future<Page | null>
Получить предыдущую страницу результатов.
future, резолвящаяся в ненулевой указатель на предыдущую страницу, если страница успешно получена future, резолвящаяся в нулевой указатель, если предыдущая страница отсутствует exceptional future, если произошла ошибка при получении страницы
items
Непустой набор объектов справочника этой страницы.
ParkingControlModel
Модель контрола парковок.
Этот интерфейс является потокобезопасным.
new ParkingControlModel(map: Map)
Функция создания модели элемента управления парковками.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
toggleParkingsVisibility(): void
Действие при нажатии на контрол. Переключает видимость парковок на карте.
PerformSearchHandler
Предложено поискать определенный набор объектов.
new PerformSearchHandler()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
searchQuery
Запрос для прогона через поисковик.
PointGeometry
Точка.
new PointGeometry()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
intersects(geometry: Geometry): boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
geometry
объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется
fromGeoPointWithElevation(point: GeoPointWithElevation): PointGeometry
Polygon
Полигон на карте.
new Polygon(options: PolygonOptions)
Создание полигона на основе параметров.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
bounds
Прямоугольник минимального размера, содержащий геометрию.
color
contours
dashedPolygonOptions
Получение параметров пунктирного контура полигона.
elevation
isVisible
levelId
Получение привязки объекта к этажу в здании.
strokeColor
strokeWidth
userData
Произвольные пользовательские данные, прикрепленные к объекту.
zIndex
Получение уровня отрисовки объекта.
PolygonGeometry
Полигон.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
intersects(geometry: Geometry): boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
geometry
объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется
Polyline
Ломаная линия на карте.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
bounds
Прямоугольник минимального размера, содержащий геометрию.
color
dashedPolylineOptions
Получение параметров пунктирной полилинии.
elevation
erasedPart
gradientPolylineOptions
Получение параметров градиентной полилинии.
isVisible
levelId
Получение привязки объекта к этажу в здании.
points
userData
Произвольные пользовательские данные, прикрепленные к объекту.
width
zIndex
Получение уровня отрисовки объекта.
PolylineGeometry
Ломаная линия.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
intersects(geometry: Geometry): boolean
Функция intersects позволяет определить, имеет ли данная геометрия пересечение с другим объектом геометрии
geometry
объект геометрии для проверки пересечения При вычислении пересечения с IPointGeometry высота (elevation) игнорируется
Projection
Проекция.
Используется сферическая проекция Меркатора (EPSG:3857), зацикленная по долготе. Отображаемые данные ограничены по широте от -85.06° до 85.06°.
new Projection()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
distanceOnMap(fromPoint: ScreenPoint, toPoint: ScreenPoint): Meter | null
Вычисление расстояния между точками на карте, соответствующими указанным точкам на экране, в метрах.
Функция возвращает пустое значение, если одна или обе указанных точки экрана находятся за пределами проекции карты.
distanceOnScreen(fromGeoPoint: GeoPoint, toGeoPoint: GeoPoint): LogicalPixel | null
Вычисление расстояния между точками на экране, соответствующими указанным точкам на карте, в пикселях.
Функция возвращает пустое значение если одна или обе точки на карте:
- имеют невалидное значение (latitude лежит вне диапазона [-90; 90] или longitude лежит вне диапазона [-180; 180]).
- находятся выше плоскости проекции карты на экран.
- находятся слишком далеко за пределами экрана и возникает переполнение типа.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
mapToScreenWithGeoPoint(point: GeoPoint): ScreenPoint | null
Вычисление точки экрана, соответствующей указанной точке карты.
Функция возвращает пустое значение:
- point имеет невалидное значение (latitude лежит вне диапазона [-90; 90] или longitude лежит вне диапазона [-180; 180]).
- если указанная точка карты находится выше плоскости проекции карты на экран.
- если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.
mapToScreenWithGeoPointWithElevation(point: GeoPointWithElevation): ScreenPoint | null
Вычисление точки экрана, соответствующей указанной точке карты с высотой.
Функция возвращает пустое значение:
- point имеет невалидное значение (latitude лежит вне диапазона [-90; 90], longitude лежит вне диапазона [-180; 180] или elevation отрицателен).
- если указанная точка карты находится выше плоскости проекции карты на экран.
- если указанная точка карты находится слишком далеко за пределами экрана и возникает переполнение типа.
screenToMap(point: ScreenPoint): GeoPoint | null
Вычисление точки карты в указанной точке экрана.
Функция возвращает пустое значение, если указанная точка экрана за пределами проекции карты.
screenToMapClipped(point: ScreenPoint): GeoPoint
Вычисление ближайшей точки карты к проекции указанной точки экрана.
RangeWidget
Виджет для представления непрерывного или дискретного набора упорядоченных значений.
new RangeWidget()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setValues(min: number, max: number): void
Установка текущих выбранных значений.
min
текущее минимальное значение.
max
текущее максимальное значение.
RasterTileSource
Источник, получающий растровые тайлы.
new RasterTileSource(context: Context, sublayerName: string, sourceTemplate: RasterUrlTemplate)
Создание источника, получающего растровые тайлы.
context
контекст.
sublayerName
имя, которое будет использовано при генерации объектов. Это имя должно быть указано в стилях в условии filter слоя типа raster для атрибута db_sublayer. Пример: ["match", ["get", "db_sublayer"], ["NAME"], true, false] Подробнее см. спецификацию: https://docs.2gis.com/en/mapgl/stylespecification
sourceTemplate
Шаблон для запроса тайлов.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setOpacity(opacity: Opacity): void
Установка значения прозрачности растрового тайла.
Remover
Объект для удаления пользовательского контента.
new Remover()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
remove(): Future<ActionResult>
Удаление контента.
действие доступно для контента, автором которого является пользователь.
RoadEvent
Дорожное событие.
new RoadEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
author
Информация о пользователе, добавившем событие.
availableActions
Список доступных действий с событием.
cameraInfo
Информация о камере.
Доступна только для событий типа "Camera".
description
Пользовательское описание дорожного события.
elevation
Высота дорожного события.
id
Идентификатор события.
lanes
Затронутые событием полосы.
На текущий момент могут быть проставлены только у пользовательских событий.
location
Координаты события.
name
Локализованное название события.
remover
Получение объекта для удаления события.
schedule
Расписание.
На текущий момент доступно только для перекрытий, и даже для них может отсутствовать.
timestamp
Временная метка создания события.
type
Тип события.
RoadEventAction
Действие события.
new RoadEventAction()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
reset(): Future<ActionResult>
Отмена действия (например, сброс отметки "нравится", сброс подтверждения события).
Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода не вызывает применение противоположного действия.
set(): Future<ActionResult>
Применение действия (например, добавление отметки "нравится", подтверждение события).
Есть действия, противоположные друг другу, например, "нравится" и "не нравится". Если для события доступны оба действия, вызов метода сбрасывает применение противоположного - невозможно одновременно поставить "нравится" и "не нравится".
RoadEventManager
Объект для создания транспортных событий.
new RoadEventManager()
createAccident(location: GeoPoint, lanes: EnumSet<Lane>, description: string): Future<AddEventResult>
Создание события "ДТП".
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
createCamera(location: GeoPoint, description: string): Future<AddEventResult>
Создание события "Камера".
location
Местоположение события.
description
Пользовательское описание события.
createComment(location: GeoPoint, description: string): Future<AddEventResult>
Создание события "Комментарий".
location
Местоположение события.
description
Пользовательское описание события.
createOther(location: GeoPoint, lanes: EnumSet<Lane>, description: string): Future<AddEventResult>
Создание события "Другое".
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
createRoadRestriction(location: GeoPoint, description: string): Future<AddEventResult>
Создание события "Перекрытие дорожного движения".
location
Местоположение события.
description
Пользовательское описание события.
createRoadWorks(location: GeoPoint, lanes: EnumSet<Lane>, description: string): Future<AddEventResult>
Создание события "Дорожные работы".
location
Местоположение события.
lanes
Полосы дороги, затрагиваемые событием.
description
Пользовательское описание события.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
instance(context: Context): RoadEventManager
Получение объекта для создания дорожных событий.
RoadEventMapObject
Объект карты "Дорожное событие".
new RoadEventMapObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
RoadEventPhoto
Фотография дорожного события.
new RoadEventPhoto()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
previewUrl(desiredSize: ScreenSize): string
URL превью фотографии.
report(): Future<ActionResult>
Отправка жалобы на фотографию.
жалоба на свою фотографию ни к чему не приведёт.
RoadEventSource
Интерфейс класса, управляющего отображением дорожных событий (tUGC) на карте.
new RoadEventSource(context: Context)
Создание источника, отображающего дорожные события на карте.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setHighlighted(directoryObjectIds: DgisObjectId[], highlighted: boolean): void
Установка или снятие выделения дорожных событий.
добавляет событию атрибут "selected", который можно использовать в стилях.
directoryObjectIds
Идентификаторы изменяемых событий. Можно получить из RoadEventMapObject.
highlighted
Установка или снятие выделения.
RotateMapToNorthEvent
Событие поворота карты на север.
new RotateMapToNorthEvent()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
RotationGestureSettings
Настройки жеста вращения.
new RotationGestureSettings()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
ScaleMapEvent
Событие изменения масштаба карты.
new ScaleMapEvent(zoomDelta: number, scalingCenter?: ScreenPoint | null)
Конструктор события изменения масштаба.
zoomDelta
Величина, на которую изменится текущее значение масштаба.
scalingCenter?
Точка на экране, относительно которой масштабируется карта. Если точка не задана,
то масштабирование происходит относительно точки позиции карты. Default: null
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
ScalingGestureSettings
Настройки жеста масштабирования.
new ScalingGestureSettings()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
SearchCategoriesResult
Результат запроса категорий.
new SearchCategoriesResult()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
SearchHistory
new SearchHistory()
addItem(item: SearchHistoryItem): void
Добавляет элемент в историю поиска. В случае, если уже существовал такой же элемент, ранний дубликат удаляется.
addItems(items: SearchHistoryItem[]): void
Добавляет список элементов в историю поиска. Считается, что порядок в списке хронологический. Все дубликаты будут убраны.
clear(): void
Очищает историю поиска.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
items(page: SearchHistoryPage): Future<SearchHistoryResult>
Возвращает страницу истории поиска. Элементы возвращаются в упорядоченном виде по времени добавления (от самых свежих до самых поздних).
removeItem(item: SearchHistoryItem): void
Удаляет элемент из истории поиска.
removeItems(items: SearchHistoryItem[]): void
Удаляет список элементов из истории поиска.
setKeyStrategy(keyStrategy: SearchHistoryKeyStrategy | null): void
Устанавливает политику формирования ключей для истории поиска. Миграцию уже существующих записей, созданных с использованием другой политики key_strategy, необходимо выполнять вручную. Если параметр не задан — используется алгоритм по умолчанию.
SearchHistoryResult
Результат работы истории поиска при запросе истории.
new SearchHistoryResult()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
items
Набор элементов истории поиска.
SearchManager
Поисковик. Основная точка входа для справочного API.
new SearchManager()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
search(query: SearchQuery): Future<SearchResult>
Получить объекты справочника, соответствующие данному запросу.
query
future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска
searchByDirectoryObjectIds(objectIds: DgisObjectId[], locale?: Locale | null): Future<DirectoryObject[]>
Получить объекты справочника по идентификаторам с указанной локалью. Для онлайна можно передать не более 100 идентификаторов.
objectIds
locale?
Default: null
future, резолвящаяся в список объектов справочника. Если объекты не найдены, то вернётся пустой список.
searchByIds(ids: string[], locale?: Locale | null): Future<DirectoryObject[]>
Получить объекты справочника по строковым идентификаторам с указанной локалью. Для онлайна можно передать не более 100 идентификаторов.
ids
locale?
Default: null
future, резолвящаяся в список объектов справочника. Если объекты не найдены, то вернётся пустой список.
searchBySuggest(suggest: Suggest, searchSettings: SearchSettings): Future<SearchResult>
Получить объекты справочника, соответствующие данному саджесту.
suggest
searchSettings
future, резолвящаяся в ненулевой указатель на результат поиска или exceptional future, если произошла ошибка при получении результатов поиска
searchCategories(query: CategoryQuery): Future<SearchCategoriesResult>
Получить категории, соответствующие данному запросу.
query
future, резолвящаяся в ненулевой указатель на результат получения категорий или exceptional future, если произошла ошибка при получении категорий
suggest(query: SuggestQuery): Future<SuggestResult>
Получить подсказки, соответствующие данному запросу.
query
future, резолвящаяся в ненулевой указатель на результат подбора подсказок или exceptional future, если произошла ошибка при получении подсказок
createOnlineManager(context: Context): SearchManager
Создать поисковик, работающий онлайн.
SearchQuery
Поисковый запрос.
new SearchQuery()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
SearchQueryBuilder
Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):
- При указании прямоугольной области интереса (set_area_of_interest), поиск ведется в некоторой ее окрестности.
- Если не указан вышестоящий параметр, то учитывается точка положения пользователя.
TODO: Данное условие пока не работает. Будет исправлено в ближайших релизах. 3. При упоминании в тексте запроса широко известного объекта (город, область или другой топоним) добавляется в поиск тот сегмент, в который попадает точка найденного объекта из глобального индекса. 4. Если не указано ничего из вышеперечисленного, то осуществляется поиск по глобальному индексу.
new SearchQueryBuilder()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setAllowedResultTypes(allowedResultTypes: ObjectType[]): SearchQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
setAreaOfInterest(rect: GeoRect | null): SearchQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
setBuildingIds(buildingIds: BuildingId[]): SearchQueryBuilder
Задать идентификаторы зданий для фильтрации объектов в зданиях.
setDirectoryFilter(filter: DirectoryFilter): SearchQueryBuilder
Задать фильтрацию для поискового запроса.
setLocale(locale: Locale | null): SearchQueryBuilder
Задать локаль для поискового запроса.
setOrgId(orgId: OrgId): SearchQueryBuilder
Задать фильтр по идентификаторам организаций, к которым относятся компании.
setPageSize(pageSize: number): SearchQueryBuilder
Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона [1; 50]
по умолчанию 10
setQueryText(queryText: string | null): SearchQueryBuilder
Задать текст поискового запроса.
setRadius(radius: Meter | null): SearchQueryBuilder
Задать радиус поиска в метрах. Работает в сочетании с установленным geo_point. Радиус по умолчанию равен 250 метров. Для поискового запроса в точке ограничение от 0 до 2000. Для остальных запросов ограничение от 0 до 50000.
setRestrictionGeometry(restrictionGeometry: Geometry | null): SearchQueryBuilder
Задать строгое ограничение области поиска геометрией. Для GeometryKind.Point будет выставлен центр строгого ограничения для поискового запроса. Радиус по умолчанию равен 250 метров.
GeometryKind.Polyline и GeometryKind.Polygon будут установлены как полигоны. Первая и последняя точки контура не обязаны совпадать.
Геометрия типа GeometryKind.Complex будет установлена как мулитиполигон. Для GeometryKind.Point внутри GeometryKind.Complex геометрия будет преобразована в контур полигона с радиусом из set_radius.
по умолчанию ограничение отсутствует.
setRubricIds(rubricIds: RubricId[]): SearchQueryBuilder
Задать идентификаторы рубрик.
setSearchNearby(searchNearby: boolean): SearchQueryBuilder
Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
setSortingType(sortingType: SortingType): SearchQueryBuilder
Задать сортировку для поискового запроса.
setTerritoryOfInterest(territoryOfInterest: Geometry | null): SearchQueryBuilder
Задать слабое ограничение области поиска: штраф за непопадание вместо строгого отбрасывания. Работает только с онлайн поиском. Будет проигнорировано при выставленном строгом ограничении поиска.
fromQuery(query: SearchQuery): SearchQueryBuilder
Начать построение запроса на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
SearchQueryWithInfo
Класс с дополнительной информацией о поисковом запросе для вывода в UI-элементах.
new SearchQueryWithInfo(searchQuery: SearchQuery, title: string, subtitle: string)
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
rubrics
Возвращает список рубрик, по которым производится запрос.
searchQuery
Возвращает объект поискового запроса.
subtitle
Возвращает текст подзаголовка. Например, это может быть текст из поля subtitle объекта ISuggest.
title
Возвращает текст заголовка, который описывает объекты поискового запроса. Например, это может быть текст из поля title объекта ISuggest.
SearchResult
Результат работы поисковика.
new SearchResult()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
markerTitles(objectIds: DgisObjectId[]): Future<UIMarkerInfo[]>[]
Получение текстов маркеров по их идентификаторам. Возвращается vector <future
, так как в облако за запрос можно отправить не более 50 идентификаторов.
actionWidgets
Виджеты быстрых фильтров.
Это так называемые "быстрые фильтры" - фильтры, наиболее интересные пользователю. Их не больше 5.
autoUseFirstResult
Признак того, что первый результат пригоден для непосредственного использования.
dynamicFilters
Динамические фильтры для этого запроса.
firstPage
Первая страница результатов поиска.
itemMarkerInfos
Асинхронное получение маркеров.
mainWidgets
Виджеты фильтров.
nearbyRequested
Признак того, что запрошены объекты поблизости.
representativeArea
Прямоугольная область, подходящая для отображения результатов поиска.
searchResultType
Тип поискового запроса.
SimpleCheckableItem
Простой отмечаемый элемент из CheckableItemsGroup.
new SimpleCheckableItem()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
filterType
Получение списка фильтров, описывающих текущее состояние виджета. Может быть использован при формировании поискового запроса.
isChecked
Получение состояния элемента.
text
Получение текстового описания элемента.
type
Получение типа отмечаемого элемента.
values
Получение списка значений, по которым происходит фильтрация. Обычно одно значение.
SimpleClusterObject
Кластер простых (simple) объектов-маркеров.
new SimpleClusterObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
anchor
Получение и установка точки привязки иконки кластера.
animatedAppearance
Получение и установка флага анимируемости появления кластера.
iconMapDirection
Получение и установка угла поворота кластера на карте относительно направления на север, по часовой стрелке.
iconOpacity
Получение и установка прозрачности иконки кластера.
iconWidth
Получение и установка целевой ширины кластера, используемой для масштабирования.
objectCount
Получение количества маркеров в кластере.
objects
Получение списка маркеров в кластере.
position
Получение позиции кластера на карте.
suppressOnOverlap
Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов).
text
Получение и установка подписи кластера.
textStyle
Получение и установка стиля подписи кластера.
userData
Произвольные пользовательские данные, прикрепленные к объекту.
zIndex
Получение и установка уровня отрисовки объекта.
SimpleMapObject
Объект на карте, для которого можно задавать видимость.
new SimpleMapObject()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
Source
Источник данных на карте.
Это может быть источник пробочных данных, маршрутов, маркеров, произвольных геометрических или других объектов карты. У любого объекта карты могут быть свои свойства. Свойства объекта влияют на то, какие к нему применяются правила и параметры отображения, описаные в стилях карты. Стиль - набор параметров и правил отображения объектов карты, получаемый через редактор стилей и использующийся для отрисовки карты.
Свойства объекта могут быть заданы:
- непосредственно для объекта;
- источнику данных (все объекты, добавленные в источник, получают эти свойства);
- карте (все объекты, добавленные на карту, получают эти свойства);
- стилю (все объекты, к которым применён стиль, получают эти свойства). Список приведён в порядке понижения приоритета применения свойств. Даже если на карту не добавлен ни один источник данных, свойства стиля и карты всё равно повлияют на карту, т.к. есть специальные отображаемые объекты, например - фон.
new Source()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
StatefulChannel
Channel that holds a current value. The value is always available through the value getter.
new StatefulChannel()
subscribe(callback: (value: T) => void): Connection
Subscribes to the channel events.
value
Current value of the channel.
Style
Стиль с набором свойств объектов карты (cм. ISource).
new Style()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
styleAttributes
Получение свойств по умолчанию для объектов, к которым применён указанный слой.
StyleZoomFollowController
Контроллер слежения за стилевым уровнем масштабирования карты.
new StyleZoomFollowController(animationDuration?: Duration)
Создание контроллера слежения за стилевым уровнем масштабирования карты.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setStyleZoom(styleZoom: StyleZoom): void
Установка нового значения стилевого уровня масштабирования.
Suggest
Поисковая подсказка.
new Suggest()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
SuggestObjectHandler
Предложен конкретный объект справочника.
new SuggestObjectHandler()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
item
Подсказанный объект.
SuggestQuery
Запрос поисковой подсказки.
new SuggestQuery()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
SuggestQueryBuilder
Построитель запросов к подсказчику.
new SuggestQueryBuilder(queryText: string)
Начать построение запроса подсказки для заданного текста и области интереса.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
setAllowedResultTypes(allowedResultTypes: SuggestedType[]): SuggestQueryBuilder
Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route
setAreaOfInterest(rect: GeoRect | null): SuggestQueryBuilder
Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.
setLimit(limit: number): SuggestQueryBuilder
Задать желаемое количество подсказок. Допустимы значения из диапазона [1; 50]
по умолчанию 10
setLocale(locale: Locale | null): SuggestQueryBuilder
Локаль, с которой производится запрос подсказки и отдаются результаты.
setRestrictionGeometry(restrictionGeometry: Geometry | null): SuggestQueryBuilder
Задать строгое ограничение области поиска геометрией. Для GeometryKind.Point геометрия будет преобразована в контур полигона с радиусом 250 метров.
GeometryKind.Polyline и GeometryKind.Polygon будут установлены как полигоны. Первая и последняя точки контура не обязаны совпадать.
Геометрия типа GeometryKind.Complex будет установлена как мулитиполигон.
по умолчанию ограничение отсутствует.
setSearchNearby(searchNearby: boolean): SuggestQueryBuilder
Указание поисковому движку использовать режим поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя.
setSuggestorType(suggestorType: SuggestorType): SuggestQueryBuilder
Задать тип подсказчика.
по умолчанию #SuggestorType::Object
setTerritoryOfInterest(territoryOfInterest: Geometry | null): SuggestQueryBuilder
Задать слабое ограничение области поиска: штраф за непопадание вместо строгого отбрасывания. Работает только с онлайн поиском. Будет проигнорировано при выставленном строгом ограничении поиска.
fromQuery(query: SuggestQuery): SuggestQueryBuilder
Начать построение запроса подсказки на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений
SuggestResult
Результат работы подсказчика.
new SuggestResult()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
SystemMemoryManager
Интерфейс управления использованием системной памяти.
new SystemMemoryManager()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
reduceMemoryUsage(): void
Уменьшение использования памяти путём очистки всевозможных кешей и буферов.
instance(context: Context): SystemMemoryManager
Получение объекта для управления использованием системной памяти.
TiltFollowController
Контроллер слежения за углом наклона карты.
new TiltFollowController(styleZoomToTilt: StyleZoomToTiltRelation)
Создание контроллера слежения за углом наклона карты.
styleZoomToTilt
зависимость угла наклона камеры от стилевого уровня масштабирования.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
TiltGestureSettings
Настройки жеста наклона.
new TiltGestureSettings()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
TimePoint
Point in time stored as milliseconds since the epoch. Created with the factory methods ofEpochMilliseconds, ofEpochSeconds, now.
ofEpochMilliseconds(ms: number): TimePoint
ofEpochSeconds(seconds: number): TimePoint
TrafficControlModel
Модель контрола пробок.
Этот интерфейс является потокобезопасным.
new TrafficControlModel(map: Map)
Функция создания модели элемента управления пробками.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
onClicked(): void
Действие при нажатии на контрол. Переключает видимость пробок на карте.
TrafficScoreProvider
Подписка на обновления информации о величине пробок.
Этот интерфейс является потокобезопасным.
new TrafficScoreProvider()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
fromGeoPoint(context: Context, point: GeoPoint): TrafficScoreProvider
TrafficSource
Интерфейс класса, управляющего отображением пробок на карте.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
Widget
Базовый класс, представляющий виджет для фильтрации поисковой выдачи.
Виджеты возвращаются в результате поиска и предназначены для фильтрации или сортировки результата по определенным параметрам. Виджеты генерируются динамически для каждого результата поиска и могут отсутствовать для некоторых запросов. Виджет представляет один конкретный фильтр или их группу, объединённую общим признаком. Например, тип кухни в результатах поиска по запросу "Поесть".
new Widget()
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
ZoomControlModel
Модель контрола зумирования. Контрол состоит из кнопок +/-, при нажатии на которые меняется масштаб карты. При достижении допустимой границы масштаба кнопка масштабирования в этом направлении становится неактивной. Методы объекта необходимо вызывать на одном потоке.
destroy(): void
Releases the native object this handle refers to. Every TypeScript reference to the destroyed object becomes invalid: any further call on it throws an error.
Without destroy the native object lives as long as its JS handle. The garbage collector can collect the handle, but it only sees the small JS wrapper, not the native memory behind it. With little pressure on the JS heap the collector may not run, so a heavy native object can stay in memory long after it was last used. Call destroy once the object is definitely no longer needed to release the native memory deterministically.
equals(other: NativeObject): boolean
Checks whether this handle and other refer to the same native object.
Every call that returns a native object creates a fresh TypeScript
wrapper, so === between two wrappers of the same underlying object is
always false. Use equals to compare identity instead: it returns true
only when both handles point to the same C++ object. Wrappers of
distinct objects, and any handle whose object was destroyed, compare as
not equal.
other
isEnabled(button: ZoomControlButton): StatefulChannel<boolean>
setPressed(button: ZoomControlButton, value: boolean): void