Composante

Géométrique

Entête (header)

Entête comprenant un logo, un titre et un petit menu pour changer la langue et afficher le lien Nous joindre.
L’entête est optionnelle.
Les options de configuration sont dans src/config.json sous « header » :
« hasHeader »: boolean (activer ou désactiver l’entête)
« logo »: string (lien vers l’image du logo)
« logoPrint »: string (lien vers l’image du logo pour impression, si nécessaire)

Carte (map)

Permet de définir les propriétés de la carte dans le contexte.
NB: Peut être définie une seule fois dans le contexte _base pour être appliqué à tous les contextes.

Exemples

{
    "map": {
      "view": {
          "enableRotation": false,
          "projection": "EPSG:3857",
          "center": [-73, 50.5],
          "zoom": 6,
          "geolocate": false,
          "maxZoomOnExtent":15,
          "maxLayerZoomExtent": [-10000000, 5000000, 6000000, 9500000]
      }
    }
}

Propriétés de l’objet « view » de map

Propriétés Type Description Valeurs possibles Valeur défaut
enableRotation Boolean
Définir si, lors de l’utilisation en mobile, on peut tourner
la carte et de cette facon ne plus avoir le nord en haut.
true | false true
projection String Indique la projection de la carte en indiquant le code EPSG.    
center Array []
Coordonnée du positionnement du centre de la carte lors de 
l’arrivée dans le contexte.
   
zoom Number
Indique le niveau de zoom de la carte lors de 
l’arrivée dans le contexte.
   
homeExtentButtonExtent String
Coordonnées de l’étendue de la carte lorsque l’utilisateur
clique sur le bouton homeExtent.
MINX | MINY | MAXX | MAXY  
geolocate Boolean
Indique si la carte est zommée sur la localisation de l’utilisateur 
lors de l’arrivée dans le contexte.
true | false true
maxZoomOnExtent Number
Indique le niveau de zoom qu’aura l’application lors d’un clic 
sur un résultat de recherche qui n’est pas une couche.
   
maxLayerZoomExtent Array []
Indique l’étendue maximale considérée comme étant valide pour un cadrage
lors du calcul de l’étendue d’une ou plusieurs couches. Les coordonnées
minimales et maximales doivent être compatibles avec la projection donnée.
   

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

** En construction, propriété a compléter

Liens

Étendue de base (homeExtent)

Bouton de l’interface utilisateur permettant de d’afficher la carte selon un point central ou une étendue. Il peut être définit par :

  • l’étendue (extent), soit les 4 points limitant l’affichage (MINX | MINY | MAXX | MAXY)
  • un point central (center + zoom). Plus le nombre du niveau de zoom est grand, plus l’affichage est zoomé sur le point central.

Cet affichage est définit à deux niveaux :

- 1 - il s’applique de façon générale, peu importe la couche ou le contexte. Il peut être définit pour un portail.
Si les 3 paramètres sont définis, l’étendue (extent) sera affichée.

Fichier de configuration : srcconfigconfig.json

Exemple :
« homeExtentButton »: {
« homeExtButtonExtent »:[-9000000, 5790000,-7500000, 6770000],
« homeExtButtonCenter »: [-71.938087, 48.446975],
« homeExtButtonZoom » : 6
}


- 2 - il s’applique par contexte
Si les 3 paramètres sont définis, le point central (center + zoom) sera affiché.

Fichier de configuration : srccontextshomeExtent.json

Exemple :
{
« uri »: « homeExtent »,
« base »: « _base »,
« map »: {
« view »: {
« projection »: « EPSG:3857 »,
« homeExtent »: {
« extent »: [-9000000, 5790000,-7500000, 6770000],
« center »: [-72.069923, 48.672381],
« zoom »: 10
}
}
}
}

Couche d’information (layer)

Permet de définir les propriétés d’une couche d’information.

Exemples

