Marker クラス
google.maps.Marker
クラス
このクラスは MVCObject
を拡張します。
const {Marker} = await google.maps.importLibrary("marker")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
Marker |
Marker([opts]) パラメータ:
指定されたオプションでマーカーを作成します。地図が指定されている場合、マーカーは作成時に地図に追加されます。マーカーを表示するには、位置を設定する必要があります。 |
定数 | |
---|---|
MAX_ZINDEX |
API がマーカーに割り当てるデフォルトの最大 z インデックス。Z インデックスを高い値にするほど、マーカーが前に表示されます。 |
メソッド | |
---|---|
getAnimation |
getAnimation() パラメータ: なし
戻り値:
Animation|null|undefined 現在実行中のアニメーションを取得します。 |
getClickable |
getClickable() パラメータ: なし
戻り値:
boolean マーカーがクリック可能であれば true。Marker のクリック可能なステータスを取得します。 |
getCursor |
getCursor() パラメータ: なし
戻り値:
string|null|undefined ホバー時に表示されるマウスカーソルのタイプを取得します。 |
getDraggable |
getDraggable() パラメータ: なし
戻り値:
boolean マーカーがドラッグ可能であれば true。Marker のドラッグ可能なステータスを取得します。 |
getIcon |
getIcon() パラメータ: なし
Marker のアイコンを取得します。MarkerOptions.icon をご確認ください。 |
getLabel |
getLabel() パラメータ: なし
戻り値:
MarkerLabel|string|null|undefined Marker のラベルを取得します。MarkerOptions.label をご確認ください。 |
getMap |
getMap() パラメータ: なし
戻り値:
Map|StreetViewPanorama Marker がレンダリングされる地図またはパノラマを取得します。 |
getOpacity |
getOpacity() パラメータ: なし
戻り値:
number|null|undefined 0.0 ~ 1.0 の数値。Marker の不透明度を取得します。 |
getPosition |
getPosition() パラメータ: なし
戻り値:
LatLng|null|undefined Marker の位置を取得します。 |
getShape |
getShape() パラメータ: なし
戻り値:
MarkerShape|null|undefined |
getTitle |
getTitle() パラメータ: なし
戻り値:
string|null|undefined Marker ツールチップのタイトルを取得します。MarkerOptions.title をご確認ください。 |
getVisible |
getVisible() パラメータ: なし
戻り値:
boolean マーカーが表示されている場合は true。Marker の可視性を取得します。 |
getZIndex |
getZIndex() パラメータ: なし
戻り値:
number|null|undefined マーカーの zIndex。Marker の zIndex を取得します。MarkerOptions.zIndex をご確認ください。 |
setAnimation |
setAnimation([animation]) パラメータ:
戻り値: なし
アニメーションを開始します。進行中のアニメーションはキャンセルされます。現在サポートされているアニメーションは Animation.BOUNCE 、Animation.DROP です。null を渡すと、アニメーションが停止します。 |
setClickable |
setClickable(flag) パラメータ:
戻り値: なし
Marker がクリック可能かどうかを設定します。 |
setCursor |
setCursor([cursor]) パラメータ:
戻り値: なし
ホバー時に表示されるマウスカーソルのタイプを設定します。 |
setDraggable |
setDraggable(flag) パラメータ:
戻り値: なし
Marker をドラッグ可能かどうかを設定します。 |
setIcon |
setIcon([icon]) 戻り値: なし
Marker のアイコンを設定します。MarkerOptions.icon をご確認ください。 |
setLabel |
setLabel([label]) パラメータ:
戻り値: なし
Marker のラベルを設定します。MarkerOptions.label をご確認ください。 |
setMap |
setMap(map) パラメータ:
戻り値: なし
指定された地図またはパノラマに Marker をレンダリングします。map が null に設定されている場合、マーカーは削除されます。 |
setOpacity |
setOpacity([opacity]) パラメータ:
戻り値: なし
Marker の不透明度を設定します。 |
setOptions |
setOptions(options) パラメータ:
戻り値: なし
Marker のオプションを設定します。 |
setPosition |
setPosition([latlng]) パラメータ:
戻り値: なし
Marker の位置を設定します。 |
setShape |
setShape([shape]) パラメータ:
戻り値: なし
|
setTitle |
setTitle([title]) パラメータ:
戻り値: なし
Marker ツールチップのタイトルを設定します。MarkerOptions.title をご確認ください。 |
setVisible |
setVisible(visible) パラメータ:
戻り値: なし
Marker を表示する場合に設定します。 |
setZIndex |
setZIndex([zIndex]) パラメータ:
戻り値: なし
Marker の zIndex を設定します。MarkerOptions.zIndex をご確認ください。 |
継承:
addListener 、
bindTo 、
get 、
notify 、
set 、
setValues 、
unbind 、
unbindAll
|
イベント | |
---|---|
animation_changed |
function() 引数: なし
このイベントは、 Marker アニメーション プロパティが変更されたときに発生します。 |
click |
function(event) 引数:
このイベントは、 Marker アイコンがクリックされたときに発生します。 |
clickable_changed |
function() 引数: なし
このイベントは、 Marker のクリック可能なプロパティが変更されたときに発生します。 |
contextmenu |
function(event) 引数:
このイベントは、 Marker で DOM contextmenu イベントが発生したときに発生します。 |
cursor_changed |
function() 引数: なし
このイベントは、 Marker カーソル プロパティが変更されたときに発生します。 |
dblclick |
function(event) 引数:
このイベントは、 Marker アイコンがダブルクリックされたときに発生します。 |
drag |
function(event) 引数:
このイベントは、ユーザーが Marker をドラッグしている間に繰り返し発生します。 |
dragend |
function(event) 引数:
このイベントは、ユーザーが Marker のドラッグを停止したときに発生します。 |
draggable_changed |
function() 引数: なし
このイベントは、 Marker draggable プロパティが変更されたときに発生します。 |
dragstart |
function(event) 引数:
このイベントは、ユーザーが Marker のドラッグを開始したときに発生します。 |
flat_changed |
function() 引数: なし
このイベントは、 Marker フラット プロパティが変更されたときに発生します。 |
icon_changed |
function() 引数: なし
このイベントは、 Marker アイコン プロパティが変更されたときに発生します。 |
mousedown |
function(event) 引数:
このイベントは、 Marker での mousedown で発生します。 |
mouseout |
function(event) 引数:
このイベントは、マウスが Marker アイコンの領域から離れたときに発生します。 |
mouseover |
function(event) 引数:
このイベントは、マウスが Marker アイコンの領域に入ったときに発生します。 |
mouseup |
function(event) 引数:
このイベントは、 Marker でのマウスアップ時に発生します。 |
position_changed |
function() 引数: なし
このイベントは、 Marker の位置プロパティが変更されたときに発生します。 |
shape_changed |
function() 引数: なし
このイベントは、 Marker シェイプ プロパティが変更されたときに発生します。 |
title_changed |
function() 引数: なし
このイベントは、 Marker のタイトル プロパティが変更されたときに発生します。 |
visible_changed |
function() 引数: なし
このイベントは、 Marker の可視プロパティが変更されたときに発生します。 |
zindex_changed |
function() 引数: なし
このイベントは、 Marker zIndex プロパティが変更されたときに発生します。 |
|
function(event) 引数:
このイベントは、 Marker を右クリックしたときに発生します。 |
MarkerOptions インターフェース
google.maps.MarkerOptions
インターフェース
Marker に設定できるプロパティを定義するために使用される MarkerOptions オブジェクト。
プロパティ | |
---|---|
anchorPoint optional |
タイプ:
Point optional マーカーの位置から、マーカーをアンカーとして開いた情報ウィンドウの先端までのオフセット。 |
animation optional |
タイプ:
Animation optional デフォルト:
null マーカーが地図に追加されたときに再生するアニメーション。 |
clickable optional |
タイプ:
boolean optional デフォルト:
true true の場合、マーカーはマウスイベントとタッチイベントを受信します。 |
|
タイプ:
string|CollisionBehavior optional デフォルト:
null ベクターマップ上のマーカーが重なった場合の動作を設定する。 |
crossOnDrag optional |
タイプ:
boolean optional デフォルト:
true false の場合、ドラッグ時にマーカーの下に表示される十字を無効にします。 |
cursor optional |
タイプ:
string optional デフォルト:
pointer マウスカーソルを重ねたときに表示するカーソルの種類。 |
draggable optional |
タイプ:
boolean optional デフォルト:
false true の場合、マーカーをドラッグできます。 |
icon optional |
フォアグラウンドのアイコン。文字列を指定すると、文字列が url の Icon として扱われます。 |
label optional |
タイプ:
string|MarkerLabel optional デフォルト:
null マーカーにラベルを追加します。マーカーラベルは、マーカー内に表示される文字または数値です。ラベルは文字列または MarkerLabel オブジェクトです。指定されていて MarkerOptions.title が指定されていない場合、指定されたラベルのテキストとともに、ユーザー補助テキスト(スクリーン リーダーでの使用など)がマーカーに追加されます。なお、label は現在、最適化されていないマーカーのユーザー補助テキストにのみ使用されます。 |
map optional |
タイプ:
Map|StreetViewPanorama optional マーカーを表示する地図。マーカーを表示するには地図が必要です。マーカーの作成時に指定しなかった場合は、 Marker.setMap で指定できます。 |
opacity optional |
タイプ:
number optional デフォルト: 1.0
0.0(透明)~ 1.0(不透明)の数値。 |
optimized optional |
タイプ:
boolean optional 最適化すると、多数のマーカーが単一の静的要素としてレンダリングされ、パフォーマンスが向上します。最適化は、多くのマーカーが必要な場合に便利です。詳しくは、マーカーの最適化をご覧ください。 |
position optional |
タイプ:
LatLng|LatLngLiteral optional マーカーの位置を設定します。マーカーは作成されていても、ユーザーの操作や選択などによって位置情報が指定されるまで表示されません。マーカーの作成時に指定しなかったマーカーの位置は、 Marker.setPosition で指定できます。 |
shape optional |
タイプ:
MarkerShape optional ドラッグ/クリック用の画像マップの領域定義。 |
title optional |
タイプ:
string optional デフォルト:
undefined ロールオーバー テキスト。指定した場合、ユーザー補助テキスト(スクリーン リーダーでの使用など)が指定された値とともにマーカーに追加されます。なお、 title は現在、最適化されていないマーカーのユーザー補助テキストにのみ使用されます。 |
visible optional |
タイプ:
boolean optional デフォルト:
true true の場合、マーカーが表示されます。 |
zIndex optional |
タイプ:
number optional すべてのマーカーは、zIndex の順序で地図上に表示されます。値が大きいマーカーは、値が小さいマーカーの前に表示されます。デフォルトでは、マーカーは画面の垂直方向の位置に従って表示され、画面で低い位置にあるマーカーが高い位置にあるマーカーより前に表示されます。 |
CollisionBehavior 定数
google.maps.CollisionBehavior
定数
const {CollisionBehavior} = await google.maps.importLibrary("marker")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
OPTIONAL_AND_HIDES_LOWER_PRIORITY |
他のマーカーと重ならない場合にのみ表示されます。このタイプのマーカー同士が重なった場合、zIndex 値の高いほうが表示されます。zIndex が同じ場合は、画面内の縦位置が低いほうが表示されます。 |
REQUIRED |
他のマーカーと重なっていても常に表示されます。これはデフォルトの動作です。 |
REQUIRED_AND_HIDES_OPTIONAL |
他のマーカーと重なっても常に表示されますが、このマーカーと表示位置が重なる OPTIONAL_AND_HIDES_LOWER_PRIORITY のマーカーやラベルはすべて非表示になります。 |
アイコン インターフェース
google.maps.Icon
インターフェース
マーカー アイコン画像を表す構造体。
プロパティ | |
---|---|
url |
タイプ:
string 画像またはスプライト シートの URL。 |
anchor optional |
タイプ:
Point optional 地図上のマーカーの位置に対応して画像を固定する位置。デフォルトでは、アンカーは画像の下辺中央に設定されています。 |
labelOrigin optional |
タイプ:
Point optional マーカーからラベルが指定されている場合、アイコン画像の左上隅を基準としたラベルの原点。デフォルトでは、原点は画像の中心点に配置されます。 |
origin optional |
タイプ:
Point optional スプライト内の画像の位置(存在する場合)。デフォルトでは、原点は画像 (0, 0) の左上に配置されます。 |
scaledSize optional |
タイプ:
Size optional スケーリング後の画像全体のサイズ(該当する場合)。このプロパティを使用して画像またはスプライトを伸縮します。 |
size optional |
タイプ:
Size optional スプライトまたは画像の表示サイズ。スプライトを使用する場合は、スプライトのサイズを指定する必要があります。サイズを指定しない場合、画像を読み込むときに設定されます。 |
MarkerLabel インターフェース
google.maps.MarkerLabel
インターフェース
これらのオプションでは、マーカーラベルの表示形式を指定します。マーカーラベルは、マーカー内に表示される文字列(多くの場合 1 文字)です。カスタム マーカーで使用している場合は、Icon
クラスの labelOrigin
プロパティで位置を変更できます。
プロパティ | |
---|---|
text |
タイプ:
string ラベルに表示するテキスト。 |
className optional |
タイプ:
string optional デフォルト:
'' (空の文字列)ラベルの要素の className プロパティ(要素の class 属性と同等)。複数の CSS クラスをスペース区切りで追加できます。フォントの色、サイズ、太さ、ファミリーは、 MarkerLabel の他のプロパティでのみ設定できます。マーカーの衝突管理も使用している場合は、CSS クラスを使用してラベルの位置や向きを変更(移動や回転など)しないでください。 |
color optional |
タイプ:
string optional デフォルト:
'black' ラベルテキストの色。 |
fontFamily optional |
タイプ:
string optional ラベルテキストのフォント ファミリー(CSS の font-family プロパティと同等)。 |
fontSize optional |
タイプ:
string optional デフォルト:
'14px' ラベルテキストのフォントサイズ(CSS の font-size プロパティと同等)。 |
fontWeight optional |
タイプ:
string optional ラベルテキストのフォントの太さ(CSS の font-weight プロパティと同等)。 |
MarkerShape インターフェース
google.maps.MarkerShape
インターフェース
このオブジェクトは、マーカー画像のクリック可能な領域を定義します。シェイプは、画像の透明でない領域を定義する 2 つのプロパティ(type
と coord
)で構成されます。
プロパティ | |
---|---|
coords |
タイプ:
Array<number> この属性の形式は type の値に依存し、 http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords にある w3 AREA coords 仕様に準拠しています。coords 属性は、ターゲット画像の左上隅を基準としたシェイプのピクセル位置を指定する整数の配列です。座標は type の値に応じて次のように異なります。- circle : coords は [x1,y1,r] です。ここで、x1、y2 は円の中心の座標、r は円の半径です。- poly : coords は [x1,y1,x2,y2...xn,yn] です。各 x,y ペアには、ポリゴンの 1 つの頂点の座標が含まれます。- rect : coords は [x1,y1,x2,y2] です。x1、y1 は長方形の左上隅の座標で、x2、y2 は長方形の右下隅の座標です。 |
type |
タイプ:
string シェイプのタイプを記述します。 circle 、poly 、rect のいずれかです。 |
Symbol インターフェース
google.maps.Symbol
インターフェース
スタイル設定されたベクターパスで構成されるシンボルを記述します。シンボルは、マーカーのアイコンとして使用することも、ポリラインに配置することもできます。
プロパティ | |
---|---|
path |
タイプ:
SymbolPath|string シンボルのパス(組み込みのシンボルパス、または SVG パスの表記法で表現されたカスタムパス)。必須。 |
anchor optional |
タイプ:
Point optional デフォルト:
google.maps.Point(0,0) マーカーまたはポリラインに対するシンボルの位置。記号のパスの座標は、アンカーの x 座標と y 座標からそれぞれ左方向と上方向に変換されます。この位置は、シンボルのパスと同じ座標系で表現されます。 |
fillColor optional |
タイプ:
string optional シンボルの塗りつぶしの色。名前付き拡張色を除くすべての CSS3 色に対応します。シンボル マーカーの場合、デフォルトは「black」です。ポリライン上のシンボルの場合、デフォルトは対応するポリラインのストローク色です。 |
fillOpacity optional |
タイプ:
number optional デフォルト:
0 シンボルの塗りつぶしの透明度。 |
labelOrigin optional |
タイプ:
Point optional デフォルト:
google.maps.Point(0,0) マーカーからラベルが提供されている場合、パスの起点に対するラベルの起点。原点は、シンボルのパスと同じ座標系で表現されます。このプロパティは、ポリライン上のシンボルには使用されません。 |
rotation optional |
タイプ:
number optional デフォルト:
0 シンボルを回転させる角度です。時計回りの度数で表します。 fixedRotation が false である IconSequence 内のシンボルは、そのシンボルの下にあるエッジの角度を基準に回転します。 |
scale optional |
タイプ:
number optional シンボルのサイズが拡大 / 縮小する度合い。シンボル マーカーの場合、デフォルトは 1 です。スケーリング後のシンボルのサイズに制限はありません。ポリライン上のシンボルの場合、デフォルトはポリラインのストロークの幅です。拡大 / 縮小後は、シンボルは、シンボルのアンカーを中心とした 22 ピクセルの正方形内に収める必要があります。 |
strokeColor optional |
タイプ:
string optional シンボルのストロークの色。名前付き拡張色を除くすべての CSS3 色に対応します。シンボル マーカーの場合、デフォルトは「black」です。ポリライン上のシンボルの場合、デフォルトはポリラインのストローク色です。 |
strokeOpacity optional |
タイプ:
number optional シンボルのストロークの不透明度。シンボル マーカーの場合、デフォルトは 1 です。ポリライン上のシンボルの場合、デフォルトはポリラインのストロークの不透明度です。 |
strokeWeight optional |
タイプ:
number optional デフォルト: シンボルの
Symbol.scale 。シンボルのストロークの太さ。 |
SymbolPath 定数
google.maps.SymbolPath
定数
組み込みシンボルパス。
const {SymbolPath} = await google.maps.importLibrary("core")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
BACKWARD_CLOSED_ARROW |
後方を指す閉じた矢印。 |
BACKWARD_OPEN_ARROW |
後方を指す開いた矢印。 |
CIRCLE |
円。 |
FORWARD_CLOSED_ARROW |
前方を指す閉じた矢印。 |
FORWARD_OPEN_ARROW |
前方を指す開いた矢印。 |
アニメーション定数
google.maps.Animation
定数
マーカーで再生できるアニメーション。アニメーションを再生するには、Marker の Marker.setAnimation
メソッドまたは MarkerOptions.animation
オプションを使用します。
const {Animation} = await google.maps.importLibrary("marker")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
BOUNCE |
null で Marker.setAnimation を呼び出してアニメーションが停止するまで、マーカーがバウンドします。 |
DROP |
マーカーが地図の上部から最終的な場所まで落ちてきます。マーカーが止まるとアニメーションが終了し、Marker.getAnimation が null に戻ります。このタイプのアニメーションは、通常マーカーの作成時に指定します。 |