Marker クラス
google.maps.Marker
クラス
このクラスは MVCObject
を拡張します。
const {Marker} = await google.maps.importLibrary("marker")
を呼び出してアクセスします。詳しくは、Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
Marker |
Marker([opts]) パラメータ:
オプションを指定してマーカーを作成します。地図を指定した場合は、作成時に地図にマーカーが追加されます。なお、マーカーを表示するには位置を設定する必要があります。 |
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|null|string|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() パラメータ: なし
戻り値: マーカーの zIndex
number|null|undefined Marker の zIndex を取得します。MarkerOptions.zIndex をご確認ください。 |
setAnimation |
setAnimation([animation]) パラメータ:
戻り値: None
アニメーションを開始します。進行中のアニメーションはすべてキャンセルされます。現在サポートされているアニメーションは Animation.BOUNCE 、Animation.DROP です。null を渡すと、アニメーションが停止します。 |
setClickable |
setClickable(flag) パラメータ:
戻り値: None
Marker がクリック可能かどうかを設定します。 |
setCursor |
setCursor([cursor]) パラメータ:
戻り値: None
マウスオーバーで表示されるマウスカーソルの種類を設定します。 |
setDraggable |
setDraggable(flag) パラメータ:
戻り値: None
Marker がドラッグ可能かどうかを設定します。 |
setIcon |
setIcon([icon]) 戻り値: None
Marker のアイコンを設定します。MarkerOptions.icon をご確認ください。 |
setLabel |
setLabel([label]) パラメータ:
戻り値: None
Marker のラベルを設定します。MarkerOptions.label をご確認ください。 |
setMap |
setMap(map) パラメータ:
戻り値: None
指定された地図またはパノラマに Marker をレンダリングします。地図が null に設定されている場合は、マーカーが削除されます。 |
setOpacity |
setOpacity([opacity]) パラメータ:
戻り値: None
Marker の不透明度を設定します。 |
setOptions |
setOptions(options) パラメータ:
戻り値: None
Marker のオプションを設定します。 |
setPosition |
setPosition([latlng]) パラメータ:
戻り値: None
Marker の形状を設定します。 |
setShape |
setShape([shape]) パラメータ:
戻り値: None
|
setTitle |
setTitle([title]) パラメータ:
戻り値: None
Marker ツールチップのタイトルを設定します。MarkerOptions.title をご確認ください。 |
setVisible |
setVisible(visible) パラメータ:
戻り値: None
Marker を表示するかどうかを設定します。 |
setZIndex |
setZIndex([zIndex]) パラメータ:
戻り値: None
Marker の zIndex を設定します。MarkerOptions.zIndex をご確認ください。 |
継承済み:
addListener 、
bindTo 、
get 、
notify 、set 、setValues 、unbind 、
unbindAll
|
定数 | |
---|---|
MAX_ZINDEX |
API がマーカーに割り当てるデフォルトの Z-Index の最大数。Z インデックスを高い値にするほど、マーカーが前に表示されます。 |
イベント | |
---|---|
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 の位置プロパティが変更されると発生します。 |
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 の場合、ドラッグ時にマーカーの下に表示される Cross. |
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 の順に表示され、値が大きいマーカーが 8 個以上表示されます。デフォルトでは、マーカーは画面の垂直方向の位置に従って表示され、画面で低い位置にあるマーカーが高い位置にあるマーカーより前に表示されます。 |
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 |
他のマーカーとの衝突があっても常に表示し、マーカーと表示が不要な DEFAULT_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
インターフェース
このオブジェクトはマーカー画像のクリック可能な領域を定義します。このシェイプは、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 色に対応します。シンボル マーカーのデフォルトは「黒」です。ポリライン上のシンボルの場合、これは対応するポリラインのストロークの色になります。 |
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 色に対応します。シンボル マーカーのデフォルトは「黒」です。ポリライン上のシンボルの場合、デフォルトはポリラインのストロークの色になります。 |
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.setAnimation
メソッドまたは MarkerOptions.animation
オプションを使用します。
const {Animation} = await google.maps.importLibrary("marker")
を呼び出してアクセスします。詳しくは、Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
BOUNCE |
null で Marker.setAnimation を呼び出すと、アニメーションが停止するまでマーカーがバウンドします。 |
DROP |
地図の上部から最終的な場所にマーカーがドロップされます。マーカーが止まるとアニメーションが終了し、Marker.getAnimation が null を返すようになります。このタイプのアニメーションは、通常、マーカーの作成時に指定します。 |