ServiceOptions interface

Pacote:

azure-maps-control

Propriedades globais usadas em todas as solicitações de serviço atlas.

Extends

Options

Propriedades

authOptions	As opções de autenticação usadas para personalizar como o controle de mapa se autentica com Azure Mapas serviços. Se essas opções de autenticação forem especificadas, ServiceOptions.subscriptionKey não deverá ser. Recomendamos usar a função atlas.setAuthenticationOptions.
disableTelemetry	Desabilitar a coleção de telemetria Essa opção só pode ser definida ao inicializar o mapa. default: false (true para a nuvem Azure Governamental)
domain	O domínio a ser usado ao solicitar blocos de mapa e outros serviços de Azure Mapas. Se o protocolo não for especificado https , será assumido. Em vez disso, é recomendável usar a função atlas.setDomain.
enableAccessibility	Habilite o recurso de acessibilidade para fornecer suporte de leitor de tela para usuários que têm dificuldade em visualizar o aplicativo Web. Essa propriedade é definida como true por padrão.
enableAccessibilityLocationFallback	Habilite o fallback para o geocodificador da API REST para detectar a acessibilidade de localização se a extração de localização de dados vetoriais falhar. Desabilitar essa opção impedirá a geração de solicitações de API de código geográfico, mas pode levar à falta de informações de localização para leitores de tela. padrão: true
fadeDuration	Controla a duração da animação fade-in/fade-out para colisões de rótulo, em milissegundos. Essa configuração afeta todas as camadas de símbolo. Essa configuração não afeta a duração das transições de estilo de runtime ou da desbotamento cruzado do bloco de raster.
localIdeographFontFamily	Define uma família de fontes CSS para substituir localmente a geração de glifos nos intervalos 'Ideógrafos Unificados do CJK', 'Hiragana', 'Katakana' e 'Hangul Syllables'. Nesses intervalos, as configurações de fonte do estilo do mapa serão ignoradas, exceto para palavras-chave de peso de fonte (light/regular/medium/bold). Defina como false para habilitar as configurações de fonte do estilo do mapa para esses intervalos de glifo. A finalidade dessa opção é evitar solicitações de servidor de glifo com uso intensivo de largura de banda.
mapConfiguration	A configuração do mapa define o conjunto de estilos disponíveis para o mapa.
maxParallelImageRequests	Número máximo de imagens (blocos raster, sprites, ícones) a serem carregadas em paralelo, o que afeta o desempenho em mapas de raster-heavy. 16 por padrão.
refreshExpiredTiles	Um booliano que especifica se os blocos vetor e raster devem ser recarregados quando expiram (com base no cabeçalho expira). Isso é útil para conjuntos de dados que são atualizados com frequência. Quando definido como false, cada bloco será carregado uma vez, quando necessário, e não será recarregado quando expirar. padrão: true
sessionId	A ID da sessão a ser passada com solicitações. Em vez disso, é recomendável usar atlas.setSessionId.
styleAPIVersion	A versão de API de estilo usada ao solicitar estilos e conjuntos de estilos
styleDefinitionsVersion	A versão de definições de estilo a ser solicitada ao solicitar estilos de styleDefinitionsPath.
subscriptionKey	A chave de assinatura do cliente usada para autorizar solicitações. Essa opção só pode ser definida ao inicializar o mapa. Recomendamos usar a função atlas.setSubscriptionKey em vez disso
transformRequest	Se definido transformRequest será chamado para fornecer parâmetros de solicitação personalizados para carregar um bloco.
validateStyle	True para validar estilos antes de ser aplicado. A validação leva um tempo significativo (algumas centenas de ms) para processar estilos durante a carga inicial.
workerCount	Número de trabalhos web instanciados em uma página. Por padrão, ele é definido como metade do número de núcleos de CPU (limitado a 6).

Detalhes da propriedade

authOptions

As opções de autenticação usadas para personalizar como o controle de mapa se autentica com Azure Mapas serviços. Se essas opções de autenticação forem especificadas, ServiceOptions.subscriptionKey não deverá ser. Recomendamos usar a função atlas.setAuthenticationOptions.

authOptions?: AuthenticationOptions

Valor da propriedade

AuthenticationOptions

disableTelemetry

Desabilitar a coleção de telemetria Essa opção só pode ser definida ao inicializar o mapa. default: false (true para a nuvem Azure Governamental)

