ServiceOptions interface

Paquete:

azure-maps-control

Propiedades globales usadas en todas las solicitudes de servicio atlas.

Extends

Options

Propiedades

authOptions	Las opciones de autenticación usadas para personalizar cómo se autentica el control de mapa con Azure Maps servicios. Si se especifican estas opciones de autenticación, ServiceOptions.subscriptionKey no debe ser. Se recomienda usar la función atlas.setAuthenticationOptions en su lugar.
disableTelemetry	Deshabilitar la recopilación de telemetría Esta opción solo se puede establecer al inicializar el mapa. default: false (true para la nube de Azure Government)
domain	Dominio que se va a usar al solicitar iconos de mapa y otros servicios de Azure Maps. Si no se especifica https el protocolo, se supone. Se recomienda usar la función atlas.setDomain en su lugar.
enableAccessibility	Habilite la característica de accesibilidad para proporcionar compatibilidad con el lector de pantalla para los usuarios que tienen dificultades para visualizar la aplicación web. Esta propiedad se establece en true de forma predeterminada.
enableAccessibilityLocationFallback	Habilite la reserva en el geocodificador de la API REST para detectar la accesibilidad de la ubicación si se produce un error al extraer la ubicación de los datos vectoriales. Si deshabilita esta opción, se evitará la generación de solicitudes de API de código geográfico, pero puede provocar la falta de información de ubicación para los lectores de pantalla. default: true
fadeDuration	Controla la duración de la animación de atenuación o atenuación para colisiones de etiquetas, en milisegundos. Esta configuración afecta a todas las capas de símbolos. Esta configuración no afecta a la duración de las transiciones de estilo en tiempo de ejecución ni al desvanecimiento cruzado del icono ráster.
localIdeographFontFamily	Define una familia de fuentes CSS para invalidar localmente la generación de glifos en los intervalos "Ideogramas unificados de CJK", "Hiragana", "Katakana" y "Hangul Syllables". En estos intervalos, se omitirá la configuración de fuente del estilo del mapa, excepto las palabras clave de peso de fuente (claro/regular/medio/negrita). Establézcalo en false para habilitar la configuración de fuente desde el estilo del mapa para estos intervalos de glifos. El propósito de esta opción es evitar solicitudes de servidor de glifos con uso intensivo de ancho de banda.
mapConfiguration	La configuración del mapa define el conjunto de estilos disponibles para el mapa.
maxParallelImageRequests	Número máximo de imágenes (iconos ráster, sprites, iconos) que se cargan en paralelo, lo que afecta al rendimiento en mapas con gran cantidad de tramas. 16 de forma predeterminada.
refreshExpiredTiles	Un valor booleano que especifica si los iconos vectoriales y ráster se deben volver a cargar cuando expiran (en función de los encabezados expirados). Esto es útil para los conjuntos de datos que se actualizan con frecuencia. Cuando se establece en false, cada icono se cargará una vez, cuando sea necesario, y no se volverá a cargar cuando expiren. default: true
sessionId	Identificador de sesión que se va a pasar con solicitudes. Se recomienda usar atlas.setSessionId en su lugar.
styleAPIVersion	La versión de la API de estilo usada al solicitar estilos y conjuntos de estilos
styleDefinitionsVersion	La versión de definiciones de estilo que se va a solicitar al solicitar estilos de styleDefinitionsPath.
subscriptionKey	Clave de suscripción de cliente usada para autorizar solicitudes. Esta opción solo se puede establecer al inicializar el mapa. Se recomienda usar la función atlas.setSubscriptionKey en su lugar.
transformRequest	Si se llamará a transformRequest definido para proporcionar parámetros de solicitud personalizados para cargar un icono.
validateStyle	True para validar los estilos antes de aplicarlos. La validación tarda unos cientos de ms en procesar estilos durante la carga inicial.
workerCount	Número de trabajos web creados en una instancia en una página. De forma predeterminada, se establece en la mitad del número de núcleos de CPU (limitado en 6).

Detalles de las propiedades

authOptions

Las opciones de autenticación usadas para personalizar cómo se autentica el control de mapa con Azure Maps servicios. Si se especifican estas opciones de autenticación, ServiceOptions.subscriptionKey no debe ser. Se recomienda usar la función atlas.setAuthenticationOptions en su lugar.

authOptions?: AuthenticationOptions

Valor de propiedad

AuthenticationOptions

disableTelemetry

