ポリラインは点のリストで、連続する点の間に線分が描画されます。ポリラインには次のプロパティがあります。
- ポイント
- 線の頂点。線分は連続する点間に描画されます。ポリラインは、デフォルトでは閉じていません。閉じたポリラインを形成するには、始点と終点が同じである必要があります。
- 幅
- 線分の幅(画面のピクセル)。幅は一定であり、カメラのズームレベルに依存しません。デフォルト値は 10 です。
- 色
- ARRGB 形式の線分の色(
Color
で使用されているのと同じ形式)。デフォルト値は黒(0xff000000
)です。 - 開始/終了上限
- ポリラインの始点または終点で使用するシェイプを定義します。サポートされているキャップタイプ:
ButtCap
、SquareCap
、RoundCap
(無地のストローク パターンに適用)、CustomCap
(すべてのストローク パターンに適用)。開始と終了のデフォルトはButtCap
です。 - ジョイントのタイプ
- ジョイント タイプでは、ポリラインの始点と終点を除くすべての頂点で、隣接する線分を結合する際に使用するシェイプを定義します。サポートされているジョイントのタイプについては、
JointType
をご覧ください。デフォルト値はDEFAULT
です。 - ストロークのパターン
- 線に沿って繰り返される単色(デフォルト、
null
で表される)または一連のPatternItem
オブジェクト。利用可能なPatternItem
タイプ:Gap
(ピクセル単位のギャップ長で定義)、Dash
(ピクセル単位の線幅と破線の長さで定義)、Dot
(円形、線を中心とする、直径はピクセル単位)です。 - Z インデックス
- 他のオーバーレイ(
GroundOverlay
、TileOverlay
、Circle
、Polygon
など。Marker
は除く)に対する、このタイル オーバーレイの描画順序。Z-Index の大きいオーバーレイは、小さい Z-Index のオーバーレイの上に描画されます。Z-Index が同じオーバーレイの順序は任意です。デフォルトの zIndex は 0 です。 - 公開設定
- ポリラインが表示 / 非表示(地図上に描画されるかどうか)を指定します。非表示のポリラインは描画されませんが、他のすべてのプロパティを保持します。デフォルトは
true
(可視)です。 - 測地線ステータス
- ポリラインのセグメントをメルカトル図法上の直線ではなく測地線として描画するかどうかを指定します。測地線は、地表面上の 2 点間の最短パスです。測地線曲線は、地球が球体であると仮定して作成されます。
- クリックされやすさ
- ユーザーがポリラインをクリックしたときに発生するイベントを処理する場合は、このプロパティを
true
に設定します。この値はいつでも変更できます。デフォルトはfalse
です。このプロパティがtrue
に設定されている場合、アプリは、setOnPolylineClickListener(GoogleMap.OnPolylineClickListener)
を通じて登録されたGoogleMap.OnPolylineClickListener
に通知を受信します。 - タグ
- ポリラインに関連付けられた
Object
。たとえばObject
には、ポリラインが表す内容に関するデータを含めることができます。これは、個別のMap<Polyline, Object>
を保存するよりも簡単です。別の例として、データセットの ID に対応するString
ID を関連付けることができます。Google Maps SDK for Android では、このプロパティの読み取りも書き込みも行いません。 - スパン
- このポリラインのレンダリングに使用するさまざまなスタイルでスパンを定義します。このプロパティを使用すると、ポリラインの各線分上に異なる
StrokeStyle
を持つポリラインを作成できます。
このクラスのメソッドは、Android UI スレッドで呼び出す必要があります。そうしないと、実行時に IllegalStateException
がスローされます。
例
GoogleMap map;
// ... get a map.
// Add a thin red line from London to New York.
Polyline line = map.addPolyline(new PolylineOptions()
.add(new LatLng(51.5, -0.1), new LatLng(40.7, -74.0))
.width(5)
.color(Color.RED));
デベロッパー ガイド
詳しくは、シェイプに関するデベロッパー ガイドをご覧ください。
パブリック メソッドの概要
ブール値 | |
整数 |
getColor()
このポリラインの色を取得します。
|
上限 |
getEndCap()
このポリラインの終点にあるキャップを取得します。
|
文字列 |
getId()
このポリラインの ID を取得します。
|
整数 |
getJointType()
ポリラインの始点と終点以外のすべての頂点で使用されるジョイント タイプを取得します。
|
List<PatternItem> |
getPattern()
このポリラインのストローク パターンを取得します。
|
List<LatLng> |
getPoints()
このポリラインのその時点での頂点のスナップショットを返します。
|
上限 |
getStartCap()
このポリラインの開始頂点にあるキャップを取得します。
|
オブジェクト |
getTag()
ポリラインのタグを取得します。
|
浮動小数点数 |
getWidth()
このポリラインの幅を取得します。
|
浮動小数点数 |
getZIndex()
このポリラインの zIndex を取得します。
|
整数 |
hashCode()
|
ブール値 |
isClickable()
ポリラインのクリック可能性を取得します。
|
ブール値 |
isGeodesic()
ラインの各セグメントが測地線として描画されるかどうかを取得します。
|
ブール値 |
isVisible()
このポリラインの表示設定を取得します。
|
void |
remove()
地図からこのポリラインを削除します。
|
void |
setClickable(ブール値のクリック able)
ポリラインのクリック可能性を設定します。
|
void |
setColor(int 色)
このポリラインの色を設定します。
|
void | |
void |
setGeodesic(ブール値の測地線)
線の各セグメントを測地線として描画するかどうかを設定します。
|
void |
setJointType(int integrationType)
ポリラインの始点と終点を除くすべての頂点のジョイント タイプを設定します。
|
void | |
void | |
void | |
void | |
void |
setTag(オブジェクト タグ)
ポリラインのタグを設定します。
|
void |
setVisible(ブール値を表示)
このポリラインの表示設定を設定します。
|
void |
setWidth(浮動小数点数の幅)
このポリラインの幅を設定します。
|
void |
setZIndex(float zIndex)
このポリラインの zIndex を設定します。
|
継承されたメソッドの概要
パブリック メソッド
public boolean equals (Object other)
public int getColor ()
このポリラインの色を取得します。
戻り値
- ARGB 形式の色を指定します。
public String getId ()
このポリラインの ID を取得します。ID は地図上のすべてのポリラインの中で一意になります。
戻り値
- 指定します。
public int getJointType ()
ポリラインの始点と終点以外のすべての頂点で使用されるジョイント タイプを取得します。設定可能な値については、JointType
をご覧ください。
戻り値
- ジョイント タイプ。
public List<LatLng> getPoints ()
このポリラインのその時点での頂点のスナップショットを返します。返されるリストは頂点のリストのコピーであるため、ポリラインの頂点を変更してもこのリストには反映されず、このリストを変更してもポリラインに反映されません。ポリラインの頂点を変更するには、setPoints(List)
を呼び出します。
public Object getTag ()
ポリラインのタグを取得します。
戻り値
setTag
でタグが設定された場合はタグ、タグが設定されていない場合はnull
。
public float getWidth ()
このポリラインの幅を取得します。
戻り値
- 画面ピクセルの幅。
public float getZIndex ()
このポリラインの zIndex を取得します。
戻り値
- ポリラインの zIndex。
public int hashCode ()
public boolean isClickable ()
ポリラインのクリック可能性を取得します。ポリラインがクリック可能な場合、ユーザーがポリラインをクリックしたときに、アプリは GoogleMap.OnPolylineClickListener
に通知を受け取ります。イベント リスナーは setOnPolylineClickListener(GoogleMap.OnPolylineClickListener)
を介して登録されます。
戻り値
- ポリラインがクリック可能な場合は
true
、そうでない場合はfalse
を返します。
public boolean isGeodesic ()
ラインの各セグメントが測地線として描画されるかどうかを取得します。
戻り値
- 各セグメントが測地線として描画される場合は
true
、各セグメントがメルカトル図法で直線として描画される場合はfalse
。
public boolean isVisible ()
このポリラインの表示設定を取得します。
戻り値
- このポリラインの表示設定を指定します。
public void remove ()
地図からこのポリラインを削除します。ポリラインが削除された後は、そのすべてのメソッドの動作が未定義になります。
public void setClickable (boolean clickable)
ポリラインのクリック可能性を設定します。ポリラインがクリック可能な場合、ユーザーがポリラインをクリックしたときに、アプリは GoogleMap.OnPolylineClickListener
に通知を受け取ります。イベント リスナーは setOnPolylineClickListener(GoogleMap.OnPolylineClickListener)
を介して登録されます。
パラメータ
クリックできます | ポリラインのクリック可能性に関する新しい設定。 |
---|
public void setColor (int 色)
このポリラインの色を設定します。
パラメータ
色 | ARGB 形式の色。 |
---|
public void setEndCap (Cap endCap)
このポリラインの終点にキャップを設定します。デフォルトのエンドキャップは ButtCap
です。
パラメータ
endCap | 終了キャップ。null は指定できません。
|
---|
public void setGeodesic (boolean geodesic)
線の各セグメントを測地線として描画するかどうかを設定します。
パラメータ
geodesic | true の場合、各セグメントは測地線として描画されます。false の場合、各セグメントはメルカトル図法上で直線として描画されます。 |
---|
public void setJointType (int matchingType)
public void setPattern (List<PatternItem> パターン)
ポリラインのストローク パターンを設定します。デフォルトのストローク パターンは無地で、null
で表されます。
パラメータ
パターン | ストロークのパターンを指定します。 |
---|
public void setPoints (List<LatLng> ポイント)
このポリラインのポイントを設定します。このメソッドはポイントのコピーを受け取るため、points
へのこれ以上のミューテーションはこのポリラインに影響しません。
パラメータ
points | ポリラインの頂点である LatLng のリスト。 |
---|
public void setStartCap (Cap startCap)
このポリラインの開始頂点にキャップを設定します。開始時のデフォルトの上限は ButtCap
です。
パラメータ
startCap | 開始上限。null は指定できません。
|
---|
public void setTag (オブジェクト タグ)
ポリラインのタグを設定します。
このプロパティを使用して、任意の Object
をこのポリラインに関連付けることができます。たとえば Object
には、ポリラインが表す内容に関するデータを含めることができます。この方法は、個別の Map<Polyline, Object>
を保存するよりも簡単です。別の例として、データセットの ID に対応する String
ID を関連付けることができます。Google Maps SDK for Android は、このプロパティの読み取りも書き込みも行いません。アプリでのメモリリークを防ぐため、不要になった場合は、setTag(null)
を呼び出してタグをクリアする必要があります。
パラメータ
タグ | null の場合、タグは消去されます。 |
---|
public void setVisible (boolean visible)
このポリラインの表示設定を設定します。非表示の場合、ポリラインは描画されませんが、他のすべてのプロパティは保持されます。
パラメータ
表示 | true の場合、ポリラインが表示されます。false の場合、ポリラインは表示されません。 |
---|
public void setWidth (float の幅)
このポリラインの幅を設定します。
パラメータ
width | 画面ピクセルの幅 |
---|
public void setZIndex (float zIndex)
このポリラインの zIndex を設定します。zIndex が高いポリラインは、インデックスが低いポリラインの上に描画されます。
パラメータ
zIndex | このポリラインの zIndex。 |
---|