disableTelemetry?: boolean

Valor da propriedade

boolean

domain

O domínio a ser usado ao solicitar blocos de mapa e outros serviços de Azure Mapas. Se o protocolo não for especificado https , será assumido. Em vez disso, é recomendável usar a função atlas.setDomain.

domain?: string

Valor da propriedade

string

enableAccessibility

Habilite o recurso de acessibilidade para fornecer suporte de leitor de tela para usuários que têm dificuldade em visualizar o aplicativo Web. Essa propriedade é definida como true por padrão.

enableAccessibility?: boolean

Valor da propriedade

boolean

enableAccessibilityLocationFallback

Habilite o fallback para o geocodificador da API REST para detectar a acessibilidade de localização se a extração de localização de dados vetoriais falhar. Desabilitar essa opção impedirá a geração de solicitações de API de código geográfico, mas pode levar à falta de informações de localização para leitores de tela. padrão: true

enableAccessibilityLocationFallback?: boolean

Valor da propriedade

boolean

fadeDuration

Controla a duração da animação fade-in/fade-out para colisões de rótulo, em milissegundos. Essa configuração afeta todas as camadas de símbolo. Essa configuração não afeta a duração das transições de estilo de runtime ou da desbotamento cruzado do bloco de raster.

fadeDuration?: number

Valor da propriedade

number

localIdeographFontFamily

Define uma família de fontes CSS para substituir localmente a geração de glifos nos intervalos 'Ideógrafos Unificados do CJK', 'Hiragana', 'Katakana' e 'Hangul Syllables'. Nesses intervalos, as configurações de fonte do estilo do mapa serão ignoradas, exceto para palavras-chave de peso de fonte (light/regular/medium/bold). Defina como false para habilitar as configurações de fonte do estilo do mapa para esses intervalos de glifo. A finalidade dessa opção é evitar solicitações de servidor de glifo com uso intensivo de largura de banda.

localIdeographFontFamily?: string

Valor da propriedade

string

mapConfiguration

A configuração do mapa define o conjunto de estilos disponíveis para o mapa.

mapConfiguration?: string | MapConfiguration

Valor da propriedade

string | MapConfiguration

maxParallelImageRequests

Número máximo de imagens (blocos raster, sprites, ícones) a serem carregadas em paralelo, o que afeta o desempenho em mapas de raster-heavy. 16 por padrão.

maxParallelImageRequests?: number

Valor da propriedade

number

refreshExpiredTiles

Um booliano que especifica se os blocos vetor e raster devem ser recarregados quando expiram (com base no cabeçalho expira). Isso é útil para conjuntos de dados que são atualizados com frequência. Quando definido como false, cada bloco será carregado uma vez, quando necessário, e não será recarregado quando expirar. padrão: true

refreshExpiredTiles?: boolean

Valor da propriedade

boolean

sessionId

A ID da sessão a ser passada com solicitações. Em vez disso, é recomendável usar atlas.setSessionId.

sessionId?: string

Valor da propriedade

string

styleAPIVersion

A versão de API de estilo usada ao solicitar estilos e conjuntos de estilos

styleAPIVersion?: string

Valor da propriedade

string

styleDefinitionsVersion

A versão de definições de estilo a ser solicitada ao solicitar estilos de styleDefinitionsPath.

styleDefinitionsVersion?: string

Valor da propriedade

string

subscriptionKey

A chave de assinatura do cliente usada para autorizar solicitações. Essa opção só pode ser definida ao inicializar o mapa. Recomendamos usar a função atlas.setSubscriptionKey em vez disso

subscriptionKey?: string

Valor da propriedade

string

transformRequest

Se definido transformRequest será chamado para fornecer parâmetros de solicitação personalizados para carregar um bloco.

transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters

Valor da propriedade

(url: string, resourceType: ResourceType) => RequestParameters

validateStyle

True para validar estilos antes de ser aplicado. A validação leva um tempo significativo (algumas centenas de ms) para processar estilos durante a carga inicial.

validateStyle?: boolean

Valor da propriedade

boolean

workerCount

Número de trabalhos web instanciados em uma página. Por padrão, ele é definido como metade do número de núcleos de CPU (limitado a 6).

workerCount?: number

Valor da propriedade

number