MAPDISPLAY
Voir égalementGère le fonctionnement d'un contrôle carte dans l'IHM.
Support WebVue partiel. Voir le tableau avec la liste des modes ci-dessous. Les modes non supportés renvoient un code d'erreur si exécutés dans ce contexte.
| Mode | Mnémonique | Syntaxe | Support WebVue |
| 1 | LOADDEFAULT | 1 | Non |
| 2 | CENTERTOMARKER | 2 | Oui |
| 3 | GETZOOM | 3 | Non |
| 4 | SETZOOM | 4 | Oui |
| 5 | GETLATITUDE | 3 | Non |
| 6 | SETLATITUDE | 4 | Oui |
| 7 | GETLONGITUDE | 3 | Non |
| 8 | SETLONGITUDE | 4 | Oui |
| 9 | EXPORT | 5 | Non |
| 10 | LOADMARKERS | 6 | Non |
| 11 | ISLAYERDISPLAYED | 7 | Non |
| 12 | SETLAYERVISIBILITY | 8 | Oui |
| 13 | GETMARKERLATITUDE | 9 | Non |
| 14 | SETMARKERLATITUDE | 10 | Non |
| 15 | GETMARKERLONGITUDE | 9 | Non |
| 16 | SETMARKERLONGITUDE | 10 | Non |
| 17 | GETMARKERTOOLTIP | 11 | Non |
| 18 | SETMARKERTOOLTIP | 10 | Non |
| 19 | GETMARKERMIMIC | 11 | Non |
| 20 | SETMARKERMIMIC | 12 | Non |
| 21 | GETMARKERBRANCH | 11 | Non |
| 22 | SETMARKERBRANCH | 12 | Non |
| 23 | GETMARKERTYPE | 13 | Non |
| 24 | GETUSERDATAVARNAME | 14 | Non |
| 25 | GETUSERDATALABEL | 14 | Non |
| 26 | SETUSERDATALABEL | 15 | Non |
| 27 | GETUSERDATAVALUE | 14 | Non |
| 28 | SETUSERDATAVALUE | 15 | Non |
| 29 | ISLOADING | 16 | Non |
| 30 | GETMARKERVISIBILITY | 17 | Non |
| 31 | SETMARKERVISIBILITY | 10 | Non |
| 32 | SETMAPPROVIDER | 18 | Non |
Les modes associées aux marqueurs de carte (2, et de 11 à 28 inclus) généreront une erreur s'ils sont exécutés lorsque le fichier de marqueurs est toujours en chargement.
Propriétés communes à tous les modes
|
Argument |
Définition |
| Window | Nom de la fenêtre contenant le Contrôle carte. Type STR |
| Branch | Branche de la fenêtre contenant le Contrôle carte. Type STR. |
| MapID | Identifiant du Contrôle carte (dans la fenêtre). Type STR |
| LayerName | Identifiant d'un calque de marqueurs. Type STR. |
| MarkerName | Identifiant d'un marqueur. Type STR. |
| ViewIndex | Index de la vue (débutant à 1) s'il y a plus d'une vue de la fenêtre (synoptique) ouverte dans la même région. Optionnel. |
| Value | Nouvelle valeur pour la propriété de la carte. Le type dépend du contexte : INTEGER, DOUBLE ou STR. |
Syntaxe 1
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 1 | LOADDEFAULT |
Réinitialise les propriétés d'exécution du contrôle carte à ses valeurs par défaut, y compris le rechargement du fichier GPX (marqueurs de carte). Retour : 1 si OK, 0 sinon. |
Syntaxe 2
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName[, ViewIndex]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 2 | CENTERTOMARKER |
Centre une carte sur un marqueur donné. Si le marqueur est multipoints (tracé ou polygone), la carte est centrée sur le premier point de l'objet. Si LayerName est vide, le calque par défaut est utilisé. Retour : 1 si OK, 0 sinon. |
Syntaxe 3
DblVal = MAPDISPLAY (Mode, Window, Branch, MapID[, ViewIndex]);
Type de retour : DOUBLE.
Exécution
|
Mode |
Mnémonique |
Action |
| 3 | GETZOOM |
Retourne le niveau de zoom de la carte. Retour : Le niveau de zoom. |
| 5 | GETLATITUDE |
Retourne la latitude du centre de la carte en utilisant le système WGS84. Retour : la latitude. |
| 7 | GETLONGITUDE |
Retourne la longitude du centre de la carte en utilisant le système WGS84. Retour : la longitude. |
| Renvoie 0 en cas d'erreur. |
Syntaxe 4
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, Value[, ViewIndex]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 4 | SETZOOM |
Positionne un nouveau niveau de zoom pour la carte. |
| 6 | SETLATITUDE |
Positionne la latitude du centre de la carte en utilisant le système WGS84. |
| 8 | SETLONGITUDE |
Positionne la longitude du centre de la carte en utilisant le système WGS84. |
| Renvoie 0 en cas d'erreur. |
Syntaxe 5
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, FileName);
Type de retour : INTEGER.
|
Argument |
Définition |
| FileName |
Nom du fichier à utiliser en sortie. Type STR. Si un nom de fichier relatif est utilisé, le fichier est relatif au dossier \Gis. |
Exécution
|
Mode |
Mnémonique |
Action |
| 6 | EXPORT |
Crée un fichier de marqueurs (type .gpx) contenant les marqueurs et les calques d’un Contrôle carte. Génère une erreur si le fichier des marqueurs est en cours de chargement. Retour : 1 si OK, 0 sinon. |
Syntaxe 6
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, FileName[, AsyncFlag[, StateVar]])
Type de retour : INTEGER.
|
Argument |
Définition |
| FileName |
Nom du fichier .gpx contenant les marqueurs. Type STR. Si un nom de fichier relatif est utilisé, le fichier est relatif au dossier \Gis. |
| AsynchFlag |
Flag indiquant si le fichier doit être chargé de façon synchrone (0) ou asynchrone (1). |
| StateVar |
Nom d'une variable mesure indiquant le status du processus de chargement. Type STR. 0 = Succès 1 = Chargement en cours 3 = Annulé 10 = Echec |
Exécution
|
Mode |
Mnémonique |
Action |
| 10 | LOADMARKERS |
Charge les calques et les marqueurs depuis le fichier .gpx spécifié. Les calques et marqueurs précédemment chargés sont effacés. Retour : 1 si OK, 0 sinon. |
Syntaxe 7
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName[, ViewIndex]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 11 | ISLAYERDISPLAYED |
Retourne la visibilité d’un calque d'un Contrôle carte donné en prenant en compte la propriété Montrer et les limites de zoom. Retour : 1 si visible, 0 si caché, sinon -1 (erreur). |
Syntaxe 8
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, Value);
Type de retour : INTEGER.
|
Argument |
Définition |
| Value |
Un flag pour indiquer le paramètre de visibilité. Type : INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
| 12 | SETLAYERVISIBILITY |
Positionne la visibilité d'un calque. Retour : 1 si OK, 0 sinon. |
Syntaxe 9
DblVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName);
Type de retour : DOUBLE.
Exécution
|
Mode |
Mnémonique |
Action |
| 13 | GETMARKERLATITUDE |
Retourne les coordonnées de latitude (-90 à 90) d'un marqueur en système WGS84. Ne fonctionne pas pour des marqueurs multipoints (tracés ou polygones). Retour : les coordonnées de la latitude. |
| 15 | GETMARKERLONGITUDE |
Retourne les coordonnées de longitude (-180 à 180) d’un marqueur en système WGS84. Ne fonctionne pas pour des marqueurs multipoints (tracés ou polygones). Retour : les coordonnées de la longitude. |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 10
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName, Value);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 14 | SETMARKERLATITUDE |
Positionne les coordonnées de la latitude (-90 à 90) d'un marqueur en système WGS84 en utilisant la valeur fournie. Ne fonctionne pas pour des marqueurs multipoints (tracés ou polygones). Le paramètre de la valeur est un double et est la valeur de la latitude. |
| 16 | SETMARKERLONGITUDE |
Positionne les coordonnées de la longitude (-180 à 180) d'un marqueur en système WGS84 en utilisant la valeur fournie. Ne fonctionne pas pour des marqueurs multipoints (tracés ou polygones). Le paramètre de la valeur est un double et est la valeur de la longitude. . |
| 18 | SETMARKERTOOLTIP |
Positionne la description du marqueur (bulle d'aide). Le paramètre Value est une chaîne et correspond au texte de la bulle d'aide. |
| 31 | SETMARKERVISIBILITY |
Positionne la visibilité du marqueur. Valeur : 1 : visible, 0 : non visible |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 11
StrVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 17 | GETMARKERTOOLTIP |
Retourne la description (bulle d'aide) du marqueur dans la langue courante. Retour : la bulle d'aide du marqueur. |
| 19 | GETMARKERMIMIC |
Retourne le nom du synoptique devant être ouvert lors du clic sur le marqueur. Retour : le nom du synoptique. |
| 21 | GETMARKERBRANCH |
Retourne la branche du marqueur. Cette branche est utilisée pour lier les propriétés du marqueur. Si la propriété synoptique est définie, lorsqu'un utilisateur clique sur le marqueur, le synoptique s'ouvre avec la branche correspondante. Pour des marqueurs de type symbole, la branche est également assignée aux symboles instanciés. Retour : la branche du marqueur. |
| Renvoie une chaîne vide en cas d'erreur. |
Syntaxe 12
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName, Value[, ChildMode]);
Type de retour : INTEGER.
|
Argument |
Définition |
| ChildMode |
Flag indiquant comment le synoptique doit être ouvert. Type INTEGER. 0 pour ouvrir le synoptique dans une fenêtre indépendante. 1 pour ouvrir le synoptique dans une fenêtre incrustée (pop-up). |
Exécution
|
Mode |
Mnémonique |
Action |
| 20 | SETMARKERMIMIC |
Positionne le nom du synoptique à ouvrir lors du clic sur le marqueur. Le paramètre Value est une chaîne qui est le nom du synoptique. |
| 22 | SETMARKERBRANCH |
Positionne la branche du marqueur. Le paramètre Value est une chaîne qui est le nom de branche. Cette branche est utilisée pour lier les propriétés du marqueur. Si la propriété synoptique est définie, lorsqu'un utilisateur clique sur le marqueur, le synoptique s'ouvre avec la branche correspondante. Pour des marqueurs de type symbole, la branche est également assignée aux symboles instanciés. |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 13
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 23 | GETMARKERTYPE |
Retourne le type de marqueur. Retour : 1 = Forme 2 = Texte 3 = Image 4 = Symbole 5 = Tracé 6 = Polygone |
Syntaxe 14
StrVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName, UserDataName);
Type de retour : STR
|
Argument |
Définition |
| UserDataName |
Nom donné à l'élément dans le tableau des UserData tel que configuré en utilisant l'éditeur de marqueurs de carte. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 24 | GETUSERDATAVARNAME |
Retourne le nom de la variable, tel que configurée pour le UserDataName fourni. Retour : le nom de la variable. |
| 25 | GETUSERDATALABEL |
Retourne le libellé, tel que configuré pour le UserDataName fourni. Retour : le libellé. |
| 27 | GETUSERDATAVALUE | Retourne la valeur de la UserData, tel que configurée pour le UserDataName fourni. Retour : La valeur UserData sous la forme d'une chaîne. |
| Renvoie une chaîne vide en cas d'erreur. |
Syntaxe 15
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName, UserDataName, Value);
Type de retour : INTEGER.
|
Argument |
Définition |
| UserDataName |
Nom donné à l'élément dans le tableau des UserData tel que configuré en utilisant l'éditeur de marqueurs de carte. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 26 | SETUSERDATALABEL |
Positionne le libellé pour le UserDataName fourni. Le paramètre Value est une chaîne et le texte du libellé. |
| 28 | SETUSERDATAVALUE | Positionne la valeur de la variable pour le UserDataName fourni. Le paramètre Value est une chaîne et la valeur de la donnée. |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 16
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 29 | ISLOADING |
Teste si le fichier des marqueurs est chargé. Retour : |
Syntaxe 17
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, LayerName, MarkerName);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 30 | GETMARKERVISIBILITY |
Positionne la visibilité d'un calque. Retour : 1 si visible 0 si caché -1 en cas d'erreur. |
Syntaxe 18
IntVal = MAPDISPLAY (Mode, Window, Branch, MapID, ProviderName, IsLocal [, UseCache]);
Type de retour : INTEGER
|
Argument |
Définition |
| ProviderName |
Nom du fournisseur de cartes. Type STR. |
| IsLocal |
Carte locale ou en ligne. |
| UseCache |
Flag indiquant d'utiliser le cache. |
Exécution
|
Mode |
Mnémonique |
Action |
| 32 | SETMAPPROVIDER |
Modifie le fournisseur de cartes. Retour : 1 si OK, 0 sinon. |