Map class

Contrôle d’une carte web visuelle et interactive.

Constructeurs

Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

Affiche une carte dans le conteneur spécifié.

Propriétés

authentication
controls
events
imageSprite
isDisposed

Retourne true si la carte a été supprimée.

layers
markers
popups
sources

Méthodes

areTilesLoaded()

Retourne une valeur booléenne indiquant si toutes les vignettes de la fenêtre d’affichage actuelle pour toutes les sources ont été chargées ou non.

clear()

Supprime toutes les sources, couches, marqueurs et fenêtres contextuelles de la carte. Les images ajoutées par l’utilisateur sont conservées.

disableElevation()

Désactive le maillage de terrain 3D.

dispose()

Nettoyez les ressources de la carte. Le mappage ne fonctionnera pas correctement après l’appel de cette méthode.

enableElevation(string | ElevationTileSource, number)

Charge un maillage de terrain 3D, basé sur une source « raster-dem ».

getCamera()

Retourne les propriétés actuelles de la caméra.

getCanvas()

Renvoie l’élément HTMLCanvasElement vers lequel la carte est dessinée.

getCanvasContainer()

Renvoie l’élément HTMLElement qui contient le code HTMLCanvasElement de la carte. Les événements de la carte (par exemple, panoramique et zoom) sont attachés à cet élément.

getMapContainer()

Renvoie l’élément HTMLElement qui contient la carte.

getServiceOptions()

Retourne les options de service avec lesquelles le contrôle de carte a été initialisé.

getStyle()

Retourne les paramètres de style actuels du contrôle de carte.

getTraffic()

Retourne les paramètres de trafic actuels du contrôle de carte.

getUserInteraction()

Retourne les paramètres actuels du gestionnaire d’interaction utilisateur du contrôle de carte.

pixelsToPositions(Pixel[])

Convertit un tableau d’objets Pixel en tableau d’objets Positions géographiques sur la carte.

positionsToPixels(Position[])

Convertit un tableau d’objets Positions en tableau d’objets Pixel par rapport au conteneur de carte.

resize(any)

Redimensionnez la carte en fonction des dimensions de son élément conteneur.

resize(number | string, number | string, any)

Redimensionne l’élément conteneur de la carte, puis la carte elle-même.

setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

Définissez la caméra du contrôle de carte avec une transition animée. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

setServiceOptions(ServiceOptions)

Définissez les options de service.

setStyle(StyleOptions, boolean)

Définissez les options de style du contrôle de carte. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

setTraffic(TrafficOptions)

Définissez les options de trafic pour la carte. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

setUserInteraction(UserInteractionOptions)

Définissez les gestionnaires d’interaction utilisateur du contrôle de carte. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

stop()

Arrête toute transition animée en cours.

triggerRepaint()

Déclencher le rendu d’une image unique. Utilisez cette méthode avec les couches WebGL pour repeindre la carte lorsque les propriétés de la couche ou les propriétés associées à la source de la couche changent. L’appel de plusieurs fois avant le rendu de l’image suivante entraîne toujours le rendu d’une seule image.

Détails du constructeur

Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

Affiche une carte dans le conteneur spécifié.

new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

Paramètres

container

string | HTMLElement

ID de l’élément dans lequel la carte doit être affichée.

options

ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)

Options pour l’affichage initial et l’interaction avec la carte.

Détails de la propriété

authentication

authentication: AuthenticationManager

Valeur de propriété

controls

controls: ControlManager

Valeur de propriété

events

events: EventManager

Valeur de propriété

imageSprite

imageSprite: ImageSpriteManager

Valeur de propriété

isDisposed

Retourne true si la carte a été supprimée.

boolean isDisposed

Valeur de propriété

boolean

layers

layers: LayerManager

Valeur de propriété

markers

markers: HtmlMarkerManager

Valeur de propriété

popups

popups: PopupManager

Valeur de propriété

sources

sources: SourceManager

Valeur de propriété

Détails de la méthode

areTilesLoaded()

Retourne une valeur booléenne indiquant si toutes les vignettes de la fenêtre d’affichage actuelle pour toutes les sources ont été chargées ou non.

function areTilesLoaded(): boolean

Retours

boolean

clear()

Supprime toutes les sources, couches, marqueurs et fenêtres contextuelles de la carte. Les images ajoutées par l’utilisateur sont conservées.

function clear()

disableElevation()

Désactive le maillage de terrain 3D.

function disableElevation()

dispose()

Nettoyez les ressources de la carte. Le mappage ne fonctionnera pas correctement après l’appel de cette méthode.

function dispose()

enableElevation(string | ElevationTileSource, number)

Charge un maillage de terrain 3D, basé sur une source « raster-dem ».

