TextOptions interface
Opcje używane do dostosowywania tekstu w elemenie symboli
- Extends
Właściwości
| allow |
Określa, czy tekst będzie widoczny, jeśli zderza się z innymi symbolami.
Jeśli wartość true, tekst będzie widoczny, nawet jeśli zderza się z innymi wcześniej narysowanymi symbolami.
Wartość domyślna |
| anchor | Określa, która część ikony znajduje się najbliżej pozycji zakotwiczenia ikon na mapie. "środek": środek ikony znajduje się najbliżej kotwicy. "lewa": lewa strona ikony znajduje się najbliżej kotwicy. "Prawo": prawa strona ikony znajduje się najbliżej kotwicy. "top": górna część ikony znajduje się najbliżej kotwicy. "Dolna": dolna część ikony znajduje się najbliżej kotwicy. "Lewy górny": lewy górny róg ikony znajduje się najbliżej kotwicy. ""Prawy górny": prawy górny róg ikony znajduje się najbliżej kotwicy. ""Lewy dolny": lewy dolny róg ikony znajduje się najbliżej kotwicy. ""Prawy dolny": prawy dolny róg ikony znajduje się najbliżej kotwicy. Wartość domyślna "środek". |
| color | Kolor tekstu.
Wartość domyślna |
| font | Stos czcionek do użycia do wyświetlania tekstu.
Możliwe wartości: |
| halo |
Odległość zanikania halo w kierunku zewnątrz w pikselach.
Musi być liczbą większą lub równą 0.
Wartość domyślna |
| halo |
Kolor halo tekstu, który pomaga wyróżnić się na tle.
Wartość domyślna |
| halo |
Odległość obwódki do konturu czcionki w pikselach.
Musi być liczbą większą lub równą 0.
Maksymalna szerokość obwódki tekstu to 1/4 rozmiaru czcionki.
Wartość domyślna |
| ignore |
Określa, czy inne symbole mogą kolidować z tekstem.
Jeśli to prawda, inne symbole mogą być widoczne, nawet jeśli zderzają się z tekstem.
Wartość domyślna |
| justify | Opcje uzasadnienia tekstowego. "auto": tekst jest wyrównany do położenia kotwicy. "lewa": tekst jest wyrównany do lewej. "środek": tekst jest wyśrodkowany. ""prawo": tekst jest wyrównany do prawej. Domyślna wartość ""center" (środek). |
| offset | Określa odległość przesunięcia ikony z kotwicy w ems.
Wartości dodatnie wskazują prawą i w dół, a wartości ujemne wskazują lewe i w górę.
Wartość domyślna |
| opacity | Liczba z zakresu od 0 do 1 wskazująca nieprzezroczystość, w której zostanie narysowany tekst.
Wartość domyślna |
| optional | Określa, czy tekst może być ukryty, jeśli nakłada się na inny symbol.
Jeśli prawda, ikony będą wyświetlane bez odpowiedniego tekstu, gdy tekst koliduje z innymi symbolami, a ikona nie.
Wartość domyślna |
| padding | Rozmiar dodatkowego obszaru wokół pola ograniczenia tekstu używanego do wykrywania kolizji symboli.
Wartość domyślna |
| pitch |
Określa orientację tekstu, gdy mapa jest rozmieściona. "auto": Automatycznie odpowiada wartości "rotationAlignment". "map": tekst jest wyrównany do płaszczyzny mapy. ""viewport": tekst jest wyrównany do płaszczyzny portu widoku. Ustawienie domyślne: "auto" |
| radial |
Przesunięcie promieniowe tekstu w kierunku kotwicy symbolu. Przydatne w połączeniu z parametrem |
| rotation | Ilość obracania tekstu zgodnie z ruchem wskazówek zegara w stopniach.
Domyślny |
| rotation |
W połączeniu "auto": gdy pozycja "umieszczania" jest ustawiona na "punkt", jest to równoważne "mapie". Gdy ustawienie "umieszczanie" ma wartość ""line", jest to równoważne "mapie". "map": gdy pozycja "umieszczania" jest ustawiona na ""punkt", wyrównuje tekst na wschód-zachód. Gdy "umieszczanie" jest ustawione na "wiersz", wyrównuje tekst osi x z linią. ""viewport": Tworzy glify, których osie x są wyrównane z osią xportu, niezależnie od wartości "umieszczania". Ustawienie domyślne: "auto" |
| size | Rozmiar czcionki w pikselach.
Musi być liczbą większą lub równą 0.
Wartość domyślna |
| text |
Określa nazwę właściwości funkcji do użycia dla etykiety tekstowej. |
| variable |
Lista potencjalnych lokalizacji kotwicy, aby zwiększyć prawdopodobieństwo umieszczania etykiet o wysokim priorytcie na mapie. Moduł renderowany podejmie próbę umieszczenie etykiety w każdej lokalizacji w kolejności przed przejściem na następną etykietę. Służy "środek": środek ikony znajduje się najbliżej kotwicy. ""left": Lewa strona ikony znajduje się najbliżej kotwicy. "Prawo": prawa strona ikony znajduje się najbliżej kotwicy. "top": górna część ikony znajduje się najbliżej kotwicy. "Dolne": dolna część ikony znajduje się najbliżej kotwicy. ""Lewy górny": lewy górny róg ikony znajduje się najbliżej kotwicy. ""Prawy górny": prawy górny róg ikony znajduje się najbliżej kotwicy. ""Lewy dolny": lewy dolny róg ikony znajduje się najbliżej kotwicy. ""Prawy dolny": prawy dolny róg ikony znajduje się najbliżej kotwicy. Ustawienie domyślne: "niezdefiniowane" |
Szczegóły właściwości
allowOverlap
Określa, czy tekst będzie widoczny, jeśli zderza się z innymi symbolami.
Jeśli wartość true, tekst będzie widoczny, nawet jeśli zderza się z innymi wcześniej narysowanymi symbolami.
Wartość domyślna false.
allowOverlap?: booleanWartość właściwości
boolean
anchor
Określa, która część ikony znajduje się najbliżej pozycji zakotwiczenia ikon na mapie.
"środek": środek ikony znajduje się najbliżej kotwicy.
"lewa": lewa strona ikony znajduje się najbliżej kotwicy.
"Prawo": prawa strona ikony znajduje się najbliżej kotwicy.
"top": górna część ikony znajduje się najbliżej kotwicy.
"Dolna": dolna część ikony znajduje się najbliżej kotwicy.
"Lewy górny": lewy górny róg ikony znajduje się najbliżej kotwicy.
""Prawy górny": prawy górny róg ikony znajduje się najbliżej kotwicy.
""Lewy dolny": lewy dolny róg ikony znajduje się najbliżej kotwicy.
""Prawy dolny": prawy dolny róg ikony znajduje się najbliżej kotwicy.
Wartość domyślna "środek".anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>Wartość właściwości
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
color
Kolor tekstu.
Wartość domyślna "#000000".
color?: string | DataDrivenPropertyValueSpecification<string>Wartość właściwości
string | DataDrivenPropertyValueSpecification<string>
font
Stos czcionek do użycia do wyświetlania tekstu.
Możliwe wartości: "SegoeFrutigerHelveticaMYingHei-Bold", "SegoeFrutigerHelveticaMYingHei-Medium""SegoeFrutigerHelveticaMYingHei-Regular""StandardFontCondensed-Light""StandardFont-Bold""StandardFontCondensed-Bold""StandardFont-Black""StandardFontCondensed-Regular""StandardFontCondensed-Black""StandardFont-Regular""StandardFont-Light""StandardCondensedSegoeUi-Regular""StandardCondensedSegoeUi-Light""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Black""SegoeUi-SemiLight""SegoeUi-Regular""SegoeUi-SymbolRegular""SegoeUi-Bold""SegoeUi-Light""SegoeUi-SemiBold".
Wartość domyślna ["StandardFont-Regular"].
font?: string[] | DataDrivenPropertyValueSpecification<string[]>Wartość właściwości
string[] | DataDrivenPropertyValueSpecification<string[]>
haloBlur
Odległość zanikania halo w kierunku zewnątrz w pikselach.
Musi być liczbą większą lub równą 0.
Wartość domyślna 0.
haloBlur?: number | DataDrivenPropertyValueSpecification<number>Wartość właściwości
number | DataDrivenPropertyValueSpecification<number>
haloColor
Kolor halo tekstu, który pomaga wyróżnić się na tle.
Wartość domyślna "rgba(0,0,0,0)".
haloColor?: string | DataDrivenPropertyValueSpecification<string>Wartość właściwości
string | DataDrivenPropertyValueSpecification<string>
haloWidth
Odległość obwódki do konturu czcionki w pikselach.
Musi być liczbą większą lub równą 0.
Maksymalna szerokość obwódki tekstu to 1/4 rozmiaru czcionki.
Wartość domyślna 0.
haloWidth?: number | DataDrivenPropertyValueSpecification<number>Wartość właściwości
number | DataDrivenPropertyValueSpecification<number>
ignorePlacement
Określa, czy inne symbole mogą kolidować z tekstem.
Jeśli to prawda, inne symbole mogą być widoczne, nawet jeśli zderzają się z tekstem.
Wartość domyślna false.
ignorePlacement?: booleanWartość właściwości
boolean
justify
Opcje uzasadnienia tekstowego.
"auto": tekst jest wyrównany do położenia kotwicy.
"lewa": tekst jest wyrównany do lewej.
"środek": tekst jest wyśrodkowany.
""prawo": tekst jest wyrównany do prawej. Domyślna wartość ""center" (środek).
justify?: "auto" | "left" | "center" | "right"Wartość właściwości
"auto" | "left" | "center" | "right"
offset
Określa odległość przesunięcia ikony z kotwicy w ems.
Wartości dodatnie wskazują prawą i w dół, a wartości ujemne wskazują lewe i w górę.
Wartość domyślna [0, 0].
offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>Wartość właściwości
opacity
Liczba z zakresu od 0 do 1 wskazująca nieprzezroczystość, w której zostanie narysowany tekst.
Wartość domyślna 1.
opacity?: number | DataDrivenPropertyValueSpecification<number>Wartość właściwości
number | DataDrivenPropertyValueSpecification<number>
optional
Określa, czy tekst może być ukryty, jeśli nakłada się na inny symbol.
Jeśli prawda, ikony będą wyświetlane bez odpowiedniego tekstu, gdy tekst koliduje z innymi symbolami, a ikona nie.
Wartość domyślna false.
optional?: booleanWartość właściwości
boolean
padding
Rozmiar dodatkowego obszaru wokół pola ograniczenia tekstu używanego do wykrywania kolizji symboli.
Wartość domyślna 2.
padding?: number | PropertyValueSpecification<number>Wartość właściwości
number | PropertyValueSpecification<number>
pitchAlignment
Określa orientację tekstu, gdy mapa jest rozmieściona.
"auto": Automatycznie odpowiada wartości "rotationAlignment".
"map": tekst jest wyrównany do płaszczyzny mapy.
""viewport": tekst jest wyrównany do płaszczyzny portu widoku.
Ustawienie domyślne: "auto"pitchAlignment?: "auto" | "map" | "viewport"Wartość właściwości
"auto" | "map" | "viewport"
radialOffset
Przesunięcie promieniowe tekstu w kierunku kotwicy symbolu. Przydatne w połączeniu z parametrem variableAnchor, który domyślnie używa dwuwymiarowych offset , jeśli istnieje.
Domyślny: 0
radialOffset?: number | DataDrivenPropertyValueSpecification<number>Wartość właściwości
number | DataDrivenPropertyValueSpecification<number>
rotation
Ilość obracania tekstu zgodnie z ruchem wskazówek zegara w stopniach.
Domyślny 0
rotation?: number | DataDrivenPropertyValueSpecification<number>Wartość właściwości
number | DataDrivenPropertyValueSpecification<number>
rotationAlignment
W połączeniu SymbolLayerOptionsz placement właściwością , określa zachowanie rotacji poszczególnych glifów tworzących tekst.
"auto": gdy pozycja "umieszczania" jest ustawiona na "punkt", jest to równoważne "mapie". Gdy ustawienie "umieszczanie" ma wartość ""line", jest to równoważne "mapie".
"map": gdy pozycja "umieszczania" jest ustawiona na ""punkt", wyrównuje tekst na wschód-zachód. Gdy "umieszczanie" jest ustawione na "wiersz", wyrównuje tekst osi x z linią.
""viewport": Tworzy glify, których osie x są wyrównane z osią xportu, niezależnie od wartości "umieszczania".
Ustawienie domyślne: "auto"rotationAlignment?: "auto" | "map" | "viewport"Wartość właściwości
"auto" | "map" | "viewport"
size
Rozmiar czcionki w pikselach.
Musi być liczbą większą lub równą 0.
Wartość domyślna 16.
size?: number | DataDrivenPropertyValueSpecification<number>Wartość właściwości
number | DataDrivenPropertyValueSpecification<number>
textField
Określa nazwę właściwości funkcji do użycia dla etykiety tekstowej.
textField?: string | DataDrivenPropertyValueSpecification<string>Wartość właściwości
string | DataDrivenPropertyValueSpecification<string>
variableAnchor
Lista potencjalnych lokalizacji kotwicy, aby zwiększyć prawdopodobieństwo umieszczania etykiet o wysokim priorytcie na mapie. Moduł renderowany podejmie próbę umieszczenie etykiety w każdej lokalizacji w kolejności przed przejściem na następną etykietę. Służy justify: "auto" do wybierania uzasadnienia tekstu na podstawie położenia kotwicy. Aby zastosować przesunięcie, użyj radialOffset opcji lub dwuwymiarowych offset .
"środek": środek ikony znajduje się najbliżej kotwicy.
""left": Lewa strona ikony znajduje się najbliżej kotwicy.
"Prawo": prawa strona ikony znajduje się najbliżej kotwicy.
"top": górna część ikony znajduje się najbliżej kotwicy.
"Dolne": dolna część ikony znajduje się najbliżej kotwicy.
""Lewy górny": lewy górny róg ikony znajduje się najbliżej kotwicy.
""Prawy górny": prawy górny róg ikony znajduje się najbliżej kotwicy.
""Lewy dolny": lewy dolny róg ikony znajduje się najbliżej kotwicy.
""Prawy dolny": prawy dolny róg ikony znajduje się najbliżej kotwicy.
Ustawienie domyślne: "niezdefiniowane"variableAnchor?: PositionAnchor[]