Karteis Mapviewer

Class: CommonLayer

commonLayer~ CommonLayer

Service de gestion générique des couches

new CommonLayer()

Source:

Members

ctx :module:core~default

instance du viewer

.

instance du viewer

Type:
  • module:core~default
Source:

propertiesName

propriétés additionelles des calques

.

propriétés additionelles des calques

Source:

Methods

addGroup(options)

ajoute un groupe a la carte

.

ajoute un groupe a la carte

Parameters:
Name Type Description
options Object

Paramètres compatibles ol.layer.group
Source:

addLayer(layer, type, ui)

Ajout un layer sur la carte

.

Ajout un layer sur la carte

Parameters:
Name Type Description
layer ol.Layer

Layer à ajouter dans la carte
type String

Type du layer
ui Object

é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 )
Source:

createMapMode(options)

Ajoute un mode de carte

.

Ajoute un mode de carte

Parameters:
Name Type Description
options Object
Properties
Name Type Description
name string

nom
interactions Array.<ol.interaction>
controls Array.<ol.control>
onactive function
oninactive function
isDefault Boolean
Source:

downLayer(id, type)

Permet de descendre d'un niveau un layer

.

Permet de descendre d'un niveau un layer

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:
Returns:

Retourne True si le layer n'est pas au plus bas

Type
Boolean

getGroup(idGroup)

Renvoit un groupe par son id

.

Renvoit un groupe par son id

Parameters:
Name Type Description
idGroup string

Id du groupe
Source:

getGroups()

Renvoit tout les groupes présents dans la carte

.

Renvoit tout les groupes présents dans la carte

Source:

getLayer(id, type)

Récupère un layer

.

Récupère un layer

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:
Returns:

Layer

Type
ol.layer.Layer

getLayerGroup(layer)

renvoit le groupe d'un calque

.

renvoit le groupe d'un calque

Parameters:
Name Type Description
layer ol.layer

Calque OpenLayer
Source:
Returns:

group

getLayerInfos(layer)

renvois les infos de type et d'id du calque

.

renvois les infos de type et d'id du calque

Parameters:
Name Type Description
layer ol.layer
Source:
Returns:

Type et Id du calque

Type
Object

getLayers(type)

Récupère la liste des layers existant

.

Récupère la liste des layers existant

Parameters:
Name Type Description
type String

Type du layer
Source:
Returns:

Liste de layers

Type
Array.<ol.Layer>

getLayersId(type)

Retourne la liste des identifiants des layers

.

Retourne la liste des identifiants des layers

Parameters:
Name Type Description
type String

Type du layer
Source:
Returns:

Liste des identifiants des layers

Type
Array.<String>

getSource(id, type)

Permet de récupérer la source d'un layer

.

Permet de récupérer la source d'un layer

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Layer
Source:
Returns:

Source du layer

Type
ol.source.Source

hideLayer(id, type)

Permet de masquer un layer

.

Permet de masquer un layer

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:

isGroup(groupOrLayer)

Est ce que l'entrée est un calque ou un groupe?

.

Est ce que l'entrée est un calque ou un groupe?

Parameters:
Name Type Description
groupOrLayer ol.layer | ol.layer.group
Source:
Returns:

l'entrée est un calque ou un groupe ?

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 | Number

Identifiant du layer
Source:
Returns:

True si visible

Type
Boolean

layerChanged(id, type)

Permet de notifier au layer qu'il à changé

.

Permet de notifier au layer qu'il à changé

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:

layerExist(id, type)

Permet de savoir si un layer existe

.

Permet de savoir si un layer existe

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:
Returns:

True si le layer existe

Type
Boolean

refreshLayer(id, type)

Force un nouveau rendu du layer sur la carte Refreshes the source.

Force un nouveau rendu du layer sur la carte Refreshes the source. The source will be cleared, and data from the server will be reloaded.

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:

removeLayer(id, type)

Retire un layer de la carte

.

Retire un layer de la carte

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:
Fires:
  • removeLayer:id Lancé avant la suppression
  • removedLayer:id Lancé après la suppression

showLayer(id, type)

Permet d'afficher un layer

.

Permet d'afficher un layer

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:

updateCommonProperties(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:

upLayer(id, type)

Permet de remonter d'un niveau un layer

.

Permet de remonter d'un niveau un layer

Parameters:
Name Type Description
id String | Number

Identifiant du layer
type String

Type du layer
Source:
Returns:

Retourne true si le layer n'est pas au plus haut

Type
Boolean