function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)

Paramètres

elevationSource

string | ElevationTileSource

source de vignette d’élévation

exaggeration

number

facteur d’exagération d’élévation

getCamera()

Retourne les propriétés actuelles de la caméra.

function getCamera(): CameraOptions & CameraBoundsOptions

Retours

getCanvas()

Renvoie l’élément HTMLCanvasElement vers lequel la carte est dessinée.

function getCanvas(): HTMLCanvasElement

Retours

HTMLCanvasElement

getCanvasContainer()

Renvoie l’élément HTMLElement qui contient le code HTMLCanvasElement de la carte. Les événements de la carte (par exemple, panoramique et zoom) sont attachés à cet élément.

function getCanvasContainer(): HTMLElement

Retours

HTMLElement

getMapContainer()

Renvoie l’élément HTMLElement qui contient la carte.

function getMapContainer(): HTMLElement

Retours

HTMLElement

getServiceOptions()

Retourne les options de service avec lesquelles le contrôle de carte a été initialisé.

function getServiceOptions(): ServiceOptions

Retours

getStyle()

Retourne les paramètres de style actuels du contrôle de carte.

function getStyle(): StyleOptions

Retours

getTraffic()

Retourne les paramètres de trafic actuels du contrôle de carte.

function getTraffic(): TrafficOptions

Retours

getUserInteraction()

Retourne les paramètres actuels du gestionnaire d’interaction utilisateur du contrôle de carte.

function getUserInteraction(): UserInteractionOptions

Retours

pixelsToPositions(Pixel[])

Convertit un tableau d’objets Pixel en tableau d’objets Positions géographiques sur la carte.

function pixelsToPositions(pixels: Pixel[]): Position[]

Paramètres

pixels

Pixel[]

Pixels à convertir.

Retours

positionsToPixels(Position[])

Convertit un tableau d’objets Positions en tableau d’objets Pixel par rapport au conteneur de carte.

function positionsToPixels(positions: Position[]): Pixel[]

Paramètres

positions

Position[]

Positions à convertir.

Retours

Pixel[]

resize(any)

Redimensionnez la carte en fonction des dimensions de son élément conteneur.

function resize(eventData?: any)

Paramètres

eventData

any

Propriétés supplémentaires facultatives à ajouter aux objets d’événements d’événements déclenchés par cette méthode.

resize(number | string, number | string, any)

Redimensionne l’élément conteneur de la carte, puis la carte elle-même.

function resize(height: number | string, width: number | string, eventData?: any)

Paramètres

height

number | string

Hauteur de la carte et de son élément conteneur. Une entrée numérique est supposée être en pixels.

width

number | string

Largeur de la carte et de son élément conteneur. Une entrée numérique est supposée être en pixels.

eventData

any

Propriétés supplémentaires facultatives à ajouter aux objets événement d’événements déclenchés par cette méthode.

setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

Définissez la caméra du contrôle de carte avec une transition animée. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

function setCamera(options?: (CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

Paramètres

options

(CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions

Options permettant de définir la caméra de la carte et de l’animation de toute modification d’affichage.

setServiceOptions(ServiceOptions)

Définissez les options de service.

function setServiceOptions(options: ServiceOptions)

Paramètres

options
ServiceOptions

setStyle(StyleOptions, boolean)

Définissez les options de style du contrôle de carte. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

function setStyle(options?: StyleOptions, diff?: boolean)

Paramètres

options
StyleOptions

Options permettant de définir le style du contrôle de carte.

diff

boolean

Si la valeur est false, force une mise à jour de style « complète », en supprimant le style actuel et en créant le donné au lieu de tenter une mise à jour basée sur diff. La valeur par défaut est true.

setTraffic(TrafficOptions)

Définissez les options de trafic pour la carte. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

function setTraffic(options?: TrafficOptions)

Paramètres

options
TrafficOptions

Options permettant de définir l’affichage du trafic de la carte.

setUserInteraction(UserInteractionOptions)

Définissez les gestionnaires d’interaction utilisateur du contrôle de carte. Toutes les options non spécifiées sont par défaut leurs valeurs actuelles.

function setUserInteraction(options?: UserInteractionOptions)

Paramètres

options
UserInteractionOptions

Options permettant d’activer/désactiver les gestionnaires d’interaction utilisateur.

stop()

Arrête toute transition animée en cours.

function stop()

triggerRepaint()

Déclencher le rendu d’une image unique. Utilisez cette méthode avec les couches WebGL pour repeindre la carte lorsque les propriétés de la couche ou les propriétés associées à la source de la couche changent. L’appel de plusieurs fois avant le rendu de l’image suivante entraîne toujours le rendu d’une seule image.

function triggerRepaint()