Karteis Mapviewer

Class: ControlBar

ControlBar

new ControlBar(options, hideOnMapMode)

surcharge de olext bar afin de simplifier son utilisation

.

surcharge de olext bar afin de simplifier son utilisation

Parameters:
Name Type Description
options Object

Options compatible ol-ext ol.control.bar surchargé de buttonList
hideOnMapMode Array.<string>

Cache la toolbar si un de ces modes de carte est lancé
options.buttonList Array.<btnOption>
btnOption.type String

Type de bouton (control, button, toggle, textButton)
btnOption.control Object

[control] ol.control valide
btnOption.className String

[button,toggle,textButton] classe du bouton
btnOption.title String

[button,toggle,textButton] titre du bouton
btnOption.icon String

[button,toggle] icon du bouton
btnOption.iconId String

[button,toggle] icon du bouton
btnOption.text String

[textButton] texte du bouton
btnOption.html String

[button,toggle,textButton][remplace icon ou text] contenu html
btnOption.onClick function

[button,toggle,textButton] fonction a appeler au click
btnOption.handleClick function

[button,textButton]remplace onClick] fonction a appeler au click
btnOption.onToggle function

[toggle][remplace onClick] fonction a appeler au toggle (or use change:active event)
btnOption.interaction ol.interaction

[toggle] interaction associée au controle
btnOption.active bool

[toggle] the control is created active, default false
btnOption.disable bool

[toggle] the control is created disabled, default false
btnOption.bar Bar

[toggle] a subbar associated with the control (drawn when active if control is nested in a ol.control.Bar)
btnOption.autoActive bool

[toggle] the control will activate when shown in an ol.control.Bar, default false
Source:

Methods

addBookMark(options)

Bookmark positions on ol maps.

Bookmark positions on ol maps.

Parameters:
Name Type Description
options

Geobookmark's options

Properties
Name Type Argument Default Description
className string

default ol-bookmark
title string | undefined

Title to use for the button tooltip, default "Geobookmarks"
placeholder string

input placeholder, default Add a new geomark...
deleteTitle string <optional>
 'Suppr.'

title for delete buttons
editable bool

enable modification, default true
namespace string

a namespace to save the boolmark (if more than one on a page), default ol
marks Array.<any>

a list of default bookmarks:
Source:

addButton(Object)

Parameters:
Name Type Description
Object option
option.type String

Type de bouton (control, button, toggle, textButton)
option.control Object

[control] ol.control valide
option.className String

[button,toggle,textButton] classe du bouton
option.title String

[button,toggle,textButton] titre du bouton
option.icon String

[button,toggle] icon du bouton
option.text String

[textButton] texte du bouton
option.html String

[button,toggle,textButton][remplace icon ou text] contenu html
option.onClick function

[button,toggle,textButton] fonction a appeler au click
option.handleClick function

[button,textButton]remplace onClick] fonction a appeler au click
option.onToggle function

[toggle][remplace onClick] fonction a appeler au toggle (or use change:active event)
option.interaction ol.interaction

[toggle] interaction associée au controle
option.active bool

[toggle] the control is created active, default false
option.disable bool

[toggle] the control is created disabled, default false
option.bar ol.control.Bar

[toggle] a subbar associated with the control (drawn when active if control is nested in a ol.control.Bar)
option.autoActive bool

[toggle] the control will activate when shown in an ol.control.Bar, default false
Source:
Returns:
Type
ol.control.Button

addControlBar()

non implementé

.

non implementé

Source:

addCopyMapButton(options)

Ajoute le bouton de copie de la carte vers le presse papier

.

Ajoute le bouton de copie de la carte vers le presse papier

Parameters:
Name Type Description
options 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)
imageType string

A string indicating the image format, default image/png
quality number

Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp
orientation string

Page orientation (landscape/portrait), default guest the best one
immediate boolean

force print even if render is not complete, default false
Source:

addExportMapButton(options)

Ajoute le bouton d'export de la carte vers une image

.

Ajoute le bouton d'export de la carte vers une image

Parameters:
Name Type Description
options 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)
imageType string

A string indicating the image format, default image/png
quality number

Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp
orientation string

Page orientation (landscape/portrait), default guest the best one
immediate boolean

