IconOptions interface
SymbolLayer のアイコンをカスタマイズするために使用するオプション
- Extends
プロパティ
| allow |
シンボル アイコンがマップ上の他のシンボルをオーバーレイできるかどうかを指定します。
以前に描画した他のシンボルと競合した場合でもアイコンが表示される場合 |
| anchor | マップ上のアイコン アンカー位置に最も近い位置に配置するアイコンの部分を指定します。 "center": アイコンの中心はアンカーに最も近い位置に配置されます。 "left": アイコンの左側はアンカーに最も近い位置に配置されます。 "right": アイコンの右側はアンカーに最も近い位置に配置されます。 '"top": アイコンの上部はアンカーに最も近い位置に配置されます。 "bottom": アイコンの下部はアンカーに最も近い位置に配置されます。 "左上": アイコンの左上隅は、アンカーに最も近い位置に配置されます。 "右上": アイコンの右上隅はアンカーに最も近い位置に配置されます。 "左下": アイコンの左下隅はアンカーに最も近い位置に配置されます。 '"右下": アイコンの右下隅はアンカーに最も近い位置に配置されます。 既定の '"bottom"'。 |
| ignore |
他のシンボルがこのシンボルと重なることができるかどうかを指定します。
true の場合、他のシンボルはアイコンと衝突した場合でも表示できます。
既定値は |
| image | アイコンの描画に使用するマップの画像スプライト内のイメージの名前。
使用可能な組み込みイメージ: |
| offset | アイコンのアンカーからのオフセット距離をピクセル単位で指定します。
正の値は右と下を示し、負の値は左と上を示します。
各コンポーネントにサイズの値を乗算して、最終的なオフセットをピクセル単位で取得します。
回転と組み合わせると、オフセットは回転方向が上にあるかのように表示されます。
既定値は |
| opacity | アイコンが描画される不透明度を示す 0 ~ 1 の範囲の数値。
既定値は |
| optional | シンボル アイコンを非表示にできるかどうかを指定しますが、別のシンボルと重複している場合は、そのテキストを表示します。
true の場合、アイコンが他のシンボルと競合し、テキストが表示されない場合、対応するアイコンなしでテキストが表示されます。
既定値は |
| padding | シンボルの競合を検出するために使用されるアイコン境界ボックスの周囲の追加領域のサイズ。
既定値は |
| pitch |
マップがピッチされたときのアイコンの向きを指定します。 '"auto"': 'rotationAlignment' の値に自動的に一致します。 "map": アイコンはマップの平面に揃えられます。 '"viewport"': アイコンはビューポートの平面に揃えられます 既定の '"auto"' |
| rotation | アイコンを時計回りに回転させる量を既定の角度で指定します |
| rotation |
SymbolLayerOptions の配置プロパティと組み合わせることで、アイコンの回転動作が決まります。 '"auto"': 配置が "point" の場合、これは "ビューポート" と同じです。 配置が "line" の場合、これは "map" と同じです。 '"map"': 配置が "point" の場合、アイコンは東から西に配置されます。 配置が "line" の場合、アイコンの x 軸が線に合わせて配置されます。 '"viewport"': アイコン' x 軸は、ビューポートの x 軸に合わせて配置されます。 既定の '"auto"' です。 |
| size | 指定した係数でアイコンの元のサイズをスケーリングします。
0 以上である必要があります。
既定値は |
プロパティの詳細
allowOverlap
シンボル アイコンがマップ上の他のシンボルをオーバーレイできるかどうかを指定します。
以前に描画した他のシンボルと競合した場合でもアイコンが表示される場合 true 。
ヒント: スムーズなレンダリングを保証するためにシンボルをアニメーション化する場合は、これを true に設定します。
既定値は false です。
allowOverlap?: booleanプロパティ値
boolean
anchor
マップ上のアイコン アンカー位置に最も近い位置に配置するアイコンの部分を指定します。
"center": アイコンの中心はアンカーに最も近い位置に配置されます。
"left": アイコンの左側はアンカーに最も近い位置に配置されます。
"right": アイコンの右側はアンカーに最も近い位置に配置されます。
'"top": アイコンの上部はアンカーに最も近い位置に配置されます。
"bottom": アイコンの下部はアンカーに最も近い位置に配置されます。
"左上": アイコンの左上隅は、アンカーに最も近い位置に配置されます。
"右上": アイコンの右上隅はアンカーに最も近い位置に配置されます。
"左下": アイコンの左下隅はアンカーに最も近い位置に配置されます。
'"右下": アイコンの右下隅はアンカーに最も近い位置に配置されます。
既定の '"bottom"'。anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>プロパティ値
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
ignorePlacement
他のシンボルがこのシンボルと重なることができるかどうかを指定します。
true の場合、他のシンボルはアイコンと衝突した場合でも表示できます。
既定値は false です。
ignorePlacement?: booleanプロパティ値
boolean
image
アイコンの描画に使用するマップの画像スプライト内のイメージの名前。
使用可能な組み込みイメージ: marker-black, , marker-blue, , marker-darkblue, , marker-red, marker-yellow, , pin-blue, pin-darkblue, pin-red, pin-round-bluepin-round-darkblue. pin-round-red
既定値は "marker-blue" です。
image?: string | DataDrivenPropertyValueSpecification<string>プロパティ値
string | DataDrivenPropertyValueSpecification<string>
offset
アイコンのアンカーからのオフセット距離をピクセル単位で指定します。
正の値は右と下を示し、負の値は左と上を示します。
各コンポーネントにサイズの値を乗算して、最終的なオフセットをピクセル単位で取得します。
回転と組み合わせると、オフセットは回転方向が上にあるかのように表示されます。
既定値は [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 | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
pitchAlignment
マップがピッチされたときのアイコンの向きを指定します。
'"auto"': 'rotationAlignment' の値に自動的に一致します。
"map": アイコンはマップの平面に揃えられます。
'"viewport"': アイコンはビューポートの平面に揃えられます
既定の '"auto"'pitchAlignment?: "auto" | "map" | "viewport"プロパティ値
"auto" | "map" | "viewport"
rotation
アイコンを時計回りに回転させる量を既定の角度で指定します 0。
rotation?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>
rotationAlignment
SymbolLayerOptions の配置プロパティと組み合わせることで、アイコンの回転動作が決まります。
'"auto"': 配置が "point" の場合、これは "ビューポート" と同じです。 配置が "line" の場合、これは "map" と同じです。
'"map"': 配置が "point" の場合、アイコンは東から西に配置されます。 配置が "line" の場合、アイコンの x 軸が線に合わせて配置されます。
'"viewport"': アイコン' x 軸は、ビューポートの x 軸に合わせて配置されます。
既定の '"auto"' です。rotationAlignment?: "auto" | "map" | "viewport"プロパティ値
"auto" | "map" | "viewport"
size
指定した係数でアイコンの元のサイズをスケーリングします。
0 以上である必要があります。
既定値は 1 です。
size?: number | DataDrivenPropertyValueSpecification<number>プロパティ値
number | DataDrivenPropertyValueSpecification<number>