Karteis Mapviewer

Class: DataLayer

dataLayer~ DataLayer

Service de couche vectorielle

new DataLayer(viewer, options)

Parameters:
Name Type Description
viewer module:dataLayer~Mapviewer
options Object

options génériques du datalayer
Source:

Members

<static> MapModes :module:dataLayer~MapMode

Type:
Properties:
Name Type Default Description
modify module:dataLayer~MapMode modify

Mode de modification de features
multiselect module:dataLayer~MapMode multiselect

Mode de sélection cumulant les features
select module:dataLayer~MapMode select

Mode de sélection simple
rectangular module:dataLayer~MapMode rectangular

Mode de sélection par tracé d'une zone rectangulaire
zonal module:dataLayer~MapMode zonal

Mode de sélection de features contenues dans une autre
polygon module:dataLayer~MapMode polygon

Mode de sélection via le tracé d'un polygon sur la carte
measureLine module:dataLayer~MapMode measureLine

Mode de mesure de distances
measureArea module:dataLayer~MapMode measureArea

Mode de mesure de surfaces
dragAndDrop module:dataLayer~MapMode dragAndDrop

Mode drag & drop sur layer
Source:

<static> SelectModes :module:dataLayer~SelectMode

Liste des modes de sélection disponibles

.

Liste des modes de sélection disponibles

Type:
Properties:
Name Type Default Description
REPLACE module:dataLayer~SelectMode replace

la sélection remplace la précédente (mode par défaut)
TOGGLE module:dataLayer~SelectMode toggle

la re-selection d'un élement le déselectionne
ADD module:dataLayer~SelectMode add

Mode de sélection additive
Source:

_currentSelection :Collection.<Feature>

Type:
  • Collection.<Feature>
Source:

_layersStyle

Styles pour chaques calques

.

Styles pour chaques calques

Source:

commonLayer

Fonction commonLayer

.

Fonction commonLayer

Source:

ctx :Mapviewer

instance du viewer

.

instance du viewer

Type:
Source:

ctx :Mapviewer

Type:
Source:

excludeLayers

Permet d'exclure des layers de la selection

.

Permet d'exclure des layers de la selection

Source:

geometrieTypesSelectableInRectangularMode

types de géométries sélectionnable en mode rectangle

.

types de géométries sélectionnable en mode rectangle

Source:

hoverableLayer

Calques survolable

.

Calques survolable

Source:

propertiesName

Nom des propriétés systeme dans une feature

.

Nom des propriétés systeme dans une feature

Source:

selectHiddenFeatureInRectangularMode

peut-on sélectionner les features en mode rectangle ?

.

peut-on sélectionner les features en mode rectangle ?

Source:

selectMode :module:dataLayer~SelectMode

Type:
Source:

systemTagName

Nom des tags systeme dans les tags

.

Nom des tags systeme dans les tags

Source:

viewer :Mapviewer

instance du viewer

.

instance du viewer

Type:
Source:

Methods

_applyStyleToFeature()

Permet de retourner le style d'une feature

.

Permet de retourner le style d'une feature

Source:

_getDataLayerStyleFunction()

Permet de retourner une fonction de style pour un layer de données

.

Permet de retourner une fonction de style pour un layer de données

Source:

activeFeature(idFeature, idLayer, noRefresh)

Activer une feature

.

Activer une feature

Parameters:
Name Type Description
idFeature *

Identifiant de la feature à activer
idLayer string

Identifiant du layer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

activeFeatures(idFeature, idLayer, noRefresh)

Activer des features

.

Activer des features

Parameters:
Name Type Description
idFeature Array.<*>

Identifiants des features à activer
idLayer string

Identifiant du layer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

activeOlFeature(feature, noRefresh)

Activer une feature OpenLayers

.

Activer une feature OpenLayers

Parameters:
Name Type Description
feature Feature

Feature OpenLayer à activer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

activeOlFeatures(features, noRefresh)

Activer des features OpenLayers

.

Activer des features OpenLayers

Parameters:
Name Type Description
features Array.<Feature>

Feature OpenLayer à activer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

addDataLayer(options)

Permet de créer un layer de données

.

Permet de créer un layer de données

Parameters:
Name Type Description
options Object

Options

Properties
Name Type Argument Default Description
layerId String | Number

Identifiant du layer
idGroup String <nullable>

Nom du groupe de calque
features Array.<Feature> | undefined

Features à inséréer. Optionnel.
style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined

Style du layer. Optionnel.
selectable Boolean | Object | undefined

Activer la sélection sur le layer. Par défaut true.

Properties
Name Type Description
minZoom Number

Zoom minimal pour être sélectionnable (exclusif). Optionnels.
maxZoom Number

