atlas module

Пакет:

azure-maps-control

Классы

EventManager	Диспетчер событий элемента управления картой. Предоставляется через свойство events атласа. Класс Map. Пользователь не может создать экземпляр .
HtmlMarker	Этот класс заключает в оболочку HTML-элемент, который может отображаться на карте.
Map	Элемент управления для визуальной и интерактивной веб-карты.
Pixel	Представляет координату или смещение пикселя. Расширяет массив [x, y].
Popup	Информационное окно, привязанное к заданной позиции на карте.
PopupTemplate	Шаблон макета для всплывающего окна.
Shape	Вспомогательный класс, который создает оболочку geometry или feature и упрощает обновление и обслуживание.

Интерфейсы

AggregateExpression	Статистическое выражение определяет вычисление, которое обрабатывается по набору данных. Schema: [operator: string, initialValue?: boolean | number, mapExpression: Expression], оператор: функция выражения, которая затем применяется ко всем значениям, вычисляемым с помощью mapExpression для каждой точки в кластере. Поддерживаемые операторы: o Для чисел: +, *, maxmin , o Для логических значений: all, any initialValue: необязательно, начальное значение, в котором вычисляется первое вычисляемое значение. mapExpression: выражение, применяемое к каждой точке в наборе данных.
AnimationOptions	Параметры анимации изменений камеры элемента управления картой.
AuthenticationManager	Диспетчер проверки подлинности элемента управления картой. Предоставляется через свойство проверки подлинности atlas. Класс Map. Пользователь не может создать экземпляр .
AuthenticationOptions	Параметры для указания способа проверки подлинности элемента управления картой в службах Azure Maps.
BubbleLayerOptions	Параметры, используемые при отрисовке объектов Point в BubbleLayer.
CameraBoundsOptions	Параметры для настройки границ камеры элемента управления картой.
CameraOptions	Параметры настройки камеры элемента управления картой.
ClusteredProperties	Свойства, которые будут существовать для ClusteredProperties
CompassControlOptions	Параметры для объекта CompassControl.
Control	Интерфейс для определения элемента управления картой.
ControlManager	Диспетчер элементов управления картой. Предоставляется через свойство controls атласа. Класс Map. Пользователь не может создать экземпляр .
ControlOptions	Параметры добавления элемента управления на карту.
DataSourceOptions	Источник данных для управления данными фигуры, которые будут отображаться на карте. Источник данных должен быть добавлен в слой, прежде чем он станет видимым на карте. Параметры для DataSourceOptions.
ElevationTileSourceOptions
HeatMapLayerOptions	Параметры, используемые при отрисовке объектов Point в HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Диспетчер маркеров HTML элемента управления картой. Предоставляется через свойство маркеров атласа. Класс Map. Пользователь не может создать экземпляр .
HtmlMarkerOptions	Параметры отрисовки объекта HtmlMarker
HyperLinkFormatOptions	Параметр format для строк гиперссылки.
IconOptions	Параметры, используемые для настройки значков в SymbolLayer
ImageLayerOptions	Параметры, используемые при отрисовке объектов Point в ImageLayer.
ImageSpriteManager	Диспетчер спрайта изображений элемента управления картой. Предоставляется через свойство imageSprite атласа. Класс Map. Пользователь не может создать экземпляр .
LayerManager	Диспетчер слоев элемента управления картой. Предоставляется через свойство слоев атласа. Класс Map. Пользователь не может создать экземпляр .
LayerOptions	Базовый класс, от которого наследуются все остальные параметры слоя.
LightOptions	Параметры освещения карты.
LineLayerOptions	Параметры, используемые при отрисовке объектов SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon и MultiPolygon в слое линий.
MapConfiguration	Представляет содержимое конфигурации карты со списком доступных стилей.
MapConfigurationStyle	Представляет сведения для одного стиля.
MapDataEvent	Объект события, возвращаемый картой при возникновении события данных.
MapErrorEvent	Объект event, возвращаемый объектом сопоставления при возникновении события ошибки.
MapEvent	Объект события, возвращаемый картой при возникновении базового события.
MapMouseEvent	Объект event, возвращаемый картой при возникновении события мыши.
MapMouseWheelEvent	Объект события, возвращаемый картой при возникновении события колеса.
MapTouchEvent	Объект события, возвращаемый картой при возникновении события касания.
MediaLayerOptions	Параметры, используемые при отрисовке холста, изображения, растровой плитки и слоев видео
Options
Padding	Представляет объем заполнений в пикселях, добавляемых на сторону BoundingBox при настройке камеры карты.
PitchControlOptions	Параметры для объекта PitchControl.
PolygonExtrusionLayerOptions	Параметры, используемые при отрисовке Polygon объектов и MultiPolygon в PolygonExtrusionLayer.
PolygonLayerOptions	Параметры, используемые при отрисовке объектов Polygon и MultiPolygon в PolygonLayer.
PopupEvents
PopupManager	Диспетчер всплывающих окон элемента управления картой. Предоставляется через popups свойство atlas.Map класса . Пользователь не может создать экземпляр .
PopupOptions	Параметры для всплывающего окна.
Properties	Набор свойств, которые можно использовать с PopupTemplate
PropertyInfo	Сведения о том, как должно отображаться свойство.
RasterTileSourceOptions
RequestParameters	Это тип объекта, который должен быть возвращен обратным вызовом transformRequest.
ScaleControlOptions	Параметры для объекта ScaleControl.
ServiceOptions	Глобальные свойства, используемые во всех запросах службы atlas.
ShapeEvents
SourceManager	Диспетчер источников элемента управления картой. Предоставляется через свойство sources атласа. Класс Map. Пользователь не может создать экземпляр .
StyleChangedEvent	Объект события, возвращаемый картой после загрузки нового стиля.
StyleControlOptions	Параметры для объекта StyleControl.
StyleOptions	Параметры стиля карты.
SymbolLayerOptions	Параметры, используемые при отрисовке геометрических объектов в SymbolLayer.
TargetedEvent
TextOptions	Параметры, используемые для настройки текста в SymbolLayer
Tile	Объект Tile, возвращаемый картой при возникновении события исходных данных.
TileId
TileLayerOptions	Параметры, используемые при отрисовке растровых плиток изображений в TileLayer.
TrafficControlOptions
TrafficOptions	Параметры для настройки трафика на карте.
UserInteractionOptions	Параметры для включения или отключения взаимодействия пользователя с картой.
VectorTileSourceOptions	Источник данных для управления данными фигуры, которые будут отображаться на карте. Источник данных должен быть добавлен в слой, прежде чем он станет видимым на карте. Параметры для VectorTileSource.
WebGLLayerOptions	Параметры, используемые для отрисовки графики в WebGLLayer.
WebGLRenderer	Интерфейс для отрисовки графики WebGL в WebGLLayer.
ZoomControlOptions	Параметры для объекта ZoomControl.

Псевдонимы типа

Expression	Можно указать в качестве значения фильтра или определенных параметров слоя. Выражение определяет формулу для вычисления значения свойства . Выражения представлены в виде массивов JSON. Первый элемент выражения — это строка, именующая оператор expression.
getAuthTokenCallback	Функция обратного вызова, используемая для получения маркера проверки подлинности в анонимном режиме проверки подлинности. Разрешение с помощью маркера проверки подлинности или отклонение с любыми ошибками.
ResourceType
StyleImageMetadata	Сигнатура для параметра, options переданного в ImageSpriteManager.add.

Перечисления

AuthenticationType	Перечисление, используемое для указания типа используемого механизма проверки подлинности.
ControlPosition	Позиции, в которых можно разместить элемент управления на карте.
ControlStyle	Доступные стили для элемента управления.

Функции

addImageTemplate(string, string, boolean)	Добавляет шаблон изображения в пространство имен atlas.
clearPrewarmedResources()	Очищает ресурсы, созданные ранее atlas.prewarm(). Обратите внимание, что обычно это необязательно. Эту функцию следует вызывать только в том случае, если ожидается, что пользователь приложения не вернется в представление карты в любой точке приложения.
getAllImageTemplateNames()	Извлекает массив имен для всех шаблонов изображений, доступных в пространстве имен atlas.
getAuthenticationOptions()	Возвращает предоставленные параметры проверки подлинности по умолчанию. Если не задано ранее, все свойства будут неопределенными.
getDomain()	Возвращает предоставленный домен по умолчанию. Если ранее не задано, значение по умолчанию — "atlas.microsoft.com".
getImageTemplate(string, number)	Извлекает шаблон SVG по имени.
getLanguage()	Возвращает язык по умолчанию, который был указан. Если ранее не задано, значение по умолчанию — "NGT".
getMaxParallelImageRequests()	Возвращает максимальное число изображений (растровых плиток, спрайтов, значков), которые загружаются параллельно.
getSessionId()	Возвращает предоставленный идентификатор сеанса по умолчанию. Если ранее не было задано, значением по умолчанию является случайный UUID.
getSubscriptionKey()	Возвращает предоставленный ключ подписки по умолчанию Azure Maps.
getUserRegion()
getVersion()	Номер текущей версии API на основе номера сборки.
getView()	Возвращает параметр представления по умолчанию для элемента управления картой. Если ранее не задано, значение по умолчанию — undefined.
getWorkerCount()	Возвращает число создаваемых рабочих ролей.
isSupported(boolean)	Проверяет, поддерживается ли браузер пользователя элементом управления картой.
prewarm()	Инициализирует такие ресурсы, как WebWorkers, которые можно совместно использовать в картах, чтобы снизить время загрузки в некоторых ситуациях. atlas.setWorkerCountЗначение , если используется, должно быть задано перед prewarm() вызовом метода , чтобы иметь эффект. По умолчанию жизненный цикл этих ресурсов управляется автоматически, и они отложенно инициализируются при первом создании карты. При вызове prewarm()эти ресурсы будут созданы заранее и не будут удалены при удалении последней карты со страницы. Это позволяет повторно использовать их новыми экземплярами map, которые будут созданы позже. Их можно очистить вручную, вызвав .atlas.clearPrewarmedResources() Это необходимо только в том случае, если веб-страница остается активной, но перестает использовать карты. Это в первую очередь полезно при использовании карт GL-JS в одностраничном приложении, где пользователь будет перемещаться между различными представлениями, что может привести к постоянному созданию и уничтожению экземпляров map.
setAuthenticationOptions(AuthenticationOptions)	Задает параметры проверки подлинности в качестве параметров по умолчанию в пространстве имен atlas, которое используется элементом управления картой и любыми модулями, которые выполняют запросы к службам Azure Maps. Если карта инициализирована с явно определенными параметрами проверки подлинности и методом setAuthenticationOptions ранее не вызывался, конструктор map будет автоматически вызываться.
setDomain(string)	Задает домен по умолчанию, используемый модулями карт и служб, если домен не указан явным образом при использовании этих частей API. Если карта инициализирована с помощью домена, явно определенного, и setDomain ранее не вызывался, она будет автоматически вызвана конструктором Map. Если протокол не указан https , предполагается.
setLanguage(string)	Задает язык по умолчанию, используемый модулями карт и служб, если язык не указан явно при использовании этих частей API. Если карта инициализирована с помощью явно определенного языка и setLanguage ранее не вызывалась, она будет автоматически вызвана конструктором Map.
setMaxParallelImageRequests(number)	Задает максимальное количество изображений (растровых плиток, спрайтов, значков) для параллельной загрузки, что влияет на производительность на растровых картах. 16 по умолчанию.
setSessionId(string)	Задает идентификатор сеанса по умолчанию, используемый модулями карты и службы, если идентификатор сеанса не указан явным образом при использовании этих частей API. Если карта инициализирована с явно определенным идентификатором сеанса и setSessionId ранее не вызывалась, она будет автоматически вызвана конструктором Map.
setSubscriptionKey(string)	Задает ключ подписки Azure Maps в качестве ключа подписки по умолчанию в пространстве имен atlas, которое используется элементом управления картой и любыми модулями, которые выполняют запросы к службам Azure Maps. Если карта инициализирована с явно определенным ключом подписки и setSubscriptionKey ранее не вызывалась, конструктор map будет автоматически вызываться.
setUserRegion(string)
setView(string)	Указывает, какой набор геополитически спорных границ и меток отображается на карте. Параметр View (также называемый "параметром региона пользователя") — это 2-буквенный код страны ISO-3166, в котором отображаются правильные карты для этой страны или региона. Страна или регионы, которые отсутствуют в списке Представление или если они не указаны, по умолчанию будут использовать "Единое" представление. См. поддерживаемые [представления]{@link https://aka.ms/AzureMapsLocalizationViews }. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которой доступны карты, изображения и другие данные и содержимое стороннего поставщика, доступ к которому вы имеете через Azure Maps.
setWorkerCount(number)	Задает количество веб-рабочих ролей, созданных на странице. По умолчанию устанавливается половина числа ядер ЦП (ограничено 6).

Сведения о функции

addImageTemplate(string, string, boolean)

Добавляет шаблон изображения в пространство имен atlas.

function addImageTemplate(templateName: string, template: string, override: boolean)

Параметры

templateName

string

Имя шаблона.

template

string

Добавляемый шаблон SVG. Поддерживает {color}, {secondaryColor}, {scale}, {text}.

override

boolean

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

clearPrewarmedResources()

Очищает ресурсы, созданные ранее atlas.prewarm(). Обратите внимание, что обычно это необязательно. Эту функцию следует вызывать только в том случае, если ожидается, что пользователь приложения не вернется в представление карты в любой точке приложения.

function clearPrewarmedResources()

getAllImageTemplateNames()

Извлекает массив имен для всех шаблонов изображений, доступных в пространстве имен atlas.

function getAllImageTemplateNames(): string[]

Возвращаемое значение

string[]

getAuthenticationOptions()

Возвращает предоставленные параметры проверки подлинности по умолчанию. Если не задано ранее, все свойства будут неопределенными.

function getAuthenticationOptions(): AuthenticationOptions

Возвращаемое значение

AuthenticationOptions

getDomain()

Возвращает предоставленный домен по умолчанию. Если ранее не задано, значение по умолчанию — "atlas.microsoft.com".

function getDomain(): string

Возвращаемое значение

string

getImageTemplate(string, number)

Извлекает шаблон SVG по имени.

function getImageTemplate(templateName: string, scale?: number): string

Параметры

templateName

string

Имя извлекаемого шаблона.

scale

number

Указывает, сколько нужно масштабировать шаблон. Чтобы получить наилучшие результаты, масштабируйте значок до максимального размера, который вы хотите отобразить на карте, а затем используйте параметр размер значка символьных слоев, чтобы уменьшить масштаб при необходимости. Это снизит размытость из-за масштабирования. Значение по умолчанию: 1.

Возвращаемое значение

string

getLanguage()

Возвращает язык по умолчанию, который был указан. Если ранее не задано, значение по умолчанию — "NGT".

function getLanguage(): string

Возвращаемое значение

string

getMaxParallelImageRequests()

Возвращает максимальное число изображений (растровых плиток, спрайтов, значков), которые загружаются параллельно.

function getMaxParallelImageRequests(): number

Возвращаемое значение

number

getSessionId()

Возвращает предоставленный идентификатор сеанса по умолчанию. Если ранее не было задано, значением по умолчанию является случайный UUID.

function getSessionId(): string

Возвращаемое значение

string

getSubscriptionKey()

Возвращает предоставленный ключ подписки по умолчанию Azure Maps.

function getSubscriptionKey(): string

Возвращаемое значение

string

getUserRegion()

Предупреждение

Теперь этот API является нерекомендуемым.

use atlas.getView() instead

function getUserRegion(): string

Возвращаемое значение

string

getVersion()

Номер текущей версии API на основе номера сборки.

function getVersion(): string

Возвращаемое значение

string

getView()

Возвращает параметр представления по умолчанию для элемента управления картой. Если ранее не задано, значение по умолчанию — undefined.

function getView(): string

Возвращаемое значение

string

getWorkerCount()

Возвращает число создаваемых рабочих ролей.

function getWorkerCount(): number

Возвращаемое значение

number

isSupported(boolean)

Проверяет, поддерживается ли браузер пользователя элементом управления картой.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Параметры

failIfMajorPerformanceCaveat

boolean

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

Возвращаемое значение

boolean

prewarm()

Инициализирует такие ресурсы, как WebWorkers, которые можно совместно использовать в картах, чтобы снизить время загрузки в некоторых ситуациях. atlas.setWorkerCountЗначение , если используется, должно быть задано перед prewarm() вызовом метода , чтобы иметь эффект. По умолчанию жизненный цикл этих ресурсов управляется автоматически, и они отложенно инициализируются при первом создании карты. При вызове prewarm()эти ресурсы будут созданы заранее и не будут удалены при удалении последней карты со страницы. Это позволяет повторно использовать их новыми экземплярами map, которые будут созданы позже. Их можно очистить вручную, вызвав .atlas.clearPrewarmedResources() Это необходимо только в том случае, если веб-страница остается активной, но перестает использовать карты.

Это в первую очередь полезно при использовании карт GL-JS в одностраничном приложении, где пользователь будет перемещаться между различными представлениями, что может привести к постоянному созданию и уничтожению экземпляров map.

function prewarm()

setAuthenticationOptions(AuthenticationOptions)

Задает параметры проверки подлинности в качестве параметров по умолчанию в пространстве имен atlas, которое используется элементом управления картой и любыми модулями, которые выполняют запросы к службам Azure Maps. Если карта инициализирована с явно определенными параметрами проверки подлинности и методом setAuthenticationOptions ранее не вызывался, конструктор map будет автоматически вызываться.

function setAuthenticationOptions(options: AuthenticationOptions)

Параметры

options

AuthenticationOptions

Новые параметры проверки подлинности по умолчанию.

setDomain(string)

Задает домен по умолчанию, используемый модулями карт и служб, если домен не указан явным образом при использовании этих частей API. Если карта инициализирована с помощью домена, явно определенного, и setDomain ранее не вызывался, она будет автоматически вызвана конструктором Map. Если протокол не указан https , предполагается.

function setDomain(domain: string)

Параметры

domain

string

Новый домен по умолчанию.

setLanguage(string)

Задает язык по умолчанию, используемый модулями карт и служб, если язык не указан явно при использовании этих частей API. Если карта инициализирована с помощью явно определенного языка и setLanguage ранее не вызывалась, она будет автоматически вызвана конструктором Map.

function setLanguage(language: string)

Параметры

language

string

Новый язык по умолчанию.

setMaxParallelImageRequests(number)

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

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Параметры

maxParallelImageRequests

number

Максимальное число изображений для параллельной загрузки.

setSessionId(string)

Задает идентификатор сеанса по умолчанию, используемый модулями карты и службы, если идентификатор сеанса не указан явным образом при использовании этих частей API. Если карта инициализирована с явно определенным идентификатором сеанса и setSessionId ранее не вызывалась, она будет автоматически вызвана конструктором Map.

function setSessionId(id: string)

Параметры

id

string

Новый идентификатор сеанса по умолчанию.

setSubscriptionKey(string)

Задает ключ подписки Azure Maps в качестве ключа подписки по умолчанию в пространстве имен atlas, которое используется элементом управления картой и любыми модулями, которые выполняют запросы к службам Azure Maps. Если карта инициализирована с явно определенным ключом подписки и setSubscriptionKey ранее не вызывалась, конструктор map будет автоматически вызываться.

function setSubscriptionKey(key: string)

Параметры

key

string

Новый ключ подписки по умолчанию.

setUserRegion(string)

Предупреждение

Теперь этот API является нерекомендуемым.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Параметры

userRegion

string

setView(string)

Указывает, какой набор геополитически спорных границ и меток отображается на карте. Параметр View (также называемый "параметром региона пользователя") — это 2-буквенный код страны ISO-3166, в котором отображаются правильные карты для этой страны или региона. Страна или регионы, которые отсутствуют в списке Представление или если они не указаны, по умолчанию будут использовать "Единое" представление. См. поддерживаемые [представления]{@link https://aka.ms/AzureMapsLocalizationViews }. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которой доступны карты, изображения и другие данные и содержимое стороннего поставщика, доступ к которому вы имеете через Azure Maps.

function setView(view: string)

Параметры

view

string

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

setWorkerCount(number)

Задает количество веб-рабочих ролей, созданных на странице. По умолчанию устанавливается половина числа ядер ЦП (ограничено 6).

function setWorkerCount(workerCount: number)

Параметры

workerCount

number

количество рабочих ролей.