TextOptions interface
Optionen zum Anpassen des Texts in einem SymbolLayer
- Extends
Eigenschaften
allow |
Gibt an, ob der Text sichtbar ist, wenn er mit anderen Symbolen kollidiert.
Wenn true, wird der Text auch dann angezeigt, wenn er mit anderen zuvor gezeichneten Symbolen kollidiert.
Standardwert: |
anchor | Gibt an, welcher Teil des Symbols am nächsten an die Symbolankerposition auf der Karte platziert wird. '"Mitte": Die Mitte des Symbols wird am nächsten am Anker platziert. '"left"': Die linke Seite des Symbols wird am nächsten am Anker platziert. '"rechts": Die rechte Seite des Symbols wird am nächsten am Anker platziert. '"top"': Der oberen Rand des Symbols wird am nächsten am Anker platziert. '"unten"': Der Unteren Rand des Symbols wird am nächsten am Anker platziert. '"oben links": Die obere linke Ecke des Symbols wird am nächsten am Anker platziert. '"oben rechts": Die obere rechte Ecke des Symbols wird am nächsten am Anker platziert. '"unten links": Die untere linke Ecke des Symbols wird am nächsten am Anker platziert. ""unten rechts": Die untere rechte Ecke des Symbols wird am nächsten am Anker platziert. Standardeinstellung '"Center"'. |
color | Die Farbe des Texts.
Standardwert: |
font | Der Schriftartstapel, der zum Anzeigen von Text verwendet werden soll.
Mögliche Werte: |
halo |
Der Fadeoutabstand des Halos nach außen in Pixeln.
Muss eine Zahl größer oder gleich 0 sein.
Standardwert: |
halo |
Die Farbe des Halos des Texts, was ihnen hilft, sich von Hintergründen abzuheben.
Standardwert: |
halo |
Der Abstand des Halos zu der Schriftgliederung in Pixeln.
Muss eine Zahl größer oder gleich 0 sein.
Die maximale Text-Halobreite beträgt 1/4 der Schriftgröße.
Standardwert: |
ignore |
Gibt an, ob die anderen Symbole mit dem Text kollidieren dürfen.
Wenn true, können andere Symbole auch dann sichtbar sein, wenn sie mit dem Text kollidieren.
Standardwert: |
justify | Textbeschriftungsoptionen. '"auto"': Der Text wird an die Ankerposition ausgerichtet. '"links"': Der Text wird links ausgerichtet. '"zentriert": Der Text wird zentriert. '"rechts": Der Text wird rechts ausgerichtet. Standard '"center"'. |
offset | Gibt einen Offsetabstand des Symbols von seinem Anker in ems an.
Positive Werte deuten auf rechts und unten hin, während negative Werte links und oben angeben.
Standardwert: |
opacity | Eine Zahl zwischen 0 und 1, die die Deckkraft angibt, an der der Text gezeichnet wird.
Standardwert: |
optional | Gibt an, ob der Text ausgeblendet werden kann, wenn es durch ein anderes Symbol überlappen wird.
Wenn true, werden Symbole ohne den entsprechenden Text angezeigt, wenn der Text mit anderen Symbolen kollidiert und das Symbol nicht.
Standardwert: |
padding | Größe des zusätzlichen Bereichs um das Textgrenzenfeld, das zum Erkennen von Symbolkollisionen verwendet wird.
Standardwert: |
pitch |
Gibt die Ausrichtung des Texts an, wenn die Karte gehöhet wird. '"auto"': Entspricht automatisch dem Wert von 'rotationAlignment'. '"map"': Der Text wird an die Ebene der Karte ausgerichtet. '"viewport": Der Text wird an die Ebene des Viewports ausgerichtet. Standard: '"auto"' |
radial |
Radialer Versatz von Text in richtung des Ankers des Symbols. Nützlich in Kombination mit |
rotation | Der Betrag, der den Text im Uhrzeigersinn in Grad drehen soll.
Standard |
rotation |
In Kombination mit der '"auto"': Wenn die Platzierung auf "Punkt" festgelegt ist, entspricht dies ""map". Wenn die Position auf "Zeile" festgelegt ist, entspricht dies ""map". '"map"': Wenn die Position auf "Punkt" festgelegt ist, wird der Text ost-west ausgerichtet. Wenn die "Platzierung" auf "Zeile" festgelegt ist, richtet text x-Achsen mit der Zeile aus. '"viewport": Erzeugt Glyphen, deren x-Achsen unabhängig vom Wert "Platzierung" an der X-Achse des Viewports ausgerichtet sind. Standard: '"auto"' |
size | Der Schriftgrad in Pixeln.
Muss eine Zahl größer oder gleich 0 sein.
Standardwert: |
text |
Gibt den Namen einer Eigenschaft für die Features an, die für eine Textbeschriftung verwendet werden sollen. |
variable |
Liste der potenziellen Ankerstandorte, um die Chance zu erhöhen, bezeichnungen mit hoher Priorität auf der Karte zu platzieren. Der Renderer versucht, die Beschriftung an jeder Position in der Reihenfolge zu platzieren, bevor Sie auf die nächste Bezeichnung wechseln. Wird verwendet '"Mitte": Die Mitte des Symbols wird am nächsten am Anker platziert. '"left": Die linke Seite des Symbols wird am nächsten am Anker platziert. '"rechts": Die rechte Seite des Symbols wird am nächsten am Anker platziert. '"top": Der obere Rand des Symbols wird am nächsten am Anker platziert. '"bottom":The bottom of the icon is closest to the anchor. '"oben links": Die obere linke Ecke des Symbols wird am nächsten am Anker platziert. '"oben rechts": Die obere rechte Ecke des Symbols wird am nächsten am Anker platziert. '"unten links": Die untere linke Ecke des Symbols wird am nächsten am Anker platziert. '"unten rechts": Die untere rechte Ecke des Symbols wird am nächsten am Anker platziert. Standard: 'nicht definiert' |
Details zur Eigenschaft
allowOverlap
Gibt an, ob der Text sichtbar ist, wenn er mit anderen Symbolen kollidiert.
Wenn true, wird der Text auch dann angezeigt, wenn er mit anderen zuvor gezeichneten Symbolen kollidiert.
Standardwert: false
.
allowOverlap?: boolean
Eigenschaftswert
boolean
anchor
Gibt an, welcher Teil des Symbols am nächsten an die Symbolankerposition auf der Karte platziert wird.
'"Mitte": Die Mitte des Symbols wird am nächsten am Anker platziert.
'"left"': Die linke Seite des Symbols wird am nächsten am Anker platziert.
'"rechts": Die rechte Seite des Symbols wird am nächsten am Anker platziert.
'"top"': Der oberen Rand des Symbols wird am nächsten am Anker platziert.
'"unten"': Der Unteren Rand des Symbols wird am nächsten am Anker platziert.
'"oben links": Die obere linke Ecke des Symbols wird am nächsten am Anker platziert.
'"oben rechts": Die obere rechte Ecke des Symbols wird am nächsten am Anker platziert.
'"unten links": Die untere linke Ecke des Symbols wird am nächsten am Anker platziert.
""unten rechts": Die untere rechte Ecke des Symbols wird am nächsten am Anker platziert.
Standardeinstellung '"Center"'.anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
Eigenschaftswert
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
color
Die Farbe des Texts.
Standardwert: "#000000"
.
color?: string | DataDrivenPropertyValueSpecification<string>
Eigenschaftswert
string | DataDrivenPropertyValueSpecification<string>
font
Der Schriftartstapel, der zum Anzeigen von Text verwendet werden soll.
Mögliche Werte: "SegoeFrutigerHelveticaMYingHei-Bold"
, "SegoeFrutigerHelveticaMYingHei-Medium"
"StandardFontCondensed-Black"
"StandardCondensedSegoeUi-Black"
"StandardCondensedSegoeUi-Bold"
"SegoeUi-SymbolRegular"
"SegoeUi-SemiLight"
"StandardCondensedSegoeUi-Light"
"StandardFont-Light"
"StandardFont-Bold"
"StandardFont-Regular"
"StandardFont-Black"
"StandardFontCondensed-Bold"
"StandardFontCondensed-Light"
"SegoeFrutigerHelveticaMYingHei-Regular"
"SegoeUi-Light"
"StandardFontCondensed-Regular"
"SegoeUi-Bold"
"SegoeUi-Regular"
"SegoeUi-SemiBold"
"StandardCondensedSegoeUi-Regular"
. . .
Standardwert: ["StandardFont-Regular"]
.
font?: string[] | DataDrivenPropertyValueSpecification<string[]>
Eigenschaftswert
string[] | DataDrivenPropertyValueSpecification<string[]>
haloBlur
Der Fadeoutabstand des Halos nach außen in Pixeln.
Muss eine Zahl größer oder gleich 0 sein.
Standardwert: 0
.
haloBlur?: number | DataDrivenPropertyValueSpecification<number>
Eigenschaftswert
number | DataDrivenPropertyValueSpecification<number>
haloColor
Die Farbe des Halos des Texts, was ihnen hilft, sich von Hintergründen abzuheben.
Standardwert: "rgba(0,0,0,0)"
.
haloColor?: string | DataDrivenPropertyValueSpecification<string>
Eigenschaftswert
string | DataDrivenPropertyValueSpecification<string>
haloWidth
Der Abstand des Halos zu der Schriftgliederung in Pixeln.
Muss eine Zahl größer oder gleich 0 sein.
Die maximale Text-Halobreite beträgt 1/4 der Schriftgröße.
Standardwert: 0
.
haloWidth?: number | DataDrivenPropertyValueSpecification<number>
Eigenschaftswert
number | DataDrivenPropertyValueSpecification<number>
ignorePlacement
Gibt an, ob die anderen Symbole mit dem Text kollidieren dürfen.
Wenn true, können andere Symbole auch dann sichtbar sein, wenn sie mit dem Text kollidieren.
Standardwert: false
.
ignorePlacement?: boolean
Eigenschaftswert
boolean
justify
Textbeschriftungsoptionen.
'"auto"': Der Text wird an die Ankerposition ausgerichtet.
'"links"': Der Text wird links ausgerichtet.
'"zentriert": Der Text wird zentriert.
'"rechts": Der Text wird rechts ausgerichtet. Standard '"center"'.
justify?: "auto" | "left" | "center" | "right"
Eigenschaftswert
"auto" | "left" | "center" | "right"
offset
Gibt einen Offsetabstand des Symbols von seinem Anker in ems an.
Positive Werte deuten auf rechts und unten hin, während negative Werte links und oben angeben.
Standardwert: [0, 0]
.
offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>
Eigenschaftswert
opacity
Eine Zahl zwischen 0 und 1, die die Deckkraft angibt, an der der Text gezeichnet wird.
Standardwert: 1
.
opacity?: number | DataDrivenPropertyValueSpecification<number>
Eigenschaftswert
number | DataDrivenPropertyValueSpecification<number>
optional
Gibt an, ob der Text ausgeblendet werden kann, wenn es durch ein anderes Symbol überlappen wird.
Wenn true, werden Symbole ohne den entsprechenden Text angezeigt, wenn der Text mit anderen Symbolen kollidiert und das Symbol nicht.
Standardwert: false
.
optional?: boolean
Eigenschaftswert
boolean
padding
Größe des zusätzlichen Bereichs um das Textgrenzenfeld, das zum Erkennen von Symbolkollisionen verwendet wird.
Standardwert: 2
.
padding?: number | PropertyValueSpecification<number>
Eigenschaftswert
number | PropertyValueSpecification<number>
pitchAlignment
Gibt die Ausrichtung des Texts an, wenn die Karte gehöhet wird.
'"auto"': Entspricht automatisch dem Wert von 'rotationAlignment'.
'"map"': Der Text wird an die Ebene der Karte ausgerichtet.
'"viewport": Der Text wird an die Ebene des Viewports ausgerichtet.
Standard: '"auto"'pitchAlignment?: "auto" | "map" | "viewport"
Eigenschaftswert
"auto" | "map" | "viewport"
radialOffset
Radialer Versatz von Text in richtung des Ankers des Symbols. Nützlich in Kombination mit variableAnchor
, was standardmäßig die Verwendung der zweidimensionalen offset
, wenn vorhanden ist.
Standardwert: 0
radialOffset?: number | DataDrivenPropertyValueSpecification<number>
Eigenschaftswert
number | DataDrivenPropertyValueSpecification<number>
rotation
Der Betrag, der den Text im Uhrzeigersinn in Grad drehen soll.
Standard 0
rotation?: number | DataDrivenPropertyValueSpecification<number>
Eigenschaftswert
number | DataDrivenPropertyValueSpecification<number>
rotationAlignment
In Kombination mit der placement
Eigenschaft des SymbolLayerOptions
, gibt das Drehverhalten der einzelnen Glyphen an, die den Text bilden.
'"auto"': Wenn die Platzierung auf "Punkt" festgelegt ist, entspricht dies ""map". Wenn die Position auf "Zeile" festgelegt ist, entspricht dies ""map".
'"map"': Wenn die Position auf "Punkt" festgelegt ist, wird der Text ost-west ausgerichtet. Wenn die "Platzierung" auf "Zeile" festgelegt ist, richtet text x-Achsen mit der Zeile aus.
'"viewport": Erzeugt Glyphen, deren x-Achsen unabhängig vom Wert "Platzierung" an der X-Achse des Viewports ausgerichtet sind.
Standard: '"auto"'rotationAlignment?: "auto" | "map" | "viewport"
Eigenschaftswert
"auto" | "map" | "viewport"
size
Der Schriftgrad in Pixeln.
Muss eine Zahl größer oder gleich 0 sein.
Standardwert: 16
.
size?: number | DataDrivenPropertyValueSpecification<number>
Eigenschaftswert
number | DataDrivenPropertyValueSpecification<number>
textField
Gibt den Namen einer Eigenschaft für die Features an, die für eine Textbeschriftung verwendet werden sollen.
textField?: string | DataDrivenPropertyValueSpecification<string>
Eigenschaftswert
string | DataDrivenPropertyValueSpecification<string>
variableAnchor
Liste der potenziellen Ankerstandorte, um die Chance zu erhöhen, bezeichnungen mit hoher Priorität auf der Karte zu platzieren. Der Renderer versucht, die Beschriftung an jeder Position in der Reihenfolge zu platzieren, bevor Sie auf die nächste Bezeichnung wechseln. Wird verwendet justify: "auto"
, um die Textbeschriftung basierend auf der Verankerungsposition auszuwählen. Wenn Sie einen Offset anwenden möchten, verwenden Sie die oder zweidimensionale radialOffset
offset
Optionen.
'"Mitte": Die Mitte des Symbols wird am nächsten am Anker platziert.
'"left": Die linke Seite des Symbols wird am nächsten am Anker platziert.
'"rechts": Die rechte Seite des Symbols wird am nächsten am Anker platziert.
'"top": Der obere Rand des Symbols wird am nächsten am Anker platziert.
'"bottom":The bottom of the icon is closest to the anchor.
'"oben links": Die obere linke Ecke des Symbols wird am nächsten am Anker platziert.
'"oben rechts": Die obere rechte Ecke des Symbols wird am nächsten am Anker platziert.
'"unten links": Die untere linke Ecke des Symbols wird am nächsten am Anker platziert.
'"unten rechts": Die untere rechte Ecke des Symbols wird am nächsten am Anker platziert.
Standard: 'nicht definiert'variableAnchor?: PositionAnchor[]