Zoom maximal pour être sélectionnable (inclusif). Optionnels.
minScale Number

echelle minimal pour être sélectionnable (exclusif). Optionnels. prévaut sur options.selectable.maxZoom.
maxScale Number

echelle maximal pour être sélectionnable (inclusif). Optionnels. prévaut sur options.selectable.minZoom.
hoverable Boolean | undefined <optional>
 false

Activer le mode survol de ce calque. Par défaut false. Il faudra lancer le service de survol sur Core pour que cela soit prit en compte (setFeatureHover)
minZoom Number | undefined

Zoom minimal pour afficher le layer (exclusif)
maxZoom Number | undefined

Zoom maximal pour afficher le layer (inclusif)
minResolution Number | undefined

Résolution minimale pour afficher le layer (inclusif). Non utilisée si maxZoom défini
maxResolution Number | undefined

Résolution maximale pour afficher le layer (exclusif). Non utilisée si minZoom défini
zIndex Number | undefined <nullable>

Si le zIndex est présent, celui-ci prévaut sur la position du layer sur la carte. Optionnel.
attributions String

Attribution de la carte. Optionnel.
cluster Object <nullable>

Options pour définir un layer de type Cluster. Optionnel.

Properties
Name Type Description
style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined

Style des points de cluster. Optionnel.
distance Number | undefined

Distance de regroupement. Par défaut 50.
exploded Boolean | undefined

Possibilité de voir une vue éclatée d'un groupe. Par défaut false. @TODO_EXPLODED: Non testée.
groupFeaturesAlone Boolean | undefined

Les groupe d'une features seront représentés sous forme de groupe. Par défaut false.
includeNoStyle Boolean | undefined

Inclure dans les groupes les features sans style. Par défaut false.
includeHidden Boolean | undefined

Inclure dans les groupes les features masquée. Par défaut false.
zoom Boolean | undefined

Permet d'afficher le cluster uniquement jusqu'à un certain niveau de zoom. Par défaut, toujours visible.
label Object <nullable>

Affichage de labels sur la carte. Optionnel.

Properties
Name Type Description
templateFunction function

Fonction de template pour générer un label. Prends une feature et la résolution en entrée et retourne un template HTML. Optionnel.
minZoom Number

Zoom minimal pour afficher les labels. Optionnels.
maxZoom Number

Zoom maximal pour afficher les labels. Optionnels.
minScale Number

echelle minimal pour afficher les labels. Optionnels. prévaut sur options.label.maxZoom.
maxScale Number

echelle maximal pour afficher les labels. Optionnels. prévaut sur options.label.minZoom.
wfs Object <nullable>

Option de chargement des données via un service wfs

Properties
Name Type Argument Default Description
url String

Url du service wfs
geometryName string

nom du champs geométrie du service (défaut geo)
params Object

paramètre du service wfs

Properties
Name Type Argument Default Description
typename string

Nom de la couche du service WFS à exploiter
srsname string <optional>
 EPSG:3857

projection de retour des données
version string <optional>
 1.1.1

version du service WFS
* string

autres paramètres du service WFS
projection string <optional>
 EPSG:3857

projection de la bbox pour interroger le service
geometryName string <optional>
 geometry

nom de la géométrie pour interroger la bbox
bboxStrategy boolean <optional>
 false

Utiliser une stratégie de chargement par bbox (true) ou par tuile (false). Par défaut false
tileStrategy boolean | Object <optional>
 false

Utiliser une stratégie de chargemen par tuile (false). Par défaut true

Properties
Name Type Argument Default Description
tileSize boolean | Object <optional>
 256

Taille des tuiles pour la stratégie par tuile
cqlFilter string

filtre cql
filters Object.<string, (string|Array)>

objet represant des filtres a générer (exemple {code_insee:[9420,8521]}). Ignoré si cqlFilter est défini
title string

titre pour affichage dans layermanager
displayInLayerSwitcher boolean

pour afficher ou non dans layermanager
ui Object <nullable>

(deprecated) élement pour l'IHM si on utilise la layervisibilitybar

Properties
Name Type Description
title string

tooltip du calque
html Element | string

contenu html du bouton a afficher
icon string

icone si html non saisie (utilisé comme )
legends Array.<LegendOption> <nullable>

Options de légende (voir examples)
loadingStrategy loadingStrategy <nullable>

stratégie de chargement de carte avec un loader personnalisé
Source:

addFeatures(features, idLayer, overwrite)

Permet d'ajouter des features openLayers dans un layer

.

Permet d'ajouter des features openLayers dans un layer

Parameters:
Name Type Description
features array.<Feature>

Tableau des features à ajouter
idLayer string

