mapConfig (depuis v4.0.0)

Utilisation

Ce paramètre permet de configurer les options disponibles pour la carte interactive. Sa définition est la suivante :

interface MapConfiguration {
  mapCenter?: {
    lat: number;
    lng: number;
    alt?: number;
  } | [number, number, number?]
  limitAroundCenter?: number
  settings?: {
    categories?: Array<CustomCategory>;
    hospitalityCategories?: {
        restaurant?: HospitalityCategory;
        afaire?: HospitalityCategory;
        avoir?: HospitalityCategory;
        hebergement?: HospitalityCategory;
        produit?: HospitalityCategory;
        service?: HospitalityCategory;
    };
    showFilter?: Array<POIType>;
  }
}

interface CustomCategory {
    name: string;
    color?: string;
    filter?: FilterData;
}

interface FilterData {
    iconUrl?: string;
    label?: string;
    localizedLabel?: Record<string, string>;
}

interface HospitalityCategory {
    display: boolean;
    label?: string;
    localizedLabel?: Record<string, string>;
    color?: string;
}

Paramètres

Nom	Requis	Type	Description
mapCenter	Non	{ lat: number, lng: number, alt?: number } | [number, number, number?]	Coordonnées du centre de la carte au chargement
limitAroundCenter	Non	number	Rayon en kilomètres autour du centre dans lequel les POI seront affichés
settings	Non	Settings	Configuration des filtres et catégories disponibles sur la carte

Settings

Nom	Requis	Type	Description
categories	Non	tableau d'objets de type CustomCategory	Catégories personnalisées pour filtrer les POI sur la carte
hospitalityCategories	Non	HospitalityCategories	Configuration des catégories d'hospitalité intégrées
showFilter	Non	Array<POIType>	Liste des types de POI pour lesquels afficher un filtre

CustomCategory

Nom	Requis	Type	Description
name	Oui	string	Nom de la catégorie, utilisé dans les requêtes graphql / elasticsearch
color	Non	string	Couleur appliquée au bouton de filtre et aux icônes de pin sur la carte
filter	Non	FilterData	Données utilisées pour le bouton de filtre et l'icône de pin sur la carte

FilterData

Nom	Requis	Type	Description
iconUrl	Non	string	Chemin vers l'icône affichée sur le bouton et le pin sur la carte
label	Non	string	Libellé du bouton, à utiliser si le même libellé est utilisé dans toutes les langues
localizedLabel	Non	Record<string, string>	Libellés par langue. Chaque entrée doit être au format <locale>: <libellé> (ex: "fr-FR": "bonjour")

HospitalityCategories

Nom	Requis	Type	Description
restaurant	Non	HospitalityCategory	Configuration de la catégorie Restaurants
afaire	Non	HospitalityCategory	Configuration de la catégorie À faire
avoir	Non	HospitalityCategory	Configuration de la catégorie À voir
hebergement	Non	HospitalityCategory	Configuration de la catégorie Hébergements
produit	Non	HospitalityCategory	Configuration de la catégorie Produits
service	Non	HospitalityCategory	Configuration de la catégorie Services

HospitalityCategory

Nom	Requis	Type	Description
display	Oui	boolean	La catégorie est affichée si ce paramètre est true
label	Non	string	Libellé de la catégorie, à utiliser si le même libellé est utilisé dans toutes les langues
localizedLabel	Non	Record<string, string>	Libellés par langue. Chaque entrée doit être au format <locale>: <libellé> (ex: "fr-FR": "bonjour")
color	Non	string	Couleur appliquée au bouton de filtre et aux icônes de pin sur la carte pour cette catégorie

POIType

enum POIType {
  restaurant = "restaurant",
  afaire = "afaire",
  avoir = "avoir",
  hebergement = "hebergement",
  produit = "produit",
  service = "service"
}