TextOptions interface
Opsi yang digunakan untuk mengkustomisasi teks dalam SymbolLayer
- Extends
Properti
allow |
Menentukan apakah teks akan terlihat jika bertabrakan dengan simbol lain.
Jika true, teks akan terlihat meskipun bertabrakan dengan simbol lain yang sebelumnya digambar.
Default |
anchor | Menentukan bagian ikon mana yang paling dekat dengan posisi jangkar ikon pada peta. '"center"': Pusat ikon ditempatkan paling dekat dengan jangkar. '"left"': Sisi kiri ikon ditempatkan paling dekat dengan jangkar. '"right"': Sisi kanan ikon ditempatkan paling dekat dengan jangkar. '"top"': Bagian atas ikon ditempatkan paling dekat dengan jangkar. '"bottom"': Bagian bawah ikon ditempatkan paling dekat dengan jangkar. '"kiri atas"': Sudut kiri atas ikon ditempatkan paling dekat dengan jangkar. '"kanan atas"': Sudut kanan atas ikon ditempatkan paling dekat dengan jangkar. '"kiri bawah"': Sudut kiri bawah ikon ditempatkan paling dekat dengan jangkar. '"kanan bawah"': Sudut kanan bawah ikon ditempatkan paling dekat dengan jangkar. Default '"center"'. |
color | Warna teks.
Default |
font | Tumpukan font yang digunakan untuk menampilkan teks.
Nilai yang mungkin: |
halo |
Jarak pudar halo terhadap bagian luar dalam piksel.
Harus angka yang lebih besar atau sama dengan 0.
Default |
halo |
Warna halo teks, yang membantunya menonjol dari latar belakang.
Default |
halo |
Jarak halo ke kerangka font dalam piksel.
Harus angka yang lebih besar atau sama dengan 0.
Lebar halo teks maksimum adalah 1/4 dari ukuran font.
Default |
ignore |
Menentukan apakah simbol lain diizinkan untuk bertabrakan dengan teks.
Jika true, simbol lain dapat terlihat meskipun bertabrakan dengan teks.
Default |
justify | Opsi pembenaran teks. '"auto"': Teks diratakan ke posisi jangkar. '"left"': Teks diratakan ke kiri. '"center"': Teks dipusatkan. '"right"': Teks diratakan ke kanan. Default '"center"'. |
offset | Menentukan jarak offset ikon dari jangkarnya di ems.
Nilai positif menunjukkan ke kanan dan ke bawah, sementara nilai negatif menunjukkan kiri dan atas.
Default |
opacity | Angka antara 0 dan 1 yang menunjukkan tingkat keburaman di mana teks akan digambar.
Default |
optional | Menentukan apakah teks dapat disembunyikan jika tumpang tindih dengan simbol lain.
Jika true, ikon akan ditampilkan tanpa teks yang sesuai ketika teks bertabrakan dengan simbol lain dan ikon tidak.
Default |
padding | Ukuran area tambahan di sekitar kotak pembatas teks yang digunakan untuk mendeteksi tabrakan simbol.
Default |
pitch |
Menentukan orientasi teks saat peta di-pitch. '"auto"': Secara otomatis cocok dengan nilai 'rotationAlignment'. '"map"': Teks diratakan ke bidang peta. '"viewport"': Teks diratakan ke bidang viewport. Default: '"auto"' |
radial |
Offset radial teks, ke arah jangkar simbol. Berguna dalam kombinasi dengan |
rotation | Jumlah untuk memutar teks searah jajar dalam derajat.
Default |
rotation |
Dalam kombinasi dengan '"auto"': Ketika 'penempatan' diatur ke '"point"', ini setara dengan '"map"'. Ketika 'penempatan' diatur ke '"line"' ini setara dengan '"map"'. '"map"': Saat 'penempatan' diatur ke '"point"', menyelaraskan teks timur-barat. Saat 'penempatan' diatur ke '"line"', meratakan teks x-axes dengan baris. '"viewport"': Menghasilkan glyph yang sumbu x-nya diselaraskan dengan sumbu x viewport, terlepas dari nilai 'penempatan'. Default: '"auto"' |
size | Ukuran font dalam piksel.
Harus angka yang lebih besar atau sama dengan 0.
Default |
text |
Menentukan nama properti pada fitur yang akan digunakan untuk label teks. |
variable |
Daftar lokasi jangkar potensial, untuk meningkatkan kemungkinan menempatkan label berprioritas tinggi di peta. Perender akan mencoba menempatkan label di setiap lokasi, secara berurutan, sebelum pindah ke label berikutnya. Gunakan '"center"': Pusat ikon ditempatkan paling dekat dengan jangkar. '"left"': Sisi kiri ikon ditempatkan paling dekat dengan jangkar. '"right"': Sisi kanan ikon ditempatkan paling dekat dengan jangkar. '"top"': Bagian atas ikon ditempatkan paling dekat dengan jangkar. '"bottom"': Bagian bawah ikon ditempatkan paling dekat dengan jangkar. '"kiri atas"': Sudut kiri atas ikon ditempatkan paling dekat dengan jangkar. '"kanan atas"': Sudut kanan atas ikon ditempatkan paling dekat dengan jangkar. '"kiri bawah"': Sudut kiri bawah ikon ditempatkan paling dekat dengan jangkar. '"kanan bawah"': Sudut kanan bawah ikon ditempatkan paling dekat dengan jangkar. Default: 'undefined' |
Detail Properti
allowOverlap
Menentukan apakah teks akan terlihat jika bertabrakan dengan simbol lain.
Jika true, teks akan terlihat meskipun bertabrakan dengan simbol lain yang sebelumnya digambar.
Default false
.
allowOverlap?: boolean
Nilai Properti
boolean
anchor
Menentukan bagian ikon mana yang paling dekat dengan posisi jangkar ikon pada peta.
'"center"': Pusat ikon ditempatkan paling dekat dengan jangkar.
'"left"': Sisi kiri ikon ditempatkan paling dekat dengan jangkar.
'"right"': Sisi kanan ikon ditempatkan paling dekat dengan jangkar.
'"top"': Bagian atas ikon ditempatkan paling dekat dengan jangkar.
'"bottom"': Bagian bawah ikon ditempatkan paling dekat dengan jangkar.
'"kiri atas"': Sudut kiri atas ikon ditempatkan paling dekat dengan jangkar.
'"kanan atas"': Sudut kanan atas ikon ditempatkan paling dekat dengan jangkar.
'"kiri bawah"': Sudut kiri bawah ikon ditempatkan paling dekat dengan jangkar.
'"kanan bawah"': Sudut kanan bawah ikon ditempatkan paling dekat dengan jangkar.
Default '"center"'.anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
Nilai Properti
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
color
Warna teks.
Default "#000000"
.
color?: string | DataDrivenPropertyValueSpecification<string>
Nilai Properti
string | DataDrivenPropertyValueSpecification<string>
font
Tumpukan font yang digunakan untuk menampilkan teks.
Nilai yang mungkin: "SegoeFrutigerHelveticaMYingHei-Bold"
, , "SegoeFrutigerHelveticaMYingHei-Medium"
, "SegoeFrutigerHelveticaMYingHei-Regular"
"SegoeUi-Bold"
, "SegoeUi-Light"
, "SegoeUi-Regular"
, "SegoeUi-SemiBold"
, "SegoeUi-SemiLight"
, "SegoeUi-SymbolRegular"
, "StandardCondensedSegoeUi-Bold"
"StandardCondensedSegoeUi-Black"
, , "StandardCondensedSegoeUi-Light"
, "StandardCondensedSegoeUi-Regular"
, "StandardFont-Black"
, "StandardFont-Bold"
, "StandardFont-Light"
, "StandardFontCondensed-Black"
"StandardFont-Regular"
, "StandardFontCondensed-Bold"
, "StandardFontCondensed-Light"
. "StandardFontCondensed-Regular"
Default ["StandardFont-Regular"]
.
font?: string[] | DataDrivenPropertyValueSpecification<string[]>
Nilai Properti
string[] | DataDrivenPropertyValueSpecification<string[]>
haloBlur
Jarak pudar halo terhadap bagian luar dalam piksel.
Harus angka yang lebih besar atau sama dengan 0.
Default 0
.
haloBlur?: number | DataDrivenPropertyValueSpecification<number>
Nilai Properti
number | DataDrivenPropertyValueSpecification<number>
haloColor
Warna halo teks, yang membantunya menonjol dari latar belakang.
Default "rgba(0,0,0,0)"
.
haloColor?: string | DataDrivenPropertyValueSpecification<string>
Nilai Properti
string | DataDrivenPropertyValueSpecification<string>
haloWidth
Jarak halo ke kerangka font dalam piksel.
Harus angka yang lebih besar atau sama dengan 0.
Lebar halo teks maksimum adalah 1/4 dari ukuran font.
Default 0
.
haloWidth?: number | DataDrivenPropertyValueSpecification<number>
Nilai Properti
number | DataDrivenPropertyValueSpecification<number>
ignorePlacement
Menentukan apakah simbol lain diizinkan untuk bertabrakan dengan teks.
Jika true, simbol lain dapat terlihat meskipun bertabrakan dengan teks.
Default false
.
ignorePlacement?: boolean
Nilai Properti
boolean
justify
Opsi pembenaran teks.
'"auto"': Teks diratakan ke posisi jangkar.
'"left"': Teks diratakan ke kiri.
'"center"': Teks dipusatkan.
'"right"': Teks diratakan ke kanan. Default '"center"'.
justify?: "auto" | "left" | "center" | "right"
Nilai Properti
"auto" | "left" | "center" | "right"
offset
Menentukan jarak offset ikon dari jangkarnya di ems.
Nilai positif menunjukkan ke kanan dan ke bawah, sementara nilai negatif menunjukkan kiri dan atas.
Default [0, 0]
.
offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>
Nilai Properti
opacity
Angka antara 0 dan 1 yang menunjukkan tingkat keburaman di mana teks akan digambar.
Default 1
.
opacity?: number | DataDrivenPropertyValueSpecification<number>
Nilai Properti
number | DataDrivenPropertyValueSpecification<number>
optional
Menentukan apakah teks dapat disembunyikan jika tumpang tindih dengan simbol lain.
Jika true, ikon akan ditampilkan tanpa teks yang sesuai ketika teks bertabrakan dengan simbol lain dan ikon tidak.
Default false
.
optional?: boolean
Nilai Properti
boolean
padding
Ukuran area tambahan di sekitar kotak pembatas teks yang digunakan untuk mendeteksi tabrakan simbol.
Default 2
.
padding?: number | PropertyValueSpecification<number>
Nilai Properti
number | PropertyValueSpecification<number>
pitchAlignment
Menentukan orientasi teks saat peta di-pitch.
'"auto"': Secara otomatis cocok dengan nilai 'rotationAlignment'.
'"map"': Teks diratakan ke bidang peta.
'"viewport"': Teks diratakan ke bidang viewport.
Default: '"auto"'pitchAlignment?: "auto" | "map" | "viewport"
Nilai Properti
"auto" | "map" | "viewport"
radialOffset
Offset radial teks, ke arah jangkar simbol. Berguna dalam kombinasi dengan variableAnchor
, yang defaultnya menggunakan dua dimensi offset
jika ada.
Default: 0
radialOffset?: number | DataDrivenPropertyValueSpecification<number>
Nilai Properti
number | DataDrivenPropertyValueSpecification<number>
rotation
Jumlah untuk memutar teks searah jajar dalam derajat.
Default 0
rotation?: number | DataDrivenPropertyValueSpecification<number>
Nilai Properti
number | DataDrivenPropertyValueSpecification<number>
rotationAlignment
Dalam kombinasi dengan placement
properti , SymbolLayerOptions
menentukan perilaku rotasi glyph individu yang membentuk teks.
'"auto"': Ketika 'penempatan' diatur ke '"point"', ini setara dengan '"map"'. Ketika 'penempatan' diatur ke '"line"' ini setara dengan '"map"'.
'"map"': Saat 'penempatan' diatur ke '"point"', menyelaraskan teks timur-barat. Saat 'penempatan' diatur ke '"line"', meratakan teks x-axes dengan baris.
'"viewport"': Menghasilkan glyph yang sumbu x-nya diselaraskan dengan sumbu x viewport, terlepas dari nilai 'penempatan'.
Default: '"auto"'rotationAlignment?: "auto" | "map" | "viewport"
Nilai Properti
"auto" | "map" | "viewport"
size
Ukuran font dalam piksel.
Harus angka yang lebih besar atau sama dengan 0.
Default 16
.
size?: number | DataDrivenPropertyValueSpecification<number>
Nilai Properti
number | DataDrivenPropertyValueSpecification<number>
textField
Menentukan nama properti pada fitur yang akan digunakan untuk label teks.
textField?: string | DataDrivenPropertyValueSpecification<string>
Nilai Properti
string | DataDrivenPropertyValueSpecification<string>
variableAnchor
Daftar lokasi jangkar potensial, untuk meningkatkan kemungkinan menempatkan label berprioritas tinggi di peta. Perender akan mencoba menempatkan label di setiap lokasi, secara berurutan, sebelum pindah ke label berikutnya. Gunakan justify: "auto"
untuk memilih pembenaran teks berdasarkan posisi jangkar. Untuk menerapkan offset, gunakan radialOffset
atau opsi dua dimensi offset
.
'"center"': Pusat ikon ditempatkan paling dekat dengan jangkar.
'"left"': Sisi kiri ikon ditempatkan paling dekat dengan jangkar.
'"right"': Sisi kanan ikon ditempatkan paling dekat dengan jangkar.
'"top"': Bagian atas ikon ditempatkan paling dekat dengan jangkar.
'"bottom"': Bagian bawah ikon ditempatkan paling dekat dengan jangkar.
'"kiri atas"': Sudut kiri atas ikon ditempatkan paling dekat dengan jangkar.
'"kanan atas"': Sudut kanan atas ikon ditempatkan paling dekat dengan jangkar.
'"kiri bawah"': Sudut kiri bawah ikon ditempatkan paling dekat dengan jangkar.
'"kanan bawah"': Sudut kanan bawah ikon ditempatkan paling dekat dengan jangkar.
Default: 'undefined'variableAnchor?: PositionAnchor[]