Id du layer
overwrite boolean

True si les features déjà existantes doivent-être écrase. Par défaut false
Source:

addFeaturesSelection(features, mapBrowserEvent)

Permet d'ajouter une ou plusieurs features à la selection actuelle

.

Permet d'ajouter une ou plusieurs features à la selection actuelle

Parameters:
Name Type Description
features Feature | Array.<Feature>

Liste des features à ajouter
mapBrowserEvent ol.mapBrowserEvent

Permet d'attacher un evenement du navigateur à la selection
Source:

addGeojsonFeatures(geojsonObject, idLayer, originProjection)

Ajoute des features a partir d'un GeoJSON

.

Ajoute des features a partir d'un GeoJSON

Parameters:
Name Type Default Description
geojsonObject Object

Object au format GeoJSON valide
idLayer string

Id du layer contenant la feature
originProjection string null

projection d'origine des feature, sinon on suppose qu'elles sont dans le systeme de la carte
Source:

addHeatMapLayer(options)

Permet de créer un layer de données sous forme de HeatMap

.

Permet de créer un layer de données sous forme de HeatMap

Parameters:
Name Type Description
options Object

Options pour la création

Properties
Name Type Description
weightProperties string | undefined

Propriété du poid de la feature
id string

Id du layer à créer
features string

Features à ajouter au layer
zIndex number | undefined

zIndex du layer sur la carte
Source:

addTagToOlFeature(feature, tag, options)

Ajout d'un tag sur une feature

.

Ajout d'un tag sur une feature

Parameters:
Name Type Description
feature Feature

Feature OpenLayer à activer
tag String

At tag a ajouter a la feature
options Object

options

Properties
Name Type Description
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

addVectorDataLayer(options)

Permet de définir une couche de données vectoriel Cette couche permet de charger un nombre important de données

.

Permet de définir une couche de données vectoriel Cette couche permet de charger un nombre important de données

Parameters:
Name Type Description
options Object

Paramètres pour limport { SelectModes } from './data-layer';

Properties
Name Type Description
id string

Id du layerimport Mapviewer from './../core/core';
attributions string | undefined

Définition des attributions propre au layer. Vide par défaut
style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined

Tableau des styles à appliquer au features ou fonction de style openlayers
selectable boolean | undefined

Autoriser la selection sur le layer. Activée par défaut
geojson Object | undefined

Geojson en EPSG:4326 des données. Permet de créer le layer plus rapidement que les features. options.geojson ou options.features requis
features Array.<Feature> | undefined

Features à charger. Préférer l'utilisation de options.geojson. options.geojson ou options.features requis
Source:

animateFeature(feature, duration)

Animation flash d'une feature pendant une durée donnée Point: crée un cercle rouge dont le rayon augmente autour de la feature LineString, Polygon: crée une bordure rouge dont la taille augmente

.

Animation flash d'une feature pendant une durée donnée Point: crée un cercle rouge dont le rayon augmente autour de la feature LineString, Polygon: crée une bordure rouge dont la taille augmente

Parameters:
Name Type Description
feature Feature
duration Number

durée de l'animation en ms
Source:

animateFeatures(features, duration)

Animation flash d'un ensemble de features pendant une durée donnée

.

Animation flash d'un ensemble de features pendant une durée donnée

Parameters:
Name Type Description
features Array.<Feature>

Features
duration Number

durée de l'animation en ms
Source:

buildFilterVisibleFeatures()

Construit une fonction de filtre de visiblité pour ne pas avoir à conserver les informations (filtre, ...)

.

Construit une fonction de filtre de visiblité pour ne pas avoir à conserver les informations (filtre, ...)

Source:

centerOnFeatures(features, noFly, options)

Permet de center sur un groupe de feature

.

Permet de center sur un groupe de feature

Parameters:
Name Type Description
features Array.<Feature>

Features devant apparaitre dans le zoom
noFly boolean

Permet de désactiver l'animation de déplacement
options Object

Permet de passer des options d'ajustement au composant ol.View (voir ol.View.fit)
Source:

centerOnLayers(idLayer, noFly, options)

Permet de centrer sur toutes les features d'un layer.

Permet de centrer sur toutes les features d'un layer. Centre sur un niveau de zoom exact adapté pour voir l'ensemble des features et avoir un fond de plan net

Parameters:
Name Type Description
idLayer string

Id du layer
noFly boolean | undefined

Permet de centrer sur le layer sans animation. Par défaut 'false'
options Object

Permet de passer des options d'ajustement au composant ol.View (voir ol.View.fit)
Source:

changedLayer(idLayer)

Permet d'indiquer à un layer qu'il a changé

.

