Data

Data 類別

google.maps.Data 類別

顯示地理空間資料的圖層。可顯示點、線串和多邊形。

根據預設,每個 Map 都有 Data 物件,因此在大多數情況下不需要建構物件。例如:

 var myMap = new google.maps.Map(...);
myMap.data.addGeoJson(...);
myMap.data.setStyle(...);
Data 物件是 Features 的集合。

這個類別會擴充 MVCObject

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data
Data([options])
參數: 
以指定的 DataOptions 建立空白集合。
add
add([feature])
參數: 
傳回值:  Data.Feature
將地圖項目新增至集合,並傳回新增的地圖項目。

如果地圖項目有 ID,則會取代集合中具有相同 ID 的現有地圖項目。如未提供地圖項目,系統會建立包含空值幾何圖形且沒有屬性的新地圖項目。如果提供 FeatureOptions,就會使用指定屬性建立新地圖項目。

請注意,ID 1234'1234' 相等。新增 ID 為 1234 的地圖項目會取代 ID 為 '1234' 的地圖項目,反之亦然。

addGeoJson
addGeoJson(geoJson[, options])
參數: 
傳回值:  Array<Data.Feature>
將 GeoJSON 地圖項目新增至集合。為此方法提供剖析的 JSON。傳回匯入的地圖項目。如果無法匯入 GeoJSON,則會擲回例外狀況。
contains
contains(feature)
參數: 
傳回值:  boolean
檢查指定的地圖項目是否在集合中。
forEach
forEach(callback)
參數: 
傳回值:
重複叫用指定的函式,在每次叫用時將集合中的地圖項目傳遞至函式。透過功能進行疊代的順序未定義。
getControlPosition
getControlPosition()
參數:
傳回值:  ControlPosition
傳回地圖上繪圖控制項的位置。
getControls
getControls()
參數:
傳回值:  Array<string>
傳回使用者可以選取的繪圖模式,並按照顯示順序排序。這不包括依預設新增的 null 繪圖模式。可能的繪圖模式為 "Point""LineString""Polygon"
getDrawingMode
getDrawingMode()
參數:
傳回值:  string|null
傳回指定資料層目前的繪圖模式。null 的繪圖模式表示使用者可以照常與地圖互動,而且點擊時不繪製任何內容。可能的繪圖模式為 null"Point""LineString""Polygon"
getFeatureById
getFeatureById(id)
參數: 
  • idnumber|string
傳回值:  Data.Feature|undefined
如果集合中含有指定 ID,則傳回該地圖項目。如果沒有,系統會傳回 undefined

請注意,ID 1234'1234' 相等。兩者都可用來查詢同一項功能。

getMap
getMap()
參數:
傳回值:  Map
傳回顯示地圖項目的地圖。
getStyle
getStyle()
參數:
取得集合中所有地圖項目的樣式。
loadGeoJson
loadGeoJson(url[, options, callback])
參數: 
傳回值:
從網址載入 GeoJSON,然後將功能新增至集合。

注意:GeoJSON 必須使用 XHR 擷取,而且可能無法跨網域運作。如有任何問題,建議您使用自己選擇的 AJAX 程式庫擷取 GeoJSON,然後呼叫 addGeoJson()

overrideStyle
overrideStyle(feature, style)
參數: 
傳回值:
變更地圖項目的樣式。這些變更會套用至 setStyle() 指定的樣式。樣式屬性設為 null 會還原為透過 setStyle() 指定的值。
remove
remove(feature)
參數: 
傳回值:
從集合中移除地圖項目。
revertStyle
revertStyle([feature])
參數: 
傳回值:
移除先前的 overrideStyle() 呼叫效果。特定地圖項目的樣式會還原為 setStyle() 指定的樣式。

如果沒有提供任何地圖項目,所有地圖項目的樣式都會還原。

setControlPosition
setControlPosition(controlPosition)
參數: 
傳回值:
設定地圖上繪圖控制項的位置。
setControls
setControls(controls)
參數: 
  • controlsArray<string>
傳回值:
設定使用者可以選取的繪圖模式,依照顯示順序執行。這不包含依預設新增的 null 繪圖模式。如果設為 null,系統會停用並顯示繪圖控制項。可能的繪圖模式為 "Point""LineString""Polygon"
setDrawingMode
setDrawingMode(drawingMode)
參數: 
  • drawingModestring optional
