TextOptions interface

Référence

Paquet:: azure-maps-control

Options utilisées pour personnaliser le texte dans un SymbolLayer

Extends: Options

Propriétés

allowOverlap	Spécifie si le texte sera visible s’il entre en collision avec d’autres symboles. Si la valeur est true, le texte est visible même s’il entre en collision avec d’autres symboles dessinés précédemment. Par défaut, `false`.
anchor	Spécifie la partie de l’icône la plus proche de la position d’ancrage des icônes sur la carte. « Centre »: le centre de l’icône est placé le plus près de l’ancre. « left » : le côté gauche de l’icône est placé le plus près de l’ancre. « right » : le côté droit de l’icône est placé le plus près de l’ancre. ''top'': le haut de l’icône est placé le plus près de l’ancre. ''bottom'': le bas de l’icône est placé le plus près de l’ancre. « « en haut à gauche » : le coin supérieur gauche de l’icône est placé le plus près de l’ancre. « « en haut à droite » : le coin supérieur droit de l’icône est placé le plus près de l’ancre. « « inférieur gauche » : le coin inférieur gauche de l’icône est placé le plus près de l’ancre. « « bas à droite » : le coin inférieur droit de l’icône est placé le plus près de l’ancre. Valeur par défaut « center » (centre).
color	Couleur du texte. Par défaut, `"#000000"`.
font	Pile de polices à utiliser pour afficher du texte. Valeurs possibles : `"SegoeFrutigerHelveticaMYingHei-Bold"`, , `"SegoeFrutigerHelveticaMYingHei-Medium"`, `"SegoeFrutigerHelveticaMYingHei-Regular"`, `"SegoeUi-Light""StandardFontCondensed-Light""StandardFontCondensed-Bold""StandardFontCondensed-Black""StandardFont-Regular""StandardFont-Bold""SegoeUi-SemiBold""StandardFont-Light""SegoeUi-Bold""StandardFont-Black""StandardCondensedSegoeUi-Regular""SegoeUi-Regular""StandardCondensedSegoeUi-Bold""SegoeUi-SemiLight""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardCondensedSegoeUi-Light"`. `"StandardFontCondensed-Regular"` Par défaut, `["StandardFont-Regular"]`.
haloBlur	Distance de fondu du halo vers l’extérieur en pixels. Doit être un nombre supérieur ou égal à 0. Par défaut, `0`.
haloColor	Couleur du halo du texte, qui l’aide à se distinguer des arrière-plans. Par défaut, `"rgba(0,0,0,0)"`.
haloWidth	Distance du halo au contour de police en pixels. Doit être un nombre supérieur ou égal à 0. La largeur maximale du halo de texte est de 1/4 de la taille de police. Par défaut, `0`.
ignorePlacement	Spécifie si les autres symboles sont autorisés à entrer en conflit avec le texte. Si la valeur est true, d’autres symboles peuvent être visibles même s’ils entrent en collision avec le texte. Par défaut, `false`.
justify	Options de justification de texte. « auto » : le texte est aligné vers la position d’ancrage. ''left'' : le texte est aligné à gauche. '"center »: le texte est centré. ''right'': Le texte est aligné à droite. Valeur par défaut « center » (centre).
offset	Spécifie une distance de décalage de l’icône de son ancre dans ems. Les valeurs positives indiquent vers la droite et vers le bas, tandis que les valeurs négatives indiquent la gauche et le haut. Par défaut, `[0, 0]`.
opacity	Nombre compris entre 0 et 1 qui indique l’opacité à laquelle le texte sera dessiné. Par défaut, `1`.
optional	Spécifie si le texte peut être masqué s’il se chevauche par un autre symbole. Si la valeur est true, les icônes s’affichent sans leur texte correspondant lorsque le texte entre en collision avec d’autres symboles et que l’icône ne le fait pas. Par défaut, `false`.
padding	Taille de la zone supplémentaire autour de la zone englobante de texte utilisée pour détecter les collisions de symboles. Par défaut, `2`.
pitchAlignment	Spécifie l’orientation du texte lorsque la carte est tangée. '"auto"' : correspond automatiquement à la valeur de 'rotationAlignment'. '"map »: le texte est aligné sur le plan de la carte. '"viewport »: le texte est aligné sur le plan de la fenêtre d’affichage. Par défaut : '"auto"'
radialOffset	Décalage radial du texte, dans la direction de l’ancre du symbole. Utile en combinaison avec `variableAnchor`, qui utilise par défaut l’utilisation de l’élément bidimensionnel `offset` s’il est présent. Valeur par défaut : `0`
rotation	Quantité à faire pivoter le texte dans le sens des aiguilles d’une montre en degrés. Par défaut `0`
rotationAlignment	En combinaison avec la `placement` propriété du `SymbolLayerOptions`, spécifie le comportement de rotation des glyphes individuels formant le texte. ''auto'': lorsque le 'placement' a la valeur ''point', cela équivaut à '"map"'. Lorsque le « placement » est défini sur « ligne », cela équivaut à « « map ». '"map »: lorsque le 'placement' est défini sur '"point », aligne le texte est-ouest. Lorsque le « placement » est défini sur « « ligne », aligne les axes x du texte avec la ligne. '"viewport »: produit des glyphes dont les axes x sont alignés avec l’axe x de la fenêtre d’affichage, quelle que soit la valeur de 'placement'. Par défaut : '"auto"'
size	Taille de la police en pixels. Doit être un nombre supérieur ou égal à 0. Par défaut, `16`.
textField	Spécifie le nom d’une propriété sur les fonctionnalités à utiliser pour une étiquette de texte.
variableAnchor	Liste des emplacements d’ancrage potentiels, afin d’augmenter le risque de placer des étiquettes à priorité élevée sur la carte. Le renderer tente de placer l’étiquette à chaque emplacement, dans l’ordre, avant de passer à l’étiquette suivante. Permet `justify: "auto"` de choisir une justification de texte en fonction de la position d’ancrage. Pour appliquer un décalage, utilisez les `radialOffset` options ou les options à deux dimensions `offset` . « Centre »: le centre de l’icône est placé le plus près de l’ancre. « left » : le côté gauche de l’icône est placé le plus près de l’ancre. « right » : le côté droit de l’icône est placé le plus près de l’ancre. ''top'': le haut de l’icône est placé le plus près de l’ancre. ''bottom'': le bas de l’icône est placé le plus près de l’ancre. « « en haut à gauche » : le coin supérieur gauche de l’icône est placé le plus près de l’ancre. « « en haut à droite » : le coin supérieur droit de l’icône est placé le plus près de l’ancre. « « inférieur gauche » : le coin inférieur gauche de l’icône est placé le plus près de l’ancre. « « bas à droite » : le coin inférieur droit de l’icône est placé le plus près de l’ancre. Valeur par défaut : 'undefined'