Permet d'indiquer à un layer qu'il a changé

Parameters:
Name Type Description
idLayer string

Id du layer
Source:

changeMapMode(mode)

Permet de changer le mode de la carte

.

Permet de changer le mode de la carte

Parameters:
Name Type Description
mode module:dataLayer~MapMode

Mode de la carte
Source:

clearCurrentSelection()

Permet d'effacer l'ensemble de la selection actuelle

.

Permet d'effacer l'ensemble de la selection actuelle

Source:

clearLayer(idLayer)

Permet d'effacer toutes les features d'un layer

.

Permet d'effacer toutes les features d'un layer

Parameters:
Name Type Description
idLayer string

Id du layer à vider
Source:

created()

Fonction lancée à l'instanciation du module

.

Fonction lancée à l'instanciation du module

Source:

createFeature(idFeature)

Permet de passer en mode de création pour dessiner une feature et l'ajouter automatiquement sur le layer Nouvelle signature afin d'étendre plus facilement les fonctionnalités

.

Permet de passer en mode de création pour dessiner une feature et l'ajouter automatiquement sur le layer Nouvelle signature afin d'étendre plus facilement les fonctionnalités

Parameters:
Name Type Description
idFeature string | number | object

IdFeature pour version deprecated ou Options pour la création
options.idFeature string | number

Identifiant de la feature à créer
options.idLayer string

Identifiant du layer
options.geometryType string

Type de géométrie à dessiner
options.properties Object

Propriétés de la feature
options.digitalizeOptions object

options de l'outil de digitalisation
options.createTemplates object

templates de création de géométries
options.toolId string

Outil qui demande la création
options.autoValidate Boolean

Validation automatique (implicite si boite outil masquée)
options.hideToolbox Boolean

Masquer la boite à outil (impossible pour multigéométrie)
options.hideGPS Boolean

Masquer l'option GPS sur les outils d'ajout
options.modifyTools Array

Outils de modifications disponibles ['move','rotate','scale','modifyVertex','removeVertex']
options.createToolOptions Object

Options pour la popup d'outils (pas encore utilisé)
Source:
Returns:

Ajoute la feature au calque idLayer et retourne un objet étendu avec la feature une fois créer

Type
Promise
Example
Ajoute la feature au calque idLayer et retourne un objet étendu avec la feature une fois créer
mapviewer.dataLayer.createFeature( {
              "geometryType": "GeometryCollection", // type de geometrie a créer (type geojson)
              "idLayer": "features-EQU", // calque ou créer la geométrie
              "idFeature" : "efefef-1234",
              "properties" : {test:1},
              "toolId": "create-EQU", // sera renvoyé lors de la levé de l'event createfeature:create
              "digitalizeOptions": { // options de l'outil de digitalisation
                  "showConstructionPoint": true,
                  "maxPoints" : 5,
                  "showConstructionLine" : true,
              },
              autoValidate: false,
              hideToolbox: false,
              modifyTools: ['move','rotate','scale','modifyVertex','removeVertex'],
              hideGPS: [],
              "createTemplates": { // templates de création de géométries
                  "features": [{ // geojson features
                          "type": "Feature",
                          "geometry": {
                              "type": "MultiPolygon",
                              "coordinates": [coordonnées de l objet]
                          },
                          "properties": { // propriétés recopiées sur la feature openlayers créées (si elle n'existe pas déjà)
                              "name": "Assainissement - Arbre"
                          },
                          "display": { // libellé affiché dans l'ihm de création
                              "label": "Assainissement - Arbre"
                          }
                      }, {
                          "type": "Feature",
                          "geometry": {
                              "type": "MultiPolygon",
                              "coordinates": [coordonnées de l objet]
                          },
                          "properties": {
                              "name": "Assainissement - Bac graisse"
                          },
                          "display": {
                              "label": "Assainissement - Bac graisse"
                          }
                      },
                  ]
              }
          }
      }
  ]
})

desactiveAllFeatures(idLayer, noRefresh)

Descativer toutes les features Si idLayer, on ne désactive que les features de ce layer

.

Descativer toutes les features Si idLayer, on ne désactive que les features de ce layer

Parameters:
Name Type Description
idLayer string | undefined

Identifiant du layer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

desactiveFeature(idFeature, idLayer, noRefresh)

Desactiver une feature

.

Desactiver une feature

Parameters:
Name Type Description
idFeature *

Identifiant de la feature à desactiver
idLayer string

Identifiant du layer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

desactiveFeatures(idFeature, idLayer, noRefresh)

Desactiver des features

.

Desactiver des features

Parameters:
Name Type Description
idFeature Array.<*>

Identifiants des features à desactiver
idLayer string

Identifiant du layer
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

desactiveOlFeature(feature, noRefresh)

Desactiver une feature OpenLayers

.

Desactiver une feature OpenLayers

Parameters:
Name Type Description
feature Feature

Feature OpenLayer à desactiver
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

desactiveOlFeatures(features, noRefresh)

Desactiver des features OpenLayers

.

Desactiver des features OpenLayers

Parameters:
Name Type Description
features Array.<Feature>

Feature OpenLayer à desactiver
noRefresh boolean

Permet de ne par recharger la carte (changement non visible).
Source:

downLayer(id)

Permet de descendre le layer d'un nieau dans l'ordre d'affichage

.

Permet de descendre le layer d'un nieau dans l'ordre d'affichage

Parameters:
Name Type Description
id string

Id du layer
Source:

excludeLayerSelection(idLayer)

Permet de désactiver la selection sur un layer Si des features du layer sont sélectionnées, elles ne seront pas déselectionnées par défaut

.

Permet de désactiver la selection sur un layer Si des features du layer sont sélectionnées, elles ne seront pas déselectionnées par défaut

Parameters:
Name Type Description
idLayer string | number

Identifiant du layer
Source:

filterVisibleFeatures()

Permet de filtrer les features en fonction de leur visibilité

.

Permet de filtrer les features en fonction de leur visibilité

Source:

findFeatures(idFeatures, layer)

Permet de rechercher une feature dans une source à l'aide de son id

.

Permet de rechercher une feature dans une source à l'aide de son id

Parameters:
Name Type Description
idFeatures string | number | Array.<(string|number)>

Identifiant de la/des features
layer ol.source.Vector

Source du layer
Source:
Returns:

Features correspondant aux ids

Type
array.<Feature>

findFeaturesInAllLayers(idFeatures)

Permet de rechercher une feature dans tous les layers vectoriels à l'aide de son id

.

Permet de rechercher une feature dans tous les layers vectoriels à l'aide de son id

Parameters:
Name Type Description
idFeatures string | number | Array.<(string|number)>

Identifiant de la/des features
Source:
Returns:

Features correspondant aux ids

Type
array.<Feature>

flattenFeatures(features)

Permet de mettre à plat les features Récupère que les features fonctionnelle même s'il y a des features de cluster en paramètre

.

Permet de mettre à plat les features Récupère que les features fonctionnelle même s'il y a des features de cluster en paramètre

Parameters:
Name Type Description
features Feature

Liste des features
Source:

getCurrentSelection()

Permet de récupérer la selection courrante

.

Permet de récupérer la selection courrante

Source:
Returns:

Tableau des features sélectionnées

Type
Array.<Feature>

getFeature(idFeature, idLayer)

Retourne une feature d'un layer

.

Retourne une feature d'un layer

Parameters:
Name Type Description
idFeature string

Id de la feature
idLayer string

Id du layer
Source:
Returns:

Feature du layer

Type
Feature

getFeatureLinkedLayers(feature)

renvoi les layers auquels la feature à été ajoutée

.

renvoi les layers auquels la feature à été ajoutée

Parameters:
Name Type Description
feature Feature

Feature OpenLayer
Source:
Returns:

identifiant du layer

getFeatures(layer)

Retourne l'ensemble des features d'un layer

.

Retourne l'ensemble des features d'un layer

Parameters:
Name Type Description
layer string | Layer

Identifiant ou instance du layer
Source:
Returns:

Liste des features du layer

Type
Array.<Feature>

getFeaturesInExtent(extent, options)

Permet de récupérer des features selectionnables présentes dans une extent

.

Permet de récupérer des features selectionnables présentes dans une extent

Parameters:
Name Type Description
extent ol.Extent

Extent de l'extraction
options object

Options

Properties
Name Type Description
layers Array.<ol.Layer> | undefined

Liste des layers dans lesquelle rechercher. Par défaut, tout les layers de données
resolution number | undefined

Résolution de la carte. Par defaut, celle de la carte principale.
filter function | undefined

Permet de filtrer les features retournées. La fonction prend une feature en argument et retourne un boolean. Par défaut, pas de filtre
Source:
Returns:

Liste des features dans l'extent

Type
Array.<Feature>

getIdsFeatures(idLayer)

Permet de retourner un tableau avec tous les identifiants des features qu'il contient

.

Permet de retourner un tableau avec tous les identifiants des features qu'il contient

Parameters:
Name Type Description
idLayer string

Id du layer
Source:
Returns:

Tableau des identifiants

Type
array.<string> | array.<number>

getLayer(id)

Permet de retourner un layer

.

Permet de retourner un layer

Parameters:
Name Type Description
id string