傳回值:
設定指定資料層目前的繪圖模式。null 的繪圖模式表示使用者可以照常與地圖互動,而且點擊時不繪製任何內容。可能的繪圖模式為 null"Point""LineString""Polygon"
setMap
setMap(map)
參數: 
傳回值:
在指定的地圖上呈現地圖項目。如果將地圖設為 null,則會從地圖中移除這些地圖項目。
setStyle
setStyle(style)
傳回值:
設定集合中所有地圖項目的樣式。透過 overrideStyle() 針對個別地圖項目指定的樣式會繼續套用。

傳遞包含所需樣式選項的物件,或是計算每個地圖項目樣式的函式。每當地圖項目的屬性更新時,系統就會呼叫此函式。

toGeoJson
toGeoJson(callback)
參數: 
  • callbackfunction(Object): void
傳回值:
將集合中的地圖項目匯出至 GeoJSON 物件。
沿用: addListenerbindTogetnotifysetsetValuesunbindunbindAll
addfeature
function(event)
引數: 
在集合中新增地圖項目時,會引發此事件。
click
function(event)
引數: 
按一下幾何圖形會引發此事件。
contextmenu
function(event)
引數: 
幾何圖形引發 DOM contentmenu 事件時,會引發此事件。
dblclick
function(event)
引數: 
在幾何圖形上按兩下時,會引發此事件。
mousedown
function(event)
引數: 
幾何圖形上出現 Mousedown 時,會引發此事件。
mouseout
function(event)
引數: 
滑鼠離開幾何圖形區域時,會引發此事件。
mouseover
function(event)
引數: 
滑鼠進入幾何圖形區域時,會引發此事件。
mouseup
function(event)
引數: 
幾何圖形上出現 Mouseup 時,會引發此事件。
removefeature
function(event)
引數: 
從集合中移除功能時,會引發此事件。
removeproperty
function(event)
引數: 
地圖項目的 屬性移除時,會引發此事件。
setgeometry
function(event)
引數: 
設定功能的幾何圖形時,會引發此事件。
setproperty
function(event)
引數: 
設定地圖項目的 屬性時,會引發此事件。
rightclick
function(event)
引數: 
在幾何圖形上按一下右鍵時,會引發此事件。

Data.DataOptions 介面

google.maps.Data.DataOptions 介面

DataOptions 物件,用於定義開發人員可在 Data 物件上設定的屬性。

map
類型:  Map
要顯示集合中地圖項目的地圖。
controlPosition optional
類型:  ControlPosition optional
地圖上繪圖控制項的位置。
controls optional
類型:  Array<string> optional
預設: null
說明使用者可以選取的繪圖模式依據顯示順序。這不包含依預設新增的 null 繪圖模式。如果設為 null,系統會停用並顯示繪圖控制項。可能的繪圖模式為 "Point""LineString""Polygon"
drawingMode optional
類型:  string optional
預設: null
指定資料層目前的繪圖模式。null 的繪圖模式表示使用者可以照常與地圖互動,而且點擊時不繪製任何內容。可能的繪圖模式為 null"Point""LineString""Polygon"
featureFactory optional
類型:  function(Data.Geometry): Data.Feature optional
如果已啟用繪圖功能,且使用者繪製了幾何圖形 (點、線字串或多邊形),系統會以該幾何圖形呼叫此函式,並傳回可加至資料層的地圖項目。如未提供 featureFactory,則將沒有 ID 和沒有屬性的地圖項目從該幾何圖形建立。預設值為 null
style optional
集合內所有地圖項目的樣式。詳情請參閱上方的 setStyle() 方法。

Data.GeoJsonOptions 介面

google.maps.Data.GeoJsonOptions 介面

匯入 GeoJSON 的選用參數。

idPropertyName optional
類型:  string optional
要做為地圖項目 ID 的地圖項目屬性名稱。如未指定,系統會使用 GeoJSON 地圖項目 ID。

Data.StyleOptions 介面

google.maps.Data.StyleOptions 介面

這些選項會指定地圖項目在地圖上顯示的方式。

