ServiceOptions interface
Глобальные свойства, используемые во всех запросах на обслуживание atlas.
- Extends
Свойства
auth |
Параметры проверки подлинности, используемые для настройки проверки подлинности элемента управления картой в службах Azure Maps. Если указаны эти параметры проверки подлинности, значение ServiceOptions.subscriptionKey не должно быть. Рекомендуется использовать функцию atlas.setAuthenticationOptions. |
disable |
Отключить сбор данных телеметрии. Этот параметр можно задать только при инициализации карты. default: false (true для облака Azure для государственных организаций) |
domain | Домен, используемый при запросе плиток карты и других служб Azure Maps.
Если протокол не указан |
enable |
Включите функцию специальных возможностей, чтобы обеспечить поддержку средства чтения с экрана для пользователей, которым трудно визуализировать веб-приложение. По умолчанию для этого свойства задано значение true. |
enable |
Включите откат к геокоду REST API для обнаружения специальных возможностей расположения в случае сбоя извлечения расположения из векторных данных. Отключение этого параметра помешает создавать запросы API геокода, но может привести к отсутствию сведений о расположении для средств чтения с экрана. default: true |
fade |
Управляет длительностью анимации затухания или исчезновения для конфликтов меток в миллисекундах. Этот параметр влияет на все слои символов. Этот параметр не влияет на продолжительность переходов стилей среды выполнения или перекрестной перекрестной растровой плитки. |
local |
Определяет семейство шрифтов CSS для локального переопределения создания глифов в диапазонах "Унифицированные идеографы CJK", "Хирагана", "Катакана" и "Хангыл Слоги". В этих диапазонах параметры шрифта из стиля карты будут игнорироваться, за исключением ключевых слов по весу шрифта (светлый,обычный/средний/полужирный). Установите значение false, чтобы включить параметры шрифта из стиля карты для этих диапазонов глифов. Этот параметр предназначен для того, чтобы избежать запросов сервера глифа с интенсивным использованием пропускной способности. |
map |
Конфигурация карты определяет набор стилей, доступных для карты. |
max |
Максимальное количество изображений (растровых плиток, спрайтов, значков) для параллельной загрузки, что влияет на производительность на картах с большим количеством растров. 16 по умолчанию. |
refresh |
Логическое значение, указывающее, следует ли перезагружать векторные и растровые плитки по истечении срока их действия (на основе заголовка истекает). Это полезно для часто обновляемых наборов данных. Если задано значение false, каждая плитка будет загружена один раз, когда это необходимо, а не перезагружается по истечении срока действия. default: true |
session |
Идентификатор сеанса для передачи с запросами. Рекомендуется использовать atlas.setSessionId. |
style |
Версия API стилей, используемая при запросе стилей и наборов стилей |
style |
Версия определений стилей, запрашиваемая при запросе стилей из styleDefinitionsPath. |
subscription |
Ключ подписки клиента, используемый для авторизации запросов. Этот параметр можно задать только при инициализации карты. Рекомендуется использовать функцию atlas.setSubscriptionKey. |
transform |
Если определен параметр transformRequest, будет вызываться для предоставления пользовательских параметров запроса для загрузки плитки. |
validate |
Значение true для проверки стилей перед применением. Для обработки стилей во время начальной загрузки требуется значительное (несколько сотен мс) времени. |
worker |
Количество веб-рабочих ролей, созданных на странице. По умолчанию устанавливается половина числа ядер ЦП (ограничено 6). |
Сведения о свойстве
authOptions
Параметры проверки подлинности, используемые для настройки проверки подлинности элемента управления картой в службах Azure Maps. Если указаны эти параметры проверки подлинности, значение ServiceOptions.subscriptionKey не должно быть. Рекомендуется использовать функцию atlas.setAuthenticationOptions.
authOptions?: AuthenticationOptions
Значение свойства
disableTelemetry
Отключить сбор данных телеметрии. Этот параметр можно задать только при инициализации карты. default: false (true для облака Azure для государственных организаций)
disableTelemetry?: boolean
Значение свойства
boolean
domain
Домен, используемый при запросе плиток карты и других служб Azure Maps.
Если протокол не указан https
, предполагается.
Рекомендуется использовать функцию atlas.setDomain.
domain?: string
Значение свойства
string
enableAccessibility
Включите функцию специальных возможностей, чтобы обеспечить поддержку средства чтения с экрана для пользователей, которым трудно визуализировать веб-приложение. По умолчанию для этого свойства задано значение true.
enableAccessibility?: boolean
Значение свойства
boolean
enableAccessibilityLocationFallback
Включите откат к геокоду REST API для обнаружения специальных возможностей расположения в случае сбоя извлечения расположения из векторных данных. Отключение этого параметра помешает создавать запросы API геокода, но может привести к отсутствию сведений о расположении для средств чтения с экрана. default: true
enableAccessibilityLocationFallback?: boolean
Значение свойства
boolean
fadeDuration
Управляет длительностью анимации затухания или исчезновения для конфликтов меток в миллисекундах. Этот параметр влияет на все слои символов. Этот параметр не влияет на продолжительность переходов стилей среды выполнения или перекрестной перекрестной растровой плитки.
fadeDuration?: number
Значение свойства
number
localIdeographFontFamily
Определяет семейство шрифтов CSS для локального переопределения создания глифов в диапазонах "Унифицированные идеографы CJK", "Хирагана", "Катакана" и "Хангыл Слоги". В этих диапазонах параметры шрифта из стиля карты будут игнорироваться, за исключением ключевых слов по весу шрифта (светлый,обычный/средний/полужирный). Установите значение false, чтобы включить параметры шрифта из стиля карты для этих диапазонов глифов. Этот параметр предназначен для того, чтобы избежать запросов сервера глифа с интенсивным использованием пропускной способности.
localIdeographFontFamily?: string
Значение свойства
string
mapConfiguration
Конфигурация карты определяет набор стилей, доступных для карты.
mapConfiguration?: string | MapConfiguration
Значение свойства
string | MapConfiguration
maxParallelImageRequests
Максимальное количество изображений (растровых плиток, спрайтов, значков) для параллельной загрузки, что влияет на производительность на картах с большим количеством растров. 16 по умолчанию.
maxParallelImageRequests?: number
Значение свойства
number
refreshExpiredTiles
Логическое значение, указывающее, следует ли перезагружать векторные и растровые плитки по истечении срока их действия (на основе заголовка истекает). Это полезно для часто обновляемых наборов данных. Если задано значение false, каждая плитка будет загружена один раз, когда это необходимо, а не перезагружается по истечении срока действия. default: true
refreshExpiredTiles?: boolean
Значение свойства
boolean
sessionId
Идентификатор сеанса для передачи с запросами. Рекомендуется использовать atlas.setSessionId.
sessionId?: string
Значение свойства
string
styleAPIVersion
Версия API стилей, используемая при запросе стилей и наборов стилей
styleAPIVersion?: string
Значение свойства
string
styleDefinitionsVersion
Версия определений стилей, запрашиваемая при запросе стилей из styleDefinitionsPath.
styleDefinitionsVersion?: string
Значение свойства
string
subscriptionKey
Ключ подписки клиента, используемый для авторизации запросов. Этот параметр можно задать только при инициализации карты. Рекомендуется использовать функцию atlas.setSubscriptionKey.
subscriptionKey?: string
Значение свойства
string
transformRequest
Если определен параметр transformRequest, будет вызываться для предоставления пользовательских параметров запроса для загрузки плитки.
transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters
Значение свойства
(url: string, resourceType: ResourceType) => RequestParameters
validateStyle
Значение true для проверки стилей перед применением. Для обработки стилей во время начальной загрузки требуется значительное (несколько сотен мс) времени.
validateStyle?: boolean
Значение свойства
boolean
workerCount
Количество веб-рабочих ролей, созданных на странице. По умолчанию устанавливается половина числа ядер ЦП (ограничено 6).
workerCount?: number
Значение свойства
number