Id du layer
Source:
Returns:

Layer recherché

Type
ol.layer.Vector

getLayers()

Permet de retourner les couches de données

.

Permet de retourner les couches de données

Source:
Returns:

Liste des layers de données

Type
array.<ol.Layer>

getLayersExtent(idLayers)

Permet de récupérer l'extent englobant tous les layers demandés

.

Permet de récupérer l'extent englobant tous les layers demandés

Parameters:
Name Type Description
idLayers Array.<string>

Ids des layers
Source:

getLayersId()

Permet de retourner la liste des couches de données

.

Permet de retourner la liste des couches de données

Source:
Returns:

Liste des ids de layer de données

Type
array.<string>

getSelectableFeatures(feature, layer, resolution, includeHidden)

Permet de récuéprer les features réellement sélectionnées à partir d'une feature.

Permet de récuéprer les features réellement sélectionnées à partir d'une feature. Retourne toujours un tableau Nécessaire sur un cluster pour récupérer le sous-ensemble

Parameters:
Name Type Default Description
feature Feature

Feature normal ou issue d'un cluster
layer ol.Layer

Layer de la feature
resolution number

Resolution de la carte
includeHidden bool false

Inclure les feature cachée?
Source:
Returns:

Liste des features fonctionnelles visibles

Type
Array.<Feature>

getSelectableLayers()

Retourne les layers actuellement sélectionnable

.

Retourne les layers actuellement sélectionnable

Source:
Returns:

Liste des layers sélectionnable

Type
Array.<ol.Layer>

getSelectMode()

Renvoit le mode de sélection actuel

.

Renvoit le mode de sélection actuel

Source:
Returns:
Type
SelectModes

getSourceLayer(id)

Permet de récupérer une source depuis un id de layer

.

Permet de récupérer une source depuis un id de layer

Parameters:
Name Type Description
id string

Id du layer
Source:
Returns:

Source vector du layer

Type
ol.source.Vector

hideAllFeatures(idLayer, silent)

Permet de masquer toutes les features d'un layer

.

Permet de masquer toutes les features d'un layer

Parameters:
Name Type Description
idLayer string

Id du layer
silent boolean

Update without triggering an event.
Source:

hideFeature(feature, idLayer, silent)

Permet de masquer une feature

.

Permet de masquer une feature

Parameters:
Name Type Description
feature Feature | string | number

Feature Openlayers à masquer ou son identifiant
idLayer string | undefined

Id du layer. Uniquement si feature est un identifiant
silent boolean

Update without triggering an event.
Source:

hideLayer(id)

Permet de masquer un layer

.

Permet de masquer un layer

Parameters:
Name Type Description
id string

Id du layer à masquer
Source:

includeLayerSelection(idLayer)

Permet d'autoriser la sélection sur un layer

.

Permet d'autoriser la sélection sur un layer

Parameters:
Name Type Description
idLayer string | number

Identifiant du layer
Source:

isCluster(layer)

Permet de déterminer si un layer est un cluster

.

Permet de déterminer si un layer est un cluster

Parameters:
Name Type Description
layer ol.Layer

Layer dont on recherche le type
Source:
Returns:

True si layer est un cluster

Type
boolean

isDataLayer(layer)

Permet de savoir si le layer est un layer de données

.

Permet de savoir si le layer est un layer de données

Parameters:
Name Type Description
layer ol.Layer | String | Number

Layer ou identifiant de layer
Source:
Returns:

True si c'est un layer de données

Type
Boolean

isHoverableLayer(layer)

Permet de savoir si le layer est survolable actuellement

.

Permet de savoir si le layer est survolable actuellement

Parameters:
Name Type Description
layer ol.Layer

Layer
Source:
Returns:

True si le layer est survolable

Type
Boolean

isSelectableInRectangularMode(feature)

Teste si la feature doit être sélectionnée lors d'une selection rectangulaire

.

Teste si la feature doit être sélectionnée lors d'une selection rectangulaire

Parameters:
Name Type Description
feature Object
Source:

isSelectableLayer(layer)

Permet de savoir si le layer est sélectionnable actuellement

.

Permet de savoir si le layer est sélectionnable actuellement

Parameters:
Name Type Description
layer ol.Layer

Layer
Source:
Returns:

True si le layer est sélectionnable

Type
Boolean

isVisible(id)

Permet de connaitre la visibilité d'un layer (en fonction de min/max zoom, propriété "visible" & group "visible")

.

Permet de connaitre la visibilité d'un layer (en fonction de min/max zoom, propriété "visible" & group "visible")

Parameters:
Name Type Description
id string

Identifiant du layer
Source:
Returns:

Visibilité

Type
boolean