Deshabilitar la recopilación de telemetría Esta opción solo se puede establecer al inicializar el mapa. default: false (true para la nube de Azure Government)

disableTelemetry?: boolean

Valor de propiedad

boolean

domain

Dominio que se va a usar al solicitar iconos de mapa y otros servicios de Azure Maps. Si no se especifica https el protocolo, se supone. Se recomienda usar la función atlas.setDomain en su lugar.

domain?: string

Valor de propiedad

string

enableAccessibility

Habilite la característica de accesibilidad para proporcionar compatibilidad con el lector de pantalla para los usuarios que tienen dificultades para visualizar la aplicación web. Esta propiedad se establece en true de forma predeterminada.

enableAccessibility?: boolean

Valor de propiedad

boolean

enableAccessibilityLocationFallback

Habilite la reserva en el geocodificador de la API REST para detectar la accesibilidad de la ubicación si se produce un error al extraer la ubicación de los datos vectoriales. Si deshabilita esta opción, se evitará la generación de solicitudes de API de código geográfico, pero puede provocar la falta de información de ubicación para los lectores de pantalla. default: true

enableAccessibilityLocationFallback?: boolean

Valor de propiedad

boolean

fadeDuration

Controla la duración de la animación de atenuación o atenuación para colisiones de etiquetas, en milisegundos. Esta configuración afecta a todas las capas de símbolos. Esta configuración no afecta a la duración de las transiciones de estilo en tiempo de ejecución ni al desvanecimiento cruzado del icono ráster.

fadeDuration?: number

Valor de propiedad

number

localIdeographFontFamily

Define una familia de fuentes CSS para invalidar localmente la generación de glifos en los intervalos "Ideogramas unificados de CJK", "Hiragana", "Katakana" y "Hangul Syllables". En estos intervalos, se omitirá la configuración de fuente del estilo del mapa, excepto las palabras clave de peso de fuente (claro/regular/medio/negrita). Establézcalo en false para habilitar la configuración de fuente desde el estilo del mapa para estos intervalos de glifos. El propósito de esta opción es evitar solicitudes de servidor de glifos con uso intensivo de ancho de banda.

localIdeographFontFamily?: string

Valor de propiedad

string

mapConfiguration

La configuración del mapa define el conjunto de estilos disponibles para el mapa.

mapConfiguration?: string | MapConfiguration

Valor de propiedad

string | MapConfiguration

maxParallelImageRequests

Número máximo de imágenes (iconos ráster, sprites, iconos) que se cargan en paralelo, lo que afecta al rendimiento en mapas con gran cantidad de tramas. 16 de forma predeterminada.

maxParallelImageRequests?: number

Valor de propiedad

number

refreshExpiredTiles

Un valor booleano que especifica si los iconos vectoriales y ráster se deben volver a cargar cuando expiran (en función de los encabezados expirados). Esto es útil para los conjuntos de datos que se actualizan con frecuencia. Cuando se establece en false, cada icono se cargará una vez, cuando sea necesario, y no se volverá a cargar cuando expiren. default: true

refreshExpiredTiles?: boolean

Valor de propiedad

boolean

sessionId

Identificador de sesión que se va a pasar con solicitudes. Se recomienda usar atlas.setSessionId en su lugar.

sessionId?: string

Valor de propiedad

string

styleAPIVersion

La versión de la API de estilo usada al solicitar estilos y conjuntos de estilos

styleAPIVersion?: string

Valor de propiedad

string

styleDefinitionsVersion

La versión de definiciones de estilo que se va a solicitar al solicitar estilos de styleDefinitionsPath.

styleDefinitionsVersion?: string

Valor de propiedad

string

subscriptionKey

Clave de suscripción de cliente usada para autorizar solicitudes. Esta opción solo se puede establecer al inicializar el mapa. Se recomienda usar la función atlas.setSubscriptionKey en su lugar.

subscriptionKey?: string

Valor de propiedad

string

transformRequest

Si se llamará a transformRequest definido para proporcionar parámetros de solicitud personalizados para cargar un icono.

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

Valor de propiedad

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

validateStyle

True para validar los estilos antes de aplicarlos. La validación tarda unos cientos de ms en procesar estilos durante la carga inicial.

validateStyle?: boolean

Valor de propiedad

boolean

workerCount

Número de trabajos web creados en una instancia en una página. De forma predeterminada, se establece en la mitad del número de núcleos de CPU (limitado en 6).

workerCount?: number

Valor de propiedad

number