Karteis Mapviewer

Global

Members

<constant> geometryBaseType

regroupe les types de géométrie dans leur base (le style d'une ligne est le même que multiligne par exemple)

.

regroupe les types de géométrie dans leur base (le style d'une ligne est le même que multiligne par exemple)

Source:

<constant> texts

Ihm pour controler l'interaction LayersFilters du viewer

.

Ihm pour controler l'interaction LayersFilters du viewer

Source:

<constant> texts

Gestion des légendes associés a des calques

.

Gestion des légendes associés a des calques

Source:

<constant> white

Controle interaction pour la modification

.

Controle interaction pour la modification

Source:

Methods

addFontDef(font, glyphs)

Permet de mapper une font graphique avec un nom utilisable pour les glyphs

.

Permet de mapper une font graphique avec un nom utilisable pour les glyphs

Parameters:
Name Type Description
font String | Object

the font name or a description ({ font: font_name, name: font_name, copyright: '', prefix })
glyphs Object

a key / value list of glyph definitions. Each key is the name of the glyph, the value is an object that code the font, the caracter code, the name and a search string for the glyph. { char: the char, code: the char code (if no char), theme: a theme for search puposes, name: the symbol name, search: a search string (separated with ',') }
Source:
Example
pour ajouter des glyphs de font awesome 5
addFontDef({
  "font":"\"Font Awesome 5 Free\"",
  "name":"FontAwesome5",
  "copyright":"SIL OFL 1.1",
  "prefix": "fa"
},{
  "fa-glass": "\uf000",
  "fa-music": "\uf001",
  "fa-search": "\uf002",
  "fa-envelope-o": "\uf003",
})

addTemplates()

génère l'ihm d'ajout de template en lisant les templates de creation

.

génère l'ihm d'ajout de template en lisant les templates de creation

Source:

<async> addTokenSource(resourceType, resourceId, tokenOptions)

Parameters:
Name Type Description
resourceType String

type de resource (layer, control, service...)
resourceId String

identifiant de la resource
tokenOptions tokenOptions | String

options de gestion du token ou token en clair (historique)
Source:
Returns:
Type
TokenManager

addTokenToUrl(url)

Parse une url pour y ajouter le token

.

Parse une url pour y ajouter le token

Parameters:
Name Type Description
url String
Source:
Returns:

url avec token

Type
String

bufferExtent(extent, buffer)

Permet d'appliquer un buffer sur une extent.

Permet d'appliquer un buffer sur une extent. Le buffer est un ratio S'il est de 1, l'extent retournée sera identique

Parameters:
Name Type Description
extent ol.Extent

Extent sur laquelle appliquer le buffer
buffer Number

Buffer à appliquer
Source:
Returns:

Nouvelle extent avec buffer

Type
ol.Extent

buildArrowCoordinates(start, pos, lenArrow, angArrow)

Construit les traits d'une fleche

.

Construit les traits d'une fleche

Parameters:
Name Type Description
start ol.coordinates

depuis cette position
pos ol.coordinates

position de la fleche
lenArrow ol.coordinates

taille de la flèche (en taille de carte)
angArrow ol.coordinates

angle de la fleche (en radian)
Source:
Returns:

[ol.coordinates]

buildArrowsStyle(options, feature, map)

Permet de créer les styles de ligne avec des flèches

.

Permet de créer les styles de ligne avec des flèches

Parameters:
Name Type Description
options Object

Options pour la création des flèches

Properties
Name Type Argument Default Description
stroke Object

options style de ligne calqués sur buildStrokeStyle
lenArrow Number <optional>
 15

longueur de la flèche en pixels
angArrow Number <optional>
 60

angle de la flèche
mode 'betweenDistance' | 'middle' | 'end' | 'none' <optional>
 'betweenDistance'

Mode d'utilisation. between: flèches espacé d'une distance ne pixel. middle: flèches au centr des segments. end: flèches au bout de chaques segments. none: pas de flèches intermédiaires
distanceBetween Number <optional>
<nullable>
 100

mode between: distance entre les flèches
betweenStartFrom 'start' | 'end' <optional>
 'start'

mode between: on commence les distance du début ou de la fin (utile si on ajoute une flèche au bout avec arrowAtEnd)
hideLine Boolean <optional>
<nullable>
 false

masque la ligne (créer uniquement les flèches)
arrowAtEnd Boolean <optional>
<nullable>
 false

affiche une flèche au bout de la ligne
hideArrowOnSmallSegment Boolean <optional>
<nullable>
 true

Masque les flèches plus grande que les segments
minZoom Number <optional>

Borne haute du zoom d'affichage des flèches
maxZoom Number <optional>

Borne basse du zoom d'affichage des flèches
feature ol.Feature

Feature pour laquelle générer les flèches
map ol.map

instance courante de la carte
Source:
Returns:

Liste des styles représentant les flèches

Type
Array.<ol.Style>

buildBadge()

renvoit une fonction qui construit le style badge en fonction de la feature

.

renvoit une fonction qui construit le style badge en fonction de la feature

Source:

buildChartStyle(literalStyle)

Crée un style de point basé sur un chart

.

Crée un style de point basé sur un chart

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Argument Description
stroke Object

options style de ligne calqués sur buildStrokeStyle
fill Object

options style de remplissage calqués sur buildFillStyle
args * <optional>

reste des options calqués sur ol-ext Chart
Source:
Returns:
Type
ol-ext.style.Chart

buildChartStyleFromLiteral(literalStyle)

Crée un style de point basé sur un chart

.

Crée un style de point basé sur un chart

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Argument Description
stroke Object

options style de ligne calqués sur buildStrokeStyleFromLiteral
fill Object

options style de remplissage calqués sur buildFillStyleFromLiteral
args * <optional>

reste des options calqués sur ol-ext Chart
Source:
Returns:
Type
ol-ext.style.Chart

buildCircleStyle(literalStyle)

Crée un style de point basé sur un cercle

.

Crée un style de point basé sur un cercle

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Argument Description
stroke Object

options style de ligne calqués sur buildStrokeStyle
fill Object

options style de remplissage calqués sur buildFillStyle
args * <optional>

reste des options calqués sur OpenLayer CircleStyle
Source:
Returns:
Type
ol.style.Circle

buildCircleStyleFromLiteral(literalStyle)

Crée un style de point basé sur un cercle

.

Crée un style de point basé sur un cercle

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Argument Description
stroke Object

options style de ligne calqués sur buildStrokeStyleFromLiteral
fill Object

options style de remplissage calqués sur buildFillStyleFromLiteral
args * <optional>

reste des options calqués sur OpenLayer CircleStyle
Source:
Returns:
Type
ol.style.Circle

buildFillStyle(fill)

Crée un style de remplissage

.

Crée un style de remplissage

Parameters:
Name Type Description
fill Object

options calqués sur OpenLayer Fill
Source:
Returns:
Type
ol.style.Fill

buildFillStyleFromLiteral(fill)

Crée un style de remplissage

.

Crée un style de remplissage

Parameters:
Name Type Description
fill Object

options calqués sur OpenLayer Fill
Source:
Returns:
Type
ol.style.Fill

buildGeometryFromLiteral(Type, coordinates, geometries)

créer une geometrie a partir de tableau de coordoonées

.

créer une geometrie a partir de tableau de coordoonées

Parameters:
Name Type Description
Type string

type de géométrie demandée
coordinates Array.<Coordinate>

tableaux de coordonnées
geometries string

tableaux de tableaux de coordonnées pour faire un type géometrieCollection
Source:
Returns:
Type
ol.geom.Geometry

buildIconStyle(icon)

Crée un style de point basé sur une icone (image)

.

Crée un style de point basé sur une icone (image)

Parameters:
Name Type Description
icon Object

options calqués sur OpenLayer Icon
Source:
Returns:
Type
ol.style.Icon

buildIconStyleFromLiteral(icon)

Crée un style de point basé sur une icone (image)

.

Crée un style de point basé sur une icone (image)

Parameters:
Name Type Description
icon Object

options calqués sur OpenLayer Icon
Source:
Returns:
Type
ol.style.Icon

buildLineBreakStyle(options)

Créer le style de ligne brisée

.

Créer le style de ligne brisée

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Default Description
breakStyles Array.<ol.style.stroke>

styles a appliquer dans l'ordre des coupures
breakPointProperty String

nom de la proprieté ou trouver les infos de coupure
breakType 'point' | 'distance' <optional>
 'point'

type de coupure (point uniquement pour l'instant)
breakPointProjection String

projection des points, sinon on utilise la projection de la carte
map ol.map

// instance actuelle de la carte
Source:
Returns:

function

buildOLPattern(color, type)

Permet de hachurer un polygon

.

Permet de hachurer un polygon

Parameters:
Name Type Description
color array | string

Couleur du paterne
type string

Type de paterne
Source:
Returns:

Paterne des hachures

Type
CanvasPattern

buildShapeStyle(literalStyle, @param)

Crée un style de point basé sur une forme

.

Crée un style de point basé sur une forme

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Description
stroke Object

options style de ligne calqués sur buildStrokeStyle
fill Object

options style de remplissage calqués sur buildFillStyle
@param *

[literalStyle.args] reste des options calqués sur OpenLayer RegularShape
Source:
Returns:
Type
ol.style.RegularShape

buildShapeStyleFromLiteral(literalStyle, @param)

Crée un style de point basé sur une forme

.

Crée un style de point basé sur une forme

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Description
stroke Object

options style de ligne calqués sur buildStrokeStyleFromLiteral
fill Object

options style de remplissage calqués sur buildFillStyleFromLiteral
@param *

[literalStyle.args] reste des options calqués sur OpenLayer RegularShape
Source:
Returns:
Type
ol.style.RegularShape

buildStrokeStyle(stroke)

Crée un style de ligne

.

Crée un style de ligne

Parameters:
Name Type Description
stroke stroke

options calqués sur OpenLayer Stroke
Source:
Returns:
Type
ol.style.Stroke

buildStrokeStyleFromLiteral(stroke)

Crée un style de ligne

.

Crée un style de ligne

Parameters:
Name Type Description
stroke stroke

options calqués sur OpenLayer Stroke
Source:
Returns:
Type
ol.style.Stroke

buildStyleFromLiteral(literalStyle)

Permet de convertir un objet litéral représentant un style en objet ol.style.Style pour OpenLayers

.

Permet de convertir un objet litéral représentant un style en objet ol.style.Style pour OpenLayers

Parameters:
Name Type Description
literalStyle Object

Definition du style sous forme d'objet literal

Properties
Name Type Description
fill Object

Definition du remplissage sous forme literal buildFillStyleFromLiteral
Source:
Returns:

Style OpenLayers

Type
ol.style.Style

buildTextStyle(literalStyle)

Crée un style de texte

.

Crée un style de texte

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Argument Description
stroke Object

bordure du texte, options style de ligne calqués sur buildStrokeStyle
fill Object

couleur du texte, options style de remplissage calqués sur buildFillStyle
backgroundStroke Object

boite autour du texte, options style de ligne calqués sur buildStrokeStyle
backgroundFill Object

surlignage du texte, options style de remplissage calqués sur buildFillStyle
args * <optional>

reste des options calqués sur OpenLayer Text
Source:
Returns:
Type
ol.style.Text

buildTextStyleFromLiteral(literalStyle)

Crée un style de texte

.

Crée un style de texte

Parameters:
Name Type Description
literalStyle Object
Properties
Name Type Argument Description
stroke Object

bordure du texte, options style de ligne calqués sur buildStrokeStyleFromLiteral
fill Object

couleur du texte, options style de remplissage calqués sur buildFillStyleFromLiteral
backgroundStroke Object

boite autour du texte, options style de ligne calqués sur buildStrokeStyleFromLiteral
backgroundFill Object

surlignage du texte, options style de remplissage calqués sur buildFillStyleFromLiteral
args * <optional>

reste des options calqués sur OpenLayer Text
Source:
Returns:
Type
ol.style.Text

buildTypedShapeStyle(options, @param)

Helper pour construire un style forme

.

Helper pour construire un style forme

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Default Description
type 'square' | 'triangle' | 'star' | 'cross' | 'diamond' | 'plus' | 'pie' | 'pie3D' | 'bar' | 'donut' <optional>
 "square"

Type de forme a créer, renvoi un cecle si on choisi un style non reconnu
@param *

[options.args] restes des options pour le style choisi
Source:
See:
Returns:
Type
ol.style.RegularShape | ol-ext.style.Chart

buildTypedShapeStyleFromLiteral(options, @param)

Helper pour construire un style forme

.

Helper pour construire un style forme

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Default Description
type 'square' | 'triangle' | 'star' | 'cross' | 'diamond' | 'plus' | 'pie' | 'pie3D' | 'bar' | 'donut' <optional>
 "square"

Type de forme a créer, renvoi un cecle si on choisi un style non reconnu
@param *

[options.args] restes des options pour le style choisi
Source:
See:
Returns:
Type
ol.style.RegularShape | ol-ext.style.Chart

ControlBarLayerVisibility(options, html, icon)

Parameters:
Name Type Description
options Object
Properties
Name Type Description
viewer Object

Instance de kmapviewer
className string

classe de la barre de layers
html Element | string

contenu du bouton
icon string

icone si html non saisie (utilisé comme )
Source:
Returns:

ControlBarLayerBar

Type
object

ControlBarSelectCreate(options)

Creation d'une bar d'outils de selection/creation et de son bouton toggle (a implementer dans une controlbar)

.

Creation d'une bar d'outils de selection/creation et de son bouton toggle (a implementer dans une controlbar)

Parameters:
Name Type Description
options SelectCreateOptions

Options de barre d'outil de selection / creation
Source:
Returns:

ControlBarSelectCreate

Type
Object

convertCoordinates(coordinates, originProjection, destProjection)

Permet de convertir une coordonées dans un autre système de projection

.

Permet de convertir une coordonées dans un autre système de projection

Parameters:
Name Type Description
coordinates Array.<number>

Coordonées en entrées (point, linestring, ...)
originProjection string

Système de projection en entrée
destProjection string

Système de projection en sortie
Source:
Returns:

Coordonées convertis

Type
Array.<number>

convertExtent(extent, originProjection, destProjection)

Permet de convertir une BBOX dans un autre système de projection

.

Permet de convertir une BBOX dans un autre système de projection

Parameters:
Name Type Description
extent ol.Extent

BBox [minx, miny, maxx, maxy]
originProjection string

Système de projection en entrée
destProjection string

Système de projection en sortie
Source:
Returns:

BBox convertis

Type
Array.<number>

convertFeatures(geometry, originProjection, destProjection)

converti des Features OpenLayers vers un systeme

.

converti des Features OpenLayers vers un systeme

Parameters:
Name Type Description
geometry Array.<ol.Feature>

Feature OpenLayers
originProjection string

Système de projection en entrée
destProjection string

Système de projection en sortie
Source:
Returns:

Copie des features reprojeté

Type
Array.<ol.Feature>

convertGeojsonGeometry(geometry, originProjection, destProjection)

converti des géométrie GeoJSON vers

.

converti des géométrie GeoJSON vers

Parameters:
Name Type Description
geometry Geometry

Geométrie Geojson
originProjection string

Système de projection en entrée
destProjection string

Système de projection en sortie
Source:
Returns:

Géométrie convertie

Type
Geometry

createGeometryCollection(geometries)

Créer une GeometryCollection a partir d'un tableau de géométries

.

Créer une GeometryCollection a partir d'un tableau de géométries

Parameters:
Name Type Description
geometries Array.<ol.geom.geometry>

Tableau de géométries
Source:
Returns:

ol.geom.GeometryCollection

createLineString(options)

Créer une ligne

.

Créer une ligne

Parameters:
Name Type Description
options Array.<Array.<number>>

Tableau de coordonnés
Source:
Returns:

ol.geom.LineString

createMultiLineString(options)

Créer une multi-ligne

.

Créer une multi-ligne

Parameters:
Name Type Description
options Array.<Array.<Array.<number>>>

Tableau de coordonnés
Source:
Returns:

ol.geom.LineString

createMultiPoint(options)

Créer un multi-point

.

Créer un multi-point

Parameters:
Name Type Description
options Array.<Coordinate> | Array.<number>

coordonnées
Source:
Returns:

ol.geom.MultiPoint

createPoint(options)

Créer un point

.

Créer un point

Parameters:
Name Type Description
options Array.<number>

coordonnées
Source:
Returns:

ol.geom.Point

createPolygonFromExtent(extent)

Créer un polygone a partir d'une étendue

.

Créer un polygone a partir d'une étendue

Parameters:
Name Type Description
extent Array.<number>

Etendue [minx, miny, maxx, maxy]
Source:
Returns:

ol.geom.Polygon

createSpline(coords, options)

Créer une spline (courbe de bezier) a partir d'un tableau de coordonnées

.

Créer une spline (courbe de bezier) a partir d'un tableau de coordonnées

Parameters:
Name Type Description
coords Array.<number>

Tableau de coordonnées
options Object

options de spline

Properties
Name Type Description
tension Number

a [0,1] number / can be interpreted as the "length" of the tangent, default 0.5
resolution Number

size of segment to split
pointsPerSeg Integer

number of points per segment to add if no resolution is provided, default add 10 points per segment
toCoords boolean

Retourne un tableau points en place d'une ol.geom.LineString
Source:
Returns:

ol.geom.LineString

createSplineBetweenPoints(fromCoordinate, toCoordinate, options)

Créer une spline (courbe de bezier) à partir de deux coordonnées

.

Créer une spline (courbe de bezier) à partir de deux coordonnées

Parameters:
Name Type Description
fromCoordinate Array.<number>

Coordonnée de départ
toCoordinate Array.<number>

Coordonée d'arrivé
options Object

options de spline

Properties
Name Type Description
angle Number

Angle pour l'ajout du point central
fromProjection string

Projection des coordonnées
toProjection string

Projection de la LineString générée
tension Number

a [0,1] number / can be interpreted as the "length" of the tangent, default 0.5
resolution Number

size of segment to split
pointsPerSeg Integer

number of points per segment to add if no resolution is provided, default add 10 points per segment
Source:
Returns:

ol.geom.LineString

createStyle(styleOptions)

Permet d'obtenir un style openlayers en objet ol.style.Style pour OpenLayers

.

Permet d'obtenir un style openlayers en objet ol.style.Style pour OpenLayers

Parameters:
Name Type Description
styleOptions Object | Array

Definition du style sous forme d'objet
Source:
Returns:

Style OpenLayers

Type
ol.style.Style

deaggregateAndAddFeature(feature)

Découper la géométrie de la feature en plein de petite géométrie a placer sur le calque d'édition:

.

Découper la géométrie de la feature en plein de petite géométrie a placer sur le calque d'édition:

Parameters:
Name Type Description
feature ol/feature
Source:

featureToGeoJson(features, originProjection, destProjection)

Permet de convertir des feature en chaine de caractères

.

Permet de convertir des feature en chaine de caractères

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

Features à convertir
originProjection string

Système de projection des données a convertir
destProjection string

Système de projection des features encodée
Source:
Returns:

Features converties

Type
string

featureToGeoJsonObject(features, originProjection, destProjection)

Permet de convertir des feature en objet

.

Permet de convertir des feature en objet

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

Features à convertir
originProjection string

Système de projection des données a convertir
destProjection string

Système de projection des features encodée
Source:
Returns:

Features converties

Type
string

geoJsonToFeature(geoJson, originProjection, destProjection)

Permet de convertir un geoJson en ol.Feature

.

Permet de convertir un geoJson en ol.Feature

Parameters:
Name Type Description
geoJson ArrayBuffer | Document | Element | Object | string

source geoJSON
originProjection string | ol.ProjectionLike

Système de projection du geoJson. Par défaut, geoJson.crs.properties.name
destProjection string | ol.ProjectionLike

Système de projection des features retournées
Source:
Returns:

Features converties

Type
Array.<ol.Feature>

geoJsonToGeometry(geoJson, originProjection, destProjection)

Permet de convertir un geoJson en ol.geom

.

Permet de convertir un geoJson en ol.geom

Parameters:
Name Type Description
geoJson ArrayBuffer | Document | Element | Object | string

source geoJSON
originProjection string | ol.ProjectionLike

Système de projection du geoJson. Par défaut, geoJson.crs.properties.name
destProjection string | ol.ProjectionLike

Système de projection des features retournées
Source:
Returns:

Features converties

Type
Array.<ol.geom>

getAzimuthBetweenCoordinates(fromCoordinate, toCoordinate, coordProjection)

Calcule l'azimuth depuis le nord entre deux coordonées

.

Calcule l'azimuth depuis le nord entre deux coordonées

Parameters:
Name Type Description
fromCoordinate Array.<number>

coordonnée de départ
toCoordinate Array.<number>

coordonnée d'arrivée
coordProjection string
Source:
Returns:

angle en degrée depuis le nord (clockwise)

Type
number

getButtonHtml( [html] [, iconId] [, icon] [, defaultHtml])

Html valide pour un bouton de la toolbar

.

Html valide pour un bouton de la toolbar

Parameters:
Name Type Argument Default Description
html Element | string <optional>

contenu du bouton (priorité 1)
iconId string <optional>

id du d'element du DOM (priorité 2)
icon string <optional>

du bouton (priorité 3)
defaultHtml string <optional>
 ''

texte par défaut (priorité 4)
Source:
Returns:

contenu du bouton

Type
Element | string

getCentroid(featureOrGeom)

Permet de récupérer le centroid d'une feature Les geometries prisent en compte sont Point, Polygon, LineString

.

Permet de récupérer le centroid d'une feature Les geometries prisent en compte sont Point, Polygon, LineString

Parameters:
Name Type Description
featureOrGeom ol.Feature | ol.geom.SimpleGeometry

Feature ou Geometry
Source:
Returns:

Centroid ou false;

Type
Array

getExternalStorageAuthorizationStatus()

Outil pour vérifier qu'un dossier de sd card est bien monté

.

Outil pour vérifier qu'un dossier de sd card est bien monté

Source:

getFeatureFromEvent(evt)

Parameters:
Name Type Description
evt ol.source.Vector.VectorSourceEvent | ol.Collection.CollectionEvent

Event.
Source:
Returns:

Feature.

Type
ol.Feature

getFeatureFromEvent(evt)

Parameters:
Name Type Description
evt ol.source.Vector.VectorSourceEvent | ol.Collection.CollectionEvent

Event
Source:
Returns:

Feature

Type
ol.Feature

getPointForGeometry(geometry [, position])

Permet de retourner uniquement un point pour une géométrie Si ce n'est pas possible, on ne retourne rien .

Permet de retourner uniquement un point pour une géométrie Si ce n'est pas possible, on ne retourne rien .

Parameters:
Name Type Argument Default Description
geometry ol.geom.Geometry

Géométrie à traiter
position 'centroid' | 'start' | 'end' <optional>
 'centroid'

Position du point a retourner
Source:
Returns:

Point ou null

Type
ol.geom.Point | null

getPosition()

Renvois la position du GPS si elle est disponible et différente de la dernière enregistrée

.

Renvois la position du GPS si elle est disponible et différente de la dernière enregistrée

Source:

getResolutionForScale(view, scale [, dpi])

Converti une échelle a atteindre en résolution de carte

.

Converti une échelle a atteindre en résolution de carte

Parameters:
Name Type Argument Default Description
view ol.view

vue de la carte
scale Number

échelle a atteindre
dpi Number <optional>
 25.4 / 0.28

nombre de pixel par pouce (utile pour un pdf)
Source:
Returns:

Number

getScaleForResolution(view, resolution [, dpi] [, round])

Converti une résolution en echelle d'affichage

.

Converti une résolution en echelle d'affichage

Parameters:
Name Type Argument Default Description
view ol.view

vue de la carte
resolution Number

résolution a convertir
dpi Number <optional>
 25.4 / 0.28

nombre de pixel par pouce (utile pour un pdf)
round Boolean <optional>
 false

arrondir le résultat?
Source:
Returns:

Number

getWfsVectorSource(wfsOptions)

Parameters:
Name Type Argument Default Description
wfsOptions Object <nullable>

Option de chargement des données via un service wfs

Properties
Name Type 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
wfs.params.typename string

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

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

version du service WFS
wfsOptions.params.* string

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

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

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

Utiliser une stratégie de chargement par bbox (true) ou par tuile (false). Par défaut false
wfsOptions.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
wfsOptions.cqlFilter string

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

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

VectorSource | Null

getZoomForScale(view, scale [, dpi])

Converti une échelle a atteindre en zoom de carte

.

Converti une échelle a atteindre en zoom de carte

Parameters:
Name Type Argument Default Description
view ol.view

vue de la carte
scale Number

échelle a atteindre
dpi Number <optional>
 25.4 / 0.28

nombre de pixel par pouce (utile pour un pdf)
Source:
Returns:

Number

hexToColor()

fonction pour gérer les couleurs des styles (utilisé par Analyse et sketchlayer)

.

fonction pour gérer les couleurs des styles (utilisé par Analyse et sketchlayer)

Source:

intersectsGeometry(container, geometry, options)

Permet de savoir si une géométrie est partiellement ou totalement inclue dans une autre

.

Permet de savoir si une géométrie est partiellement ou totalement inclue dans une autre

Parameters:
Name Type Description
container Geometry

Géométrie contenante
geometry Geometry

Géométrie contenue
options Object

Options

Properties
Name Type Description
fullyInside boolean

Doit être intégralement dans le conteneur
Source:

isSplitPossible(feature)

Est-ce que cette feature peut-être découpée?

.

Est-ce que cette feature peut-être découpée?

Parameters:
Name Type Description
feature Feature
Source:
Returns:

est-ce que la feature peut être découpée

isUnionPossible(features)

Est-ce que ces features peuvent avoir une union?

.

Est-ce que ces features peuvent avoir une union?

Parameters:
Name Type Description
features Array.<Feature>
Source:
Returns:

Boolean

loadProjections(projections)

Enregistre des nouvelles projections en mémoire

.

Enregistre des nouvelles projections en mémoire

Parameters:
Name Type Description
projections Array.<Object>
projection[].name string

Nom de la projection (EPSG:4326)
projection[].projection string

Définition proj4 (exemple https://epsg.io/27562)
Source:

matchPredicate(predicateType, predicateValues, value)

Evalue une condition (prédicat) pour une valeur donnée Renvoie true ou false

.

Evalue une condition (prédicat) pour une valeur donnée Renvoie true ou false

Parameters:
Name Type Description
predicateType

Type de prédicat (opérateur)
predicateValues

Valeurs possibles pour le type de prédicat (simple valeur ou tableau de valeurs)
value

Valeur à tester
Source:

onClickAddFeatureTemplate()

Ajout d'une multigéométrie a partir d'un template

.

Ajout d'une multigéométrie a partir d'un template

Source:

onClickAddPoint()

Ajout d'un un point temporaire pour la triangulation

.

Ajout d'un un point temporaire pour la triangulation

Source:

onClickSelectAll()

Sélectionne tous les morceaux de feature de la feature en cours d'edition

.

Sélectionne tous les morceaux de feature de la feature en cours d'edition

Source:

onClickTransform()

Choisi un des modes de d'edition d'une feature

.

Choisi un des modes de d'edition d'une feature

Source:

<async> pathExist(path)

Vérifie que le dossier est bien monté dans une sd-car via cordova

.

Vérifie que le dossier est bien monté dans une sd-car via cordova

Parameters:
Name Type Description
path string
Source:
Returns:
Type
boolean

recordPosition()

Enregistre la position

.

Enregistre la position

Source:

removeResource(resourceType, resourceId [, removeTokenManagerIfNoResource])

Retire une source de la liste des resources utilisant un token manager, si plus aucune resource n'utilise ce token manager, on le supprime

.

Retire une source de la liste des resources utilisant un token manager, si plus aucune resource n'utilise ce token manager, on le supprime

Parameters:
Name Type Argument Default Description
resourceType String

type de resource (layer, control, service...)
resourceId String

identifiant de la resource
removeTokenManagerIfNoResource Boolean <optional>
 false

indique si le token manager doit être supprimé si aucune ressource ne l'utilise
Source:

removeTokenSource(tokenOptions)

supprime un token manager et toutes les resources qui l'utilisent

.

supprime un token manager et toutes les resources qui l'utilisent

Parameters:
Name Type Description
tokenOptions tokenOptions | String

options de gestion du token ou token en clair (historique)
Source:
Returns:
Type
Boolean

splitFeature(options)

Lance le découpage de la feature

.

Lance le découpage de la feature

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
feature Feature
viewer Viewer

instance active du viewer
toolId string <optional>

Outil qui demande la découpe
snapOptions object <optional>

options de snap (doc TODO)
Source:
Returns:

les features crées, null si aucune n'a été créé

tokenSourceExists(tokenOptions)

Est-ce que la clé de token manager existe déjà?

.

Est-ce que la clé de token manager existe déjà?

Parameters:
Name Type Description
tokenOptions tokenOptions | String

options de gestion du token ou token en clair (historique)
Source:
Returns:
Type
Boolean

unByKey(listener)

Permet de ne plus ecouter un event

.

Permet de ne plus ecouter un event

Parameters:
Name Type Description
listener Listener

clé renvoyées par on ou once
Source:

union(features)

Effectue l'union de feature

.

Effectue l'union de feature

Parameters:
Name Type Description
features Array.<Feature>
Source:
Returns:

ol-feature

zoomByDelta_()

Zoom avant ou arrière

.

Zoom avant ou arrière

Source:

zoomToExtent_()

Zoom sur une étendue renvoyée par une fonction fournie a l'initialisation

.

Zoom sur une étendue renvoyée par une fonction fournie a l'initialisation

Source:

Type Definitions

ClearButton

Type:
  • Object
Properties:
Name Type Argument Description
html Element | string <optional>

contenu du bouton (priorité 1)
iconId string <optional>

id du d'element du DOM (priorité 2)
icon string <optional>

du bouton (priorité 3)
title string <optional>

tooltip du bouton clear

Options supplémentaire pour l'ajout de la barre de selection
Source:

Mapviewer

Type:
  • Object
Source:

Mapviewer

Type:
  • Object
Source:

tokenOptions

paramètre de type tokenOption

.

paramètre de type tokenOption

Type:
  • Object
Properties:
Name Type Argument Default Description
type String

Type de token (TOKEN, LOCALSTORAGE, URL, FUNCTION)
tokenKey String <optional>
 'token'

Le nom de la clé à utiliser dans l'url pour envoyer le token (défaut 'token')
refreshInterval Number <optional>

Intervalle de rafraichissement du token en ms (optionnel)
token String <optional>

Le token (si type TOKEN)
path String <optional>

Le path en localstorage (si type LOCALSTORAGE)
url String <optional>

L'url à appeler pour récupérer le token (si type URL)
method String <optional>

La méthode d'appel (GET, POST, PUT, DELETE) (si type URL) (défaut POST)
data Object <optional>

Les données à envoyer (si type URL)
headers Object <optional>

Les headers à envoyer (si type URL)
tokenName String <optional>

Le nom de la propriété dans la réponse qui contient le token (si type URL)
auth Object <optional>

Les informations d'authentification {username, password} (si type URL)
tokenCallback function <optional>

La fonction à appeler pour récupérer le token (si type FUNCTION)
Source: