Marker (legacy)

Marker 類別

google.maps.Marker class

這個類別會擴充 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 如果標記可供點選,則傳回「是」。
取得 Marker 的可點選狀態。
getCursor
getCursor()
參數:
傳回值:  string|null|undefined
取得滑鼠游標在懸停時顯示的類型。
getDraggable
getDraggable()
參數:
傳回值:  boolean 如果標記可拖曳,則傳回值為 True。
取得 Marker 的可拖曳狀態。
getIcon
getIcon()
參數:
傳回值:  string|Icon|Symbol|null|undefined
取得 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
取得用於互動的 Marker 形狀。請參閱 MarkerOptions.shapeMarkerShape
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])
參數: 
  • animationAnimation optional 要播放的動畫。
傳回值:
啟動動畫。所有正在進行的動畫都會取消。目前支援的動畫為:Animation.BOUNCEAnimation.DROP。傳入 null 會導致任何動畫停止。
setClickable
setClickable(flag)
參數: 
  • flagboolean 如果為 true,則可點選標記。
傳回值:
設定 Marker 是否可點選。
setCursor
setCursor([cursor])
參數: 
  • cursorstring optional滑鼠游標類型。
傳回值:
設定滑鼠游標在游標懸停時顯示的類型。
setDraggable
setDraggable(flag)
參數: 
  • flagboolean optional 如果為 true,則可拖曳標記。
傳回值:
設定 Marker 是否可拖曳。
setIcon
setIcon([icon])
參數: 
傳回值:
設定 Marker 的圖示。查看《MarkerOptions.icon》。
setLabel
setLabel([label])
參數: 
傳回值:
設定 Marker 的標籤。查看《MarkerOptions.label》。
setMap
setMap(map)
參數: 
傳回值:
在指定地圖或全景上算繪 Marker。如果地圖設為 null,標記就會移除。
setOpacity
setOpacity([opacity])
參數: 
  • opacitynumber optional 介於 0.0 (透明) 和 1.0 (不透明) 之間的數字。
傳回值:
設定 Marker 的不透明度。
setOptions
setOptions(options)
參數: 
傳回值:
設定 Marker 的選項。
setPosition
setPosition([latlng])
參數: 
傳回值:
設定 Marker 的位置。
setShape
setShape([shape])
參數: 
傳回值:
設定用於互動的 Marker 形狀。請參閱 MarkerOptions.shapeMarkerShape
setTitle
setTitle([title])
參數: 
  • titlestring optional
傳回值:
設定 Marker 工具提示的標題。查看《MarkerOptions.title》。
setVisible
setVisible(visible)
參數: 
  • visibleboolean 如果為 true,則標記會顯示
傳回值:
設定 Marker 是否可見。
setZIndex
setZIndex([zIndex])
參數: 
  • zIndexnumber optional
傳回值:
設定 Marker 的 zIndex。查看《MarkerOptions.zIndex》。
繼承: addListenerbindTogetnotifysetsetValuesunbindunbindAll
animation_changed
function()
引數:
Marker 動畫屬性變更時,系統會觸發此事件。
click
function(event)
引數: 
點選 Marker 圖示時會觸發這項事件。
clickable_changed
function()
引數:
Marker 可點選屬性變更時,系統就會觸發此事件。
contextmenu
function(event)
引數: 
當 DOM 內容選單事件在 Marker 上觸發時,系統會觸發此事件
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 上發生 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 屬性變更時,系統會觸發此事件。
rightclick
function(event)
引數: 
當使用者在 Marker 上按一下滑鼠右鍵時,系統會觸發此事件。

MarkerOptions 介面

google.maps.MarkerOptions 介面

MarkerOptions 物件用於定義可在 Marker 上設定的屬性。

anchorPoint optional
類型:  Point optional
從標記位置到以標記為錨點開啟的 InfoWindow 尖端的位移值。
animation optional
類型:  Animation optional
預設值: null
在地圖中新增標記時所要播放的動畫。
clickable optional
類型:  boolean optional
預設值: true
如果為 true,標記就會接收滑鼠和觸控事件。
BetacollisionBehavior optional
類型:  string|CollisionBehavior optional
預設值: null
設定向量地圖上標記的衝突行為。
crossOnDrag optional
類型:  boolean optional
預設值: true
如果為 false,則會在拖曳時停用標記下方顯示的十字架。
cursor optional
類型:  string optional
預設值: pointer
滑鼠游標在游標懸停時顯示的類型。
draggable optional
類型:  boolean optional
預設值: false
如果為 true,則可拖曳標記。
icon optional
類型:  string|Icon|Symbol 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 標記只會在沒有重疊情況時顯示。如果這個類型的兩個標記重疊,系統會顯示 zIndex 較高的標記。如果兩者的 zIndex 相同,系統會顯示直向畫面位置較低的標記。
REQUIRED 無論是哪種衝突,一律顯示標記。此為預設行為。
REQUIRED_AND_HIDES_OPTIONAL 無論是哪種衝突,一律顯示標記,並隱藏與標記重疊的任何 OPTIONAL_AND_HIDES_LOWER_PRIORITY 標記或標籤。

圖示介面

google.maps.Icon 介面

代表標記圖示圖片的結構。

url
類型:  string
圖片或綜合連續圖片的網址。
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 介面

這些選項會指定標記標籤的外觀。標記標籤是字串 (通常為單一字元),會顯示在標記內。如果您搭配自訂標記使用,可以使用 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 介面

這個物件會定義標記圖片的可點選區域。形狀由兩個屬性組成,分別是 typecoord,用於定義圖片的非透明區域。

type
類型:  string
描述形狀的類型,可以是 circlepolyrect
coords optional
類型:  Array<number> optional
這項屬性的格式取決於 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 組合都包含多邊形一個頂點的座標。
  - rect:coords 為 [x1,y1,x2,y2],其中 x1、y1 是矩形左上角的座標,而 x2、y2 是矩形右下角的座標。

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
符號的順時針旋轉角度。IconSequence 中的符號 (fixedRotationfalse) 會根據所屬邊緣的角度旋轉。
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 一端開放且指向前方的箭頭。

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。這類動畫通常是在建立標記時指定。