Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(Docs) vector dataSource doc et exemple avec donnéeQuébec dans démo #581

Merged
merged 2 commits into from
Jan 28, 2021
+116 −60
Merged

(Docs) vector dataSource doc et exemple avec donnéeQuébec dans démo #581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dba1a45
(Docs) vecto source add exemple and doc
Jan 27, 2021
b341336
Update variousFormats.json
mbarbeau Jan 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 89 additions & 58 deletions docs/properties.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Propriétés
- objet `WorkspaceOptions`_
- .. line-block::
Permet de définir si une source possèdera une table
d'attribut dans l'application ainsi
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`_
Expand Down Expand Up @@ -205,10 +205,10 @@ Propriétés
- Object{}
- .. line-block::
Définir la source pour les metadonnées. Lien pour
le bouton i de la couche -> 'i'. Si la balise url
le bouton i de la couche -> 'i'. 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,
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
Expand All @@ -217,14 +217,14 @@ Propriétés
- url
- extern
- keyword
- abstract = résumé de la couche. Sert au tooltip ici bas.
- abstract = résumé de la couche. Sert au tooltip ici bas.
- {url: "http://www.igouverte.org/", extern: true}
-
* - tooltip
- Object{}
- .. line-block::
Permet de définir le type de tooltip à afficher sur survol de la couche
dans la table des matières (liste de couche).
dans la table des matières (liste de couche).
Les divers types sont:
- title
- abstract
Expand All @@ -235,8 +235,8 @@ Propriétés
- .. line-block::
{ type: 'title'
ou 'abstract'
ou 'custom',
text: 'text à afficher si le type est custom'
ou 'custom',
text: 'text à afficher si le type est custom'
}
- { type: 'title'}
* - opacity
Expand Down Expand Up @@ -308,7 +308,7 @@ LegendOptions

.. line-block::
Propriétés de l'objet legendOptions.
Permet de controler le rendu de légende.
Permet de controler le rendu de légende.

Exemples

Expand All @@ -322,7 +322,7 @@ Exemples
"stylesAvailable": [
{ "name": "rain", "title": "Pluie" },
{ "name": "raster", "title": "Défaut" }
]
]
}}

Propriétés
Expand Down Expand Up @@ -363,9 +363,9 @@ Propriétés
* - stylesAvailable
- ItemStyleOptions[]
- .. line-block::
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.
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.
- .. line-block::
Ex: "stylesAvailable": [
{ "name": "raster", "title": "pixel" },
Expand Down Expand Up @@ -439,8 +439,8 @@ WorkspaceOptions

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

Exemples

Expand Down Expand Up @@ -476,24 +476,24 @@ Propriétés
true | false
- .. line-block::
Pour les sources vectorielles, true par défault.
Pour les wms avec des propriétés
Pour les wms avec des propriétés
WFS associées, false par défault
* - minResolution
- Number
- .. line-block::
Indique la résolution minimale (grande échelle, très zoomé)
à laquelle la table d'attribut pourra faire apparaitre des
Indique la résolution minimale (grande échelle, très zoomé)
à laquelle la table d'attribut pourra faire apparaitre des
enregistrements.
- 0 à Infinity ou absent
-
-
* - maxResolution
- Number
- .. line-block::
Indique la résolution maximale (petite échelle, peu zoomé)
à laquelle la table d'attribut pourra faire apparaitre des
Indique la résolution maximale (petite échelle, peu zoomé)
à laquelle la table d'attribut pourra faire apparaitre des
enregistrements.
- 0 à Infinity ou absent
-
-

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

Expand Down Expand Up @@ -544,19 +544,19 @@ Propriétés de LinkedLayersOptions
- String
- .. line-block::
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
Diffère du ID du la couche car cet id doit être
connu au pilotage, pas seulement lors l'éxécution
du code.
-
-
-
-
* - links
- :ref:`LayersLinkProperties[] <LayersLinkProperties>`
- .. line-block::
Définit la liste des couches "enfant" liées
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.

Expand All @@ -582,8 +582,8 @@ Propriétés de LayersLinkProperties
* - bidirectionnal
- Boolean
- .. line-block::
Indique si les 2 couches sont liées de manière
bi-directionnelles. C'est à dire, si une modification
Indique si les 2 couches sont liées de manière
bi-directionnelles. C'est à dire, si une modification
de l'enfant est transférée au parent et inversement.
- true | false
- true
Expand All @@ -592,13 +592,13 @@ Propriétés de LayersLinkProperties
- .. line-block::
Liste des identifiants de liaison.
C'est à dire, une liste des linkId des couches enfant.
-
-
-
-
* - syncedDelete
- Boolean
- .. line-block::
Indique si les 2 couches doivent être supprimées
simultanément lorsque une ou l'autre des couches
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
Expand All @@ -613,8 +613,8 @@ Propriétés de LayersLinkProperties
- maxResolution
- zIndex
- timeFilter => `Configuration filtre temporel WMS-T (timeFilter)`_
-
-
-
-

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

Expand Down Expand Up @@ -671,17 +671,17 @@ Propriétés
- String
- .. line-block::
Les droits d'auteurs liés à la couche.
-
-
- .. line-block::
Pour OpenStreetMap, la valeur par défaut est @OpenStreetMap contributors
* - crossOrigin
- String
- .. line-block::
Permet de définir l'entête de l'appel faite au serveur.
Permet entre autres, d'éviter les problématiques de CORS.
Permet entre autres, d'éviter les problématiques de CORS.
De manière plus commune, définir "crossOrigin": "anonymous".
- anonymous | use-credentials | null
-
-

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

Expand Down Expand Up @@ -1036,17 +1036,48 @@ Liens
Vecteur
===============

.. note::
Disponible actuellement mais la documentation est en cours de construction.

.. line-block::
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 <https://openlayers.org/en/latest/apidoc/module-ol_format_GeoJSON-GeoJSON.html>`__

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.


Exemples

.. code:: json

{"sourceOptions": {

{
"title": "Donnée geojson sur DQ (pas de service)",
"sourceOptions": {
"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"
},
}
},
{
"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
Expand Down Expand Up @@ -1246,16 +1277,16 @@ Propriétés
* - contentDependentLegend
- Boolean
- .. line-block::
Pour Mapserver et Geoserver, il est possible de retourner
Pour Mapserver et Geoserver, il est possible de retourner
la légende WMS du contenu de la carte et non pas toute la
légende de la couche. Exemple: Si ce paramètre est définit
à true et que vous zoomer sur un secteur dans lequel il y
à true et que vous zoomer sur un secteur dans lequel il y
seulement 1 classe de symbologie, la légende retournée sera
composée d'une seule couleur. Si vous zoomez a l'échelle
composée d'une seule couleur. Si vous zoomez a l'échelle
provinciale et que vous voyez tous les classes de données,
la légende retournée sera composée de toutes les classes de
la couche.
IMPORTANT: Ne tient pas compte des filtres OGC appliqués.
la légende retournée sera composée de toutes les classes de
la couche.
IMPORTANT: Ne tient pas compte des filtres OGC appliqués.
- true/false
- false
* - queryable
Expand Down Expand Up @@ -3383,13 +3414,13 @@ ogcFilter
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 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 à: :ref:`Configuration des filtres attributaires OGC <igoOgcFilterObject>` pour configurer les filtres au niveau des couches.
Expand Down Expand Up @@ -3700,7 +3731,7 @@ Options
Permet de controler la liste des projections disponible dans l'outil.
- .. line-block::
{
"projFromConfig": true, // Utiliser les projections définies dans la configuration
"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)
Expand Down Expand Up @@ -3729,7 +3760,7 @@ Options
"mtmZone": {
"minZone": 1,
"maxZone": 10
}}
}}
* - importExportType
- String
- .. line-block::
Expand All @@ -3742,8 +3773,8 @@ Options
- Boolean
- .. line-block::
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.
Si false, le type définit précédemment, sera le seul type affiché.
Se base sur l'option importExportType.
- .. line-block::
true / false
- .. line-block::
Expand Down
29 changes: 27 additions & 2 deletions src/contexts/variousFormats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"base": "_base",
"layers": [
{
"title": "MSP Tel. Urgence",
"title": "WMS - MSP Tel. Urgence",
"sourceOptions": {
"type": "wms",
"url": "https://geoegl.msp.gouv.qc.ca/apis/ws/igo_gouvouvert.fcgi",
Expand Down Expand Up @@ -92,6 +92,32 @@
}
}
},
{
"title": "Geojson sur DQ (pas de service)",

"sourceOptions": {
"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"
}
}
},
{
"title": "Vector geojson d'apel WFS",
"sourceOptions": {
"type": "vector",
"url": "http://geoegl.msp.gouv.qc.ca/apis/ws/swtq?service=WFS&request=GetFeature&version=1.1.0&typename=aeroport_piste&outputFormat=geojson",
"queryable": true,
"queryFormat": "geojson",
"queryTitle": "desclocal"
}
},
{
"title": "Arcgis Rest",
"sourceOptions": {
Expand All @@ -117,4 +143,3 @@

]
}