LABEL

ALIGN [left|center|right]

Depuis la version 5.4. Définie l’alignement du texte pour les étiquettes de plusieurs lignes (voir WRAP). Notez que l’algorithme pour l’alignement est loin d’être précis, n’espérez pas de résultats fabuleux (spécialement pour l’alignement à droite) si vous n’utilisez pas une police à taille fixe.

Nouveau dans la version 5.4.

ANGLE [double|auto|auto2|follow|attribute]
  • Angle, counterclockwise, given in degrees, to draw the label. Default is 0.

  • AUTO permet à MapServer de calculer l’angle. Valide uniquement pour les couches de type ligne (LINE).

  • AUTO2 same as AUTO, except no logic is applied to try to keep the text from being rendered in reading orientation (i.e. the text may be rendered upside down). Useful when adding text arrows indicating the line direction.

  • FOLLOW was introduced in version 4.10 and tells MapServer to compute a curved label for appropriate linear features (see MS RFC 11: Support for Curved Labels for specifics). See also MAXOVERLAPANGLE.

  • [ATTRIBUTE] a été implémenté dans la version 5.0 pour spécifier le nom de l’attribut dans la table attributaire à utiliser pour les valeurs angulaires. Les crochets [] sont nécessaires. Par exemple, si le fichier DBF de votre fichier Shape contient un champ nommé “MONANGLE” qui indique la valeur de l’angle pour chaque enregistrement, votre objet LABEL doit contenir :

    LABEL
      COLOR  150 150 150
      OUTLINECOLOR 255 255 255
      FONT "sans"
      TYPE truetype
      SIZE 6
      ANGLE [MYANGLE]
      POSITION AUTO
      PARTIALS FALSE
    END
    

    le document RFC associé pour cette fonctionnalité est MS RFC 19: Style & Label attribute binding.

ANTIALIAS [true|false]

Le texte devrait-il être anticrênelé? Notez que cela nécessite plus de couleurs disponibles, diminue les performances de rendu, et renvoie des images de sortie de taille un peu plus large. Seulement utile pour le rendu GD (gif). Par défaut, défini à “false”. N’a pas d’effet sur les autres types de générateur de rendus (où l’anticrênelage ne peut pas être désactivé).

BACKGROUNDCOLOR [r] [g] [b] | [hexadecimal string]

