Configuration requise¶

Cette section détaille les configurations possibles pour le navigateur dans un contexe cartographique. À l’aide de fichiers de configuration (fichiers JSON) , il est possible de paramétrer:

l’application

contenu cartographie.

Application¶

La configuration de l’application est possible grâce au fichier config.json. Ce dernier est situé dans le répertoire :

src/config/config.json

Il est également de configurer l’application grâce a un second fichier selon l’environnement désiré (test ou production). Pour modifier le comportement de l’application, vous pouvez modifier:

igo2/src/environments/environment.prod.ts

igo2/src/environments/environment.ts

Si vous désirez changer, le chemin d’accès de ce fichier ou bien d’environnement.*.ts , il est spécifié dans le code de l’application dans le fichier:

/src/app/app.module.ts ligne 41.

Important : Notez que le fichier config.json à préséance sur le fichier environment.*.ts

Résumé¶

Propriétés Type Description Outil lié

auth Auth

Objet permettant d’activer le serveur

d’authentification.

catalog Catalog []

Doit être présente si l’outil de catalogue.

Permet de gérer les sources WMS et WMTS

Catalog

CatalogBrowser

context Context

Activation de l’API de context d’IGO2.

Cette API sera documentée

indépendamment ce la présente

documentation.

ContextManager

hasExpansionPanel Boolean

Permet d’ouvrir un paneau d’expansion à partir

d’un bouton situé dans le coin inférieur gauche

de la carte.

Ce dernier contient les données tabulaire pour

les données WFS / Vectorielle / Cluster

** Encore en développement **

importExport ImportExport

Nécessaire si l’outil d’importation exportation

pour gérer l’importation des Shapefiles

Importation

Exportation

language* Language

Chemin d’accès des fichiers de traduction de

l’application.

Tous

projections Projection []

Liste de projections non enregistrées

par défault par OpenLayers.

routingSources RoutingSource

Source serveur pour la création des itinéraires.

Actuellement, le serveur utilisé est OSRM.

Itinéraire

searchSources* SearchSources

Nécessaire afin de permettre la recherche par

texte et/ou la recherche par coordonnées.

Recherche

Carte

Theme*

Voir: theme

String

Permet de définir les thèmes de l’application.

Les choix sont:

- blue-theme

- bluegrey.theme

- dark.theme

Le répertoire où sont conservés les thèmes est

le igo2-lib/packages/core/src/style/themes

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

Auth¶

Note

En cours de construction

Sert à effectuer l’authentification des usagers.

Exemples

"auth": {
    "url": "/apis/users",
    "tokenKey": "id_token_igo",
    "allowAnonymous": true
}

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

url* String

Définit l’url d’appel du service

d’authentification

tokenKey* String

Définit la clef de l’api d’authentification

utilisée

allowAnonymous Boolean

Permet/Bloque l’accès aux usagers non

authentifiés

d’accéder aux contextes publics

true | false true

… …

…

… …

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

Liens

igo2-lib/packages/auth/src/lib/shared/auth.interface.ts

Catalog¶

Cette section de la configuration permet de charger une liste de sources de cataloguage. Une fois les sources chargées, il est possible d’ajouter des couches d’informations à la carte.

Les sources de cataloguage permise:

- Service WMS

- Service WMTS

- baselayers

Les couches d’informations contenues dans ces services sont récupérées grâce au couches publiées dans le GetCapabilities du service.

Dans la présente version

1- les couches ajoutées par le catalogue sont partagées lors du partage de carte.

2- La structure de l’url pour les couches partagées est la suivante:

- wmsUrl => une liste, séparé par une “,” (virgule) listant les url de service ajoutées.

- Exemple : wmsUrl=urlDuService1,urlDuService2

- layers => une liste, séparé par une “,” (virgule) groupé par un bloc de parenthèses, respectant l’ordre des services déclarés dans wmsUrl

- Exemple : layers=(layer1,layer2),(layer3,layer4)

- layer1 et layer2 proviennent de l’url « urlDuService1 »

- layer3 et layer4 proviennent de l’url « urlDuService2 »

- si un « layer » possède le suffix :igoz13

- Il s’agit de la position du « layer » dans la table des matières. Ici la position 13.

Chaque couche ajoutée possède un identifiant unique généré à partir du « layer name » et de l’url du service source. Se référer à :igo2-lib/packages/geo/src/lib/datasource/utils/id-generator.ts#L15

Exemples

