ServiceOptions interface
Propriedades globais utilizadas em todos os pedidos de serviço atlas.
- Extends
Propriedades
auth |
As opções de autenticação utilizadas para personalizar a forma como o controlo de mapa é autenticado com Azure Maps serviços. Se estas opções de autenticação forem especificadas, ServiceOptions.subscriptionKey não deve ser. Recomendamos a utilização da função atlas.setAuthenticationOptions. |
disable |
Desativar coleção de telemetria Esta opção só pode ser definida ao inicializar o mapa. predefinição: falso (verdadeiro para a cloud Azure Government) |
domain | O domínio a utilizar ao pedir mosaicos de mapa e outros serviços de Azure Maps.
Se o protocolo não for especificado |
enable |
Ative a funcionalidade de acessibilidade para fornecer suporte ao leitor de ecrã para os utilizadores com dificuldades em visualizar a aplicação Web. Esta propriedade está definida como verdadeira por predefinição. |
enable |
Ative a contingência para o geocódigo da API REST para detetar a acessibilidade da localização se a extração da localização dos dados de vetor falhar. Desativar esta opção impedirá a geração de pedidos de API de geocódigo, mas poderá levar à falta de informações de localização para os leitores de ecrã. predefinição: verdadeiro |
fade |
Controla a duração da animação fade-in/fade-out para colisões de etiquetas, em milissegundos. Esta definição afeta todas as camadas de símbolos. Esta definição não afeta a duração das transições de estilo do runtime ou do desvanecimento cruzado do mosaico rasterador. |
local |
Define uma família de tipos de letra CSS para a geração local de glifos nos intervalos "CJK Unified Ideographs", "Hiragana", "Katakana" e "Hangul Syllables". Nestes intervalos, as definições do tipo de letra do estilo do mapa serão ignoradas, exceto para palavras-chave de espessura do tipo de letra (claro/regular/médio/negrito). Defina como falso, para ativar as definições do tipo de letra a partir do estilo do mapa para estes intervalos de glifos. O objetivo desta opção é evitar pedidos de servidor de glifos intensivos de largura de banda. |
map |
A configuração do mapa define o conjunto de estilos disponíveis para o mapa. |
max |
Número máximo de imagens (mosaicos raster, sprites, ícones) para carregar em paralelo, o que afeta o desempenho em mapas raster-heavy. 16 por predefinição. |
refresh |
Um booleano que especifica se os mosaicos de vetor e raster devem ser recarregados quando expiram (com base no cabeçalho expira). Isto é útil para conjuntos de dados que são atualizados com frequência. Quando definido como falso, cada mosaico será carregado uma vez, quando necessário, e não recarregado quando expirarem. predefinição: verdadeiro |
session |
O ID da sessão a transmitir com pedidos. Em alternativa, recomendamos a utilização de atlas.setSessionId. |
style |
A versão da API de estilo utilizada ao pedir estilos e conjuntos de estilos |
style |
A versão de definições de estilo a pedir ao pedir estilos de styleDefinitionsPath. |
subscription |
A chave de subscrição do cliente utilizada para autorizar pedidos. Esta opção só pode ser definida ao inicializar o mapa. Recomendamos a utilização da função atlas.setSubscriptionKey |
transform |
Se for definido, transformRequest será chamado para fornecer parâmetros de pedido personalizados para carregar um mosaico. |
validate |
Verdadeiro para validar estilos antes de ser aplicado. A validação demora muito(algumas centenas de ms) a processar estilos durante o carregamento inicial. |
worker |
Número de web workers instanciados numa página. Por predefinição, está definido para metade do número de núcleos de CPU (limitado a 6). |
Detalhes de Propriedade
authOptions
As opções de autenticação utilizadas para personalizar a forma como o controlo de mapa é autenticado com Azure Maps serviços. Se estas opções de autenticação forem especificadas, ServiceOptions.subscriptionKey não deve ser. Recomendamos a utilização da função atlas.setAuthenticationOptions.
authOptions?: AuthenticationOptions
Valor de Propriedade
disableTelemetry
Desativar coleção de telemetria Esta opção só pode ser definida ao inicializar o mapa. predefinição: falso (verdadeiro para a cloud Azure Government)
disableTelemetry?: boolean
Valor de Propriedade
boolean
domain
O domínio a utilizar ao pedir mosaicos de mapa e outros serviços de Azure Maps.
Se o protocolo não for especificado https
, é assumido.
Em alternativa, recomendamos a utilização da função atlas.setDomain.
domain?: string
Valor de Propriedade
string
enableAccessibility
Ative a funcionalidade de acessibilidade para fornecer suporte ao leitor de ecrã para os utilizadores com dificuldades em visualizar a aplicação Web. Esta propriedade está definida como verdadeira por predefinição.
enableAccessibility?: boolean
Valor de Propriedade
boolean
enableAccessibilityLocationFallback
Ative a contingência para o geocódigo da API REST para detetar a acessibilidade da localização se a extração da localização dos dados de vetor falhar. Desativar esta opção impedirá a geração de pedidos de API de geocódigo, mas poderá levar à falta de informações de localização para os leitores de ecrã. predefinição: verdadeiro
enableAccessibilityLocationFallback?: boolean
Valor de Propriedade
boolean
fadeDuration
Controla a duração da animação fade-in/fade-out para colisões de etiquetas, em milissegundos. Esta definição afeta todas as camadas de símbolos. Esta definição não afeta a duração das transições de estilo do runtime ou do desvanecimento cruzado do mosaico rasterador.
fadeDuration?: number
Valor de Propriedade
number
localIdeographFontFamily
Define uma família de tipos de letra CSS para a geração local de glifos nos intervalos "CJK Unified Ideographs", "Hiragana", "Katakana" e "Hangul Syllables". Nestes intervalos, as definições do tipo de letra do estilo do mapa serão ignoradas, exceto para palavras-chave de espessura do tipo de letra (claro/regular/médio/negrito). Defina como falso, para ativar as definições do tipo de letra a partir do estilo do mapa para estes intervalos de glifos. O objetivo desta opção é evitar pedidos de servidor de glifos intensivos de largura de banda.
localIdeographFontFamily?: string
Valor de Propriedade
string
mapConfiguration
A configuração do mapa define o conjunto de estilos disponíveis para o mapa.
mapConfiguration?: string | MapConfiguration
Valor de Propriedade
string | MapConfiguration
maxParallelImageRequests
Número máximo de imagens (mosaicos raster, sprites, ícones) para carregar em paralelo, o que afeta o desempenho em mapas raster-heavy. 16 por predefinição.
maxParallelImageRequests?: number
Valor de Propriedade
number
refreshExpiredTiles
Um booleano que especifica se os mosaicos de vetor e raster devem ser recarregados quando expiram (com base no cabeçalho expira). Isto é útil para conjuntos de dados que são atualizados com frequência. Quando definido como falso, cada mosaico será carregado uma vez, quando necessário, e não recarregado quando expirarem. predefinição: verdadeiro
refreshExpiredTiles?: boolean
Valor de Propriedade
boolean
sessionId
O ID da sessão a transmitir com pedidos. Em alternativa, recomendamos a utilização de atlas.setSessionId.
sessionId?: string
Valor de Propriedade
string
styleAPIVersion
A versão da API de estilo utilizada ao pedir estilos e conjuntos de estilos
styleAPIVersion?: string
Valor de Propriedade
string
styleDefinitionsVersion
A versão de definições de estilo a pedir ao pedir estilos de styleDefinitionsPath.
styleDefinitionsVersion?: string
Valor de Propriedade
string
subscriptionKey
A chave de subscrição do cliente utilizada para autorizar pedidos. Esta opção só pode ser definida ao inicializar o mapa. Recomendamos a utilização da função atlas.setSubscriptionKey
subscriptionKey?: string
Valor de Propriedade
string
transformRequest
Se for definido, transformRequest será chamado para fornecer parâmetros de pedido personalizados para carregar um mosaico.
transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters
Valor de Propriedade
(url: string, resourceType: ResourceType) => RequestParameters
validateStyle
Verdadeiro para validar estilos antes de ser aplicado. A validação demora muito(algumas centenas de ms) a processar estilos durante o carregamento inicial.
validateStyle?: boolean
Valor de Propriedade
boolean
workerCount
Número de web workers instanciados numa página. Por predefinição, está definido para metade do número de núcleos de CPU (limitado a 6).
workerCount?: number
Valor de Propriedade
number