TextOptions interface
SymbolLayer のテキストをカスタマイズするために使用するオプション
- Extends
プロパティ
| allow |
他の記号と競合する場合にテキストを表示するかどうかを指定します。
true の場合、以前に描画した他のシンボルと競合した場合でも、テキストが表示されます。
既定値は |
| anchor | マップ上のアイコン アンカー位置に最も近い位置に配置するアイコンの部分を指定します。 "center": アイコンの中心はアンカーに最も近い位置に配置されます。 "left": アイコンの左側はアンカーに最も近い位置に配置されます。 "right": アイコンの右側はアンカーに最も近い位置に配置されます。 '"top": アイコンの上部はアンカーに最も近い位置に配置されます。 "bottom": アイコンの下部はアンカーに最も近い位置に配置されます。 "左上": アイコンの左上隅は、アンカーに最も近い位置に配置されます。 "右上": アイコンの右上隅はアンカーに最も近い位置に配置されます。 "左下": アイコンの左下隅はアンカーに最も近い位置に配置されます。 '"右下": アイコンの右下隅はアンカーに最も近い位置に配置されます。 既定の '"center"'。 |
| color | テキストの色。
既定値は |
| font | テキストの表示に使用するフォント スタック。
指定できる値: |
| halo |
外側に向かうハローのフェードアウト距離 (ピクセル単位)。
0 以上の数値を指定する必要があります。
既定値は |
| halo |
テキストのハローの色は、背景から目立つのに役立ちます。
既定値は |
| halo |
フォント アウトラインまでのハローの距離 (ピクセル単位)。
0 以上の数値を指定する必要があります。
テキストのハローの最大幅は、フォント サイズの 1/4 です。
既定値は |
| ignore |
他の記号がテキストと競合できるかどうかを指定します。
true の場合、他の記号はテキストと衝突しても表示できます。
既定値は |
| justify | テキストの理由オプション。 '"auto"': テキストはアンカー位置に合わせて配置されます。 '"left"': テキストは左に揃えられます。 "center": テキストは中央揃えです。 '"right":テキストは右側に揃えられます。 既定の '"center"'。 |
| offset | アイコンのアンカーからの ems のオフセット距離を指定します。
正の値は右と下を示し、負の値は左と上を示します。
既定値は |
| opacity | テキストが描画される不透明度を示す 0 から 1 の範囲の数値。
既定値は |
| optional | テキストが別の記号で重なっている場合に非表示にできるかどうかを指定します。
true の場合、テキストが他の記号と競合し、アイコンが表示されない場合、アイコンは対応するテキストなしで表示されます。
既定値は |
| padding | シンボルの競合を検出するために使用されるテキスト境界ボックスの周囲の追加領域のサイズ。
既定値は |
| pitch |
マップのピッチを設定するときのテキストの向きを指定します。 '"auto"': 'rotationAlignment' の値に自動的に一致します。 '"map"': テキストはマップの平面に揃えられます。 '"viewport"': テキストはビューポートの平面に揃えられます。 既定値: '"auto"' |
| radial |
シンボルのアンカーの方向のテキストの放射状オフセット。 と組み合わせて |
| rotation | テキストを時計回りに度単位で回転させる量。
既定 |
| rotation |
のプロパティ '"auto"': 'placement' が '"point"に設定されている場合、これは '"map"と同等です。 'placement' が '"line"に設定されている場合、これは '"map"と同等です。 '"map"': 'placement' が '"point"に設定されている場合は、テキストを東西に揃えます。 "配置" が "line" に設定されている場合は、テキストの x 軸を線に合わせます。 '"viewport"': '配置' の値に関係なく、x 軸がビューポートの x 軸に揃っているグリフを生成します。 既定値: '"auto"' |
| size | フォントのサイズ (ピクセル単位)。
0 以上の数値である必要があります。
既定値は |
| text |
テキスト ラベルに使用するフィーチャのプロパティの名前を指定します。 |
| variable |
マップ上に優先度の高いラベルを配置する可能性を高めるために、アンカーの潜在的な場所の一覧。 レンダラーは、次のラベルに移動する前に、ラベルを各場所に順番に配置しようとします。 アンカー位置に基づいてテキストの理由を選択する場合に使用 '"center"': アイコンの中心はアンカーに最も近い位置に配置されます。 '"left"': アイコンの左側はアンカーに最も近い位置に配置されます。 '"right":アイコンの右側はアンカーに最も近い位置に配置されます。 '"top":アイコンの上部はアンカーに最も近い位置に配置されます。 '"bottom"': アイコンの下部はアンカーに最も近い位置に配置されます。 '"左上隅":アイコンの左上隅はアンカーに最も近い位置に配置されます。 '"右上隅": アイコンの右上隅がアンカーに最も近い位置に配置されます。 '"左下":アイコンの左下隅はアンカーに最も近い位置に配置されます。 '"右下":アイコンの右下隅はアンカーに最も近い位置に配置されます。 既定値: 'undefined' |
プロパティの詳細
allowOverlap
他の記号と競合する場合にテキストを表示するかどうかを指定します。
true の場合、以前に描画した他のシンボルと競合した場合でも、テキストが表示されます。
既定値は false です。
allowOverlap?: booleanプロパティ値
boolean
anchor
マップ上のアイコン アンカー位置に最も近い位置に配置するアイコンの部分を指定します。
"center": アイコンの中心はアンカーに最も近い位置に配置されます。
"left": アイコンの左側はアンカーに最も近い位置に配置されます。
"right": アイコンの右側はアンカーに最も近い位置に配置されます。
'"top": アイコンの上部はアンカーに最も近い位置に配置されます。
"bottom": アイコンの下部はアンカーに最も近い位置に配置されます。
"左上": アイコンの左上隅は、アンカーに最も近い位置に配置されます。
"右上": アイコンの右上隅はアンカーに最も近い位置に配置されます。
"左下": アイコンの左下隅はアンカーに最も近い位置に配置されます。
'"右下": アイコンの右下隅はアンカーに最も近い位置に配置されます。
既定の '"center"'。anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>プロパティ値
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
color
テキストの色。
既定値は "#000000" です。
color?: string | DataDrivenPropertyValueSpecification<string>プロパティ値
string | DataDrivenPropertyValueSpecification<string>
font
テキストの表示に使用するフォント スタック。
指定できる値: "SegoeFrutigerHelveticaMYingHei-Bold", , , "SegoeFrutigerHelveticaMYingHei-Regular", , "SegoeUi-Bold", , "SegoeUi-Light", "SegoeUi-Regular", "SegoeUi-SemiBold", "SegoeUi-SemiLight", "SegoeUi-SymbolRegular", , "StandardCondensedSegoeUi-Black", "StandardCondensedSegoeUi-Light""StandardCondensedSegoeUi-Bold", "StandardCondensedSegoeUi-Regular", "StandardFontCondensed-Black""StandardFont-Light""StandardFontCondensed-Regular""StandardFont-Black""StandardFontCondensed-Light""StandardFont-Bold""StandardFontCondensed-Bold""StandardFont-Regular", . "SegoeFrutigerHelveticaMYingHei-Medium"
既定値は ["StandardFont-Regular"] です。
font?: string[] | DataDrivenPropertyValueSpecification<string[]>プロパティ値
string[] | DataDrivenPropertyValueSpecification<string[]>
haloBlur
外側に向かうハローのフェードアウト距離 (ピクセル単位)。
0 以上の数値を指定する必要があります。
既定値は 0 です。
haloBlur?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
haloColor
テキストのハローの色は、背景から目立つのに役立ちます。
既定値は "rgba(0,0,0,0)" です。
haloColor?: string | DataDrivenPropertyValueSpecification<string>プロパティ値
string | DataDrivenPropertyValueSpecification<string>
haloWidth
フォント アウトラインまでのハローの距離 (ピクセル単位)。
0 以上の数値を指定する必要があります。
テキストのハローの最大幅は、フォント サイズの 1/4 です。
既定値は 0 です。
haloWidth?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
ignorePlacement
他の記号がテキストと競合できるかどうかを指定します。
true の場合、他の記号はテキストと衝突しても表示できます。
既定値は false です。
ignorePlacement?: booleanプロパティ値
boolean
justify
テキストの理由オプション。
'"auto"': テキストはアンカー位置に合わせて配置されます。
'"left"': テキストは左に揃えられます。
"center": テキストは中央揃えです。
'"right":テキストは右側に揃えられます。 既定の '"center"'。
justify?: "auto" | "left" | "center" | "right"プロパティ値
"auto" | "left" | "center" | "right"
offset
アイコンのアンカーからの ems のオフセット距離を指定します。
正の値は右と下を示し、負の値は左と上を示します。
既定値は [0, 0] です。
offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>プロパティ値
opacity
テキストが描画される不透明度を示す 0 から 1 の範囲の数値。
既定値は 1 です。
opacity?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
optional
テキストが別の記号で重なっている場合に非表示にできるかどうかを指定します。
true の場合、テキストが他の記号と競合し、アイコンが表示されない場合、アイコンは対応するテキストなしで表示されます。
既定値は false です。
optional?: booleanプロパティ値
boolean
padding
シンボルの競合を検出するために使用されるテキスト境界ボックスの周囲の追加領域のサイズ。
既定値は 2 です。
padding?: number | PropertyValueSpecification<number>プロパティ値
number | PropertyValueSpecification<number>
pitchAlignment
マップのピッチを設定するときのテキストの向きを指定します。
'"auto"': 'rotationAlignment' の値に自動的に一致します。
'"map"': テキストはマップの平面に揃えられます。
'"viewport"': テキストはビューポートの平面に揃えられます。
既定値: '"auto"'pitchAlignment?: "auto" | "map" | "viewport"プロパティ値
"auto" | "map" | "viewport"
radialOffset
シンボルのアンカーの方向のテキストの放射状オフセット。 と組み合わせて variableAnchor使用すると、既定で 2 次元 offset が使用されます (存在する場合)。
既定値: 0
radialOffset?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
rotation
テキストを時計回りに度単位で回転させる量。
既定 0
rotation?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
rotationAlignment
のプロパティSymbolLayerOptionsとplacement組み合わせて、テキストを形成する個々のグリフの回転動作を指定します。
'"auto"': 'placement' が '"point"に設定されている場合、これは '"map"と同等です。 'placement' が '"line"に設定されている場合、これは '"map"と同等です。
'"map"': 'placement' が '"point"に設定されている場合は、テキストを東西に揃えます。 "配置" が "line" に設定されている場合は、テキストの x 軸を線に合わせます。
'"viewport"': '配置' の値に関係なく、x 軸がビューポートの x 軸に揃っているグリフを生成します。
既定値: '"auto"'rotationAlignment?: "auto" | "map" | "viewport"プロパティ値
"auto" | "map" | "viewport"
size
フォントのサイズ (ピクセル単位)。
0 以上の数値である必要があります。
既定値は 16 です。
size?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
textField
テキスト ラベルに使用するフィーチャのプロパティの名前を指定します。
textField?: string | DataDrivenPropertyValueSpecification<string>プロパティ値
string | DataDrivenPropertyValueSpecification<string>
variableAnchor
マップ上に優先度の高いラベルを配置する可能性を高めるために、アンカーの潜在的な場所の一覧。 レンダラーは、次のラベルに移動する前に、ラベルを各場所に順番に配置しようとします。 アンカー位置に基づいてテキストの理由を選択する場合に使用 justify: "auto" します。 オフセットを適用するには、2 次元オプションまたは 2 次元offsetオプションをradialOffset使用します。
'"center"': アイコンの中心はアンカーに最も近い位置に配置されます。
'"left"': アイコンの左側はアンカーに最も近い位置に配置されます。
'"right":アイコンの右側はアンカーに最も近い位置に配置されます。
'"top":アイコンの上部はアンカーに最も近い位置に配置されます。
'"bottom"': アイコンの下部はアンカーに最も近い位置に配置されます。
'"左上隅":アイコンの左上隅はアンカーに最も近い位置に配置されます。
'"右上隅": アイコンの右上隅がアンカーに最も近い位置に配置されます。
'"左下":アイコンの左下隅はアンカーに最も近い位置に配置されます。
'"右下":アイコンの右下隅はアンカーに最も近い位置に配置されます。
既定値: 'undefined'variableAnchor?: PositionAnchor[]