Détails de la propriété

allowOverlap

Spécifie si le texte sera visible s’il entre en collision avec d’autres symboles. Si la valeur est true, le texte est visible même s’il entre en collision avec d’autres symboles dessinés précédemment. Par défaut, false.

allowOverlap?: boolean

Valeur de propriété

boolean

anchor

Spécifie la partie de l’icône la plus proche de la position d’ancrage des icônes sur la carte.

« Centre »: le centre de l’icône est placé le plus près de l’ancre.

« left » : le côté gauche de l’icône est placé le plus près de l’ancre.

« right » : le côté droit de l’icône est placé le plus près de l’ancre.

''top'': le haut de l’icône est placé le plus près de l’ancre.

''bottom'': le bas de l’icône est placé le plus près de l’ancre.

« « en haut à gauche » : le coin supérieur gauche de l’icône est placé le plus près de l’ancre.

« « en haut à droite » : le coin supérieur droit de l’icône est placé le plus près de l’ancre.

« « inférieur gauche » : le coin inférieur gauche de l’icône est placé le plus près de l’ancre.

« « bas à droite » : le coin inférieur droit de l’icône est placé le plus près de l’ancre.

Valeur par défaut « center » (centre).

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

Valeur de propriété

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

color

Couleur du texte. Par défaut, "#000000".

color?: string | DataDrivenPropertyValueSpecification<string>

Valeur de propriété

string | DataDrivenPropertyValueSpecification<string>

font

Pile de polices à utiliser pour afficher du texte. Valeurs possibles : "SegoeFrutigerHelveticaMYingHei-Bold", , "SegoeFrutigerHelveticaMYingHei-Medium", "SegoeFrutigerHelveticaMYingHei-Regular", "SegoeUi-Light""StandardFontCondensed-Light""StandardFontCondensed-Bold""StandardFontCondensed-Black""StandardFont-Regular""StandardFont-Bold""SegoeUi-SemiBold""StandardFont-Light""SegoeUi-Bold""StandardFont-Black""StandardCondensedSegoeUi-Regular""SegoeUi-Regular""StandardCondensedSegoeUi-Bold""SegoeUi-SemiLight""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardCondensedSegoeUi-Light". "StandardFontCondensed-Regular" Par défaut, ["StandardFont-Regular"].

font?: string[] | DataDrivenPropertyValueSpecification<string[]>

Valeur de propriété

string[] | DataDrivenPropertyValueSpecification<string[]>

haloBlur

