Skip to content

Version Intégrable

matt-litwiller edited this page Aug 15, 2023 · 18 revisions

Configurations de la version intégrable useEmbeddedVersion

Configuration Type Description
layerId string Identifiant unique pour la couche (définie dans _default.json)
showMap boolean Permet de contrôler la visibilité de la carte
simpleFilters Object Permet de définir les filtres qui seront possibles pour filtrer les entités, ce qui sera reflété dans la carte et la liste s'ils sont visibles. Sans la configuration simpleFilters, les filtres ne sont pas visibles.
simpleFeatureList Object Permet de configurer la liste, les attributs qui seront présents pour chaque entité ainsi que la configuration pour le nombre de résultats par page et le triage des résultats. Sans la configuration simpleFeatureList, la liste n'est pas visible

Exemple:

"useEmbeddedVersion": {
    "layerId": "dq2",
    "showMap": true,
    "simpleFilters": {
      "filters": [
      {"type": "region", "description": "Région"},
      {"type": "responsable", "description": "Responsable"},
      {"type": "municipalites", "description": "Municipalité"},
      {"type": "arrondissements", "description": "Arrondissements"}
    ],
    "uniqueAttribute": "adressebur"
  },
    "simpleFeatureList": {
      "attributeOrder": [
        {"attributeName": "adressebur", "header": "small"},
        {"attributeName": "label", "header": "title"},
        {"attributeName": "region", "description": "Région", "header": "standard"},
        {"attributeName": "mrc", "description": "MRC", "header": "standard"},
        {"attributeName": "municipalites", "description": "Municipalité"},
        {"attributeName": "responsable", "description": "Responsable"},
        {"attributeName": "telephonebur", "description": "Téléphone"},
        {"attributeName": "telecopieurbur", "description": "Télécopieur"},
        {"attributeName": "courriel"},
        {"attributeName": "arrondissements", "description": "Arrondissements"}
      ],
      "sortBy": {
        "default": {"attributeName": "region"},
        "attributes": [
          {"type": "region", "description": "Région"},
          {"type": "responsable", "description": "Responsable"}
        ]
      },
      "formatURL": true,
      "formatEmail": true,
      "paginator": {
        "pageSizeOptions": [1,5,10,20,50],
        "pageSize": 5,
        "showFirstLastPageButtons": true,
        "showPreviousNextPageButtons": true
      }
    }
  },

image

Configurations des filtres simpleFilters

Configuration Type Description
filters SimpleFilter[] Liste de filtres qui seront affichés. Les descriptions peuvent être choisis par l'utilisateur - et ne doivent pas être unique - mais les types doivent provenir du champ properties de chaque Feature ou des types de terrAPI. À noter: seulement les types de terrAPI en polygone/multipolygone peuvent être utilisés et les autres types seront rejettés

Configurations de la liste simpleFeatureList

Interfaces

SimpleFilter

interface SimpleFilter {
	type: string;
	description: string;
}
Clone this wiki locally