Marker クラス
google.maps.Marker
クラス
このクラスは MVCObject
を拡張します。
const {Marker} = await google.maps.importLibrary("marker")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
Marker |
Marker([opts]) パラメータ:
指定されたオプションでマーカーを作成します。地図が指定されている場合、マーカーは作成時に地図に追加されます。マーカーを表示するには、位置を設定する必要があります。 |
定数 | |
---|---|
MAX_ZINDEX |
API がマーカーに割り当てるデフォルトの最大 Z-Index。Z インデックスを高い値にするほど、マーカーが前に表示されます。 |
Methods | |
---|---|
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 がレンダリングされる地図または panaroama を取得します。 |
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 をレンダリングします。地図が 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 コンテキスト メニュー イベントが発生すると発生します。 |
cursor_changed |
function() 引数: なし
このイベントは、 Marker カーソル プロパティが変更されると発生します。 |
dblclick |
function(event) 引数:
このイベントは、 Marker アイコンがダブルクリックされると発生します。 |
drag |
function(event) 引数:
このイベントは、ユーザーが Marker をドラッグしている間に繰り返し発生します。 |
dragend |
function(event) 引数:
このイベントは、ユーザーが Marker のドラッグを停止すると発生します。 |
draggable_changed |
function() 引数: なし
このイベントは、 Marker ドラッグ可能なプロパティが変更されると発生します。 |
dragstart |
function(event) 引数:
このイベントは、ユーザーが Marker のドラッグを開始すると発生します。 |
flat_changed |
function() 引数: なし
このイベントは、 Marker フラット プロパティが変更されると発生します。 |
icon_changed |
function() 引数: なし
このイベントは、 Marker アイコン プロパティが変更されると発生します。 |
mousedown |
function(event) 引数:
このイベントは Marker でマウスダウンが発生すると発生します。 |
mouseout |
function(event) 引数:
このイベントは、マウスが Marker アイコンの領域から出ると発生します。 |
mouseover |
function(event) 引数:
このイベントは、マウスが Marker アイコンの領域に入ると発生します。 |
mouseup |
function(event) 引数:
このイベントは Marker でマウスアップが発生すると発生します。 |
position_changed |
function() 引数: なし
このイベントは、 Marker の position プロパティが変更されると発生します。 |
shape_changed |
function() 引数: なし
このイベントは、 Marker シェイプ プロパティが変更されると発生します。 |
title_changed |
function() 引数: なし
このイベントは、 Marker のタイトル プロパティが変更されると発生します。 |
visible_changed |
function() 引数: なし
このイベントは、 Marker の表示プロパティが変更されると発生します。 |
zindex_changed |
function() 引数: なし
このイベントは、 Marker zIndex プロパティが変更されると発生します。 |
|
function(event) 引数:
このイベントは Marker を右クリックすると発生します。 |
MarkerOptions インターフェース
google.maps.MarkerOptions
インターフェース
MarkerOptions に設定できるプロパティを定義するための 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 |
フォアグラウンドのアイコン。文字列を指定すると、 Icon のように文字列とともに url として扱われます。 |
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 |
他のマーカーと重ならない場合のみ表示します。このタイプのマーカーが 2 つ重なる場合は、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 のフォント ファミリー プロパティに相当)。 |
fontSize optional |
タイプ:
string optional デフォルト:
'14px' ラベルテキストのフォントサイズ(CSS の font-size プロパティと同等)。 |
fontWeight optional |
タイプ:
string optional ラベルテキストのフォントの太さ(CSS の font-weight プロパティに相当します)。 |
MarkerShape インターフェース
google.maps.MarkerShape
インターフェース
このオブジェクトは、マーカー画像のクリック可能な領域を定義します。このシェイプは、画像の不透明な領域を定義する type
と coord
の 2 つのプロパティで構成されています。
プロパティ | |
---|---|
coords |
タイプ:
Array<number> この属性の形式は type の値に依存し、 http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords にある w3 AREA coords 仕様に従います。coords 属性は、ターゲット画像の左上隅を基準として図形のピクセル位置を指定する整数の配列です。座標は、次のように type の値に依存します。- circle : 座標は [x1,y1,r] です。ここで、x1 と y2 は円の中心の座標、r は円の半径です。- poly : 座標は [x1,y1,x2,y2...xn,yn] で、x と y の各ペアにはポリゴンの 1 つの頂点の座標が含まれます。- rect : 座標は [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 シンボルを回転させる角度。時計回りの角度で表します。 IconSequence 内のシンボル(fixedRotation が false の場合)は、そのシンボルが存在するエッジの角度を基準に回転します。 |
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 |
前方矢印。 |
Animation 定数
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 が返されます。このタイプのアニメーションは、通常、マーカーの作成時に指定します。 |