"catalog": {
      "sources": [
      {
            "id": "opendataqc",
            "title": "Données Ouvertes Québec",
            "url": "/ws/igo_gouvouvert.fcgi"
      },
      {
            "id": "mtq",
            "title": "MTQ",
            "url": "/swtq",
            "sortDirection": "desc",
            "queryFormat": {
                  "htmlgml2": "*",
                  "json": "stations_meteoroutieres"
                  },
            "queryHtmlTarget": "iframe",
            "count": 365
            "tooltipType": "abstract"
      },
      {
            "id": "regexmtq",
            "title": "MTQ (filtered by regex)",
            "url": "/swtq",
            "regFilters": ["zpegt"]
      }
      ]
}

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

count Integer

Nombre de résultats retournés par le serveur

lors de requêtes WMS de GetFeatureInfo

5

id* String

Identifiant unique permettant de différencier

les catalogues entre eux.

uuid()

matrixSet String

Nom du matrixSet définit pour le service

WMTS seulement

Obligatoire pour les services WMTS

queryFormat QueryFormat

Pour les services WMS, le format d’interrogation

de la données.

Voir QueryFormat

queryHtmlTarget String

Pour les services WMS, definit la destination des

résultats d’interrogation pour les formats HTML.

iframe (intégré à la plage) ou _blank (ouverture page externe) iframe

queryParams objet {}

Paramètre supplémentaires à ajouter à l’appel des

couches ajoutées à partir du service.

Que ce soit des paramètres normés (WMS|WMTS)

ou lié à votre service.

regFilters String[]

Une liste d’expressions régulières (regex)

permettant de limiter les couches

d’information présentés dans l’outil

CatalogBrowser

requestEncoding String

Type d’encodage des paramètre demandés au

serveur

KVP REST KVP

setCrossOriginAnonymous Boolean

Afin de définir si l’entête de l’appel faite

au serveur sera anonyme. Permet entre autres,

d’éviter les problématiques de CORS

true false false

sortDirection String

Permet de trier l’ordre d’apparition des couches

du catalogue dans l’outil CatalogBrowser

Influence l’ordre d’ajout des couches

d’information à la carte.

asc desc

Aucun, l’ordre présenté par service

timeFilter TimeFilterOptions

Options temporelles liées à l’entièreté des

couches du service web.

Voir TimeFilter

1.0.0 (WMTS)

title* String

Titre pour la source du catalogue qui sera utilisé

dans l’outil Catalog

tooltipType String

Pour les couches ajoutées, défini si le tooltip

(sulvol du titre) sera le résumé du « layer »

(wms/wmts) ou son titre

abstract title title

type String

Type de service à appeler

baselayers wmts wms wms

url* String

Url du service WMS ou WMTS sans les paramètre

d’url normés OGC

(i.e. service=wms&request=GetCapabilities)

OU url du service de baselayers

version String

Version du service

WMS ou WMTS

Référer au

GetCapabilities

du service

(WMS|WMTS)

1.0.0 (WMTS)

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

Liens

igo2-lib/packages/geo/src/lib/catalog/shared/catalog.interface.ts

igo2/blob/master/src/environments/environment.github.ts

Context¶

Note

En cours de construction

Permet de rejoindre une API nous fournissant des contextes cartographiques.

Cette API sera documentée indépendamment ce la présente documentation.

Exemples

context: {
    url: 'https://geoegl.msp.gouv.qc.ca/apis/igo2/...',
    defaultContextUri: '5'
}

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

url* String

Définit l’url d’appel du service

de contexte

defaultContextUri* String

Nom ou identifiant du contexte

cartographique par défaut.

_default

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

Liens

igo2-lib/packages/context/src/lib/context-manager/shared/context.interface.ts

hasExpansionPanel¶

Note

En cours de construction

ImportExport¶

Cette configuration permet de définir un service qui sera en mesure de convertir des formats de fichiers géométriques non gérés par IGO2(OpenLayers).

Actuellement, les GeoJson, KML, KMZ sont acceptés par IGO2. Par contre, les Esri Shapefile doivent transiger par un serveur de conversion.

C’est à partir ce cette propriété que vous pouvez définir le serveur de conversion qui vous retournera un fichier utilisable par IGO2 (GeoJson).

Exemples

importExport: {
    url: 'https://geoegl.msp.gouv.qc.ca/apis/ogre'
}

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

url* String

Url du service de conversion.

https://geoegl.msp.gouv.qc.ca/apis/ogre

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

Liens

igo2-lib/packages/geo/src/lib/import-export/shared/import.interface.ts

Language¶

Définir le dossier contenant les fichiers de traduction de l’appplication.

IGO2 est actuellement disponible en anglais et en francais, selon les paramètres du navigateur.

Il est toutefois possible de définir le language désiré à même le code de l’application.

Exemples

language: {
    prefix: './locale/'
}

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

prefix* String

Définir le dossier contenant

les fichiers de traduction

de l’appplication.

./locale/

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

Liens

igo2-lib/packages/core/src/lib/language/shared/language.interface.ts

locale démo https://infra-geo-ouverte.github.io/igo2/

Projection¶

Permet de définir une liste de projections non enregistrées par défault par IGO2 (Proj4). On parle ici de projection non mondiale ou à référence locale (ex: mtm, Lambert MTQ…)

Référez vous à : http://epsg.io/. Ils y définissent l’entièreté des paramètres nécessaires.

Exemples

projections: [
    {
        alias: 'Québec Lambert'
        code: 'EPSG:32198,
        def: '+proj=lcc +lat_1=60 +lat_2=46 +lat_0=44 +lon_0=-68.5 +x_0=0 +y_0=0 +ellps=GRS80 +datum=NAD83 +units=m +no_defs',
        extent: [-886251.0296, 180252.9126, 897177.3418, 2106143.8139]
      }
]

Propriétés

Propriétés

Type

Description

alias String

Nom d’affichage que vous

voulez donner à la

projection ajoutée.

code* String

Code de la projection/

système de coordonnées

à ajouter à l’application.

def* String

Paramètres associés à la

définition de votre

projection / système de

coordonnées.

extent*

Liste de

nombre

Liste de nombre définissant

les limites d’application

de la projection. L’ordre à

respecter est:

[Xmin,YMin,XMax,YMax].

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

Liens

RoutingSource¶

Source serveur pour la création des itinéraires. Actuellement, le serveur utilisé est OSRM.

Exemples

"routingSources": {
    "osrm": {
        "enabled": true
        "url": "https://geoegl.msp.gouv.qc.ca/services/itineraire/route/v1/driving/";
    }

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

enabled Boolean

Permet d’activer

/ désactiver

la source.

true | false true

url String

Url du serveur

retournant

l’itinéraire.

https://geoegl.msp.gouv.qc.ca/services/itineraire/route/v1/driving/

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

Liens

igo2/blob/master/src/config/config.json

SearchSources¶

Note

En cours de construction

Theme¶

Permet de définir les thèmes (couleur, fonts) de l’application.

Le répertoire où sont conservés les thèmes est le igo2-lib/packages/core/src/style/themes

Exemples

"theme": "blue-theme"

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur défaut

theme* String

Thème à utiliser pour

la présente application

configurée.

- blue-theme

- bluegrey.theme

- dark.theme

- deeppurple.theme

- indigo.theme

- orange.theme

- teal.theme

blue-theme

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

Liens

igo2-lib/packages/core/src/style/themes

Exemple complet¶

Note

En cours de construction

Contenu cartographique¶

La configuration du contenu cartographie est possible grâce aux fichiers:

base.json
nom_du_contexte.json

Ces derniers sont situés dans le répertoire :

igo2/src/contexts

Le fichier nom_du_contexte.json contient les éléments spécifiques selon le contexte à exploiter. Exemple, dans une application cartographique vous pouvez avoir plusieurs contextes(thématiques):

hydrograhie.json

routes.json

risques.json

…

On peut y définir:

l’étendue cartographique
les couches d’informations disponible
les outils accessible
certaines configuration d’outils

Quant à lui, le fichier base.json contient les éléments partagés entre chancun des contexte l’héritant. Selon l’exemple précédent, dans une application cartographique, vous avez 3 contextes (thématiques):

hydrograhie.json

routes.json

risques.json

Plutôt que de répéter 3 fois les mêmes éléments (fonds cartographique, outils, couches de base) dans chaque contexte, il est possibe de déclarer dans le base.json les éléments communs aux 3 contextes. La maintenance de l’application en sera facilitée.

Important : Notez que le fichier nom_du_contexte.json à préséance sur le fichier _base.json.

Résumé¶

Propriétés Type Description Outil lié

base string

Identification du nom

du ficher de base dont

les contextes peuvent

hériter du contenu.

Map

ContextManager

Config d’outils

…

layers*

Voir

layers

layer[]

Liste des couches

d’informations

disponible pour

le contexte

sélectionnée.

Map

MapDetails

map* map

Définition de la carte

lors de l’ouverture

initial du contexte

toolbar String[]

Liste des outils

disponible dans

l’application.

L’ordre dans la

liste correspond

à l’ordre

d’apparition des

outils dans IGO2.

Tous

tools Objet[]

Liste de configuration

des outils présent dans

l’application.

Tous

uri*

Voir uri

String

Nom ou identifiant

du contexte.

Doit être unique

au sein de la

même application.

Map

ShareMap

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

Base¶

Identification du nom du ficher de base dont les contextes peuvent hériter du contenu.

À l’intérieur d’un fichier base.json, les propriétés tolérés sont:

- layers

- map

- toolbar

- tools

Pour le détail de ces propriétés, référez-vous aux sections suivantes.

Exemples

Définition : igo2/src/contexts/_base.json

Utilisation: igo2/src/contexts/_default.json

Layers¶

Permet de définir une liste de couches d’informations disponible à l’usager lors de l’ouverture de l’application.

L’ordre d’apparition des couches dans la table des matières peut être controlée de divers moyens:

1- l’ordre d’apparition des couches dans le contexte. Plus la couche est au début de la liste, plus elle sera au bas de la table des matière.

2- La propriété zIndex de chaque couche d’information. Plus le zIndex et élevé, plus la couche sera au haut de la table des matières.

Exemples

"layers": [
      {
            "id": "fond_osm",
            "title": "OSM",
            "visible": false,
            "baseLayer": true,
            "sourceOptions": {
            "type": "osm",
            "attributions": "© les contributeurs <a href='https://www.openstreetmap.org/copyright' target='_blank'>d’OpenStreetMap</a> / <a href='http://www.igouverte.org/' target='_blank'>IGO2</a>"
            }
      },
      {
            "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='http://www.droitauteur.gouv.qc.ca/copyright.php' target='_blank'><img src='/gouvouvert/public/images/quebec/gouv_qc_logo.png' width='64' height='14'>Gouvernement du Québec</a> / <a href='http://www.igouverte.org/' target='_blank'>IGO2</a>",
            "type": "xyz",
            "crossOrigin": "anonymous"
            }
      },
      {
            "title": "Blanc",
            "baseLayer": true,
            "visible": false,
            "sourceOptions": {
            "attributions": "<a href='http://www.igouverte.org/' target='_blank'>IGO2</a>",
            "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+ip1sAAAAASUVORK5CYII=",
            "type": "xyz"
            }
      }
]

Propriétés: Permet de définir une liste de couches. Référer-vous à la description de ce qu’est un layer.

Liens

igo2-lib/packages/geo/src/lib/layer/shared/layers/layer.interface.ts

Layer IGO2.

Map¶

Permet de définir les propriétés de la carte à l’ouverture du contexte.

Exemples

"map": {
      "view": {
            "projection": "EPSG:3857",
            "center": [-71.938087, 48.446975],
            "geolocate": true,
            "zoom": 6,
            "maxZoom": 17,
            "rotation": 15,
            "enableRotation": true
      }
}

Propriétés: Référez vous à map.

Liens

igo2-lib/packages/geo/src/lib/map/shared/map.interface.ts

Map IGO2.

Title¶

Nom du contexte qui sera affiché dans l’application.

Exemples

"title": "Nom de votre contexte",

Tools¶

Définit la liste des configuration permise pour chaque outil.

Pour les options spécifiques à chauque outil, veuillez vous référer aux descriptif de l’outil. Cette section détaille seulement les propriétés communes.

Exemples

{
    "icon" : "iconName"
    "name": "catalogBrowser",
    "title": "TitreOutilQuiDoitEtreTraduit",
    "options" : {
        ...
    }
}

Propriétés

Propriétés

Type

Description

Valeurs possibles

Valeur par défaut

name* String

Le nom de l’outil

- about

- catalog

- catalogBrowser

- contextManager

- directions

- ogcFilter

- timeFilter

- importExport

- mapDetails

- map

- print

- searchResults

title String

Le titre affiché dans l’application. Sujet aux traduction.

Si vous modifier le titre par défaut, vous devez ajouter

ce titre dans les langues supportées par IGO2 (fr-en).

- fichiers dans Language

Référer vous à

l’outil désiré.

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

Liens

igo2-lib/tree/master/packages/integration/src/lib/…

Uri¶

Identifiant du contexte. Particulièrement utile pour le partage de cartes. C’est cette propriété du contexte qui est utilisée pour bâtir l’url de partage de carte:

ex: …/?context=uriDuContexte…

Si votre contexte est dans un sous-répertoire, y inscrire également dans l’uri le chemin (repertoire/uriDuContexte)

Ne pas y inscrire d’extension du fichier.

Exemples

"uri": "uriDuContexte",

Configuration requise¶

Application¶

Résumé¶

Auth¶

Catalog¶

Context¶

hasExpansionPanel¶

ImportExport¶

Language¶

Projection¶

RoutingSource¶

SearchSources¶

Theme¶

Exemple complet¶

Contenu cartographique¶

Résumé¶

Base¶

Layers¶

Map¶

Title¶

Toolbar¶

Tools¶

Uri¶