{
    "title": "Satellite",
    "baseLayer": true,
    "visible": false,
    "sourceOptions": {
            "url": "https://geoegl.msp.gouv.qc.ca/apis/carto/tms/1.0.0/orthos@EPSG_3857/{z}/{x}/{-y}.jpeg",
            "attributions": "© <a href='https://www.droitauteur.gouv.qc.ca/copyright.php' target='_blank'><img src='https://geoegl.msp.gouv.qc.ca/gouvouvert/public/images/quebec/gouv_qc_logo.png' width='64' height='14'>Gouvernement du Québec</a> / <a href='https://www.igouverte.org/' target='_blank'>IGO2</a>",
            "type": "xyz",
            "crossOrigin": "anonymous"
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
baseLayer Boolean
Définir si la couche doit être considérée comme une couche de base. Les couches de
base sont présentées dans le « baselayer » switcher dans le coin inférieur gauche et
peuvent être exclues visuellement de la table des matières.
 true| false false
id String
Identifiant unique de la couche à l’échelle de l’application.
Particulièrement utile pour bâtir le lien pour le partage
de cartes. Si vous avez plusieurs fois la même couche dans un context
vous devez avoir un id pour que le lien de partage foinctionne bien.
Attention: si vous définissez un id, la couche ajoutée par le catalogue
ou par la recherche sera considérée par l’app. comme une couche différente,
vous aurez donc 2 fois la même couche.
   Uuid ()
legendOptions LegendOptions Permet de définir des options sur la légende.    
workspace WorkspaceOptions
Permet de définir si une source possèdera une table
d’attribut dans l’application ainsi que ses propriétés associées.
workspace:  | {  enabled: true,  | minResolution: 0,  | maxResolution: 400} Voir dans l’objet WorkspaceOptions
maxResolution Number
Définir la résolution à laquelle la couche d’information commence à s’afficher. |
Intéressant pour les couches exigeantes à récupérer à très petite échelle (ex. 1: 5000000).
Pour les WMS récupérant certaines propriétés du service, cette valeur peut
être récupérée.
    
maxScaleDenom Number
Définir l’échelle à laquelle la couche d’information commence
à s’afficher. Le chiffre inscrit correspond à l’échelle.
Ex. 2000000 correspond à 1:2000000
   
minResolution Number
Définir la résolution à laquelle la couche d’information arrête de s’afficher

Pour les WMS récupérant certaines propriétés du service,
cette valeur peut y être récupérée.
    
minScaleDenom Number
Définir l’échelle à laquelle la couche d’information arrête
de s’afficher. Le chiffre inscrit correspond à l’échelle.
Ex. 2000000 correspond à 1:2000000
   
messages ref:Message[] <_igomessage>.
Affichage d’une liste des messages. Les messages s’affichent seulement 1 fois
pendant la session lorsque la couche s’affiche.
   
metadata Object{}
Définir la source pour les metadonnées. Lien pour le bouton i de la couche. 
Si la balise url est configurée, elle permet de définir un url au choix.
Pour les WMS, si la couche wms a une balise dataUrl et que la source wms à 
l’option optionsFromCapabilities : true, | | l’application ira récupérer le lien dans le service WMS.
La valeur pilotée à préséance sur la valeur récupérée du service.
Pour les sources WMS, WMTS et ArcGISREST, si celui-ci n’est pas défini, c’est l’abstract 
du catalogue qui sera utilisé. Les propriété permises sont:
- url
- extern
- keyword
- abstract = résumé de la couche. Sert au tooltip ici bas.
{url: « https://www.igouverte.org/ », extern: true}  
showButtonZoomToExtent Boolean N’affiche pas le bouton de zoom sur l’étendu dans les options de la couche    
tooltip Object{}
Permet de définir le type de tooltip à afficher sur survol de la couche
dans la table des matières (liste de couche).
Les divers types sont:
- title
- abstract
- custom
Le type title présente uniquement le titre de la couche
Le type abstract récupère le « abstract » de la balise metadata.
Le type custom récupère le texte de la balise text
{  type: “title”
ou  “abstract”
ou  “custom”,
text: “text à afficher”
si le type est custom”}
{  type: “title”}
opacity Number
Définir la transparence de la couche. 0 = invisible 1 = aucune transparence
Également controlable par l’interface.
 de 0.0 à 1.0 1
showInLayerList Boolean Définit si la couche est visible ou non dans la table des matières true| false true
sourceOptions* SourceOptions
Diverses sources de données sont supportées.
Référez-vous aux section suivantes pour plus de détails.
    
title* String
Titre de la couche tel qu’affiché dans
la table des matières et dans les résultats
d’interrogations.
Pour les WMS et WMTS récupérant
certaines propriétés du service, cette
valeur peut y être récupérée et n’est plus obligatoire à ce moment.
    
visible Boolean Visibilité de la couche à l’ouverture du contexte. true| false true
zIndex Number
Ordre dans la table des matières. Plus
le nombre est élevé, plus la couche
apparait au haut de la table des matières. 
Si absent, l’ordre dans le contexte.json fait office d’ordonnancement.
   

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

LegendOptions

Propriétés de l’objet legendOptions.
Permet de controler le rendu de légende.

Exemples

{"legendOptions": {
      "collapsed": false,
      "display": true,
      "url": "https://v.seloger.com/s/width/1144/visuels/0/m/l/4/0ml42xbt1n3itaboek3qec5dtskdgw6nlscu7j69k.jpg",
      "stylesAvailable": [
            { "name": "rain", "title": "Pluie" },
            { "name": "raster", "title": "Défaut" }
      ]
}}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
collapsed Boolean Définir si la légende est ouverte. true | false  
display Boolean Indique si on affiche la légende. true | false true
html String Inscription html pour la légende.    
stylesAvailable ItemStyleOptions[]
Permet de modifier/contrôler la liste des styles provenant du
service web. Correspond aux styles disponible pour le layer
WMS tel que décrit dans le GetCapabilities WMS.
Ex:  « stylesAvailable »: [  
{ « name »: « raster », « title »: « pixel » },
{ « name »: « Contour », « title »: « aucune couleur » }
]
 
url String
URL imposé pour l’appel de la légende.
Exemple: « /ws/mffpecofor.fcgi?&REQUEST=GetLegendGraphic&SERVICE=WMS&FORMAT=image/png&SLD_VERSION=1.1.0&VERSION=1.3.0&LAYER=lidar_index_extraction »
   

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

SourceOptions

Diverses sources de données sont supportées.
Référez-vous aux section suivantes pour
plus de détails.

- ArcGis
- Image ArcGis
- Tile ArcGis
- Carto
- OSM
- Cluster
- TMS (xyz)
- Vector Tiles
- Vecteur
- Websocket
- WFS
- WMS
- WMTS

WorkspaceOptions

Permet de définir si une source possèdera une table
d’attribut dans l’application ainsi
que ses propriétés associées.

Exemples

{"workspace": {
      "enabled": true,
      "minResolution": 0,
      "maxResolution": 400,
      "searchIndexEnabled": false,
      "queryOptions": {
        "mapQueryOnOpenTab": false,
        "tabQuery": false
      }
}}

Propriétés

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

LinkedLayersOptions

Permet de définir un lien entre des couches et
de synchroniser les propriétés choisies.

Exemples

{"linkedLayers": {
    "linkId": "wmsTimeFilterSrc",
    "links": [{
                "linkedIds": ["wmsTimeFilterDest"],
                "syncedDelete": true,
                "properties": ["opacity","timeFilter","visible"]
              }]
}}

Propriétés de LinkedLayersOptions

Propriétés Type Description Valeurs possibles Valeur défaut
linkId String
Identifiant de liaison de la présente couche.
Diffère du ID du la couche car cet id doit être
connu au pilotage, pas seulement lors l’éxécution du code.
   
links LayersLinkProperties[]
Définit la liste des couches « enfant » liées
ainsi que leurs propriété qui sont synchronisées.
Obligatoire pour les couches parents.
    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Propriétés de LayersLinkProperties

Propriétés Type Description Valeurs possibles Valeur défaut
linkedIds String[]
Liste des identifiants de liaison.
C’est à dire, une liste des linkId des couches enfant.
   
syncedDelete Boolean
Indique si les 2 couches doivent être supprimées
simultanément lorsque une ou l’autre des couches
est supprimée de la liste des couches.
true | false false
properties String[]
Indique les propriétés à maintenir entre les 2 couches liées.
- opacity
- visible
- ogcFilters
- minResolution
- maxResolution
- zIndex
- timeFilter => Configuration filtre temporel WMS-T (timeFilter)
    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

Sources de données (datasource)

Certaines sources de données possèdent des propriétés communes et spécifiques.

Les propriétés communes et spécifiques seront traitées et différenciées dans les sections suivantes.

Propriétés communes

Les propriétés communes aux sources de données (sourceOptions).

Exemples

{"sourceOptions": {
      "attributions": "Droits d'auteurs que vous désirez afficher avec votre couche.",
      "crossOrigin": "anonymous",
      "download": {
        "url": "https://diffusion.mffp.gouv.qc.ca/Diffusion/DonneeGratuite/Foret/IMAGERIE/Mosaiques_Landsat/Mosaique_Sentinel_2021/",
        "extern": true,
        "allowedFormats": ["URL"]
      }
}}

Propriétés

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

ArcGis

Note

Disponible actuellement mais la documentation est en cours de construction. Problématique observée pour les styles complexe. Même QGIS ne rends pas correctement les styles complexe. https://github.com/infra-geo-ouverte/igo2-lib/issues/810

Exemples

{
    "sourceOptions": {
        "type": "arcgisrest",
        "layer": "2",
        "queryable": true,
        "url": "https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer",
        "queryFormat": "esrijson",
        "queryPrecision": 20 , // unité en mètres pour l'interrogation de la couche
        "idColumn": "OBJECTID"
    }
}

Image ArcGis

Note

Disponible actuellement mais la documentation est en cours de construction. C’est la version qui effectue un seul appel pour toute l’étendu de la carte.

Exemples

{
    "sourceOptions": {
        "type": "imagearcgisrest",
        "layer": "1",
        "queryable": true,
        "url": "https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer",
        "queryFormat": "esrijson",
        "queryPrecision": 20 , // unité en mètres pour l'interrogation de la couche
        "idColumn": "OBJECTID"
    }
}

Tile ArcGis

Note

Disponible actuellement mais la documentation est en cours de construction. C’est la version qui effectue plusieurs appels pour l’étendue de la carte. Peut être conflictuel pour les étiquettes qui seront dupliqués pour chacune des tuiles.

Exemples

{
    "sourceOptions": {
        "type": "tilearcgisrest",
        "layer": "1",
        "queryable": true,
        "url": "https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer",
        "queryFormat": "esrijson",
        "queryPrecision": 20 , // unité en mètres pour l'interrogation de la couche
        "idColumn": "OBJECTID"
    }
}

Carto

Note

Disponible actuellement mais la documentation est en cours de construction.

Exemples

{
  "sourceOptions": {
  "type": "carto",
  "account": "common-data",
  "queryable": true,
  "queryFormat": "geojson",
  "queryPrecision": "5000",
  "crossOrigin": "anonymous",
  "config": {
      "version": "1.3.0",
      "layers": [
            {
                "type": "cartodb",
                "options": {
                    "cartocss_version": "2.3.0",
                    "cartocss": "#layer { line-width: 3; line-color: ramp([yr], (#5F4690, #1D6996, #38A6A5, #0F8554, #73AF48, #EDAD08, #E17C05, #CC503E, #94346E, #6F4070, #666666), (\"2004\", \"2008\", \"2011\", \"1998\", \"2003\", \"1999\", \"1992\", \"2010\", \"2005\", \"1995\"), \"=\"); }",
                    "sql": "select * from tornado"
                    }
            }
      ]
  }}
}

OSM

Le fond standard OpenStreetMap.
Ce type de service n’est pas interrogeable.

Exemples

{"sourceOptions": {
      "type": "osm"
}}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
type* String   osm osm

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

Cluster

Note

Une source de données pour les données vectorielle composées de points. Elle génere des regroupements d’entité lorsque ceux-ci se retrouve près l’une de l’autre.

Exemples

{"sourceOptions": {
      "url": "https://d2ad6b4ur7yvpq.cloudfront.net/naturalearth-3.3.0/ne_50m_populated_places.geojson",
      "type": "cluster",
      "distance": 50
}}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
type* String   cluster cluster
url* String L’URL du fichier contenant les entités.    
excludeAttribute String[] Liste des attributs exclus du getInfo lorsque l’application est en ligne.    
excludeAttributeOffline String[] Liste des attributs exclus du getInfo lorsque l’application est en hors-ligne.    
distance Number Distance en pixel entre les entités afin d’être agrégées en grappe.   20

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

TMS (xyz)

Une source de données pour les services de données tuilées de type XYZ où le X et le Y représentent la position de la tuile appelée et le Z, le niveau de zoom (résolution) de la tuile.

Exemples

{"sourceOptions": {
      "url": "https://geoegl.msp.gouv.qc.ca/apis/carto/tms/1.0.0/orthos@EPSG_3857/{z}/{x}/{-y}.jpeg",
      "type": "xyz"
}}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
type* String   xyz xyz
url* String
L’URL du service de données tuilées en spécifiant la position
des tuiles en déclarant les balises de remplacement:
- {x}
- {-y}
- {z}
X et Y représentent la position de la tuile appelée
tandis que le Z, le zoom.
   

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

Vector Tiles

Une source de données pour les services de données au format Vector tiles. Plus spécifiquement,
au format Mapbox Vector Tiles (MVT) .

Exemples

{"sourceOptions": {
      "type": "mvt",
      "url": "https://ws.mapserver.transports.gouv.qc.ca/swtq?mode=tile&tilemode=gmap&tile={x}+{y}+{z}&layers=bgr_v_sous_route_res_inv_act&map.imagetype=mvt"
}}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
type* String   mvt mvt
url* String
L’URL du service de données tuilées en spécifiant la position
des tuiles en déclarant les balises de remplacement:
- {x}
- {-y}
- {z}
X et Y représentent la position de la tuile appelée
tandis que le Z, le zoom.
   
excludeAttribute String []
Liste des attributs exclus du getInfo lorsque l’application
est en ligne.
   
excludeAttributeOffline String []
Liste des attributs exclus du getInfo lorsque l’application
est hors-ligne.
    
featureClass String
Définir cette option en tant que “feature” pour obtenir
une prise en charge complète de l’édition
et de la géométrie des tuiles.
Cette option diminue les performances de rendu des tuiles.
Ne pas utiliser cette option pour
optimiser le rendu des tuiles.
feature  
queryLayerFeatures Boolean Définit si les entitées vectorielles de la couche seront interrogées true | false true
queryUrl String
Paramètres possibles dans l’url:
{ymin}, {xmax}, {ymax}, {xmin}, {x}, {y}, {resolution}, {srid}
Exemple:
« queryUrl »: « https://mapserver.com/test?x={x}&y={y} »
Null si non défini

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

Vecteur

Source de donnée permettant d’afficher des données vectorielles provenant de fichier en ligne ou de service donnant des entitées.

La projection doit être EPSG:3857. Si ce n’est pas le cas il faut ajouter les paramètres dans formatOptions pour convertir.
Par exemple pour le format Geojson:
- dataProjection = la projection de la donnée source
- featureProjection = la projection IGO -> 3857
Les paramètres possibles dans formatOptions sont ratachés au format de openLayer.
Par exemple ici pour le Geojson

NB: Le site web ou est stockés le fichier, par exemple https://www.donneesquebec.ca doit être ajouté à la sécurité du site IGO et
le site IGO doit être ajouté à la sécurité du site de donnée.

NB2: Pour que le partage de carte fonctionne bien il est nécessaire d’ajouter un id à la couche

Exemples

{
  "title": "Donnée geojson sur DQ (pas de service)",
  "id": "vector1",
  "sourceOptions": {
    "preload": {
       "comment": "Charger la donnée dans la source même si le layer est non visible ou hors échelle d'affichage."
       "bypassVisible": true
       "bypassResolution": true
    },
    "type": "vector",
    "url": "https://www.donneesquebec.ca/recherche/dataset/f647f5ed-a8f3-4a47-8ceb-977cbf090675/resource/68e0e20a-415d-44f5-af82-a90311784616/download/bornes-incendies.geojson"
    "queryable": true,
    "queryFormat": "geojson",
    "queryTitle": "Le titre",
    "formatOptions": {
      "dataProjection": "EPSG:4326",
      "featureProjection":"EPSG:3857"
    },
  }
},
{
  "id": "vector2",
  "title": "Geojson provenant d'un apel wfs",
  "sourceOptions": {
      "queryable": true,
      "type": "vector",
      "url": "https://ws.mapserver.transports.gouv.qc.ca/swtq?service=WFS&request=GetFeature&version=1.1.0&typename=aeroport_piste&outputFormat=geojson"
  }
}

Websocket

Une source de données provenant d’un websocket.

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
onmessage* String
Action déclenchée lors de la réception
de la donnée par le websocket
update | delete | add add
onopen String Action déclenchée lors de l’ouverture du websocket.    
onclose String Action déclenchée lors de la fermeture du websocket.    
onerror String Action déclenchée lors d’une erreur du websocket.    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Exemple

{

      "title": "Points temps réel",
      "sourceOptions": {
            "type": "websocket",
            "url": "wss://websocket.domain/api/websocket/",
            "onmessage": "update",
            "queryable": true,
            "queryTitle": "Véhicule : ${unitid}"
      }
}

Liens

WFS

Note

Disponible actuellement mais la documentation est en cours de construction.

Exemples

{
      "sourceOptions": {
            "type": "wfs",
            "url": "https://geoegl.msp.gouv.qc.ca/apis/ws/igo_gouvouvert.fcgi",
            "queryable": true,
            "params": {
                  "featureTypes": "vg_observation_v_autre_wmst",
                  "fieldNameGeometry": "geometry",
                  "maxFeatures": 10000,
                  "version": "2.0.0",
                  "outputFormat": "geojson_utf8"
            }
      }
}

WMS

Une source de données pour les services de données au format OGC WMS .
Les diverses version WMS sont acceptées.
NB: Il est possible de combiner une couche WMS et WFS en ajoutant les paramètres WFS à l’intérieur.

Note

En cours de construction.

Exemples

{
      "sourceOptions": {
            "type": "wms",
            "url": "https://geoegl.msp.gouv.qc.ca/apis/ws/igo_gouvouvert.fcgi",
            "params": {
                  "layers": "telephone_urg",
                  "version": "1.3.0"
            },
            "queryable": true,
            "queryFormat": "gml2",
            "queryTitle": "desclocal",
            "optionsFromCapabilities": true,
            "optionsFromApi": true
      }
}

Propriétés

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Paramètre (params) WMS

Propriétés Type Description Valeurs possibles Valeur défaut
layers* String
Correspond au nom de la couche demandée.
Vous pouvez appeler plusieurs couches,
en séparant chacune de celles-ci par une virgule.

IMP:      
- Pour les couches multiples, vous 
ne pourrez récupérer les propriétés
fournies par les GetCapabilities.
Vous devez donc fournir les propriétés
title, max/min Resolution (au besoin).

- Si vous voulez appliquer des filters
OGC à des couches multiples, elles
doivent partager le même schéma de
 données (même champs).
Exemple:
Layers=nomDeLaCouche1
layers=nomDeLaCouche1,nomDeLaCouche2
 
version String Version  de l’appel WMS
1.1.0 
1.1.1
1.3.0
1.3.0
feature_count Number
Nombre de résultats retournés par le serveur
lors des appels GetFeatureInfo (clic sur carte)
   5
info_format String
Nom spécifique du format d’appel du GetFeatureInfo.
Nécessaire si vos format d’appels diffèrent des
noms standards gérés par IGO (décrits précédemment).
   
dpi Number
Nombre de points par pouce du résultat
de l’appel du GetMap. Particulièrement
utile dans IGO pour effectuer la conversion
entre la résolution et le nombre échelle.
  96
map_resolution Number
Nombre de points par pouce du résultat
de l’appel du GetMap. Particulièrement
utile dans IGO pour effectuer la conversion
entre la résolution et le nombre échelle.
  96
format_options String
Nombre de points par pouce du résultat
de l’appel du GetMap. Particulièrement
utile dans IGO pour effectuer la conversion
entre la résolution et le nombre échelle.
  dpi:96

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Pour les propriétés dpi, map_resolution et format_options, les 3 paramètres sont envoyés au serveur en tout temps pour éviter les erreurs de conversion d’échelle. La décision de faire l’appel des 3 paramètres en simultané est basé sur le fait que QGIS procède de la même manière.

Liens

WMS avec WFS combinés

Note

Disponible actuellement mais la documentation est en cours de construction.

Il est possible de combiner un wms et à partir d’une certaine échelle d’apeller la couche en WFS si le service web offre les 2 options.

** Attention le champ ID du service doit être bien définie car ce sera ce champ qui servira a reconnaitre chaque entitée WFS, par exemple dans
la table attributaire. Si le champ id n’est pas bien définie dans le service ou que vous configurez une sortie dans un type ou ID n’est
pas présent au 1er niveau de l’objet dans le retour du service (geojson, GML, etc), vous pourez avoir des problèmes d’entitées qui sont dédoublées.

Exemples

{"title": "WMS with underlying WFS params",
     "visible": true,
     "maxResolution": 1200,
     "workspace": {
         "enabled": true,
         "maxResolution": 100
     },
     "sourceOptions": {
         "queryable": true,
         "queryTitle": "nometablis",
         "queryFormatAsWms": true,
         "type": "wms",
         "url": "https://ws.mapserver.transports.gouv.qc.ca/swtq",
         "urlWfs": "https://ws.mapserver.transports.gouv.qc.ca/swtq",
         "params": {
             "layers": "etablissement_mtq"
         },
         "paramsWFS": {
             "featureTypes": "etablissement_mtq",
             "fieldNameGeometry": "geometry",
             "maxFeatures": 5000
         },
         "ogcFilters": {
             "enabled": true,
             "editable": true
         }
     }
 }

WMTS

Une source de données pour les services de données au format OGC WMTS .

Exemples

{"sourceOptions": {
    "type": "wmts",
    "url": "https://geoegl.msp.gouv.qc.ca/carto/wmts",
    "format": "image/jpeg",
    "matrixSet": "EPSG_3857",
    "layer": "orthos"
}}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
type* String   wmts wmts
format String
Format d’image demandé au serveur. 
Dépend des capacités du serveur (wmts Getcapabilities)
Dépends des capacités du serveur image/jpeg
layer* String Nom de la couche demandée    
matrixSet* String Le nom du matrix set demandé au serveur    
projection String La projection de l’appel de tuile EPSG:3857 La projection de la carte
style  
Le nom du style demandé tel que présenté dans le 
GetCapabilities du service
   
url* String L’URL du service de données tuilées    
version String La version WMTS du service demandé 1.0.0 1.0.0

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

Options de sources avancées

Configuration filtre temporel WMS-T (timeFilter)

La configuration du filtre temporel doit être configurée dans SourceOptions

Exemples

{
  "sourceOptions": {
      "timeFilterable": true,
      "timeFilter": {
              "min": "1890",
              "max": "2019",
              "style": "calendar",
              "range": true,
              "step": 63072000000,
              "type": "year"
        }
  }
}

Propriétés de l’objet timeFilter

Propriétés Type Description Valeurs possibles Valeur défaut
min String Période de temps minimum.
En fonction du type, 
peut être une année, 
une date ou une heure. 

NB: Si la valeur est absente, 
le système appliquera ce qui 
est définit dans le service.
 
max String Période de temps maximum.
En fonction du type, 
peut être une année, 
une date ou une heure. 

NB: Si la valeur est absente, 
le système appliquera ce qui 
est définit dans le service.
 
range Boolean Intervalle à saisir par utilisateur. true/false  
step Number Le temps de l’intervalle en millisecondes. Ex: 63072000000 pour un an.  
style String Le style du selecteur temporel calendar, slider slider
type String Le type temporel de calendrier. En année, jour, heure, etc. year, date  
timeInterval Number
Pour configuration en “slider”, 
le temps d’attente avant de passer 
au suivant, en millisecondes.
   

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Configuration filtre attributaire OGC (ogcFilters)

Permet de définir la configuration des filtres attributaires(OGC) qui seront appliqués par l’utilisateur sur la couche. Plusieurs configurations de filtre sont disponibles. Par exemple, il est possible de créer des boutons sur lesquels l’utilisateur pourra appuyer pour filtrer la couche affichée, de réaliser des groupes de filtre, ou bien de donner la possibilité à l’utilisateur de créer lui même ces propres filtres à l’aide des filtres avancés.

  • Limitation: Disponible uniquement sur des couches de type WFS ou WMS produite par mapServer 7.2 et+ ou geoserver.
  • Les outils ogcFilter et/ou activeOgcFilter doivent être activés dans les outils (“tools”). (Voir activeOgcFilter et ogcFilter dans la section outil )
  • Pour activation des filtres avancés, ils est nécessaire de définir un objet sourceField pour les champs à filtrer. Référez-vous à: Configuration des attributs champs source de donnée (sourceFields)
  • Il est possible de définir plusieurs opérateurs sur un même filtre.
  • les paramètres de sourceOptions maxDate et minDate sont comparés pour indiquer si le filtre temporel est actif (badge rouge dans les options de la couche).

Si le param de sourceOptions optionsFromCapabilities est true les valeurs min et max peuvent provenir du service.

NB: Lorsqu’une couche a une échelle d’affichage définit dans le service, vous devez activer le paramètre dans sourceOptions -> optionsFromCapabilities:true. Dans le cas contraire, des apels contenant les filtres seront fait au service et ce, même à l’échelle ou la couche n’est pas affichée.

Exemples

Exemple - filtre avancé disponible à l’utilisateur.

{
      "ogcFilters": {
            "enabled": true,
            "editable": true,
            "allowedOperatorsType": "Basic"
      }
}

Exemple - filtre avancé définit (zone_veg = Z2) appliqué sur la couche et non disponible pour modification par l’utilisateur

{
      "ogcFilters": {
            "enabled": true,
            "editable": false,
            "filters": {
                  "operator": "PropertyIsEqualTo",
                  "propertyName": "zone_veg",
                  "expression": "Z2"
            }
      }
}

Exemple - filtre 2 boutons avec l’un eux activé. Filtre avancé non disponible

{
      "ogcFilters": {
            "enabled": true,
            "editable": false,
            "pushButtons": {
                  "groups": [
                        {"title": "Group 1","name": "1","ids": ["id1"]}
                  ],
                  "bundles": [
                        {
                              "id": "id1",
                              "logical": "Or",
                              "title": "Type de radar photo",
                              "selector": [
                                    {
                                          "title": "Radar photo fixe",
                                          "enabled": true,
                                          "color": "0,0,255",
                                          "tooltip": "Here a tooltip explaning ...",
                                          "filters": {
                                                "operator": "PropertyIsEqualTo",
                                                "propertyName": "typeAppareil",
                                                "expression": "Radar photo fixe"
                                          }
                                    },
                                    {
                                          "title": "Radar photo mobile",
                                          "enabled": false,
                                          "color": "255,200,0",
                                          "tooltip": "Here a tooltip explaning ...",
                                          "filters": {
                                                "operator": "PropertyIsEqualTo",
                                                "propertyName": "typeAppareil",
                                                "expression": "Radar photo mobile"
                                          }
                                    }
                              ]
                        }
                  ]
            }
      }
}

Exemple - 2 groupes de filtre avec radio boutons et cases à cocher spécifiques à chaque groupe

{
    "ogcFilters": {
        "enabled": true,
        "editable": true,
        "allowedOperatorsType": "All",
        "radioButtons": {
            "order": 2,
            "groups": [
                {"title": "filtre foret","name":"1", "ids": ["type_couv", "densite"]},
                {"title": "filtre metadonnée et densité", "name":"2", "ids": ["densite", "no_program"]}
            ],
            "bundles" : [
                {
                    "id": "type_couv",
                    "logical": "Or",
                    "title": "Type",
                    "selector": [
                        {
                            "title": "type couv = Résineux",
                            "enabled": false,
                            "color": "255,0,0",
                            "tooltip": "Here a tooltip explaning ...",
                            "filters": {
                                  "operator": "PropertyIsEqualTo",
                                  "propertyName": "type_couv",
                                  "expression": "R"
                             }
                        },
                        {
                            "title": "type couv = Feuillus",
                            "enabled": false,
                            "color": "255,100,255",
                            "tooltip": "Here a tooltip explaning ...",
                            "filters": {
                                  "operator": "PropertyIsEqualTo",
                                  "propertyName": "type_couv",
                                  "expression": "F"
                             }
                        }
                    ]
                },
                {
                    "id": "densite",
                    "logical": "Or",
                    "vertical": false,
                    "title": "Densité",
                    "selector": [
                        {
                            "title": "densite = A",
                            "enabled": false,
                            "color": "255,0,0",
                            "tooltip": "Here a tooltip explaning ...",
                            "filters": {
                                  "operator": "PropertyIsEqualTo",
                                  "propertyName": "cl_dens",
                                  "expression": "A"
                             }
                        },
                        {
                            "title": "densite = A & B",
                            "enabled": false,
                            "color": "255,100,255",
                            "tooltip": "Here a tooltip explaning ...",
                            "filters": {
                                "logical":"Or",
                                "filters":[
                                  {"operator": "PropertyIsEqualTo","propertyName": "cl_dens", "expression": "A"},
                                  {"operator": "PropertyIsEqualTo","propertyName": "cl_dens", "expression": "B"}
                                ]
                             }
                        },
                        {
                            "title": "différent de A",
                            "enabled": false,
                            "color": "255,100,255",
                            "tooltip": "Here a tooltip explaning ...",
                            "filters": {
                                "operator": "PropertyIsNotEqualTo",
                                "propertyName": "cl_dens",
                                "expression": "A"
                             }
                        }
                    ]
                 },
            ]
        },
        "checkboxes": {
            "order": 1,
            "bundles" : [
                  {
                    "id": "no_program",
                    "logical": "Or",
                    "vertical":false,
                    "title": "Programme"
                    "selector": [
                      {
                        "title": "prg no= 4",
                        "enabled": false,
                        "color": "255,0,0",
                        "tooltip": "Here a tooltip explaning ...",
                        "filters": {
                              "operator": "PropertyIsEqualTo",
                              "propertyName": "no_prg",
                              "expression": "4"
                        }
                      },
                      {
                        "title": "prg no=5",
                        "enabled": false,
                        "color": "255,100,255",
                        "tooltip": "Here a tooltip explaning ...",
                        "filters": {
                              "operator": "PropertyIsEqualTo",
                              "propertyName": "no_prg",
                              "expression": "5"
                        }
                      }
                    ]
                  }
            ]
        }
    }

}

Exemple - Filtre temporel avec minimum, maximum et pas de temps.

  {
      "type": "wfs",
      "url": "https://geoegl.msp.gouv.qc.ca/apis/ws/igo_gouvouvert.fcgi",
      "params": {
            "featureTypes": "vg_observation_v_autre_wmst",
            "fieldNameGeometry": "geometry",
            "maxFeatures": 10000,
            "version": "2.0.0"
      },
      "sourceFields": [{
            "name": "date_observation",
            "alias": "Date de l\"observation",
            "allowedOperatorsType": "time"
      }],
      "ogcFilters": {
            "enabled": true,
            "editable": true,
            "allowedOperatorsType": "time",
            "filters": {
                  "operator": "During",
                  "propertyName": "date_observation",
                  "begin": "today - 2 days",
                  "end": "today"
            }
      },
      "minDate": "2016-01-01T00:00:00-05:00",
      "maxDate": "2025-12-31T00:00:00-05:00",
      "stepDate": "P1D"
}

Exemple - filtre temporel en mode année

{
      "filters" :{
            "operator": "During",
            "propertyName": "annee_date",
            "begin": "1920",
            "end": "2020",
            "restrictToStep": false,
            "calendarModeYear": true
        }
      "stepDate": "P1Y"
}

Exemple - filtre avec boutons spécifique à un groupe et calendrier (filtrage temporel)

{
      "type": "wms",
      "url": "https://geoegl.msp.gouv.qc.ca/apis/ws/igo_gouvouvert.fcgi",
      "queryable": true,
      "paramsWFS": {
            "featureTypes": "vg_observation_v_autre_wmst",
            "fieldNameGeometry": "geometry",
            "maxFeatures": 10000,
            "version": "2.0.0",
            "outputFormat": "geojson",
            "outputFormatDownload": "SHP"
      },
      "params": {
            "layers": "vg_observation_v_autre_wmst"
      },
      "sourceFields": [
            {"name": "date_observation", "alias": "Date de l'observation", "allowedOperatorsType": "Time"},
            {"name": "type", "alias": "type", "allowedOperatorsType": "all"}
      ],
      "ogcFilters": {
            "enabled": true,
            "editable": false,
            "pushButtons": {
               "groups": [
                  {"title": "Group 1 Title","name": "1","ids": ["id1"]}
               ],
               "bundles": [
                  {
                     "id": "id1",
                     "logical": "Or",
                     "title": "Évènements",
                     "selectors": [
                        {
                           "title": "Mouvement de terrain",
                           "tooltip": "Here a tooltip explaning ...",
                           "filters": {
                              "operator": "PropertyIsEqualTo",
                              "propertyName": "type",
                              "expression": "Mouvement de terrain"
                           }
                        },
                        {
                           "title": "Inondation",
                           "tooltip": "Here a tooltip explaning ...",
                           "filters": {
                              "operator": "PropertyIsEqualTo",
                              "propertyName": "type",
                              "expression": "Inondation"
                           }
                        }
                     ]
                  }
               ]
            },
            "filters": {
               "operator": "During",
               "propertyName": "date_observation",
               "begin": "2016-01-21T00:00:00-05:00",
               "end": "today"
            },
            "allowedOperatorsType": "basic"
      },
      "minDate": "2010-01-01T00:00:00-05:00",
      "maxDate": "2025-12-31T00:00:00-05:00",
      "stepDate": "P1D"
}

Exemple - groupe de filtre avec autocomplétion et domaine de valeurs (dom)

{
    "ogcFilters": {
        "enabled": true,
        "editable": true,
        "allowedOperatorsType": "All",
        "autocomplete": {
            "groups": [
                {"title": "Autocomplete","name": "1","ids": ["id1"]}
            ],
            "bundles": [
                {
                    "id": "id1",
                    "logical": "Or",
                    "unfiltered": true,
                    "title": "dom",
                    "domSelectors": [
                        {
                            "id": 1
                            "name": "dom",
                            "operator": "PropertyIsEqualTo",
                            "propertyName": "typeAppareil"
                        }
                    ]
                }
            ]
        }
    }

}

Propriétés de ogcFilters

Propriétés Type Description Valeurs possibles Valeur défaut
allowedOperatorsType String
Paramètre relatif aux filtres avancés. 
Les opérateurs pour construire l’expression filtrante 
qui seront accessible à l’utilisateur.

NB: Ce paramètre s’appliquera a tous les champs 
définit dans sourceField mais ce paramètre peut aussi
être définit à l’intérieur de sourceField pour l’appliquer | au niveau d’un champ spécifique si besoin.
| BasicNumericOperator,            | Basic,  | Spatial,            | BasicAndSpatial,            | All | time. BasicAndSpatial
editable Boolean
Active ou non la possibilité à l’utilisateur de
construire des filtres avancés.
true | false true
enabled Boolean | Active ou non les filtres modifiable par l’utilisateur sur  | la couche. Si = false, le bouton de filtre n’apparait plus. | Par exemple, dans le cas que le pilote voudrait filtrer une  | couche mais que ce filtre ne soit pas modifiable par l’utilisateur. true | false true
filters | IgoLogicalArrayOptions | AnyBaseOgcFilterOptions
Permet de définir un filtre avancé.
voir configuration filters
   
pushButtons PushButton | Permet de définir des boutons poussoirs qui pourront être  | activés par l’utilisateur pour appliquer des filtres voulus. | Doit contenir obligatoirement bundles[].    
checkboxes Checkbox | Permet de définir des cases à cocher qui pourront être  | activées par l’utilisateur pour appliquer des filtres voulus. | Doit contenir obligatoirement bundles[].    
radioButtons RadioButton | Permet de définir des boutons radio qui pourront être  | activés par l’utilisateur pour appliquer des filtres voulus. | Doit contenir obligatoirement bundles[].    
select Select
Permet de définir une liste déroulante permettant à
l’utilisateur d’appliquer un ou plusieurs filtres.
Doit contenir obligatoirement bundles[].
    
autocomplete Automcomplete
Permet de définir un autocomplétion permettant à
l’utilisateur d’appliquer un ou plusieurs filtres à partir d’un domaine de valeurs.
Doit contenir obligatoirement domSelectors[].
    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

Propriétés de l’objet ogcFilter.{pushButtons/checkboxes/radioButtons}.selectorType

Propriétés Type Description Valeurs possibles Valeur défaut
title String Le type de sélecteur. pushButton, checkbox, radioButton, select  

Propriétés de l’objet ogcFilter.{pushButtons/checkboxes/radioButtons}.groups

Propriétés Type Description Valeurs possibles Valeur défaut
ids String []
Liste des identifiants pour le classement des paquets
(« bundles ») de boutons dans les groupes.
   
title String Le titre du groupe qui apparaitra à l’utilisateur.    

Propriétés de l’objet ogcFilter.{pushButtons/checkboxes/radioButtons}.bundles

Propriétés Type Description Valeurs possibles Valeur défaut
ids String []
Liste des identifiants pour le classement des paquets
(« bundles ») de boutons dans les groupes.
   
title String Le titre du groupe qui apparaitra à l’utilisateur.    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Propriétés de l’objet ogcFilter.{selector}.bundles.selector

Propriétés Type Description Valeurs possibles Valeur défaut
color String La couleur du bouton lorsque celui-ci sera activé. valeur « R,G,B » « 224, 224, 224 »
enabled Boolean Indique si le bouton est actif ou non. true | false false
filters
IgoLogicalArrayOptions
AnyBaseOgcFilterOptions
Configuration de l’expression filtrante appliquée sur l’activation du bouton. 
Voir filters.
   
title String Indique ce qu’il y aura d’inscrit sur le bouton.    
tooltip String Indique ce qu’il y aura d’inscrit dans l’info-bulle sur le bouton.    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Propriétés de l’objet filters (IgoLogicalArrayOptions|AnyBaseOgcFilterOptions)

Propriétés Type Description Valeurs possibles Valeur défaut
expression String Valeur    
operator String | Opérateurs à appliquer.  | ** Certains opérateurs sont disponibles uniquement sur certain type de filtre. | Par exemple, l’opérateur during est disponible uniquement sur le filtre de type time
PropertyIsEqualTo, PropertyIsNotEqualTo,
PropertyIsGreaterThan, PropertyIsGreaterThanOrEqualTo,
PropertyIsLessThan, PropertyIsLessThanOrEqualTo,
Intersects, Within
During
  
propertyName String Nom de la propriété sur laquelle appliquer le filtre (nom de la colonne)    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Propriétés de l’objet filter de type During

Propriétés Type Description Valeurs possibles Valeur défaut
begin String Valeur de début du filtre temporel   Valeur minDate de la couche
end String Valeur de fin du filtre temporel   Valeur maxDate de la couche
step String Pas de temps défini selon la norme ISO-8601 Voir wiki 60000 millisecondes
restrictedToStep Boolean
True si le filtre doit respecter le pas de temps depuis
l’attribut minDate.

Sinon le pas de temps est respecté selon l’attribut begin
 True | False False
calendarModeYearBoolean   Lorsque true, l’interface présentera uniquement des | années et ajustera les requête aux service pour | que l’année de début et de fin soit incluse dans | le retour. True | False False

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Configuration des attributs champs source de donnée (sourceFields)

Une liste de nom d’attribut, de leur alias, valeurs permises et autres configurations.
** Nécessaire pour utilisation des filtres attributaires avancés et de l’outil d’édition. Ce sont ces configurations qui définiront ce qui sera
présenté à l’utilisateur lors de l’utilisation des filtres avancés et de la table d’édition.

Exemples

[
      {"name": "type_couv", "alias": "type couv", "values": ["R", "F"]},
      {"name": "no_prg", "alias": "No inventaire", "values": ["3", "4", "5"]},
      { "name": "code_municipalite", "alias": "# de la municipalitée" },
      { "name": "date_observation", "allowedOperatorsType": "time" },
      { "name": "urgence", "values": ["Immédiate", "Inconnue"], "allowedOperatorsType": "basic" }
]

Propriétés de l’objet sourceFields

Propriétés Type Description Valeurs possibles Valeur défaut
name* String Nom de l’attribut    
alias String Alias de l’attribut.   Le nom de l’attribut est utilisé si nul.
values [] Liste de valeurs permises  
Si vide, pour les WFS, 
sera récupéré automatiquement.
visible Boolean Indique si le champ doit être visible ou non dans la table d’édition. true/false true
type String Indique le type de saisie pour l’outil d’édition. number/string/autocomplete/list/date  
multiple Boolean Indique si la liste en saisie doit être multiple ou non true/false false
excludeFromOgcFilters Boolean Indique si l’attribut est utilisé dans l’outil de filtre OGC. true/false true
allowedOperatorsType String Indique les opérateurs permis pour cet attribut
BasicNumericOperator
Basic
BasicAndSpatial
Spatial
All
Time
Référez vous à ogc-filter.ts pour les opérateurs correspondants.
 BasicAndSpatial
validation Object Indique les validations lors de la sauvegarde d’une entité
Référez vous à entity.interface.ts .
  
relation String Indique les relations à lier pour la saisie des champs de type list
Référez vous à datasource.interface.ts .
  
searchIndex Object Indique si et comment le champs doit etre indexé pour etre recherchable (vector source seulement)
enabled?: boolean;
preset?: Preset;
tokenize?: Tokenizer;
cache?: boolean | number;
resolution?: number;
context?: boolean;
optimize?: boolean;
language?: string;
encode?: Encoders;
Si aucun champ n’est renseigné, la valeur par défaut s’appliquera. Seuls les champs dont l’occurrence des valeurs est supérieure a 2% sera indexé OU si le contenu n’est pas du float.
Voir https://github.com/nextapps-de/flexsearch/ pour les propriétés associées.
 tokenize: « full »

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Configuration de l’édition d’une couche

Une liste de configuration permettant l’utilisation de la table d’édition sur la couche.
** Les sourceFields permettront de définir les champs à visualiser ainsi que les formats de saisies
et les validations attributaires.

Exemples

{
    "enabled": true,
    "baseUrl": "odrsi_vehicule_ssi",
    "addUrl": "",
    "deleteUrl": "id_vehicule=eq.",
    "modifyUrl": "id_vehicule=eq.",
    "geomType": "Point",
    "addWithDraw": false,
    "messages": [{ "odrsi_vehicule_ssi_unique_no_vehicule": "Le numéro de véhicule doit être unique pour la caserne." }]
}

Propriétés de l’objet edition

Propriétés Type Description Valeurs possibles Valeur défaut
name* String Nom de l’attribut    
enabled Boolean Activer ou non la table d’édition sur la couche. true/false false
baseUrl String Url de base du service à appeler.    
addUrl String Url d’appel pour l’ajout d’une entité.    
deleteUrl String Url d’appel pour la suppression d’une entité (par le champ primaire).    
modifyUrl String Url d’appel pour la modification d’une entité(par le champ primaire).    
geomType String Géométrie de la couche (Point/Ligne/Polygone).    
addWithDraw Boolean Activer ou non le dession lors de l’ajout de l’entité. true/false false
messages Object[] Personnaliser les messages affichés à l’utilisateur.    
addHeaders Object Personnaliser les headers de l’appel fait à l’ajout    
modifyProtocole String Personnaliser le protocole d’appel fait la modification   patch
modifyHeaders Object Personnaliser les headers de l’appel fait à la modification    
addButton Boolean Activer ou non le bouton d’ajout sur la couche. true/false true
modifyButton Boolean Activer ou non le bouton de modification sur la couche. true/false true
deleteButton Boolean Activer ou non le bouton de suppression sur la couche. true/false true

Propriétés de l’objet relations

Propriétés Type Description Valeurs possibles Valeur défaut
name* String Nom de l’attribut    
name String nom de la relation.    
alias String Alias de la relation.    
title String Titre du workspace à faire le lien avec.    
icon String Icône du bouton permettant de faire la liaison (https://materialdesignicons.com/).    
table Boolean Indique si le champ doit être visible ou non dans la table d’édition. true/false true
parent String Indique la table parent.    

Sources de recherche (search-source)

Configuration des sources qui seront impliquées dans la recherche faite dans la barre de recherche. Il peut y en avoir plusieurs.

Source (base commune)

Toutes les sources de recherche possèdent des propriétés commnunes. Certaines spécificités existent pour chacune des sources de recherche.
Elles seront présentées dans les sections dédiées aux sources.

Les sources disponible sont:
- Coordonnées
- iCherche (Québec)
- iCherche Reverse - par coordonnées (Québec)
- iLayer (Québec)
- Nominatim (internationnal)
- StoredQueries , WFS 2.0 (Québec)
- StoredQueries Reverse , WFS 2.0 - par coordonnées (Québec)

Selon votre contexte, les sources de recherche ayant une limitation au Québec, peuvent être utilisées comme exemple afin d’adapter
votre propre service de recherche.

Exemples

Les exemples seront présentés pour chacune des sources de recherche.

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
available Boolean Permet de préciser si le service est utilisable dans l’application. true | false true
enabled Boolean
Permet de préciser si le service est activé (coché)
à l’ouverture de l’application.
 true | false true
order Number
Définit la position des résultats dans la liste
des résultats de recherche. Plus le nombre est élevé,
plus les résultats de cette source seront
au bas de la liste.
  99
params Object {}
Paramètres supplémentaires à ajouter à la requête
faite au serveur associé. Spécifique selon la source.
    
searchUrl String URL du serveur à utiliser.   Spécifique selon la source.
settings SearchSourceSettings [] En construction   Spécifique selon la source.
title* String Titre du service de recherche   Spécifique selon la source.

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

Coordonnées

Le service de recherches de coordonnées permet de se localiser sous diverses structures de coordonnées.
- Degré décimal (dd.ddd)
- lon, lat (-68.165547, 48.644546)
- lat, lon (48.644546, -68.165547)
- Degré minute seconde (dd mm ss)
- lon, lat (-68 9 56, 48 38 40)
- lat, lon (48 38 40, -68 9 56)
- Degré minute décimal (dd mm.mmmm)
- lon, lat (-68 9.56, 48 38.40)
- lat, lon (48 38.40, -68 9.567)
- Projeté
- -7588141.73,6214750.96 (exemple en 3857)
- MTM-6 255760.176, 5389773.700 (exemple en MTM)
- UTM-19 561466.861, 5388278.862 (exemple en UTM)
- BELL
- Lat: 48 38 40N Long: 68 9 56W UNC:100 CONF:90
- Metre Metre (MM)
- -111594.63, 445854.74;32198 (exemple en 32198)

Le résultat de la recherche est la position du point ainsi qu’un lien vers Google Maps / Streetview.
Le service est disponible par défaut dans les applications.

Exemples

{"coordinatesreverse": {
      "order": 1,
      "enabled": false,
      "available": true
}}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Valeur défaut
title
Basé sur la traduction de 2 fichiers.
Propriété igo.geo.search.coordinates.name dans
      - `en.geo.json  <https://github.com/infra-geo-ouverte/igo2-lib/blob/eaa7565fd0cfbc66eefcae6906489cb30ad11e50/packages/geo/src/locale/en.geo.json>`__
      - `fr.geo.json  <https://github.com/infra-geo-ouverte/igo2-lib/blob/eaa7565fd0cfbc66eefcae6906489cb30ad11e50/packages/geo/src/locale/fr.geo.json>`__

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

iCherche

iCherche est un service de recherche développé
par le Ministère de la Sécurité Publique du Québec
afin de permettre des recherches textuelles sur les entités suivantes:
- Adresses
- Code postal
- Routes (segments de routes)
- Municipalités (et ancien municipalités)
- MRC
- Régions administratives
- Lieux nommés
Le contenu accessible par le service de recherche est limité au territoire québécois.
** Le code de iCherche peut être utilisé comme exemple afin d’adapter votre propre service de recherche textuel.

Exemples

{"icherche": {
      "title":"ICherche",
      "showInPointerSummary": true,
      "searchUrl": "https://geoegl.msp.gouv.qc.ca/apis/icherche",
      "params": {
            "limit": "8"
      }
}}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Valeur défaut
searchUrl https://geoegl.msp.gouv.qc.ca/apis/icherche
settings `Ligne 79  <https://github.com/infra-geo-ouverte/igo2-lib/blob/56e45cdb030d39d1637ddfaf81f07e65345dcd89/packages/geo/src/lib/search/shared/sources/icherche.ts#L79>`_
title iCherche

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

iCherche Reverse

iCherche Reverse est un service de recherche développé
par le Ministère de la Sécurité Publique du Québec
afin de permettre des recherches par coordonnées / rayon sur les entités suivantes:
- Adresses
- Routes (segments de /routes)
- Arrondissements (segments de routes)
- Municipalités (et ancien municipalités)
- MRC
- Régions administratives
Le contenu accessible par le service de recherche est limité au territoire québécois.
** Le code de iCherche Reverse peut être utilisé comme exemple afin d’adapter votre propre service de recherche textuel.

Exemples

{"icherchereverse": {
      "searchUrl": "https://geoegl.msp.gouv.qc.ca/apis/territoires",
      "params": {
            "bufffer": 12
      }
}}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Valeur défaut
searchUrl https://geoegl.msp.gouv.qc.ca/apis/terrapi
settings `Ligne 427 <https://github.com/infra-geo-ouverte/igo2-lib/blob/master/packages/geo/src/lib/search/shared/sources/icherche.ts#L427>`__
title Recherche par coordonnées

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

iLayer

iLayer est un service de recherche développé par le Ministère de la Sécurité Publique du Québec
afin de permettre des recherches de couches d’informations par mots clefs.
Le contenu accessible par le service de recherche est limité au territoire quuébécois.

Une fois la couche trouvée, il vous est possible de l’ajouter à la carte.

Actuellement, les couches retournées dans le service de recherche sont des couches WMS.

** Le code de iLayer peut être utilisé comme exemple afin d’adapter votre propre service de recherche textuel.

Exemples

{"ilayer": {
      "searchUrl": "https://geoegl.msp.gouv.qc.ca/apis/icherche/layers",
            "params": {
            "limit": 15
      },
      "queryFormat": {
            "html": {
                  "urls": ["https://geoegl.msp.gouv.qc.ca/apis/ws/mffpecofor.fcgi"]
            }
      }
}}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Valeur défaut
searchUrl https://geoegl.msp.gouv.qc.ca/apis/layers/search
settings `Ligne 93 <https://github.com/infra-geo-ouverte/igo2-lib/blob/master/packages/geo/src/lib/search/shared/sources/ilayer.ts#L93>`__
title
Basé sur la traduction de 2 fichiers.
Propriété igo.geo.search.layer.title dans
- `en.geo.json  <https://github.com/infra-geo-ouverte/igo2-lib/blob/eaa7565fd0cfbc66eefcae6906489cb30ad11e50/packages/geo/src/locale/en.geo.json>`__ 
- `fr.geo.json  <https://github.com/infra-geo-ouverte/igo2-lib/blob/eaa7565fd0cfbc66eefcae6906489cb30ad11e50/packages/geo/src/locale/fr.geo.json>`__
queryFormat Possibilité de définir le format par URL pour la présentation des informations lors de l’interrogation de la couche par clic.

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

Nominatim

Nominatim est un service de recherche développé autour de la communauté
OpenStreetMap. Il est possible de faire des recherches par mots clefs.

Pour plus de détails:
- API Nominatim

Note

Bien que la recherche par coordonnées soit disponible par Nominatim, IGO2 ne gère pas les appels par coordonnées vers Nominatim.

Exemples

{"ilayer": {
      "searchUrl": "https://nominatim.openstreetmap.org/search",
      "params": {
            "limit": 15
      }
}}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Valeur défaut
searchUrl https://nominatim.openstreetmap.org/search
settings `Ligne 44 <https://github.com/infra-geo-ouverte/igo2-lib/blob/master/packages/geo/src/lib/search/shared/sources/nominatim.ts#L44>`__
title Nominatim (OSM)

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

StoredQueries

Note

Il se veut plus des EXEMPLES qu’un réel service de recherche.

StoredQueries est un service de recherche par mots clefs exploitant les capacités WFS 2.0. disponibles sur serveurs cartographiques comme Mapserver ou Geoserver(Geoserver StoredQuery)
Exemple 1:
RTSS: Cette storedQueries interroge un service WMS du Ministère du Transport du Québec qui peut retourner:
  • Route ex: 138
  • Route tronçon ex: 13801
  • Route tronçon section (RTS) ex: 13801116
  • Route tronçon section sous-route (RTSS) ex: 0013801116000C
  • RTSS Chainage ex: 0013801116000C+12
Elle nécessite l’envoi au serveur de 2 attributs.
  • rtss
  • chainage

Ces 2 attributs et leurs valeurs par défault sont définies par 2 champs dans la configuration (voir l’exemple ici-bas).

Exemple 1

{
    "storedqueries": {
        "available": true,
        "title": "le titre interface",
        "searchUrl": "https://ws.mapserver.transports.gouv.qc.ca/swtq",
        "storedquery_id": "rtss",
        "fields": [
            {"name": "rtss","defaultValue": "-99"},
            {"name": "chainage","defaultValue": "0","splitPrefix": "\\+"}
        ],
        "resultTitle": "etiquette"
    }
}
Exemple 2:

Le Ministère des forêts de la faune et des parcs a développé une storedQueries qui retourne les feuillets SNRC au 250k et 20k. Une fois que cette storedQueries est ajoutée a la configuration IGO, il suffit alors à l’utilisateur de saisir un feuillet ou un début de feuillet SNRC dans la barre de recherche IGO. (Ex: 31P08) et l’application retournera la/les géométries associées aux résultats trouvés par la recherche via la storedQueries.

Cette StoredQueries nécessite l’envoie au serveur de l’attribut: no_feuillet qui sera définit dans la configuration.

Exemple 2

{
    "storedqueries": {
        "available": true,
        "title": "Feuillets SNRC",
        "searchUrl": "/ws/mffpecofor.fcgi",
        "storedquery_id": "sq250et20kFeuillet",
        "fields": [
              {"name": "no_feuillet","defaultValue": "0"}
        ],
        "resultTitle": "feuillet",
        "params": {
              "limit": 10
        }
    }
}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Description Valeur défaut
fields*
Liste des champs à intéroger pour la StoredQueries.
La structure est la suivante:
1er attribut: {« name »: « rtss », »defaultValue »: « -99 »},
2e attribut : {« name »: « chainage », »defaultValue »: « 0 », »splitPrefix »: « + »}
afin de représenter le terme dans la barre de recherche: 0013801110000c+12
  
outputFormat
Référer au GetCapabilities pour découvrir les formats supportés par votre serveur.
Vous ne pouvez définir de GML 3.2 + compte tenu d’un 
`bug <https://github.com/openlayers/openlayers/pull/6400>`__  connu d’Openlayers.
text/xml; subtype=gml/3.1.1
param
Objet contenant les paramètres supplémentaires à envoyer au service lors de l’appel
de la storedqueries.
Le paramètre “limit” peut aussi y être utilisé pour limité le nombre de résultat de recherche.
 
resultTitle Nom de l’attribut à utiliser pour le titre du résultat.  
searchUrl Url du service https://ws.mapserver.transports.gouv.qc.ca/swtq
storedquery_id* Nom de la requête à demander au serveur.  

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

StoredQueries Reverse

Note

Il se veut plus un EXEMPLE qu’un réel service de recherche.

StoredQueries Reverse est un service de recherche par coordonnées exploitant les capacités WFS 2.0.
Actuellement, il interroge un service WMS du Ministère du Transport du Québec
qui peut retourner deux limites administratives du MTQ:
- Centre de services du MTQ
- Direction Générale Territoriales

Cette StoredQueries nécessite l’envoi au serveur de 2 attributs.
- long
- lat

Ces 2 attributs et leurs valeurs par défault
sont définies par 2 champs (longField et latField)
dans la configuration (voir l’exemple ici-bas).

Exemples

{"storedqueriesreverse": {
      "searchUrl": "https://ws.mapserver.transports.gouv.qc.ca/swtq",
      "storedquery_id": "lim_adm",
      "longField": "long",
      "latField": "lat",
      "resultTitle": "nom_unite"
}}

Propriétés

Seulement les propriétés spécifiques à ce service sont présentées.

Propriétés Description Valeur défaut
latField* Nom du champ à demander au server pour la latitude.  
longField* Nom du champ à demander au server pour la longitude.  
outputFormat
Référer au GetCapabilities pour découvrir les formats supportés par votre serveur.
Vous ne pouvez définir de GML 3.2 + compte tenu d’un 
`bug <https://github.com/openlayers/openlayers/pull/6400>`__  connu d’Openlayers.
text/xml; subtype=gml/3.1.1
resultTitle Nom de l’attribut à utiliser pour le titre du résultat.  
searchUrl Url du service https://ws.mapserver.transports.gouv.qc.ca/swtq
srsname SRS demandé au serveur EPSG:4326
storedquery_id* Nom de la requête à demander au serveur.  

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Pour les autres propriétés, référez-vous à Source (base commune) .

Liens

Intégration

La composante intégration permet de définir une gamme d’outils aisément intégrables à l’application grâce
aux configuration d’outils (tools).

Outils (tools)

about

Outil générique offrant la possibilité d’informer les usagers grâce à un outil d’aide.

Exemples

{
    "name": "about",
    "options": {
        "html": ["<p>Voici IGO</p>", "<p>Voici la seconde ligne</p>"]
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ help-circle
name* String   about  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.about
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
html String ou String[] Configure le html qui sera présenté dans l’outil.
« <p>Contenu html</p> »
ou sous forme de liste (pour les changement de lignes)
[« <p>Contenu html de la première ligne</p> », »<p>Contenu de la seconde ligne</p> »]
 igo.integration.about.html

Liens

catalog

Outil permettant de lister les catalogues disponibles configurés dans l’application:
- Configuration des catalogue.

Exemples

{
    "name": "catalog"
    "options": {
        "addCatalogAllowed": true,
        "predefinedCatalogs": [
            {
                "id": "Gououvert3",
                "title": "Gouvouvert3",
                "externalProvider": true,
                "url": "/apis/ws/igo_gouvouvert.fcgi"
            }
        ]
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ layers-plus
name* String   catalog  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.catalog
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
addCatalogAllowed Boolean
Définit  si le formulaire d’ajout de catalogue est disponible ou non. 
Les catalogues ajoutés sont enregistrés dans la mémoire du fureteur.
true | false false
predefinedCatalogs Catalog[].
Liste prédéfinie de catalogues permettant de pré-remplir un
menu de sélection, afin d’ajouter des catalogues.
    

Liens

catalogBrowser

Outil permettant de lister les couches d’informations du catalogue sélectionné par l’usager.
L’outil catalogue fore dans le catalogue jusqu’à concurence de 2 niveaux hiérarchiques.
Toutes les couches d’information doivent être dans un groupe.

Exemples

{
    "name": "catalogBrowser",
    "options": {
        "toggleCollapsedGroup": true
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ photo-browser
name* String   catalogBrowser  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.catalog
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
toggleCollapsedGroup Boolean
Force l’usager à entrer dans le groupe et d’y visualiser
les couches disponible avant de pouvoir ajouter le groupe
à la carte. false = le groupe doit être ouvert avant
de pouvoir l’ajouter à la carte
true | false false

Liens

contextManager

Outil permettant de lister/gérer plusieurs contextes à l’intérieur d’une même application.
Il existe un fichier de configuration définissant les contexte disponibles à l’intérieur du gestionnaire de contexte.
- _context.json
Ce dernier constitue une liste des contextes disponibles à l’intérieur du gestionnaire de contexte.

Si un contexte est non présent dans ce fichier, il ne sera pas mis à la disposition dans l’application.
De ce fait, le seul moyen d’y accéder est par URL.
- …votreDomaine/?context=nomDuContexteNonGéréParLeGestionnaireDeContexte

Exemples

{
    "name": "contextManager",
    "options": {
        "toolToOpenOnContextChange": "searchResults"
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ star
name* String   contextManager  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.contexts
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
toolToOpenOnContextChange String Nom de l’outil a ouvrir suite au changement de contexte Voir le nom des divers outils de cette section Dans l’ordre | mapTools”, | mapTool, | mapDetails | mapLegend | si ces outils sont | disponibles.

Liens

directions

Outil permettant de configurer l’outil d’itinéraire, basé sur la configuration dans l’application:
- Configuration des sources d’itinéraires.

Exemples

{
    "name": "directions"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ directions
name* String   directions  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.directions

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

draw

Outil permettant de faire des dessins sur la carte. Il est aussi possible de remplacer les points dessinés par une liste d’icônes.

Exemples

{
    "name": "draw"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ pencil
name* String   draw  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.draw

Important : Les propriétés en caractère gras suivies d’un * sont obligatoires.

Liens

ogcFilter

Outil permettant de définir des filtres que l’utilisateur pourra appliquer sur les couches visibles dans la carte et ainsi voir
seulement les objets géométriques (points, polygones, etc) qui correspondent aux filtres qu’il a appliqués. Les filtres peuvent être
configurés comme des boutons ou des cases à cocher que l’utilisateur peut activer ou comme filtres avancés. Dans ce cas, c’est l’utilisateur qui doit
saisir le champ, l’opérateur à appliquer ainsi que la valeur à filtrer.

| ** Limitation: Disponible uniquement sur des couches de type WFS ou WMS produite par mapServer 7.2 et+ ou geoserver.

| Cet outil présente toutes les couches de la carte ayant un ou plusieurs filtres configurés. Comparativement à l’outil

activeOgcFilter qui lui présente uniquement le/les filtres de la couche active sélectionnée.

| NB: L’activation de l’outil se fait ici via « tools », mais la configuration de chaque filtre disponible doit se faire à l’intérieur de la couche dans les contextes.
| layer -> sourceOptions -> ogcFilters
| Référez-vous à: Configuration des filtres attributaires OGC pour configurer les filtres au niveau des couches.

Exemples

{
    "name": "ogcFilter",
    "icon": "filter",
    "title": "igo.integration.tools.ogcFilter"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ filter
name* String   ogcFilter  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.ogcFilter

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

activeOgcFilter

Outil permettant de définir un ou plusieurs filtres sur la couche active de service OGC filtrable. Outil relatif à la couche active. Une fois activé dans « tools » l’outil sera disponible dans les outils de la couche sélectionnée. | ** Limitation: Disponible sur des couches de type WFS ou WMS produite par mapServer 7.2 et+ ou geoserver. Cet outil présente uniquement le ou les filtres qui sont applicables sur la couche active, comparativement à l’outil ogcFilter, qui lui présentera toute les couches ayant un filtre configuré. Comme cet outil présente uniquement le filtre appliqué sur une seule couche, la configuration classique est de ne pas présenter cet outil dans la barre verticale avec les autres outils de l’application et de le laisser uniquement dans les outils de la couche active. Pour ce faire, vous devez mettre l’outil dans « tools » et ne pas le mettre dans « toolbar » | NB: L’activation se fait ici via les outils, mais la configuration du filtre doit se faire à l’intérieur de la couche dans les contextes. | layer -> sourceOptions -> ogcFilters | Référez-vous à: Configuration des filtres attributaires OGC pour configurer les filtres au niveau des couches.

Exemples

{
    "name": "activeOgcFilter"
}

Liens

timeFilter

Outil permettant de configurer un filtre temporel sur une couche d’un service ayant une propriété temporelle (WMS-T)
NB: L’activation de l’outil se fait via les outils, mais la configuration de chaque filtre doit se faire à l’intérieur de la couche dans les contextes.
layer -> sourceOptions -> timeFilter

Référez-vous à : Configuration filtre temporel WMS-T (timeFilter) pour configurer les filtres au niveau des couches.

Exemples

{
    "name": "timeFilter"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ history
name* String   timeFilter  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.timeFilter

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

activeTimeFilter

Outil permettant de filtrer la couche WMS active filtrable temporellement.
Outil relatif à la couche active. Une fois activé dans « tools » l’outil sera alors disponible dans les outils de la couche
sélectionnée.

Le bouton permettant de sélectionner une couche active est disponible dans les outils mapTools, mapTool et mapDetails.
L’outil apparait seulement lorsque le bouton est cliqué.

Référez-vous à : Configuration filtre temporel WMS-T (timeFilter) pour configurer les filtres au niveau des couches.

Exemples

{
    "name": "activeTimeFilter"
}

Liens

importExport

Outil permettant d’importer et d’exporter des couches.
Certaines restrictions s’appliquent:
Import:
- La projection doit être en EPSG:4326
- La taille du fichier est configurable via la configuration. Voir importExport.Par défaut a 30Mo
- Les shapeFiles doivent être dans un .zip

Export:
- Seulement les couches en WFS peuvent être exportées, les couches WMS ne sont pas exportable.

Exemples

{
  "name": "importExport",
   "options": {
       "selectFirstProj": false,
       "projectionsLimitations": {
              "projFromConfig": true,
              "nad83": true,
              "wgs84": true,
              "webMercator": true,
              "utm": true,
              "mtm": true,
              "utmZone": {
                    "minZone": 17,
                    "maxZone": 21
              },
              "mtmZone": {
                    "minZone": 4,
                    "maxZone": 10
              }
        },
      "importExportType": "layer",
      "importExportShowBothType": true
  }
}
Noter que des précisions peuvent etre ajoutées dans l’interface pour guider l’utilisateur. Ceci à l’aide des traductions disponibles:
Import: liste= importTabTitle, importClarifications, importSizeMax, importFormatAuthorized, importShpZip, importHtmlClarifications
ou plutot que la liste, vous pouvez définir du html personnalisé avec la balise importHtmlClarifications
Export: Définir du html personnalisé avec la balise exportHtmlClarifications.
- Fichier traduction en.json

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ file-move
name* String   importExport  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.importExport
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
selectFirstProj Boolean Permet de controler si la première projection rencontrée dans la liste sera sélectionnée. true / false false
projectionsLimitations Objet Permet de controler la liste des projections disponible dans l’outil.
{
« projFromConfig »: true, // Utiliser les projections définies dans la configuration
« nad83 »: true, // Utiliser le NAD83
« wgs84 »: true, // Utiliser le WGS84
« webMercator »: true, // Utiliser le WebMercator (EPSG:3857)
« utm »: true, // Utiliser les projections UTM
« mtm »: true, // Utiliser les projections MTM
« utmZone »: {
« minZone »: 17, // Zone minimale UTM
« maxZone »: 21 // Zone maximale UTM
},
« mtmZone »: {

« | minZone »: 4, // Zone minimale MTM | « maxZone »: 10 // Zone maximale MTM | }}
{
« projFromConfig »: true,
« nad83 »: true,
« wgs84 »: true,
« webMercator »: true,
« utm »: true,
« mtm »: true,
« utmZone »: {
« minZone »: 1,
« maxZone »: 60
},
« mtmZone »: {

« | minZone »: 1, | « maxZone »: 10 | }}
importExportType String Définit quel type d’exportation sera ouvert par défaut layer ou context layer
importExportShowBothType Boolean
Permet d’afficher ou non les 2 types d’importation ou exportation 
(layer ou contexte) Si false, le type définit précédemment, sera
le seul type affiché.Se base sur l’option importExportType.
 true / false true

Liens

mapTool

Outil permettant de présenter le contenu à l’aide de deux onglets distincts.
- Carte : Couches disponible à la carte, avec paramètres et outils permettant de gérer les couches:
- ordonnancement
- visibilité
- accès aux métadonnées (si disponible)
- accès au téléchargements des données (si disponible)
- filter les données (temporellement et par attributs si disponible)
- supression de couches
- Gestionnaire de contexte : Outil permettant de lister/gérer/changer de contexte à l’intérieur d’une même application.

Note

Si vous voulez pouvoir filtrer des données WMS/WFS temporellement et par attributs, activez les outils

Exemples

{
    "name": "map",
    "options": {
        "updateLegendOnResolutionChange": false,
        "toggleLegendOnVisibilityChange": true,
        "expandLegendOfVisibleLayers": true,
        "ogcButton": false,
        "timeButton": false,
        "queryBadge": false,
        "layerListControls": {
            "excludeBaseLayers": true,
            "showToolbar": "default",
            "keyword": "allo",
            "sortAlpha": true,
            "onlyVisible": true
        }
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ map
name* String   map  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.map

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
expandLegendOfVisibleLayers Boolean À l’ouverture de l’outil, sous l’onglet Carte, déroule (affiche) les légendes des couches visibles. true / false false
ogcButton Boolean Permet d’afficher le bouton filtre OGC pour les couches le permettant. true / false true
queryBadge Boolean Sous l’onglet Carte, affiche en superposition à l’oeil de visiblité, un « ? » pour les couches interrogeable. true / false false
timeButton Boolean Permet d’afficher le bouton filtre temporel pour les couches le permettant. true / false true
toggleLegendOnVisibilityChange Boolean
Sous l’onglet Carte, déroule (affiche) les légendes lorsque le statut de visibilité 
d’une couche passe de non-visible à visible
true / false false
updateLegendOnResolutionChange Boolean Permet de rafraichir la légende à chaque changement de résolution (zoom) true / false false
layerListControls Objet
Divers contrôles effectués à la liste de couches affichées dans l’interface.
« excludeBaseLayers » = Retire les couches identifiées comme baseLayer.
« showToolbar » = Outil permettant de contrôler la liste des couche                 
« always », « never » ou « default » = visible si 5 couches et +
« keyword » = Mot clef filtrant la liste de couches
« sortAlpha » = Tri la liste de couches alphabétiquement.
« onlyVisible » = Ne garde que dans la liste de couches, les couches visible.
« layerListControls »: {
« excludeBaseLayers »: true,
« showToolbar »: « always »,
« keyword »: « allo »,
« sortAlpha »: true,
« onlyVisible »: true
}
« layerListControls »: {
« excludeBaseLayers »: false,
« showToolbar »: « default »,
« sortAlpha »: false,
« onlyVisible »: false
}

Liens

mapLegend

Outil permettant de présenter le contenu de la carte sous forme de légende.
Seul les légendes sont contenues.

Il est possible d’ajouter une option permettant de montrer toutes les légendes de la carte
même pour les couches non visible OU hors échelle d’affichage.

Exemples

{
    "name": "mapLegend",
    "options": {
        "allowShowAllLegends": true,
        "showAllLegendsValue": true,
        "layerAdditionAllowed": true,
        "updateLegendOnResolutionChange": false,
        "layerListControls": {
            "excludeBaseLayers": true
        }
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ format-list-bulleted-type
name* String   mapLegend  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.legend
options Objet Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
allowShowAllLegends Boolean
Affiche un bouton permettant de montrer toutes les légendes de la carte,
même pour les couches non visible OU hors échelle d’affichage.
true / false false
showAllLegendsValue Boolean
Si allowShowAllLegends est permis (true), définit la valeur à l’ouverture de l’application.
true = toutes les légendes sont affichées (même ceux non visibles à la carte)
true / false false
layerAdditionAllowed Boolean
Identifie si l’ajout de couches à la carte sont permises.
Influence les messages d’aide à l’usager
 true / false true
updateLegendOnResolutionChange Boolean Permet de rafraichir la légende à chaque changement de résolution (zoom) true / false false
layerListControls Objet Divers contrôles effectués à la liste de couches affichées dans l’interface.   {« excludeBaseLayers »: false}

Liens

mapDetails

Outil permettant de présenter les couches disponible à la carte, avec paramètres et outils permettant de gérer les couches:
- ordonnancement
- visibilité
- accès aux métadonnées (si disponible)
- accès au téléchargements des données (si disponible)
- filter les données (temporellement et par attributs si disponible)
- supression de couches

Note

Si vous voulez pouvoir filtrer des données WMS/WFS temporellement et par attributs, activez les outils

Exemples

{
    "name": "mapDetails",
    "options": {
        "layerAdditionAllowed": true,
        "updateLegendOnResolutionChange": false,
        "toggleLegendOnVisibilityChange": true,
        "expandLegendOfVisibleLayers": true,
        "ogcButton": false,
        "timeButton": false,
        "queryBadge": false,
        "layerListControls": {
            "excludeBaseLayers": true,
            "showToolbar": "default",
            "keyword": "allo",
            "sortAlpha": true,
            "onlyVisible": true
        }
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ map
name* String   map  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.map

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
expandLegendOfVisibleLayers Boolean À l’ouverture de l’outil, sous l’onglet Carte, déroule (affiche) les légendes des couches visibles. true / false false
layerAdditionAllowed Boolean
Identifie si l’ajout de couches à la carte sont permises.
Influence les messages d’aide à l’usager
true / false true
ogcButton Boolean Permet d’afficher le bouton filtre OGC pour les couches le permettant. true / false true
queryBadge Boolean Sous l’onglet Carte, affiche en superposition à l’oeil de visiblité, un « ? » pour les couches interrogeable. true / false false
timeButton Boolean Permet d’afficher le bouton filtre temporel pour les couches le permettant. true / false true
toggleLegendOnVisibilityChange Boolean
Sous l’onglet Carte, déroule (affiche) les légendes lorsque le statut de visibilité 
d’une couche passe de non-visible à visible
true / false false
updateLegendOnResolutionChange Boolean Permet de rafraichir la légende à chaque changement de résolution (zoom) true / false false
layerListControls Objet
Divers contrôles effectués à la liste de couches affichées dans l’interface.
« excludeBaseLayers » = Retire les couches identifiées comme baseLayer.
« showToolbar » = Outil permettant de contrôler la liste des couche                 
« always », « never » ou « default » = visible si 5 couches et +
« keyword » = Mot clef filtrant la liste de couches
« sortAlpha » = Tri la liste de couches alphabétiquement.
« onlyVisible » = Ne garde que dans la liste de couches, les couches visible.
« layerListControls »: {
« excludeBaseLayers »: true,
« showToolbar »: « always »,
« keyword »: « allo »,
« sortAlpha »: true,
« onlyVisible »: true
}
« layerListControls »: {
« excludeBaseLayers »: false,
« showToolbar »: « default »,
« sortAlpha »: false,
« onlyVisible »: false
}

Liens

mapTools

Outil permettant de présenter le contenu à l’aide de deux onglets distincts.
- Carte : Couches disponible à la carte, avec paramètres et outils permettant de gérer les couches:
- ordonnancement
- visibilité
- accès aux métadonnées (si disponible)
- accès au téléchargements des données (si disponible)
- filter les données (temporellement et par attributs si disponible)
- supression de couches
- Légende : Légendes de la carte

Note

Si vous voulez pouvoir filtrer des données WMS/WFS temporellement et par attributs, activez les outils
  • activeOgcFilter
  • activeTimeFilter

Exemples

{
    "name": "mapTools",
    "options": {
        "allowShowAllLegends": true,
        "showAllLegendsValue": true,
        "layerAdditionAllowed": true,
        "updateLegendOnResolutionChange": false,
        "toggleLegendOnVisibilityChange": true,
        "expandLegendOfVisibleLayers": true,
        "selectedTabAtOpening" : "legend",
        "ogcButton": false,
        "timeButton": false,
        "queryBadge": false,
        "layerListControls": {
            "excludeBaseLayers": true,
            "showToolbar": "default",
            "keyword": "allo",
            "sortAlpha": true,
            "onlyVisible": true
        }
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ map
name* String   mapTools  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.map

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
allowShowAllLegends Boolean
Affiche un bouton permettant de montrer toutes les légendes de la carte,
même pour les couches non visible OU hors échelle d’affichage.
true / false false
showAllLegendsValue Boolean
Si allowShowAllLegends est permis (true), définit la valeur à l’ouverture de l’application.
true = toutes les légendes sont affichées (même ceux non visibles à la carte)
true / false false
expandLegendOfVisibleLayers Boolean À l’ouverture de l’outil, sous l’onglet Carte, déroule (affiche) les légendes des couches visibles. true / false false
layerAdditionAllowed Boolean
Identifie si l’ajout de couches à la carte sont permises.
Influence les messages d’aide à l’usager
true / false true
ogcButton Boolean Permet d’afficher le bouton filtre OGC pour les couches le permettant. true / false true
queryBadge Boolean Sous l’onglet Carte, affiche en superposition à l’oeil de visiblité, un « ? » pour les couches interrogeable. true / false false
timeButton Boolean Permet d’afficher le bouton filtre temporel pour les couches le permettant. true / false true
selectedTabAtOpening String Permet de définir, lors de la première ouverture de l’outil, quel onglet est ouvert. “legend” L’onglet Carte est ouvert par défaut.
toggleLegendOnVisibilityChange Boolean
Sous l’onglet Carte, déroule (affiche) les légendes lorsque le statut de visibilité 
d’une couche passe de non-visible à visible
true / false false
updateLegendOnResolutionChange Boolean Permet de rafraichir la légende à chaque changement de résolution (zoom) true / false false
layerListControls Objet
Divers contrôles effectués à la liste de couches affichées dans l’interface.
« excludeBaseLayers » = Retire les couches identifiées comme baseLayer.
« showToolbar » = Outil permettant de contrôler la liste des couche                 
« always », « never » ou « default » = visible si 5 couches et +
« keyword » = Mot clef filtrant la liste de couches
« sortAlpha » = Tri la liste de couches alphabétiquement.
« onlyVisible » = Ne garde que dans la liste de couches, les couches visible.
« layerListControls »: {
« excludeBaseLayers »: true,
« showToolbar »: « always »,
« keyword »: « allo »,
« sortAlpha »: true,
« onlyVisible »: true
}
« layerListControls »: {
« excludeBaseLayers »: false,
« showToolbar »: « default »,
« sortAlpha »: false,
« onlyVisible »: false
}

Liens

measurer

Outil permettant d’effectuer des mesures sur la carte.

Exemples

{
    "name": "measurer"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ ruler
name* String   measurer  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.measurer

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

print

Outil permettant d’effectuer des impressions de la carte.

Exemples

{
    "name": "print"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ printer
name* String   print  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.print

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens

searchResults

Outil permettant d’afficher les résultats effectués à l’aide de la barre de recherche

Exemples

{
    "name": "searchResults",
    "options": {
        "showIcons": false,
        "topPanelStateDefault": "expanded"
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ magnify
name* String   searchResults  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.searchResults
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
showIcons Boolean Permet de faire afficher ou non des icônes pour chacun des résultats de recherche. true / false true
topPanelStateDefault String Permet de définir l’état par défaut du panneau de détails. “expanded”/ “collapsed” “expanded”

Liens

spatialFilter

Outil permettant d’appliquer un filtre sur des adresses ou des thématiques ciblées selon une zone prédéfinie ou selon une zone dessinée par l’utilisateur.

Exemples

{
    "name": "spatialFilter",
    "options": {
        "type": "Predefined",
        "itemType": "Thematics",
        "freehandDrawIsActive": true
    }
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ selection-marker
name* String   spatialFilter  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.spatialFilter
options Object Voir les options ici-bas.    

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Options

Propriétés Type Description Valeurs possibles Valeur défaut
type SpatialFilterType
Spécifie le type de zone sur lequel le filtrage sera appliqué
Predefined = Zone prédéfinie (Municipalités, Arrondissements, Région administratives…)
Polygon = Polygone dessinée par l’utilisateur
Point = Cercle dessinée par l’utilisateur
Predefined
Polygon
Point
  
itemType SpatialFilterItemType
Spécifie le type des éléments qui seront filtrés
Address = Adresses provenant de la couche d’Adresses Québec
Thematics = Données provenant de l’api terrAPI
Address
Thematics
 Address
freehandDrawIsActive Boolean Indique si le mode de dessin « à main levée » est actif ou non. True | false  

Liens

shareMap

Outil permettant de partager, à l’aide d’un lien, la carte à l’écran.

Exemples

{
  "name": "shareMap"
}

Propriétés

Propriétés Type Description Valeurs possibles Valeur défaut
icon String Icône dans la barre d’outil `MDI <https://materialdesignicons.com/>`__ share-variant
name* String   shareMap  
title String
Le titre affiché dans l’application. Sujet aux traduction.
Si vous modifiez le titre par défaut, vous devez ajouter
ce titre dans les langues supportées par IGO2 (fr-en).
      - fichiers dans Language.
  igo.integration.tools.shareMap

Important : Les propriétés en caractère gras suivis d’un * sont obligatoires.

Liens