force print even if render is not complete, default false
filename string

Nom de fichier
Source:

addGroup()

non implementé

.

non implementé

Source:

addSearchControl(options)

Paramètre de recherche PostFilter

.

Paramètre de recherche PostFilter

Parameters:
Name Type Description
options Object

Options de création du contrôle de recherche

Properties
Name Type Argument Default Description
provider 'ban' | 'photon' | 'wfs' <optional>
 ban

Nom du fournisseur pour la recherche
reverse boolean <optional>
 false

Affiche un outil de géocodage inverse d'adresse
reverseTitle string <optional>
 Cliquer sur la carte...

Titre à afficher sur le tooltip du bouton de géocodage inverse
position boolean <optional>
 true

Priorise les résultats près du centre de la carte affichée
label string <optional>
 Rechercher

Libellé affiché pour la zone de recherche
placeholder string <optional>
 Rechercher une adresse

Placeholder de la zone de recherche
maxItems integer <optional>
 10

Nombre de résultats affichés classés par score
limit integer <optional>
 10

Nombre de résultats recherchés (utile lorsque l'on va appliquer un filtre)
typing number <optional>
 500

le délais en ms pour lancer la recherche après une saisie utilisateur
minLength integer <optional>
 3

la longueur de la chaine de recherche à partir de laquelle lancer la recherche
resultZoom integer <optional>
 16

Zoom minimal à appliquer lors de la localisation sur la carte d'un résultat
citycodes Array.<string> <optional>
 []

Liste de code insee sur lesquels on va lancer la recherche (attention, une requête sera réalisée par code insee)
postfilters Array.<PostFilter> <optional>
 []

Liste des filtres à appliquer sur les résultats (attention, il est possible qu'aucun résultat ne s'affiche)
wfsSources Array.<WfsSource> <optional>
 []

Options de recherche pour le type wfs en cascade (dans l'ordre du tableau)
Properties:
Name Type Argument Description
type 'citycode' | 'postalcode' | 'city' | 'context'

type de filtre (seul les types 'citycode' et 'postalcode' sont pris en charge)
values Array.<(string|number)>

liste des valeurs que l'on accepte

Paramètre de recherche WfsSource
name String

type de filtre
wfs Object

Paramère générale de la source

Properties
Name Type Argument Default Description
url string

Url du service
version string <optional>
<nullable>
 1.0.0

version du service
featureNS string

Namespace (a retrouver avec getCapabilities)
featurePrefix string

prefix de la source a interroger
featureTypes Array.<string>

// liste des couches a interroger
searchIn Array.<string>

// recherche ce que l'utilisateur va taper dans ces champs
prefilter Object

préfiltrage sur une des propriétée

Properties
Name Type Description
key string | Array

Nom du champ que l'on préfiltre, on peut utiliser une valeur, une liste de valeur ou un mot clé pour utiliser un résultat précédent (code_dep: "94" ou code_insee: ['94041','94081','94046','94002'] ou code_dep: 'PREVIOUS_RESULT.commune.code_dep' ou code_com: 'PREVIOUS_RESULT.commune.<%= code_insee.slice(2) %>')
value string | Array

nom du champ ou des champs a retourner (pour utiliser dans la cascade)
display string

libellé a afficher dans la liste
placeholder string <nullable>

surcharge du placeholder de la zone de recherche pour cette étape
geometryName string <nullable>

nom de la propriété géométrie (utilisé pour filtre bbox ou lors du zoom vers une feature)
useBbox boolean <nullable>

tente d'utiliser la bbox du résultat fin le plus proche comme filtre, geometryName est nécessaire
minLength number <nullable>

surcharge du nombre de caractère minimum a taper pour cette étape

Permet d'ajouter un contrôle de recherche
Source:

addSelectCreateBar(options)

Ajoute la bar de création/sélection sur la controlbar

.

Ajoute la bar de création/sélection sur la controlbar

Parameters:
Name Type Description
options SelectCreateOptions

Options de barre d'outil de selection / creation
Source:
Example
returns ajoute la sous-barre de création-selection a cette barre d'outil
mapviewer.horizontalToolbar.addSelectCreateBar({
  "className": "audit-edit-bar",
  "allowChangeSelectMode":true
  "clearButton": { // paramètre optionnels du bouton de clear sélection
      "icon": null, // voir getButtonHtml
      "html": "<i class=\\" q - icon map - tool - icon material - icons \\ ">not_interested</i>",
      "title": "Effacer la sélection"
  },
  "tools": [{ // liste des outils a afficher
          "type": "select",
          "toolId": "select-single", // sera renvoyé lors de la levé de l'event change:selection
          "html": "<i class=\\" q - icon map - tool - icon material - icons \\ ">touch_app</i>",
          "title": "Outil de sélection"
      }, {
          "type": "select",
          "toolId": "select-and-edit",
          "html": "<i class=\\" q - icon map - tool - icon material - icons \\ ">edit</i>",
          "title": "Editer",
      },
      { // separateur dans la barre d'outils
          "type": "separator"
      }, { // exemple d'un outil de création
          "toolId": "create-EQU", // sera renvoyé lors de la levé de l'event createfeature:create
          "idFeature" : "efefef-1234",
          "properties" : {test:1},
          "title": "Créer un Equipement",
          "type": "create",
          "iconId": "map-create-icon-create-EQU", // voir getButtonHtml
          "icon": "mdi-network",
          "options": {
              "geometryType": "GeometryCollection", // type de geometrie a créer (type geojson)
              "idLayer": "features-EQU", // calque ou créer la geométrie
              "digitalizeOptions": { // options de l'outil de digitalisation
                  "showConstructionPoint": true,
                  "maxPoints" : 5,
                  "showConstructionLine" : true,
              },
              "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"
                          }
                      },
                  ]
              }
          }
      }
  ]
})