Couleur à utiliser pour dessiner un rectangle d’arrière plan (panneau d’étiquette (“billboard”). Désactivé par défaut.

Note

Enlevé dans la version 6.0. Utilise un objet LABEL STYLE avec un GEOMTRANSFORM labelpoly et une COLOR.

BACKGROUNDSHADOWCOLOR [r] [g] [b] | [hexadecimal string]

Couleur à utiliser pour dessiner l’ombre d’un rectangle d’arrière plan (panneau d’étiquette (“billboard”). Désactivé par défaut.

Note

Enlevé dans la version 6.0. Utilise un objet LABEL STYLE avec un GEOMTRANSFORM labelpoly, une COLOR et un OFFSET.

BACKGROUNDSHADOWSIZE [x][y]

Jusqu’où le rectangle d’arrière plan doit être décalé ? 1 par défaut.

Note

Enlevé dans la version 6.0. Utilise un objet LABEL STYLE avec un GEOMTRANSFORM labelpoly, une COLOR et un OFFSET.

BUFFER [integer]

Remplissage, en pixels, autour des étiquettes. Utile pour maintenir un espace autour du texte pour en améliorer sa lecture. Disponible seulement pour les étiquettes “cachables”. 0 par défaut.

COLOR [r] [g] [b] | [hexadecimal string] | [attribute]
  • Couleur à utiliser pour dessiner le texte.

  • r, g and b shall be integers [0..255]. To specify green, the following is used:

    COLOR 0 255 0
    
  • hexadecimal string can be

    • RGB value: “#rrggbb”. To specify magenta, the following is used:

      COLOR "#FF00FF"
      
    • RGBA value (adding translucence): “#rrggbbaa”. To specify a semi-translucent magenta, the following is used:

      COLOR "#FF00FFCC"
      
  • [ATTRIBUTE] a été implémenté dans la version 5.0 pour spécifier le nom de l’attribut dans la table attributaire à utiliser pour les valeurs de couleur. Les crochets [] sont nécessaires. Par exemple, si le fichier DBF de votre fichier Shape contient un champ nommé “MACOULEUR” qui indique la valeur de la couleur pour chaque enregistrement, votre objet LABEL doit contenir :

    LABEL
      COLOR  [MYCOLOR]
      OUTLINECOLOR 255 255 255
      FONT "sans"
      TYPE truetype
      SIZE 6
      POSITION AUTO
      PARTIALS FALSE
    END
    

    le document RFC associé pour cette fonctionnalité est MS RFC 19: Style & Label attribute binding.

ENCODING [string]

Supported encoding format to be used for labels. If the format is not supported, the label will not be drawn. Requires the iconv library (present on most systems). The library is always detected if present on the system, but if not, the label will not be drawn.

Required for displaying international characters in MapServer. More information can be found in the Label Encoding document.

Obsolète depuis la version 7.0: Removed. UTF-8 is now the encoding used by MapServer, and data set encodings are handled using LAYER ENCODING.

EXPRESSION [string]

Expression qui détermine quand un LABEL doit être appliqué. Voir EXPRESSION dans CLASS.

Nouveau dans la version 6.2.

FONT [nom|attribut]
  • Nom de la police de caractères (comme défini dans le FONTSET) à utiliser pour les étiquettes.

  • [Attribute] a été introduit dans la version 5.6 pour définir l’alias de la police.

  • May contain a comma-separated list of up to MS_MAX_LABEL_FONTS (usually 5) font aliases used as fallback fonts in renderers supporting it, if a glyph is not available in a font. If specified directly, be sure to enclose the list with quotes. See MS RFC 80: Font Fallback Support.
  • Since version 7, Mapserver supports language specific fonts. See MS RFC 98: Label/Text Rendering Overhaul.
FORCE [true|false]

Force l’affichage des étiquettes d’une classe particulière, sans s’occuper des superpositions (collisions). Disponible seulement pour les étiquettes en cache. Désactivé par défaut. Si FORCE est à true et PARTIALS est à false, FORCE prend la précédence, et les étiquettes partielles sont dessinées.

MAXLENGTH [integer]

Introduit dans mapserver 5.4, ce mot clé interagit avec le mot clé WRAP afin que les retours à la lignes aient lieu seulement après un nombre défini de caractères.

Interaction with WRAP keyword
  maxlength = 0 maxlength > 0
wrap = ‘char’

retour à la ligne au caractère WRAP

nouvelle ligne dès le premier caractère WRAP après MAXLENGTH caractères

pas de wrap

aucun traitement

ignore l’étiquette s’il contient plus que MAXLENGTH caractères

Le document RFC associé pour cette fonctionalité est MS RFC 40: Support Label Text Transformations.

Nouveau dans la version 5.4.

Support for negative MAXLENGTH that implied forced linebreaks is not supported since version 7, a workaround implies pre-processing such labels to include linebreaks or wrap characters.

MAXOVERLAPANGLE [double]

Seuil de l’angle à utiliser pour filtrer les étiquettes ANGLE FOLLOW dans lesquelles les caractères se superposent (valeur flottante en degrés). Ce filtrage sera activé par défaut avec MapServer 6.0. La valeur MAXOVERLAPANGLE par défaut sera 22.5 degrees, qui correspond aussi à celle par défaut de GeoServer. Les utilisateurs seront libres de personnaliser la valeur en plus ou en moins en fonction du type de données qu’ils gèrent et de leur tolérance à la mauvaise superposition des étiquettes. Selon la RFC 60, si MAXOVERLAPANGLE est défini à 0, alors on retombe sur le comportement antérieur à la version 6.0 qui était d’utiliser maxoverlapangle = 0.4*MS_PI (40% de 180 degrés = 72 degrés).

Le document RFC associé pour cette fonctionalité est MS RFC 60: Labeling enhancement: ability to skip ANGLE FOLLOW labels with too much character overlap.

MAXSCALEDENOM [double]

Minimum scale at which this LABEL is drawn. Scale is given as the denominator of the actual scale fraction, for example for a map at a scale of 1:24,000 use 24000.

Nouveau dans la version 5.4.

Voir aussi

Map Scale

MAXSIZE [double]

Taille maximum de polices à utiliser quand on met à l’échelle le texte (pixels). Par défaut, la valeur est 256. A partir de la version 5.4, la valeur peut aussi être une valeur fractionnelle (et pas seulement un entier). Voir le SYMBOLSCALEDENOM de la LAYER.

MINDISTANCE [integer]
Minimum distance between duplicate labels. Given in pixels. Starting from version 7.2, the distance is calculated from the label boundary. Prior versions used the label center.
MINFEATURESIZE [integer|auto]

Taille minimale d’une entité devant être étiquettée, en pixels. Pour les données linéaires, la longueur totale de la ligne affichée est utilisée, pour les entités polygonales la taille du plus petit côté du rectangle englobant est utilisée. Le mot-clé “Auto” indique à MapServer d’étiqueter uniquement les entités plus grandes que leur propre étiquette. Disponible seulement pour les étiquettes en cache.

MINSCALEDENOM [double]

Maximum scale at which this LABEL is drawn. Scale is given as the denominator of the actual scale fraction, for example for a map at a scale of 1:24,000 use 24000.

Nouveau dans la version 5.4.

Voir aussi

Map Scale

MINSIZE [double]

Taille minimum de polices à utiliser quand on met à l’échelle le texte (pixels). Par défaut, la valeur est 4. A partir de la version 5.4, la valeur peut aussi être une valeur fractionnelle (et pas seulement un entier). Voir le SYMBOLSCALEDENOM de la LAYER.

OFFSET [x][y]

Offset values for labels, relative to the lower left hand corner of the label and the label point. Given in pixels. In the case of rotated text specify the values as if all labels are horizontal and any rotation will be compensated for.

When used with FOLLOW angle, two additional options are available to render the label parallel to the original feature:

  • OFFSET x -99 : will render the label to the left or to the right of the feature, depending on the sign of {x}.
  • OFFSET x 99 : will render the label above or below the feature, depending on the sign of {x}.

See LAYER SYMBOLSCALEDENOM.

OUTLINECOLOR [r] [g] [b] | [hexadecimal string] | [attribute]
  • Couleur utilisée pour dessiner une ligne d’un pixel autour du texte.

  • r, g and b shall be integers [0..255]. To specify green, the following is used:

    OUTLINECOLOR 0 255 0
    
  • hexadecimal string can be

    • RGB value: “#rrggbb”. To specify magenta, the following is used:

      OUTLINECOLOR "#FF00FF"
      
    • RGBA value (adding translucence): “#rrggbbaa”. To specify a semi-translucent magenta, the following is used:

      OUTLINECOLOR "#FF00FFCC"
      
  • [ATTRIBUTE] a été implémenté dans la version 5.0 pour spécifier le nom de l’attribut dans la table attributaire à utiliser pour les valeurs de couleur. Les crochets [] sont nécessaires. Par exemple, si le fichier DBF de votre fichier Shape contient un champ nommé “MACOULEUREXTERIEURE” qui indique la valeur de la couleur pour chaque enregistrement, votre objet LABEL doit contenir :

    LABEL
      COLOR  150 150 150
      OUTLINECOLOR [MYOUTCOLOR]
      FONT "sans"
      TYPE truetype
      SIZE 6
      POSITION AUTO
      PARTIALS FALSE
    END
    

    le document RFC associé pour cette fonctionnalité est MS RFC 19: Style & Label attribute binding.

OUTLINEWIDTH [integer]
Width of the outline if OUTLINECOLOR has been set. Defaults to 1. Currently only the AGG renderer supports values greater than 1, and renders these as a ‘halo’ effect: recommended values are 3 or 5. If the renderer supports it and the text size is variable, the outline will be scaled proportionally to the text and the value specified as OUTLINEWIDTH is therefore the width at the same scale at which the SIZE is specified.
PARTIALS [true|false]

Le text peut-il sortir de la carte? Par défaut, oui. Si FORCE est à “true” et PARTIALS est à “false”, FORCE prend la précédence, et les étiquettes partielles sont alors dessinées.

POSITION [ul|uc|ur|cl|cc|cr|ll|lc|lr|auto]

Position de l’étiquette relative au point d’insertion (couches seulement). La première lettre est la position en “Y”, la seconde lettre est la position en “X”. “Auto” indique à MapServer de calculer une position d’étiquette qui n’interférera pas avec d’autres étiquettes. Avec des points, MapServer sélectionne l’une des 8 positions extérieures (c’est à dire en excluant cc). Avec les polygones, MapServer sélectionne cc (ajouté dans MapServer 5.4), uc, lc, cl et cr comme positions possible. Avec des lignes, il utilise seulement lc ou uc, jusqu’à ce qu’il trouve une position qui n’entraîne pas de chevauchement (collision) avec des étiquettes déjà dessinées. Si toutes les positions entraînent un conflit, alors l’étiquette n’est pas dessinée (sauf si le paramètre d’étiquette FORCE est à “true”). “Auto” est seulement disponible avec les étiquettes en cache.

PRIORITY [integer]|[item_name]|[attribute]

Le paramètre de priorité (ajouté dans la version 5.0) prend un chiffre entier entre 1 (la plus basse) et 10 (la plus haute). La valeur par défaut est de 1. Il est également possible d’affecter la priorité à un attribut (item_name) en utilisant des crochets autour de l’attribut. Par exemple “PRIORITY [monattribut]”

Les étiquettes sont stockées dans le cache des étiquettes et sont dessinées par ordre de priorité : les plus hauts niveaux de priorité sont dessinés en premier. Spécifier dans le mapfile une valeur en dehors de la plage correcte du paramètre PRIORITY entrainera une erreur (“parse error”). Une valeur en dehors de la plage correcte récupérée depuis MapScript ou depuis un attribut prendra la valeur minimale ou maximale de PRIORITY au moment du rendu. Il n’y a pas d’impact attendu sur les performances lors de l’utilisation des priorités des étiquettes.

[Attribute] a été introduit dans la version 5.6.

Nouveau dans la version 5.0.

REPEATDISTANCE [integer]

L’étiquette sera répétée sur chaque ligne d’une géométrie multligne et sera répétée plusieurs fois le long d’une ligne donnée dans un interval de REPEATDISTANCE pixels.

Le document RFC associé pour cette fonctionalité est MS RFC 57: Labeling enhancements: ability to repeat labels along a line/multiline.

Nouveau dans la version 5.6.

SHADOWCOLOR [r] [g] [b] | [hexadecimal string]

Couleur de l’ombre portée. Une étiquette avec le même texte sera rendu dans cette couleur avant le dessin de l’étiquette principale, donnant ainsi un effet d’ombrage sur les caractères de l’étiquette. Le décalage de l’ombre rendue est défini avec SHADOWSIZE.

  • r, g and b shall be integers [0..255]. To specify green, the following is used:

    SHADOWCOLOR 0 255 0
    
  • hexadecimal string can be

    • RGB value: “#rrggbb”. To specify magenta, the following is used:

      SHADOWCOLOR "#FF00FF"
      
    • RGBA value (adding translucence): “#rrggbbaa”. To specify a semi-translucent magenta, the following is used:

      SHADOWCOLOR "#FF00FFCC"
      
SHADOWSIZE [x][y]|[attribute][attribute]|[x][attribute]|[attribute][y]

Décalage de l’ombre en pixels, voir SHADOWCOLOR.

[Attribut] a été introduit dans la version 6.0, et peut être utilisé de cette manière :

SHADOWSIZE 2 2
SHADOWSIZE [shadowsizeX] 2
SHADOWSIZE 2 [shadowsizeY]
SHADOWSIZE [shadowsize] [shadowsize]
SIZE [integer]|[tiny|small|medium|large|giant]|[attribute]
  • Taille de texte. Utilise un nombre pour donner la taille en pixels de votre étiquette basée sur la police TrueType, ou n’importe quel des 5 mots-clés listés pour les polices bitmap.

    Quand la mise à l’échelle est utilisée (SYMBOLSCALEDENOM est spécifié pour la LAYER), la SIZE donne la taille de la police qui doit être utilisée à l’échelle de carte 1:SYMBOLSCALEDENOM.

  • [Attribut] a été introduit dans la version 5.0, pour spécifier le nom de l’élément dans la table d’attribut pour utiliser les valeurs de taille. Les crochets [] sont requis. Par exemple, si le DBF de votre shapefile a un champ nommé “MYSIZE” qui porte des valeurs de taille pour chaque enregistrement, votre objet LABEL contiendra peut-être :

    LABEL
      COLOR  150 150 150
      OUTLINECOLOR 255 255 255
      FONT "sans"
      TYPE truetype
      SIZE [MYSIZE]
      POSITION AUTO
      PARTIALS FALSE
    END
    

    le document RFC associé pour cette fonctionnalité est MS RFC 19: Style & Label attribute binding.

Note

The SIZE value can only be an integer (not a fractional value), because the renderer Freetype only accepts integers.

STYLE

Le début d’un objet STYLE

Les mécanisme spécifiques aux étiquettes de l’objet STYLE sont dans les options GEOMTRANSFORM :

GEOMTRANSFORM [labelpnt|labelpoly]

Creates a geometry that can be used for styling the label. Does not apply to ANGLE FOLLOW labels.

  • labelpnt dessine un marqueur sur la position géographique à laquelle l’étiquette est attachée. Cela correspond au centre de l’étiquette texte seulement si l’étiquette est en position CC.

  • labelpoly génère le rectangle englobant pour le texte, avec 1 pixel d’espacement ajouté dans toutes les directions.

Les géométries résultantes peuvent être stylées en utilisant les mécanismes disponibles dans l’objet STYLE.

Exemple - dessine un rectangle de fond rouge pour les étiquettes avec un ombrage “shadow” en gris:

STYLE
  GEOMTRANSFORM 'labelpoly'
  COLOR 153 153 153
  OFFSET 3 2
END # STYLE
STYLE
  GEOMTRANSFORM 'labelpoly'
  COLOR 255 0 0
END # STYLE

Nouveau dans la version 6.0.

TEXT [string|expression]

Text to label features with (useful when multiple labels are used). Overrides values obtained from the LAYER LABELITEM and the CLASS TEXT. See TEXT in CLASS.

Nouveau dans la version 6.2.

TYPE [bitmap|truetype]

Type de polices à utiliser. Généralement, les polices bitmap sont plus rapides à dessiner que les polices TrueType. Cependant, les polices TrueType permettent le changement d’échelles et sont disponibles dans une variété de types de polices. Assurez-vous d’avoir défini le paramètre FONT si vous avez sélectionné TrueType.

Note

Les polices Bitmap sont seulement supportées avec les moteurs de rendus AGG et GD

WRAP [character]

Caractère qui représente une condition de fin de ligne dans le texte de l’étiquette, par conséquent, donnant une étiquette multi-ligne. Interagit avec MAXLENGTH pour les conditions de retour à la ligne des étiquettes en fonction d’un nombre de caractères donné