animation optional
類型:  Animation optional
在地圖中加入標記時要播放的動畫。僅適用於點幾何圖形。
clickable optional
類型:  boolean optional
預設: true
如果為 true,標記會接收滑鼠和觸控事件。
cursor optional
類型:  string optional
懸停時顯示滑鼠遊標。僅適用於點幾何圖形。
draggable optional
類型:  boolean optional
預設: false
如果為 true,物件可以拖曳到地圖上,基礎地圖項目的幾何圖形會更新。
editable optional
類型:  boolean optional
預設: false
如果設為 true,則可拖曳控制點來編輯物件,基礎地圖項目的幾何圖形會更新。僅適用於 LineString 和 Polygon 幾何圖形。
fillColor optional
類型:  string optional
填色。系統支援所有 CSS3 色彩 (延伸的具名色彩除外)。僅適用於多邊形幾何圖形。
fillOpacity optional
類型:  number optional
填滿透明度介於 0.0 和 1.0 之間。僅適用於多邊形幾何圖形。
icon optional
類型:  string|Icon|Symbol optional
前景的圖示。如果提供字串,系統會將字串視為 Icon,且字串為 url。僅適用於點幾何圖形。
icons optional
類型:  Array<IconSequence> optional
要沿著折線顯示的圖示。僅適用於線條幾何圖形。
label optional
類型:  string|MarkerLabel optional
為標記新增標籤。標籤可以是字串或 MarkerLabel 物件。僅適用於點幾何圖形。
opacity optional
類型:  number optional
標記的不透明度,介於 0.0 和 1.0 之間。僅適用於點幾何圖形。
shape optional
類型:  MarkerShape optional
定義用於偵測命中的圖片點擊區。僅適用於點幾何圖形。
strokeColor optional
類型:  string optional
筆觸色彩。系統支援所有 CSS3 色彩 (延伸的具名色彩除外)。僅適用於線條和多邊形幾何圖形。
strokeOpacity optional
類型:  number optional
筆觸透明度介於 0.0 和 1.0 之間。僅適用於線條和多邊形幾何圖形。
strokeWeight optional
類型:  number optional
筆觸寬度 (以像素為單位)。僅適用於線條和多邊形幾何圖形。
title optional
類型:  string optional
滑鼠遊標懸停效果文字。僅適用於點幾何圖形。
visible optional
類型:  boolean optional
預設: true
是否顯示地圖項目。
zIndex optional
類型:  number optional
所有地圖項目會按照 zIndex 順序顯示,值較大的地圖項目會顯示在值較低的地圖項目前面。標記一律會顯示在線串和多邊形的前方。

Data.StylingFunction typedef

google.maps.Data.StylingFunction typedef

計算地圖項目外觀的函式。

Data.setStyle() 方法可接受樣式函式。這項功能會根據屬性顯示不同內容,請使用這個選項。如要進一步瞭解樣式功能,請參閱開發人員指南

function(Data.Feature): Data.StyleOptions

Data.Feature 類別

google.maps.Data.Feature 類別

地圖項目包含幾何圖形、ID 和一組屬性。

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.Feature
Data.Feature([options])
參數: 
使用指定的選項建構功能。
forEachProperty
forEachProperty(callback)
參數: 
  • callbackfunction(*, string): void
傳回值:
重複叫用指定的函式,在每次叫用時傳遞屬性值和名稱。透過屬性的疊代順序未定義。
getGeometry
getGeometry()
參數:
傳回值:  Data.Geometry
傳回地圖項目的幾何圖形。
getId
getId()
參數:
傳回值:  number|string|undefined
傳回地圖項目 ID。
getProperty
getProperty(name)
參數: 
  • namestring
傳回值:  *
傳回要求屬性的值;如果屬性不存在,則傳回 undefined
removeProperty
removeProperty(name)
參數: 
  • namestring
傳回值:
移除具有指定名稱的屬性。
setGeometry
setGeometry(newGeometry)
參數: 
傳回值:
設定地圖項目的幾何圖形。
setProperty
setProperty(name, newValue)
參數: 
  • namestring
  • newValue*
傳回值:
設定指定屬性的值。如果 newValueundefined,則等同於呼叫 removeProperty
toGeoJson
toGeoJson(callback)
參數: 
  • callbackfunction(Object): void
傳回值:
將地圖項目匯出到 GeoJSON 物件。
removeproperty
function(event)
引數: 
地圖項目屬性移除時,會觸發這個事件。
setgeometry
function(event)
引數: 
設定地圖項目幾何圖形時,會觸發這個事件。
setproperty
function(event)
引數: 
設定地圖項目的 屬性時,會觸發這個事件。

Data.FeatureOptions 介面

google.maps.Data.FeatureOptions 介面

建立 Data.Feature 物件的選用參數。

geometry optional
類型:  Data.Geometry|LatLng|LatLngLiteral optional
地圖項目幾何圖形。如果建構地圖項目時未指定,功能的幾何圖形將會是 null。如果指定 LatLng 物件或 LatLngLiteral,系統會將該物件轉換為 Data.Point 幾何圖形。
id optional
類型:  number|string optional
特徵 ID 是選填項目。如有提供,即可用於透過 getFeatureById() 方法在 Data 物件中查詢地圖項目。請注意,地圖項目 ID 在後續無法變更。
properties optional
類型:  Object optional
地圖項目屬性。這是將屬性名稱與值的任意對應。

Data.Geometry 介面

google.maps.Data.Geometry 介面

各種幾何物件的父類別。

forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
在每次叫用時重複叫用指定的函式,並將幾何圖形中的點傳遞至函式。
getType
getType()
參數:
傳回值:  string
傳回幾何圖形物件的類型。可能包括 "Point""MultiPoint""LineString""MultiLineString""LinearRing""Polygon""MultiPolygon""GeometryCollection"

Data.Point 類別

google.maps.Data.Point 類別

點幾何圖形包含單一 LatLng

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.Point
Data.Point(latLng)
參數: 
從指定的 LatLngLatLngLiteral 建構 Data.Point
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
get
get()
參數:
傳回值:  LatLng
傳回包含的 LatLng
getType
getType()
參數:
傳回值:  string
傳回 "Point" 字串。

Data.MultiPoint 類別

google.maps.Data.MultiPoint 類別

MultiPoint 幾何圖形包含的 LatLng 數量。

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.MultiPoint
Data.MultiPoint(elements)
參數: 
從指定的 LatLngLatLngLiteral 建構 Data.MultiPoint
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<LatLng>
傳回內含 LatLng 的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  LatLng
傳回包含 LatLng 的第 n 個。
getLength
getLength()
參數:
傳回值:  number
傳回包含的 LatLng 數量。
getType
getType()
參數:
傳回值:  string
傳回 "MultiPoint" 字串。

Data.LineString 類別

google.maps.Data.LineString 類別

LineString 幾何圖形包含多個 LatLng

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.LineString
Data.LineString(elements)
參數: 
從指定的 LatLngLatLngLiteral 建構 Data.LineString
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<LatLng>
傳回內含 LatLngs 的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  LatLng
傳回包含 LatLng 的第 n 個。
getLength
getLength()
參數:
傳回值:  number
傳回包含的 LatLng 數量。
getType
getType()
參數:
傳回值:  string
傳回 "LineString" 字串。

Data.MultiLineString 類別

google.maps.Data.MultiLineString 類別

MultiLineString 幾何圖形包含多個 LineString

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.MultiLineString
Data.MultiLineString(elements)
參數: 
從指定的 Data.LineString 或位置陣列建構 Data.MultiLineString
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<Data.LineString>
傳回內含 Data.LineString 的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  Data.LineString
傳回包含 Data.LineString 的第 n 個。
getLength
getLength()
參數:
傳回值:  number
傳回包含的 Data.LineString 數量。
getType
getType()
參數:
傳回值:  string
傳回 "MultiLineString" 字串。

Data.LinearRing 類別

google.maps.Data.LinearRing 類別

LinearRing 幾何圖形包含多個 LatLng,代表封閉式 LineString。不需要讓第一個 LatLng 等於最後一個 LatLng。LinearRing 已隱含關閉。

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.LinearRing
Data.LinearRing(elements)
參數: 
從指定的 LatLngLatLngLiteral 建構 Data.LinearRing
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<LatLng>
傳回內含 LatLng 的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  LatLng
傳回包含 LatLng 的第 n 個。
getLength
getLength()
參數:
傳回值:  number
傳回包含的 LatLng 數量。
getType
getType()
參數:
傳回值:  string
傳回 "LinearRing" 字串。

Data.Polygon 類別

google.maps.Data.Polygon 類別