addTriangulationTool(options)

Ajoute le bouton de sélection triangle

.

Ajoute le bouton de sélection triangle

Parameters:
Name Type Description
options 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)
snapOptions object <optional>

options de snap (doc TODO)
Source:

addZoomBox(options)

Ajoute le bouton de zoom rectangle a la toolbar

.

Ajoute le bouton de zoom rectangle a la toolbar

Parameters:
Name Type Description
options 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)
Source:

buildButtons(buttonList)

construit des boutons suivant les parametre suivant

.

construit des boutons suivant les parametre suivant

Parameters:
Name Type Description
buttonList Array.<btnOption>
btnOption.type String

Type de bouton (control, button, toggle, textButton)
btnOption.control Object

[control] ol.control valide
btnOption.className String

[button,toggle,textButton] classe du bouton
btnOption.title String

[button,toggle,textButton] titre du bouton
btnOption.icon String

[button,toggle] icon du bouton
btnOption.iconId String

[button,toggle] icon du bouton
btnOption.text String

[textButton] texte du bouton
btnOption.html String

[button,toggle,textButton][remplace icon ou text] contenu html
btnOption.onClick function

[button,toggle,textButton] fonction a appeler au click
btnOption.handleClick function

[button,textButton]remplace onClick] fonction a appeler au click
btnOption.onToggle function

[toggle][remplace onClick] fonction a appeler au toggle (or use change:active event)
btnOption.interaction ol.interaction

[toggle] interaction associée au controle
btnOption.active bool

[toggle] the control is created active, default false
btnOption.disable bool

[toggle] the control is created disabled, default false
btnOption.bar ol.control.Bar

[toggle] a subbar associated with the control (drawn when active if control is nested in a ol.control.Bar)
btnOption.autoActive bool

[toggle] the control will activate when shown in an ol.control.Bar, default false
Source:
Returns:

Array<ol.control.Control>

getControlByName(name)

Renvoit un controle de la toolbar

.

Renvoit un controle de la toolbar

Parameters:
Name Type Description
name string
Source:
Returns:

control

Type
ol.control

removeControl(name)

Supprime un control de la bar

.

Supprime un control de la bar

Parameters:
Name Type Description
name string

control name utilisé lors de l'initialisation du control
Source:

removeSelectCreateBar()

Supprime la bar de création/sélection de la controlbar

.

Supprime la bar de création/sélection de la controlbar

Source:

updateControlHtml()

Met a jour le html d'un control

.

Met a jour le html d'un control

Source:

updateControlIcon()

Met a jour l'icone

.

Met a jour l'icone

Source: