atlas module

Ссылка

Пакет:: azure-maps-control

Классы

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

Интерфейсы

AggregateExpression	Статистическое выражение определяет вычисление, обрабатываемое по набору данных. Схема: [оператор: string, initialValue?: boolean \| number, mapExpression: Expression]: функция выражения, которая затем применяется ко всем значениям, вычисляемым `mapExpression` для каждой точки в кластере. Поддерживаемые операторы: o Для чисел: `+`, `*`, `maxmin` , `min` o Для логических значений: `all`, `any` initialValue: Необязательно, начальное значение, в котором первое вычисляемое значение агрегируется. mapExpression: выражение, применяемое к каждой точке в наборе данных.
AnimationOptions	Параметры анимации изменений камеры элемента управления картой.
AuthenticationManager	Диспетчер проверки подлинности элемента управления картой. Предоставляется через свойство проверки подлинности атласа. Класс Map. Невозможно создать экземпляр пользователя.
AuthenticationOptions	Параметры указания способа проверки подлинности элемента управления картой со службами Azure Maps.
BubbleLayerOptions	Параметры, используемые при отрисовке объектов Point в BubbleLayer.
CameraBoundsOptions	Параметры настройки границ камеры элемента управления картой.
CameraOptions	Параметры настройки камеры элемента управления картой.
ClusteredProperties	Свойства, которые будут существовать для ClusteredProperties
CompassControlOptions	Параметры объекта CompassControl.
Control	Интерфейс для определения элемента управления картой.
ControlManager	Диспетчер элементов управления картой. Предоставляется с помощью свойства элементов управления atlas. Класс Map. Невозможно создать экземпляр пользователя.
ControlOptions	Параметры добавления элемента управления на карту.
DataSourceOptions	Источник данных для управления данными фигур, которые будут отображаться на карте. Источник данных необходимо добавить в слой, прежде чем он отображается на карте. Параметры `DataSourceOptions`.
ElevationTileSourceOptions
FullscreenControlOptions	Параметры объекта FullscreenControl.
HeatMapLayerOptions	Параметры, используемые при отрисовке объектов Point в HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Диспетчер маркеров HTML элемента управления картой. Предоставляется через свойство маркеров атласа. Класс Map. Невозможно создать экземпляр пользователя.
HtmlMarkerOptions	Параметры отрисовки объекта HtmlMarker
HyperLinkFormatOptions	Параметр форматирования строк гиперссылки.
IconOptions	Параметры, используемые для настройки значков в SymbolLayer
ImageLayerOptions	Параметры, используемые при отрисовке объектов Point в ImageLayer.
ImageSpriteManager	Диспетчер спрайта изображения элемента управления картой. Предоставляется через свойство imageSprite атласа. Класс Map. Невозможно создать экземпляр пользователя.
LayerManager	Диспетчер слоев элемента управления картой. Предоставляется через свойство слоев атласа. Класс Map. Невозможно создать экземпляр пользователя.
LayerOptions	Базовый класс, от которого наследуются все остальные параметры слоя.
LightOptions	Параметры освещения карты.
LineLayerOptions	Параметры, используемые при отрисовке объектов SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon и MultiPolygon на уровне линий.
MapConfiguration	Представляет содержимое конфигурации карты, содержащую список стилей, доступных для них.
MapConfigurationStyle	Представляет сведения для одного стиля.
MapDataEvent	Объект события, возвращаемый картами при возникновении события данных.
MapErrorEvent	Объект события, возвращаемый картами при возникновении события ошибки.
MapEvent	Объект события, возвращаемый картами при возникновении базового события.
MapMouseEvent	Объект события, возвращаемый картами при возникновении события мыши.
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	Менеджер источников элемента управления картой. Предоставляется через свойство источников атласа. Класс Map. Невозможно создать экземпляр пользователя.
StyleChangedEvent	Объект события, возвращаемый картой после загрузки нового стиля.
StyleControlOptions	Параметры объекта StyleControl.
StyleOptions	Параметры стиля карты.
SymbolLayerOptions	Параметры, используемые при отрисовке геометрий в SymbolLayer.
TargetedEvent
TextOptions	Параметры, используемые для настройки текста в SymbolLayer
Tile	Объект плитки, возвращаемый картой при возникновении события исходных данных.
TileId
TileLayerOptions	Параметры, используемые при отрисовке растровых растровых изображений в плитке TileLayer.
TrafficControlOptions
TrafficOptions	Параметры настройки трафика на карте.
UserInteractionOptions	Параметры включения и отключения взаимодействия пользователей с картой.
VectorTileSourceOptions	Источник данных для управления данными фигур, которые будут отображаться на карте. Источник данных необходимо добавить в слой, прежде чем он отображается на карте. Параметры `VectorTileSource`.
WebGLLayerOptions	Параметры, используемые для отрисовки графики в WebGLLayer.
WebGLRenderer	Интерфейс для отрисовки графики WebGL в WebGLLayer.
ZoomControlOptions	Параметры объекта ZoomControl.

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

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

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

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

Функции

addImageTemplate(string, string, boolean)	Добавляет шаблон изображения в пространство имен atlas.
addProtocol(string, (args: any[]) => Promise<any>)	Добавляет пользовательскую функцию ресурса загрузки, которая будет вызываться при использовании URL-адреса, начинающегося с пользовательской схемы URL-адресов.
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()`эти ресурсы будут созданы заранее и не будут удалены при удалении последней карты со страницы. Это позволяет повторно использовать их новыми экземплярами карты, созданными позже. Их можно очистить вручную, вызвав `atlas.clearPrewarmedResources()`. Это необходимо только в том случае, если веб-страница остается активной, но перестает использовать карты в целом. Это особенно полезно при использовании GL-JS карт в одном приложении страницы, в котором пользователь будет перемещаться между различными представлениями, которые могут привести к постоянному созданию и уничтожению экземпляров карты.
removeProtocol(string)	Удаляет ранее добавленный протокол в основном потоке.
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 ранее не была вызвана конструктором Карты.
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

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

addProtocol(string, (args: any[]) => Promise<any>)

Добавляет пользовательскую функцию ресурса загрузки, которая будет вызываться при использовании URL-адреса, начинающегося с пользовательской схемы URL-адресов.

function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)

Параметры

customProtocol: string

протокол для перехватчика, например "custom"

loadFn: (args: any[]) => Promise<any>

функция, используемая при попытке получить плитку, указанную в customProtocol

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

Теперь этот 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

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

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

boolean

prewarm()

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

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

function prewarm()

removeProtocol(string)

Удаляет ранее добавленный протокол в основном потоке.

function removeProtocol(customProtocol: string)

Параметры

customProtocol: string

Пользовательский протокол для удаления регистрации

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 ранее не была вызвана конструктором Карты.

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

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

Поделиться через

atlas module

Классы

Интерфейсы

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

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

Функции

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

addImageTemplate(string, string, boolean)

Параметры

addProtocol(string, (args: any[]) => Promise<any>)

Параметры

clearPrewarmedResources()

getAllImageTemplateNames()

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

getAuthenticationOptions()

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

getDomain()

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

getImageTemplate(string, number)

Параметры

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

getLanguage()

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

getMaxParallelImageRequests()

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

getSessionId()

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

getSubscriptionKey()

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

getUserRegion()

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

getVersion()

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

getView()

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

getWorkerCount()

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

isSupported(boolean)

Параметры

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

prewarm()

removeProtocol(string)

Параметры

setAuthenticationOptions(AuthenticationOptions)

Параметры

setDomain(string)

Параметры

setLanguage(string)

Параметры

setMaxParallelImageRequests(number)

Параметры

setSessionId(string)

Параметры

setSubscriptionKey(string)

Параметры

setUserRegion(string)

Параметры

setView(string)

Параметры

setWorkerCount(number)

Параметры

Дополнительные ресурсы