多邊形幾何圖形包含多個 Data.LinearRing。第一個線性環必須是多邊形外邊界,後續的線性環則須為內部邊界 (也稱為孔洞)。請參閱有孔的多邊形範例

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.Polygon
Data.Polygon(elements)
參數: 
從指定的 Data.LinearRing 或位置陣列建構 Data.Polygon
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<Data.LinearRing>
傳回內含 Data.LinearRing 的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  Data.LinearRing
傳回包含 Data.LinearRing 的第 n 個。
getLength
getLength()
參數:
傳回值:  number
傳回包含的 Data.LinearRing 數量。
getType
getType()
參數:
傳回值:  string
傳回 "Polygon" 字串。

Data.MultiPolygon 類別

google.maps.Data.MultiPolygon 類別

MultiPolygon 幾何圖形包含多個 Data.Polygon

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.MultiPolygon
Data.MultiPolygon(elements)
從指定的 Data.Polygon 或位置陣列建構 Data.MultiPolygon
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<Data.Polygon>
傳回內含 Data.Polygon 的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  Data.Polygon
傳回包含 Data.Polygon 的第 n 個。
getLength
getLength()
參數:
傳回值:  number
傳回包含的 Data.Polygon 數量。
getType
getType()
參數:
傳回值:  string
傳回 "MultiPolygon" 字串。

Data.GeometryCollection 類別

google.maps.Data.GeometryCollection 類別

幾何圖形集合包含多個幾何圖形物件。任何 LatLngLatLngLiteral 物件都會自動轉換為 Data.Point 幾何圖形物件。

這個類別會實作 Data.Geometry

呼叫 const {Data} = await google.maps.importLibrary("maps") 即可存取。請參閱 Maps JavaScript API 中的程式庫

Data.GeometryCollection
Data.GeometryCollection(elements)
參數: 
從指定的幾何物件或 LatLng 建構 Data.GeometryCollection
forEachLatLng
forEachLatLng(callback)
參數: 
  • callbackfunction(LatLng): void
傳回值:
getArray
getArray()
參數:
傳回值:  Array<Data.Geometry>
傳回內含幾何物件的陣列。每次呼叫 getArray() 時都會傳回新的陣列。
getAt
getAt(n)
參數: 
  • nnumber
傳回值:  Data.Geometry
傳回包含第 n 個的幾何圖形物件。
getLength
getLength()
參數:
傳回值:  number
傳回內含的幾何圖形物件數量。
getType
getType()
參數:
傳回值:  string
傳回 "GeometryCollection" 字串。

Data.MouseEvent 介面

google.maps.Data.MouseEvent 介面

這個物件會傳遞至 Data 物件的滑鼠事件處理常式。

這個介面會擴充 MapMouseEvent

feature
類型:  Data.Feature
產生滑鼠事件的功能。
沿用: domEventlatLng
沿用: stop

Data.AddFeatureEvent 介面

google.maps.Data.AddFeatureEvent 介面

addfeature 事件的屬性。

feature
類型:  Data.Feature
新增至 FeatureCollection 的地圖項目。

Data.RemoveFeatureEvent 介面

google.maps.Data.RemoveFeatureEvent 介面

removefeature 事件的屬性。

feature
類型:  Data.Feature
FeatureCollection 中移除的功能。

Data.SetGeometryEvent 介面

google.maps.Data.SetGeometryEvent 介面

setgeometry 事件的屬性。

feature
類型:  Data.Feature
設定幾何圖形的地圖項目。
newGeometry optional
類型:  Data.Geometry optional
全新地圖項目幾何圖形。
oldGeometry optional
類型:  Data.Geometry optional
上一個地圖項目幾何圖形。

Data.SetPropertyEvent 介面

google.maps.Data.SetPropertyEvent 介面

setproperty 事件的屬性。

feature
類型:  Data.Feature
已設定屬性的地圖項目。
name
類型:  string
屬性名稱。
newValue
類型:  *
新的值。
oldValue
類型:  *
舊值。如果新增此屬性,將會是 undefined

Data.RemovePropertyEvent 介面

google.maps.Data.RemovePropertyEvent 介面

removeproperty 事件的屬性。

feature
類型:  Data.Feature
已移除屬性的地圖項目。
name
類型:  string
屬性名稱。
oldValue
類型:  *
舊值。