atlas module

Paquete:

azure-maps-control

Clases

EventManager	Administrador de los eventos del control de mapa. Expuesto a través de la propiedad events del atlas. Clase de mapa. El usuario no puede crear instancias.
HtmlMarker	Esta clase encapsula un elemento HTML que se puede mostrar en el mapa.
Map	Control de un mapa web visual e interactivo.
Pixel	Representa una coordenada de píxeles o un desplazamiento. Extiende una matriz de [x, y].
Popup	Ventana de información anclada en una posición especificada en un mapa.
PopupTemplate	Plantilla de diseño para un elemento emergente.
Shape	Una clase auxiliar que encapsula una geometría o una característica y facilita la actualización y el mantenimiento.

Interfaces

AggregateExpression	Una expresión de agregado define un cálculo que se procesa sobre un conjunto de datos. Schema: [operator: string, initialValue?: boolean | number, mapExpression: Expression] operator: Una función de expresión que se aplica a todos los valores calculados por el mapExpression para cada punto del clúster. Operadores admitidos: o para números: +, *, max, min o For Booleans: all, any initialValue: opcional, un valor inicial en el que se agrega el primer valor calculado. mapExpression: expresión que se aplica a cada punto del conjunto de datos.
AnimationOptions	Las opciones para animar los cambios en la cámara del control de mapa.
AuthenticationManager	Administrador de la autenticación del control de mapa. Expuesto a través de la propiedad de autenticación del atlas. Clase de mapa. El usuario no puede crear instancias.
AuthenticationOptions	Opciones para especificar cómo debe autenticarse el control de mapa con los servicios de Azure Maps.
BubbleLayerOptions	Opciones usadas al representar objetos Point en un BubbleLayer.
CameraBoundsOptions	Opciones para establecer los límites de la cámara del control de mapa.
CameraOptions	Las opciones para establecer la cámara del control de mapa.
ClusteredProperties	Propiedades que existirán para ClusteredProperties
CompassControlOptions	Las opciones de un objeto CompassControl.
Control	Interfaz para definir un control del mapa.
ControlManager	Administrador de los controles del control de mapa. Expuesto a través de la propiedad controls del atlas. Clase de mapa. El usuario no puede crear instancias.
ControlOptions	Opciones para agregar un control al mapa.
DataSourceOptions	Origen de datos para administrar los datos de formas que se mostrarán en el mapa. Un origen de datos debe agregarse a una capa antes de que esté visible en el mapa. Opciones de un DataSourceOptions.
ElevationTileSourceOptions
FullscreenControlOptions	Las opciones de un objeto FullscreenControl.
HeatMapLayerOptions	Opciones usadas al representar objetos Point en un HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Administrador de los marcadores HTML del control de mapa. Expuesto a través de la propiedad markers del atlas. Clase de mapa. El usuario no puede crear instancias.
HtmlMarkerOptions	Opciones para representar un objeto HtmlMarker
HyperLinkFormatOptions	Opción formato para cadenas de hipervínculo.
IconOptions	Opciones que se usan para personalizar los iconos de una clase SymbolLayer
ImageLayerOptions	Opciones usadas al representar objetos Point en imageLayer.
ImageSpriteManager	Administrador del sprite de imagen del control de mapa. Expuesto a través de la propiedad imageSprite del atlas. Clase de mapa. El usuario no puede crear instancias.
LayerManager	Administrador de las capas del control de mapa. Expuesto a través de la propiedad layers del atlas. Clase de mapa. El usuario no puede crear instancias.
LayerOptions	Clase base de la que heredan todas las demás opciones de capa.
LightOptions	Las opciones para la iluminación del mapa.
LineLayerOptions	Opciones usadas al representar objetos SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon y MultiPolygon en una capa de línea.
MapConfiguration	Representa el contenido de la configuración del mapa que contiene una lista de estilos disponibles para ellos.
MapConfigurationStyle	Representa la información de un solo estilo.
MapDataEvent	Objeto de evento devuelto por los mapas cuando se produce un evento de datos.
MapErrorEvent	Objeto de evento devuelto por los mapas cuando se produce un evento de error.
MapEvent	Objeto de evento devuelto por los mapas cuando se produce un evento básico.
MapMouseEvent	Objeto de evento devuelto por los mapas cuando se produce un evento del mouse.
MapMouseWheelEvent	Objeto de evento devuelto por los mapas cuando se produce un evento de rueda.
MapTouchEvent	Objeto de evento devuelto por los mapas cuando se produce un evento táctil.
MediaLayerOptions	Opciones que se usan al representar el lienzo, la imagen, el icono ráster y las capas de vídeo
Options
Padding	Representa la cantidad de relleno en píxeles que se van a agregar al lado de un BoundingBox al establecer la cámara de un mapa.
PitchControlOptions	Las opciones de un objeto PitchControl.
PolygonExtrusionLayerOptions	Opciones que se usan al representar objetos Polygon y MultiPolygon en un PolygonExtrusionLayer.
PolygonLayerOptions	Opciones usadas al representar objetos Polygon y MultiPolygon en polygonLayer.
PopupEvents
PopupManager	Administrador de los elementos emergentes del control de mapa. Se expone a través de la propiedad popups de la clase atlas.Map. El usuario no puede crear instancias.
PopupOptions	Las opciones de un elemento emergente.
Properties	Conjunto de propiedades que se pueden usar con un PopupTemplate
PropertyInfo	Detalles de especies de cómo se va a mostrar una propiedad.
RasterTileSourceOptions
RequestParameters	Este es el tipo de objeto que se espera que devuelva la devolución de llamada transformRequest.
ScaleControlOptions	Las opciones de un objeto ScaleControl.
ServiceOptions	Propiedades globales usadas en todas las solicitudes de servicio atlas.
ShapeEvents
SourceManager	Administrador de los orígenes del control de mapa. Expuesto a través de la propiedad sources del atlas. Clase de mapa. El usuario no puede crear instancias.
StyleChangedEvent	Objeto de evento devuelto por el mapa después de cargar un nuevo estilo.
StyleControlOptions	Las opciones de un objeto StyleControl.
StyleOptions	Las opciones del estilo del mapa.
SymbolLayerOptions	Opciones usadas al representar geometrías en un SymbolLayer.
TargetedEvent
TextOptions	Opciones usadas para personalizar el texto en un SymbolLayer
Tile	Objeto de mosaico devuelto por el mapa cuando se produce un evento de datos de origen.
TileId
TileLayerOptions	Opciones usadas al representar imágenes en mosaico de ráster en una clase TileLayer.
TrafficControlOptions
TrafficOptions	Opciones para establecer el tráfico en el mapa.
UserInteractionOptions	Las opciones para habilitar o deshabilitar la interacción del usuario con el mapa.
VectorTileSourceOptions	Origen de datos para administrar los datos de formas que se mostrarán en el mapa. Un origen de datos debe agregarse a una capa antes de que esté visible en el mapa. Opciones de un VectorTileSource.
WebGLLayerOptions	Opciones usadas para representar gráficos en webGLLayer.
WebGLRenderer	Interfaz para representar gráficos de WebGL en webGLLayer.
ZoomControlOptions	Las opciones de un objeto ZoomControl.