Distance de fondu du halo vers l’extérieur en pixels. Doit être un nombre supérieur ou égal à 0. Par défaut, 0.

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

haloColor

Couleur du halo du texte, qui l’aide à se distinguer des arrière-plans. Par défaut, "rgba(0,0,0,0)".

haloColor?: string | DataDrivenPropertyValueSpecification<string>

Valeur de propriété

string | DataDrivenPropertyValueSpecification<string>

haloWidth

Distance du halo au contour de police en pixels. Doit être un nombre supérieur ou égal à 0. La largeur maximale du halo de texte est de 1/4 de la taille de police. Par défaut, 0.

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

ignorePlacement

Spécifie si les autres symboles sont autorisés à entrer en conflit avec le texte. Si la valeur est true, d’autres symboles peuvent être visibles même s’ils entrent en collision avec le texte. Par défaut, false.

ignorePlacement?: boolean

Valeur de propriété

boolean

justify

Options de justification de texte.

« auto » : le texte est aligné vers la position d’ancrage.

''left'' : le texte est aligné à gauche.

'"center »: le texte est centré.

''right'': Le texte est aligné à droite. Valeur par défaut « center » (centre).

justify?: "auto" | "left" | "center" | "right"

Valeur de propriété

"auto" | "left" | "center" | "right"

offset

Spécifie une distance de décalage de l’icône de son ancre dans ems. Les valeurs positives indiquent vers la droite et vers le bas, tandis que les valeurs négatives indiquent la gauche et le haut. Par défaut, [0, 0].

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

Valeur de propriété

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

Nombre compris entre 0 et 1 qui indique l’opacité à laquelle le texte sera dessiné. Par défaut, 1.

opacity?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

optional

Spécifie si le texte peut être masqué s’il se chevauche par un autre symbole. Si la valeur est true, les icônes s’affichent sans leur texte correspondant lorsque le texte entre en collision avec d’autres symboles et que l’icône ne le fait pas. Par défaut, false.

optional?: boolean

Valeur de propriété

boolean

padding

Taille de la zone supplémentaire autour de la zone englobante de texte utilisée pour détecter les collisions de symboles. Par défaut, 2.

padding?: number | PropertyValueSpecification<number>

Valeur de propriété

number | PropertyValueSpecification<number>

pitchAlignment

Spécifie l’orientation du texte lorsque la carte est tangée.

'"auto"' : correspond automatiquement à la valeur de 'rotationAlignment'.

'"map »: le texte est aligné sur le plan de la carte.

'"viewport »: le texte est aligné sur le plan de la fenêtre d’affichage.

Par défaut : '"auto"'

pitchAlignment?: "auto" | "map" | "viewport"

Valeur de propriété

"auto" | "map" | "viewport"

radialOffset

Décalage radial du texte, dans la direction de l’ancre du symbole. Utile en combinaison avec variableAnchor, qui utilise par défaut l’utilisation de l’élément bidimensionnel offset s’il est présent. Valeur par défaut : 0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

rotation

Quantité à faire pivoter le texte dans le sens des aiguilles d’une montre en degrés. Par défaut 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

En combinaison avec la placement propriété du SymbolLayerOptions, spécifie le comportement de rotation des glyphes individuels formant le texte.

''auto'': lorsque le 'placement' a la valeur ''point', cela équivaut à '"map"'. Lorsque le « placement » est défini sur « ligne », cela équivaut à « « map ».

'"map »: lorsque le 'placement' est défini sur '"point », aligne le texte est-ouest. Lorsque le « placement » est défini sur « « ligne », aligne les axes x du texte avec la ligne.

'"viewport »: produit des glyphes dont les axes x sont alignés avec l’axe x de la fenêtre d’affichage, quelle que soit la valeur de 'placement'.

Par défaut : '"auto"'

rotationAlignment?: "auto" | "map" | "viewport"

Valeur de propriété

"auto" | "map" | "viewport"

size

Taille de la police en pixels. Doit être un nombre supérieur ou égal à 0. Par défaut, 16.

size?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

textField

Spécifie le nom d’une propriété sur les fonctionnalités à utiliser pour une étiquette de texte.

textField?: string | DataDrivenPropertyValueSpecification<string>

Valeur de propriété

string | DataDrivenPropertyValueSpecification<string>

variableAnchor

Liste des emplacements d’ancrage potentiels, afin d’augmenter le risque de placer des étiquettes à priorité élevée sur la carte. Le renderer tente de placer l’étiquette à chaque emplacement, dans l’ordre, avant de passer à l’étiquette suivante. Permet justify: "auto" de choisir une justification de texte en fonction de la position d’ancrage. Pour appliquer un décalage, utilisez les radialOffset options ou les options à deux dimensions offset .