CUB.Layer.Dynamic
Classe

Couche dynamique

Hérite de CUB.Layer

CUB.Layer.Dynamic - résumé
Attributs du constructeur	Nom du constructeur et description
	CUB.Layer.Dynamic(name, url, options) Crée une nouvelle couche dynamique

Membres - résumé
Attributs de membre	Nom des membres et description
	cursorOver Nom du curseur à utiliser pour le survol d'un objet de la couche (false ou null pour désactiver)
<static>	CUB.Layer.Dynamic.layers Couches dynamique de la carte
	layerType Type de la couche.
	selectable Décrit si la couche est sélectionnable.
	style Renvoie ou définit le style par défaut des objets de la couche
	styleOver Renvoie ou définit le style des objets lorsqu'ils sont survolés par la souris.
	styleSelected Renvoie ou définit le style de sélection.
	symbolGrid La taille de la grille pour grouper les entités.
Membres hérités de CUB.Layer:
	error Erreur sur la couche
	errorText Description explicite de l'erreur le cas échéant
	name Nom de la couche
	projections Liste des projections supportées par la source de données et utilisables dans l'API
	state État de la couche
Membres hérités de CUB.Class:
	isAbstract True si la classe est abstraite (c'est-à-dire qu'elle ne peut pas être instanciée)
	isSingleton True si la classe est un singleton (c'est-à-dire une classe statique)
	namespace Type de base de l'objet
	type Nom de la classe

Méthodes - résumé

Attributs de méthode	Nom des méthodes et description
	clearSelection(entities) Désélectionne toutes les entités de la couche
	createEntity(options) Crée une entité vide dans la couche
	findCircle(Point, Distance) Recherche toutes les entités de la couche dans un rayon distance autour de position
	geometryType() Renvoie le type de géométrie de la couche
	getEntities() Renvoie toutes les entités de la couche
	getEntitiesCount() Renvoie le nombre d'entités de la couche
<static>	CUB.Layer.Dynamic.getLayerByName(name) Retourne une couche dynamique à partir de son nom
	getSelection() Renvoie toutes les entités de la couche qui sont sélectionnées
<inner>	onEntityRender(obj)
	redraw() Force le redessin de la couche
	removeAll() Supprime toutes les entités de la couche
	updateStyles() Met à jour les objets de la carte avec les styles de la couche.
Méthodes héritées de CUB.Layer:
	bringToBack() Positionne la couche au dessous des autres couches du même type
	bringToFront() Positionne la couche au dessus les autres couches du même type
	destroy() Détruit la couche et la retire de la carte
	disable() Rend la couche invisible et inactive
	enable() Rend la couche visible et active
	isEnabled() Retourne la visibilité de la couche
	isProjSupported(Projection) Teste si la projection passée en paramètre est supportée par la couche
	maxScaledenom() Renvoie ou définit le dénominateur de l'échelle maximum d'apparition de la couche.
	minScaledenom() Renvoie ou définit le dénominateur de l'échelle minimum d'apparition de la couche.
	toggle() Inverse la visibilité de la couche (Rend la couche visible si elle est invisible, invisible si elle est visible)
	zOrder(index) Change la profondeur de la couche par rapport aux autres couches du même type.
Méthodes héritées de CUB.Class:
	internal() Méthode interne. Ne pas utiliser.
	toString()

Évènements - résumé
Pour attacher une fonction à un évènement, procéder comme ceci :
CUB.evenement = function(a, b, c) { ... }
Attributs de l'évènement	Nom de l'évènement et description
	onEntityRender = function(entity, style, render_type) { ... } Évènement déclenché avant le rendu de chaque entité, que ce soit un rendu par défaut, de survol ou de sélection.
	onEntityRenderDefault = function(entity, style) { ... } Évènement déclenché avant le rendu de chaque entité.
	onEntityRenderOver = function(entity, style) { ... } Évènement déclenché avant le rendu du survol d'une entité.
	onEntityRenderSelect = function(entity, style) { ... } Évènement déclenché avant le rendu de la sélection d'une entité.
	onSelect = function(entity) { ... } Évènement déclenché à la sélection d'un objet
Évènements hérités de CUB.Layer:
	onDestroy() Fonction appelée lors de la destruction de la couche
	onLoadEnd(time) Fonction appelée à la fin du chargement des données
	onLoadStart() Fonction appelée au début du chargement des données

Détail de CUB.Layer.Dynamic

CUB.Layer.Dynamic(name, url, options)

Crée une nouvelle couche dynamique

Parameters:

{String} name Optional, Default: ""

Nom de la couche à créer

{String} url Optional, Default: null

URL d'origine des données à afficher sur la couche. Null si layerType = CUB.Layer.Dynamic.layerType.RAW

{Object/String} options Optional, Default: null

options de création de la couche. La majorité des attributs de la couche peut-être définie dans les options. Peut-être directement le nom de la couche WFS dans le cas d'une couche de ce type

options.projection {CUB.projections} : Projection source des données. Si non précisé, la projection est lue à partir de la données source si possible. Peut permettre de forcer une projection d'un serveur WFS si la projection réelle courante n'est pas supportée par celui-ci

Si layerType = CUB.Layer.Dynamic.layerType.WFS :

options.layerName {String} : Nom WFS attendu par le serveur, de la couche à afficher
options.loadAllAtOnce {Boolean} : Si true, la totalité des objets de la couche est chargée une fois. Si false, seuls les objets dans l'étendue visible de la vue seront chargés, et ce à chaque zoom. Défault : false
options.symbolGrid {Int} : Taille de la grille pour grouper les entités. Défault : 0
options.attributes {[String]} : Tableau des attributs à conserver dans la couche lors du chargement. Si non précisé, tous les attributs seront chargés.

Détail des membres

cursorOver

Nom du curseur à utiliser pour le survol d'un objet de la couche (false ou null pour désactiver)

Default Value:: 'pointer'

<static> {[CUB.Layer.Dynamic]} CUB.Layer.Dynamic.layers

Couches dynamique de la carte

layerType

Type de la couche. Si omis à la création de la couche, le type sera automatiquement détecté.

selectable

Décrit si la couche est sélectionnable. Si false, les attributs styleSelected et styleOver sont ignorés

Default Value:: false

{CUB.Style} style

Renvoie ou définit le style par défaut des objets de la couche

{CUB.Style} styleOver

Renvoie ou définit le style des objets lorsqu'ils sont survolés par la souris. Si non renseigné à la création de la couche, prendra le même style que le style par défaut si celui-ci est renseigné

{CUB.Style} styleSelected

Renvoie ou définit le style de sélection. Si non renseigné à la création de la couche, prendra le même style que le style par défaut si celui-ci est renseigné

symbolGrid

La taille de la grille pour grouper les entités. Défault : 0.

Détail des méthodes

clearSelection(entities)

Désélectionne toutes les entités de la couche

Parameters:

{[CUB.Entity]} entities Optional, Default: null

Entité ou tableau d'entité à ne PAS déselectionner
createEntity(options)

Crée une entité vide dans la couche

Parameters:

{Object} options Optional, Default: null

options de création de l'entité. La majorité des attributs de peut-être définie dans les options.
options.geometry {CUB.Geometry} : Géométrie de l'entité

Returns:

L'entité créée
{[CUB.Entity]} findCircle(Point, Distance)

Recherche toutes les entités de la couche dans un rayon distance autour de position

Parameters:

{CUB.Position} Point

central de recherche

{Int} Distance

de recherche autour du point
{CUB.Entity.geomType} geometryType()

Renvoie le type de géométrie de la couche
{[CUB.Entity]} getEntities()

Renvoie toutes les entités de la couche
{[Int]} getEntitiesCount()

Renvoie le nombre d'entités de la couche
<static> {CUB.Layer.Dynamic} CUB.Layer.Dynamic.getLayerByName(name)

Retourne une couche dynamique à partir de son nom

Parameters:

{String} name

Nom de la couche à chercher

Returns:

La couche, null sinon
{[CUB.Entity]} getSelection()

Renvoie toutes les entités de la couche qui sont sélectionnées
<inner> onEntityRender(obj)

Parameters:

obj
{void} redraw()

Force le redessin de la couche
{[CUB.Entity]} removeAll()

Supprime toutes les entités de la couche
{CUB.Style} updateStyles()

Met à jour les objets de la carte avec les styles de la couche. À utiliser après avoir changé les attributs des styles

Détail des évènements

onEntityRender = function(entity, style, render_type) { ... }

Évènement déclenché avant le rendu de chaque entité, que ce soit un rendu par défaut, de survol ou de sélection. Cet évènement est le regroupement des trois évènements onEntityRenderDefault, onEntityRenderOver et onEntityRenderSelect. Le style peut être modifié pour personnaliser le rendu de l'entité.

Parameters:
{CUB.Entity} entity: Entité qui va être rendue
{CUB.Style} style: Style qui va être utilisé pour le rendu
{String} render_type: Type de rendu. Peut-être 'default', 'over' ou 'select'

onEntityRenderDefault = function(entity, style) { ... }

Évènement déclenché avant le rendu de chaque entité. Le style peut être modifié pour personnaliser le rendu de l'entité.

Parameters:
{CUB.Entity} entity: Entité qui va être rendue
{CUB.Style} style: Style qui va être utilisé pour le rendu

onEntityRenderOver = function(entity, style) { ... }

Évènement déclenché avant le rendu du survol d'une entité. Le style peut être modifié pour personnaliser le rendu de l'entité.

Parameters:
{CUB.Entity} entity: Entité qui est survolée
{CUB.Style} style: Style qui va être utilisé pour le rendu de l'entité survolée

onEntityRenderSelect = function(entity, style) { ... }

Évènement déclenché avant le rendu de la sélection d'une entité. Le style peut être modifié pour personnaliser le rendu de l'entité.

Parameters:
{CUB.Entity} entity: Entité qui est survolée
{CUB.Style} style: Style qui va être utilisé pour le rendu de l'entité survolée

onSelect = function(entity) { ... }

Évènement déclenché à la sélection d'un objet

Parameters:
{CUB.Entity} entity: Entité sélectionnée