layerExist(id)

Permet de savoir si un layer existe

.

Permet de savoir si un layer existe

Parameters:
Name Type Description
id string

Id du layer
Source:
Returns:

Si le layer existe

Type
boolean

modifyFeature(idFeature)

Permet de passer en mode de modification pour dessiner une feature et la modifier automatiquement sur le layer Nouvelle signature afin d'étendre plus facilement les fonctionnalités

.

Permet de passer en mode de modification pour dessiner une feature et la modifier automatiquement sur le layer Nouvelle signature afin d'étendre plus facilement les fonctionnalités

Parameters:
Name Type Description
idFeature string | number | object

IdFeature pour version deprecated ou Options pour la création
options.idFeature string | number

Identifiant de la feature à créer
options.idLayer string

Identifiant du layer
options.geometryType string

Type de géométrie à dessiner
options.properties object

Propriétés de la feature
options.digitalizeOptions object

options de l'outil de digitalisation
options.createTemplates object

templates de création de géométries
options.toolId string

Outil qui demande la création
options.autoValidate Boolean

Validation automatique (implicite si boite outil masquée)
options.hideToolbox Boolean

Masquer la boite à outil (impossible pour multigéométrie)
options.hideGPS Boolean

Masquer l'option GPS sur les outils d'ajout
options.modifyTools Array

Outils de modifications disponibles ['move','rotate','scale','modifyVertex','removeVertex']
options.createToolOptions Object

Options pour la popup d'outils (pas encore utilisé)
Source:
Returns:

Ajoute la feature au calque idLayer et retourne un objet étendu avec la feature une fois créer

Type
Promise
Example
Ajoute la feature au calque idLayer et retourne un objet étendu avec la feature une fois créer
mapviewer.dataLayer.modifyFeature( {
              "type": "GeometryCollection", // type de geometrie a créer (type geojson)
              "feature": olFeature,  si non présent recherche la feature avec les paramètres idLayer/idFeature
              "idLayer": "features-EQU", // calque ou se trouve la geométrie
              "idFeature" : "efefef-1234",
              "properties" : {test:1},
              "toolId": "create-EQU", // sera renvoyé lors de la levé de l'event createfeature:create
              "digitalizeOptions": { // options de l'outil de digitalisation
                  "showConstructionPoint": true,
                  "maxPoints" : 5,
                  "showConstructionLine" : true,
              },
              autoValidate: false,
              hideToolbox: false,
              modifyTools: ['move','rotate','scale','modifyVertex','removeVertex'],
              hideGPS: [],
              "createTemplates": { // templates de création de géométries
                  "features": [{ // geojson features
                          "type": "Feature",
                          "geometry": {
                              "type": "MultiPolygon",
                              "coordinates": [coordonnées de l objet]
                          },
                          "properties": { // propriétés recopiées sur la feature openlayers créées (si elle n'existe pas déjà)
                              "name": "Assainissement - Arbre"
                          },
                          "display": { // libellé affiché dans l'ihm de création
                              "label": "Assainissement - Arbre"
                          }
                      }, {
                          "type": "Feature",
                          "geometry": {
                              "type": "MultiPolygon",
                              "coordinates": [coordonnées de l objet]
                          },
                          "properties": {
                              "name": "Assainissement - Bac graisse"
                          },
                          "display": {
                              "label": "Assainissement - Bac graisse"
                          }
                      },
                  ]
              }
          }
      }
  ]
})

onViewChange(layer, options)

Mets à jours les propriétés OpenLayer ou Karteis Mapviewer d'un calque

.

Mets à jours les propriétés OpenLayer ou Karteis Mapviewer d'un calque

Parameters:
Name Type Description
layer ol.layer

Calque OpenLayer
options Object

Options possibles pour les calques
Source:

refreshCluster(idLayer)

Permet de recalculer un layer (style, position, ...)

.

Permet de recalculer un layer (style, position, ...)

Parameters:
Name Type Description
idLayer string

Id du layer
Source:

refreshLayer(idLayer)

Permet de recalculer un layer

.

Permet de recalculer un layer

Parameters:
Name Type Description
idLayer string

Id du layer
Source:

removeFeature(feature, idLayer)

Permet de supprimer une feature d'un layer

.

Permet de supprimer une feature d'un layer

Parameters:
Name Type Description
feature Feature | string | number

La feature Openlayers à supprimer
idLayer string

Id du layer contenant la feature
Source:

removeFeatures(features, idLayer)

Permet de supprimer un ensemble de features d'un layer

.

Permet de supprimer un ensemble de features d'un layer

Parameters:
Name Type Description
features array.<(string|number|Feature)>

Tableau des features à supprimer
idLayer string

Id du layer contenant les features
Source:

removeFeaturesSelection(features, mapBrowserEvent)

Permet de retirer une ou plusieurs features de la selection actuelle

.

Permet de retirer une ou plusieurs features de la selection actuelle

Parameters:
Name Type Description
features Feature | Array.<Feature>

Liste des features à retirer
mapBrowserEvent ol.mapBrowserEvent

Permet d'atacher un evenement du navigateur à la selection
Source:

removeLayer(idLayer)

Permet de supprimer un layer

.

Permet de supprimer un layer

Parameters:
Name Type Description
idLayer string

Id du layer à supprimer
Source:
Fires:
  • event:removeLayer Lancé avant la suppression
  • event:removedLayer Lancé après la suppression

setgeometrieTypesSelectableInRectangularMode(geometries)

garde les géométries de type de features filtrées en mode rectangulaire

.

garde les géométries de type de features filtrées en mode rectangulaire

Parameters:
Name Type Description
geometries Array.<string>
Source:

setHoverableLayer(idLayer, hoverable)

Le calque génère-t-il des events au survol d'une feature?

.

Le calque génère-t-il des events au survol d'une feature?

Parameters:
Name Type Description
idLayer string | number

Identifiant du layer
hoverable Boolean
Source:

setLayerSelectionAtZoomLevel(options)

Autorise ou non la sélection sur un layer pour une plage de zoom donnée en fonction du zoom courant

.

Autorise ou non la sélection sur un layer pour une plage de zoom donnée en fonction du zoom courant

Parameters:
Name Type Description
options Object

Options

Properties
Name Type Description
idLayer String | Number

Identifiant du layer
minZoom Number | undefined

Contrainte sur le niveau de zoom minimal. Optionnelle.
maxZoom Number | undefined

Contrainte sur le niveau de zoom maximal. Optionnelle.
currentZoom Number

Niveau de zoom actuel de la carte.
Source:

setRectangularModeOptions(options)

Options pour le mode de sélection bbox

.

Options pour le mode de sélection bbox

Parameters:
Name Type Description
options Object
Source:

setSelectMode(mode)

change le mode de sélection

.

change le mode de sélection

Parameters:
Name Type Description
mode SelectModes

mode de sélection @link DataLayer.SelectModes
Source:

showAllFeatures(idLayer, silent)

Permet d'afficher toutes les features d'un layer

.

Permet d'afficher toutes les features d'un layer

Parameters:
Name Type Description
idLayer string

Id du layer
silent boolean

Update without triggering an event.
Source:

showFeature(feature, idLayer [, silent])

Permet d'afficher une feature

.

Permet d'afficher une feature

Parameters:
Name Type Argument Description
feature Feature | string | number

Feature Openlayers à afficher ou son identifiant
idLayer string | undefined

Id du layer. Uniquement si feature est un identifiant
silent boolean <optional>

Update without triggering an event.
Source:

showLayer(id)

Permet d'afficher un layer

.

Permet d'afficher un layer

Parameters:
Name Type Description
id string

Id du layer à afficher
Source:

unionFeature(options)

Effectue l'union de feature et génère les évènements utiles

.

Effectue l'union de feature et génère les évènements utiles

Parameters:
Name Type Description
options Object

Options de l'outil

Properties
Name Type Argument Default Description
features Array.<Feature>

Liste des features a fusionner
idFeature string | number <optional>

Identifiant de la feature à créer (ou guid)
idLayer string <optional>

Identifiant du layer (ou layer de la première feature)
toolId toolId <optional>
 'tool-union'

Outil qui demande la création
updateLayer Boolean <optional>
 true

On supprime les anciennes features et on ajout la nouvelle
contiguonsPolygon Boolean <optional>
 false

les polygones doivent être contigue? Sinon peut créer des multipolygone
copyProperties Boolean <optional>
 false

copie les propriétées de la première feature
Source:
Returns:

features fusionnées

Type
Feature

updateFeature(olFeature, idLayer, geojsonFeature)

Permet de mettre à jour une feature d'un layer

.

Permet de mettre à jour une feature d'un layer

Parameters:
Name Type Description
olFeature Feature | string | number

La feature Openlayers à mettre à jour
idLayer string

Id du layer contenant la feature
geojsonFeature Object

Données de la feature en geojson

Properties
Name Type Description
properties Object

Les propriétés mises à jour
geometry Object

La géométrie à mettre à jour
Source:

upLayer(id)

Permet de monter le layer d'un niveau dans l'ordre d'affichage

.

Permet de monter le layer d'un niveau dans l'ordre d'affichage

Parameters:
Name Type Description
id string

Id du layer
Source: