Data

Data 類別

google.maps.Data class

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

每個 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 contextmenu 事件在幾何圖形上觸發時,系統會觸發此事件。
dblclick
function(event)
引數: 
此事件會在使用者按兩下幾何圖形時觸發。
mousedown
function(event)
引數: 
此事件會在幾何圖形上發生 mousedown 時觸發。
mouseout
function(event)
引數: 
當滑鼠離開幾何圖形的區域時,系統會觸發此事件。
mouseover
function(event)
引數: 
當滑鼠進入幾何圖形的區域時,系統會觸發此事件。
mouseup
function(event)
引數: 
當使用者在幾何圖形上放開滑鼠時,系統會觸發此事件。
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 和屬性的 Feature。預設值為 null
style optional
集合中所有地圖項目的樣式。詳情請參閱上述 setStyle() 方法。

Data.GeoJsonOptions 介面

google.maps.Data.GeoJsonOptions 介面

匯入 GeoJSON 的選用參數。

idPropertyName optional
類型:  string optional
要用來做為地圖項目 ID 的 Feature 屬性名稱。如未指定,系統會使用 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 class

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

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

Data.Feature
Data.Feature([options])
參數: 
使用指定選項建構 Feature。
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 class

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 class

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
傳回第 n 個包含的 LatLng
getLength
getLength()
參數:
傳回值:  number
傳回包含的 LatLng 數量。
getType
getType()
參數:
傳回值:  string
傳回字串 "MultiPoint"

Data.LineString 類別

google.maps.Data.LineString class

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
傳回第 n 個包含的 LatLng
getLength
getLength()
參數:
傳回值:  number
傳回包含的 LatLng 數量。
getType
getType()
參數:
傳回值:  string
傳回字串 "LineString"

Data.MultiLineString 類別

google.maps.Data.MultiLineString class

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
傳回第 n 個包含的 Data.LineString
getLength
getLength()
參數:
傳回值:  number
傳回包含的 Data.LineString 數量。
getType
getType()
參數:
傳回值:  string
傳回字串 "MultiLineString"

Data.LinearRing 類別

google.maps.Data.LinearRing class

線性環幾何圖形包含多個 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
傳回第 n 個包含的 LatLng
getLength
getLength()
參數:
傳回值:  number
傳回包含的 LatLng 數量。
getType
getType()
參數:
傳回值:  string
傳回字串 "LinearRing"

Data.Polygon 類別

google.maps.Data.Polygon class

多邊形幾何圖形包含多個 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
傳回第 n 個包含的 Data.LinearRing
getLength
getLength()
參數:
傳回值:  number
傳回包含的 Data.LinearRing 數量。
getType
getType()
參數:
傳回值:  string
傳回字串 "Polygon"

Data.MultiPolygon 類別

google.maps.Data.MultiPolygon class

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
傳回第 n 個包含的 Data.Polygon
getLength
getLength()
參數:
傳回值:  number
傳回包含的 Data.Polygon 數量。
getType
getType()
參數:
傳回值:  string
傳回字串 "MultiPolygon"

Data.GeometryCollection 類別

google.maps.Data.GeometryCollection class

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
類型:  *
先前的值。