Skip to content

SxtViewerElement

Référence de l'API du web component <sxt-viewer>.

Obtenir une référence à l'élément puis appeler ses méthodes :

html
<sxt-viewer id="viewer"></sxt-viewer>
<script type="module">
  const viewer = document.getElementById('viewer')
  await viewer.setInitialContext({ layers: [], view: { center: [2.35, 48.85], zoom: 10 } })
</script>

Méthodes

addLayer

typescript
addLayer(layer, zoomToExtent)

Ajoute une couche au-dessus de la pile de couches actuelle.

ParamètreDescription
layerDéfinition de la couche. Accepte tous les types MapContextLayer ainsi que le type stac.
zoomToExtentSi true et que la couche a une emprise connue, la vue s'ajuste automatiquement.

getContext

typescript
getContext(): ExtendedMapContext

Retourne le contexte de carte actuel incluant les couches, couches de fond et l'étendue de la vue. Les métadonnées internes (id, version) sont supprimées du résultat.


setContext

typescript
setContext(context: ExtendedMapContext): void

Remplace l'intégralité du contexte de carte (couches, couches de fond, vue, sources de données). Le remplacement est total : ce que le contexte n'inclut pas est supprimé. Ne supporte pas les couches nécessitant un enrichissement asynchrone (ex. STAC) ; utiliser setInitialContext dans ce cas.

ParamètreDescription
contextLe nouveau contexte à appliquer.

setInitialContext

typescript
setInitialContext(context: ExtendedMapContext): void

Définit le contexte initial et déclenche l'enrichissement des couches. À utiliser au premier chargement ou pour les couches nécessitant une initialisation asynchrone (ex. collections STAC). Le contexte peut déclarer des dataSources (p. ex. un index ElasticSearch de Geonetwork), sondées pour détecter les couches WMS filtrables par attributs.

ParamètreDescription
contextLe contexte initial de la carte.

setView

typescript
setView(view: MapContextView): void

Déplace ou zoom la carte vers la vue spécifiée sans modifier les couches.

ParamètreDescription
viewVue définie par zoom+centre, emprise ou géométrie.

Événements

ÉvénementPayloadDescription
map-extent-change[extent: Extent]Émis à chaque déplacement ou zoom de la carte. Le payload est en EPSG:4326.

Props

Aucune propriété HTML pour le moment — la configuration se fait via les méthodes.

Variables CSS

Aucune variable CSS pour le moment.