Alias de tipos

Expression	Se puede especificar como el valor de filtro o determinadas opciones de capa. Una expresión define una fórmula para calcular el valor de la propiedad. Las expresiones se representan como matrices JSON. El primer elemento de una expresión es una cadena que denomina al operador de expresión.
getAuthTokenCallback	Función de devolución de llamada usada para adquirir un token de autenticación en modo de autenticación anónimo. Resuelva con el token de autenticación o rechace los errores.
ResourceType
StyleImageMetadata	Firma del parámetro options pasado a ImageSpriteManager.add.

Enumeraciones

AuthenticationType	Enumeración utilizada para especificar el tipo de mecanismo de autenticación que se va a usar.
ControlPosition	Posiciones donde se puede colocar el control en el mapa.
ControlStyle	Estilos disponibles para un control.

Funciones

addImageTemplate(string, string, boolean)	Agrega una plantilla de imagen al espacio de nombres atlas.
addProtocol(string, (args: any[]) => Promise<any>)	Agrega una función de recursos de carga personalizada a la que se llamará cuando se use una dirección URL que comience con un esquema de dirección URL personalizado.
clearPrewarmedResources()	Borra los recursos creados anteriormente por atlas.prewarm(). Tenga en cuenta que esto normalmente no es necesario. Solo debes llamar a esta función si esperas que el usuario de la aplicación no vuelva a una vista de mapa en cualquier momento de la aplicación.
getAllImageTemplateNames()	Recupera una matriz de nombres para todas las plantillas de imagen que están disponibles en el espacio de nombres atlas.
getAuthenticationOptions()	Obtiene las opciones de autenticación predeterminadas proporcionadas. Si no se han establecido previamente todas las propiedades, no se definirán.
getDomain()	Obtiene el dominio predeterminado que se proporcionó. Si no se ha establecido previamente, el valor predeterminado es "atlas.microsoft.com".
getImageTemplate(string, number)	Recupera una plantilla SVG por nombre.
getLanguage()	Obtiene el idioma predeterminado que se proporcionó. Si no se ha establecido previamente, el valor predeterminado es "NGT".
getMaxParallelImageRequests()	Obtiene el número máximo de imágenes (iconos ráster, sprites, iconos) que se cargan en paralelo.
getSessionId()	Obtiene el identificador de sesión predeterminado que se proporcionó. Si no se ha establecido previamente, el valor predeterminado es un UUID aleatorio.
getSubscriptionKey()	Obtiene la clave de suscripción predeterminada de Azure Maps que se proporcionó.
getUserRegion()
getVersion()	Número de versión de la API actual en función del número de compilación.
getView()	Obtiene la configuración de vista predeterminada del control de mapa. Si no se ha establecido previamente, el valor predeterminado es undefined.
getWorkerCount()	Obtiene el recuento de trabajos que se creará.
isSupported(boolean)	Comprueba si el explorador del usuario es compatible con el control de mapa.
prewarm()	Inicializa recursos como WebWorkers que se pueden compartir entre mapas para reducir los tiempos de carga en algunas situaciones. atlas.setWorkerCount, si se usa, debe establecerse antes de que se llame a prewarm() para que tenga un efecto. De forma predeterminada, el ciclo de vida de estos recursos se administra automáticamente y se inicializan de forma diferida cuando se crea un mapa por primera vez. Al invocar prewarm(), estos recursos se crearán con antelación y no se borrarán cuando se quite el último mapa de la página. Esto les permite volver a usar las nuevas instancias de Mapa que se crean más adelante. Se pueden borrar manualmente llamando a atlas.clearPrewarmedResources(). Esto solo es necesario si la página web permanece activa, pero deja de usar mapas por completo. Esto es principalmente útil cuando se usan mapas de GL-JS en una sola aplicación de página, donde un usuario navegaría entre varias vistas que pueden hacer que las instancias de Mapa se creen y destruyan constantemente.
removeProtocol(string)	Quita un protocolo agregado anteriormente en el subproceso principal.
setAuthenticationOptions(AuthenticationOptions)	Establece las opciones de autenticación como las opciones predeterminadas en el espacio de nombres atlas que usa el control de mapa y los módulos que realizan solicitudes a los servicios de Azure Maps. Si se inicializa un mapa con las opciones de autenticación definidas explícitamente y setAuthenticationOptions no se le ha llamado anteriormente, el constructor map llamará automáticamente.
setDomain(string)	Establece el dominio predeterminado usado por los módulos de asignación y servicio, a menos que el dominio se especifique explícitamente al usar esas partes de la API. Si se inicializa un mapa con el dominio definido explícitamente y el constructor Map no lo llamará previamente. Si no se especifica el protocolo https se supone.
setLanguage(string)	Establece el idioma predeterminado usado por los módulos de asignación y servicio, a menos que el idioma se especifique explícitamente al usar esas partes de la API. Si se inicializa un mapa con el idioma definido explícitamente y el constructor Map no lo llamará previamente.
setMaxParallelImageRequests(number)	Establece el número máximo de imágenes (mosaicos ráster, sprites, iconos) que se cargan en paralelo, lo que afecta al rendimiento en mapas pesados de ráster. 16 de forma predeterminada.
setSessionId(string)	Establece el identificador de sesión predeterminado usado por los módulos de asignación y servicio, a menos que se especifique explícitamente el identificador de sesión al usar esas partes de la API. Si se inicializa un mapa con el identificador de sesión definido explícitamente y el constructor Map no lo llamará previamente.
setSubscriptionKey(string)	Establece la clave de suscripción de Azure Maps como clave de suscripción predeterminada en el espacio de nombres atlas que usa el control de mapa y los módulos que realizan solicitudes a los servicios de Azure Maps. Si se inicializa un mapa con la clave de suscripción definida explícitamente y setSubscriptionKey no se le ha llamado anteriormente, el constructor map llamará automáticamente.
setUserRegion(string)
setView(string)	Especifica qué conjunto de bordes y etiquetas geopolíticamente disputados se muestran en el mapa. El parámetro View (también denominado "parámetro de región de usuario") es un código de país ISO-3166 de 2 letras que mostrará los mapas correctos para ese país o región. País o regiones que no están en la lista Vista o si no se especifica, el valor predeterminado es la vista "Unificada". Consulte las [Vistas]{@link https://aka.ms/AzureMapsLocalizationViews }compatibles. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado el acceso a través de Azure Maps.
setWorkerCount(number)	Establece el número de trabajos web creados en una página. De forma predeterminada, se establece en la mitad del número de núcleos de CPU (limitados en 6).

Detalles de la función

addImageTemplate(string, string, boolean)

Agrega una plantilla de imagen al espacio de nombres atlas.

function addImageTemplate(templateName: string, template: string, override: boolean)

Parámetros

templateName

string

Nombre de la plantilla.

template

string

Plantilla SVG que se va a agregar. Admite {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Especifica si debe invalidar las plantillas existentes si ya existe una con el mismo nombre.

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

Agrega una función de recursos de carga personalizada a la que se llamará cuando se use una dirección URL que comience con un esquema de dirección URL personalizado.

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

Parámetros

customProtocol

string

el protocolo que se va a enlazar, por ejemplo, "personalizado".

loadFn

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

la función que se va a usar al intentar capturar un icono especificado por customProtocol

clearPrewarmedResources()

Borra los recursos creados anteriormente por atlas.prewarm(). Tenga en cuenta que esto normalmente no es necesario. Solo debes llamar a esta función si esperas que el usuario de la aplicación no vuelva a una vista de mapa en cualquier momento de la aplicación.

function clearPrewarmedResources()

getAllImageTemplateNames()

Recupera una matriz de nombres para todas las plantillas de imagen que están disponibles en el espacio de nombres atlas.

function getAllImageTemplateNames(): string[]

Devoluciones

string[]

getAuthenticationOptions()

Obtiene las opciones de autenticación predeterminadas proporcionadas. Si no se han establecido previamente todas las propiedades, no se definirán.

function getAuthenticationOptions(): AuthenticationOptions

Devoluciones

AuthenticationOptions

getDomain()

Obtiene el dominio predeterminado que se proporcionó. Si no se ha establecido previamente, el valor predeterminado es "atlas.microsoft.com".

function getDomain(): string

Devoluciones

string

getImageTemplate(string, number)

Recupera una plantilla SVG por nombre.

function getImageTemplate(templateName: string, scale?: number): string

Parámetros

templateName

string

Nombre de la plantilla que se va a recuperar.

scale

number

Especifica cuánto se escala la plantilla. Para obtener los mejores resultados, escale el icono al tamaño máximo que desea mostrar en el mapa y, a continuación, use la opción de tamaño del icono de capas de símbolos para reducir verticalmente si es necesario. Esto reducirá la borrosidad debido al escalado. Valor predeterminado: 1

Devoluciones

string

getLanguage()

Obtiene el idioma predeterminado que se proporcionó. Si no se ha establecido previamente, el valor predeterminado es "NGT".

function getLanguage(): string

Devoluciones

string

getMaxParallelImageRequests()

Obtiene el número máximo de imágenes (iconos ráster, sprites, iconos) que se cargan en paralelo.

function getMaxParallelImageRequests(): number

Devoluciones

number

getSessionId()

Obtiene el identificador de sesión predeterminado que se proporcionó. Si no se ha establecido previamente, el valor predeterminado es un UUID aleatorio.

function getSessionId(): string

Devoluciones

string

getSubscriptionKey()

Obtiene la clave de suscripción predeterminada de Azure Maps que se proporcionó.

function getSubscriptionKey(): string

Devoluciones

string

getUserRegion()

Advertencia

Esta API ya está en desuso.

use atlas.getView() instead

function getUserRegion(): string

Devoluciones

string

getVersion()

Número de versión de la API actual en función del número de compilación.

function getVersion(): string

Devoluciones

string

getView()

Obtiene la configuración de vista predeterminada del control de mapa. Si no se ha establecido previamente, el valor predeterminado es undefined.

function getView(): string

Devoluciones

string

getWorkerCount()

Obtiene el recuento de trabajos que se creará.

function getWorkerCount(): number

Devoluciones

number

isSupported(boolean)

Comprueba si el explorador del usuario es compatible con el control de mapa.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parámetros

failIfMajorPerformanceCaveat

boolean

Si es true, la función devolverá false si el rendimiento del control de mapa sería considerablemente peor de lo esperado (por ejemplo, se usaría un representador webGL de software).

Devoluciones

boolean

prewarm()

Inicializa recursos como WebWorkers que se pueden compartir entre mapas para reducir los tiempos de carga en algunas situaciones. atlas.setWorkerCount, si se usa, debe establecerse antes de que se llame a prewarm() para que tenga un efecto. De forma predeterminada, el ciclo de vida de estos recursos se administra automáticamente y se inicializan de forma diferida cuando se crea un mapa por primera vez. Al invocar prewarm(), estos recursos se crearán con antelación y no se borrarán cuando se quite el último mapa de la página. Esto les permite volver a usar las nuevas instancias de Mapa que se crean más adelante. Se pueden borrar manualmente llamando a atlas.clearPrewarmedResources(). Esto solo es necesario si la página web permanece activa, pero deja de usar mapas por completo.

Esto es principalmente útil cuando se usan mapas de GL-JS en una sola aplicación de página, donde un usuario navegaría entre varias vistas que pueden hacer que las instancias de Mapa se creen y destruyan constantemente.

function prewarm()

removeProtocol(string)

Quita un protocolo agregado anteriormente en el subproceso principal.

function removeProtocol(customProtocol: string)

Parámetros

customProtocol

string

el protocolo personalizado para el que se va a quitar el registro

setAuthenticationOptions(AuthenticationOptions)

Establece las opciones de autenticación como las opciones predeterminadas en el espacio de nombres atlas que usa el control de mapa y los módulos que realizan solicitudes a los servicios de Azure Maps. Si se inicializa un mapa con las opciones de autenticación definidas explícitamente y setAuthenticationOptions no se le ha llamado anteriormente, el constructor map llamará automáticamente.

function setAuthenticationOptions(options: AuthenticationOptions)

Parámetros

options

AuthenticationOptions

Las nuevas opciones de autenticación predeterminadas.

setDomain(string)

Establece el dominio predeterminado usado por los módulos de asignación y servicio, a menos que el dominio se especifique explícitamente al usar esas partes de la API. Si se inicializa un mapa con el dominio definido explícitamente y el constructor Map no lo llamará previamente. Si no se especifica el protocolo https se supone.

function setDomain(domain: string)

Parámetros

domain

string

Nuevo dominio predeterminado.

setLanguage(string)

Establece el idioma predeterminado usado por los módulos de asignación y servicio, a menos que el idioma se especifique explícitamente al usar esas partes de la API. Si se inicializa un mapa con el idioma definido explícitamente y el constructor Map no lo llamará previamente.

function setLanguage(language: string)

Parámetros

language

string

Nuevo idioma predeterminado.

setMaxParallelImageRequests(number)

Establece el número máximo de imágenes (mosaicos ráster, sprites, iconos) que se cargan en paralelo, lo que afecta al rendimiento en mapas pesados de ráster. 16 de forma predeterminada.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parámetros

maxParallelImageRequests

number

Número máximo de imágenes que se van a cargar en paralelo.

setSessionId(string)

Establece el identificador de sesión predeterminado usado por los módulos de asignación y servicio, a menos que se especifique explícitamente el identificador de sesión al usar esas partes de la API. Si se inicializa un mapa con el identificador de sesión definido explícitamente y el constructor Map no lo llamará previamente.

function setSessionId(id: string)

Parámetros

id

string

Nuevo identificador de sesión predeterminado.

setSubscriptionKey(string)

Establece la clave de suscripción de Azure Maps como clave de suscripción predeterminada en el espacio de nombres atlas que usa el control de mapa y los módulos que realizan solicitudes a los servicios de Azure Maps. Si se inicializa un mapa con la clave de suscripción definida explícitamente y setSubscriptionKey no se le ha llamado anteriormente, el constructor map llamará automáticamente.

function setSubscriptionKey(key: string)

Parámetros

key

string

Nueva clave de suscripción predeterminada.

setUserRegion(string)

Advertencia

Esta API ya está en desuso.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parámetros

userRegion

string

setView(string)

Especifica qué conjunto de bordes y etiquetas geopolíticamente disputados se muestran en el mapa. El parámetro View (también denominado "parámetro de región de usuario") es un código de país ISO-3166 de 2 letras que mostrará los mapas correctos para ese país o región. País o regiones que no están en la lista Vista o si no se especifica, el valor predeterminado es la vista "Unificada". Consulte las [Vistas]{@link https://aka.ms/AzureMapsLocalizationViews }compatibles. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado el acceso a través de Azure Maps.

function setView(view: string)

Parámetros

view

string

Nueva vista predeterminada

setWorkerCount(number)

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

function setWorkerCount(workerCount: number)

Parámetros

workerCount

number

recuento de trabajadores.