DataSource class

套件:

azure-maps-control

資料來源類別，可讓您輕鬆地管理在地圖上顯示的圖形資料。 資料來源必須新增至圖層，才能在地圖上看見。 DataSource 類別可以與 SymbolLayer、LineLayer、PolygonLayer、BubbleLayer 和 HeatMapLayer 搭配使用。

Extends

Source<DataSourceEvents>

建構函式

DataSource(string, DataSourceOptions)

資料來源類別，可讓您輕鬆地管理在地圖上顯示的圖形資料。 資料來源必須新增至圖層，才能在地圖上看見。 類別 DataSource 可與 、 LineLayer 、 PolygonLayer 、 BubbleLayer 和 HeatMapLayer 搭配 SymbolLayer 使用。

方法

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)	將圖形新增至資料來源。 GeoJSON 物件將會包裝在 Shape 類別內，使其更容易管理。 選擇性地指定索引，以在圖層中的其他圖形/特徵之間插入特徵。
clear()	移除資料來源中的所有資料。
dispose()	清除此物件所耗用的任何資源。
getClusterChildren(number)	擷取給定群集在下一個縮放層級上的子系。 這可能是圖形和子叢集的組合。 子叢集將會是具有符合 ClusteredProperties 屬性的功能。
getClusterExpansionZoom(number)	計算群集將開始擴大或分解的臨界縮放層級。
getClusterLeaves(number, number, number)	擷取叢集中的圖形。
getOptions()	取得資料來源所使用的選項。
getShapeById(string | number)	擷取具有指定識別碼的圖形。如果資料來源中未包含具有指定識別碼的圖形，則會傳回 null。
getShapes()	傳回 DataSource 中的所有圖形。
importDataFromUrl(string)	下載 GeoJSON 檔並將其資料匯入資料來源。 GeoJSON 檔必須位於相同的網域，或使用 CORS 存取。
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	從資料來源中移除一或多個圖形。 如果傳入字串，則會假設它是識別碼。如果傳入數位，請移除該索引處的圖形。
removeById(number | string | Array<number | string>)	根據資料來源的識別碼，從資料來源中移除一或多個圖形。
setOptions(DataSourceOptions)	設定資料來源選項。 資料來源會針對提供的選項中未指定的任何選項保留其目前值。
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	使用新的圖形陣列覆寫資料來源中的所有圖形。
toJson()	會傳回 GeoJSON FeatureCollection，其中包含資料來源中的所有圖形資料。

繼承的方法

getId()

取得資料來源的識別碼

建構函式詳細資料

DataSource(string, DataSourceOptions)

資料來源類別，可讓您輕鬆地管理在地圖上顯示的圖形資料。 資料來源必須新增至圖層，才能在地圖上看見。 類別 DataSource 可與 、 LineLayer 、 PolygonLayer 、 BubbleLayer 和 HeatMapLayer 搭配 SymbolLayer 使用。

new DataSource(id?: string, options?: DataSourceOptions)

參數

id

string

使用者指派給資料來源的唯一識別碼。 如果未指定此專案，則資料來源會自動獲指派識別碼。

options

DataSourceOptions

資料來源的選項。

方法詳細資料

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)

將圖形新增至資料來源。 GeoJSON 物件將會包裝在 Shape 類別內，使其更容易管理。 選擇性地指定索引，以在圖層中的其他圖形/特徵之間插入特徵。

function add(data: FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, index?: number)

參數

data

FeatureCollection | Feature<Geometry, any> | Geometry | GeometryCollection | Shape | Array<Feature<Geometry, any> | Geometry | Shape>

index

number

clear()

移除資料來源中的所有資料。

function clear()

dispose()

清除此物件所耗用的任何資源。

function dispose()

getClusterChildren(number)

擷取給定群集在下一個縮放層級上的子系。 這可能是圖形和子叢集的組合。 子叢集將會是具有符合 ClusteredProperties 屬性的功能。

function getClusterChildren(clusterId: number): Promise<Array<Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>

參數

clusterId

number

傳回

Promise<Array<Feature<Geometry, ClusteredProperties | any> | Shape>>

getClusterExpansionZoom(number)

計算群集將開始擴大或分解的臨界縮放層級。

function getClusterExpansionZoom(clusterId: number): Promise<number>

參數

clusterId

number

傳回

Promise<number>

getClusterLeaves(number, number, number)

擷取叢集中的圖形。

function getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Array<Feature<atlas.data.Geometry, any> | Shape>>

參數

clusterId

number

limit

number

要傳回的功能數目上限。 設定為 [無限大] 以傳回所有圖形。

offset

number

要略過的圖形數目。 可讓您逐頁流覽叢集中的圖形。

傳回

Promise<Array<Feature<Geometry, any> | Shape>>

getOptions()

取得資料來源所使用的選項。

function getOptions(): DataSourceOptions

傳回

DataSourceOptions

getShapeById(string | number)

擷取具有指定識別碼的圖形。如果資料來源中未包含具有指定識別碼的圖形，則會傳回 null。

function getShapeById(id: string | number): Shape

參數

id

string | number

要傳回之圖形的識別碼。

傳回

Shape

getShapes()

傳回 DataSource 中的所有圖形。

function getShapes(): Shape[]

傳回

Shape[]

importDataFromUrl(string)

下載 GeoJSON 檔並將其資料匯入資料來源。 GeoJSON 檔必須位於相同的網域，或使用 CORS 存取。

function importDataFromUrl(url: string): Promise<void>

參數

url

string

傳回

Promise<void>

remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)

從資料來源中移除一或多個圖形。 如果傳入字串，則會假設它是識別碼。如果傳入數位，請移除該索引處的圖形。

function remove(shape: number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)

參數

shape

number | string | Shape | Feature<Geometry, any> | Array<number | string | Shape | Feature<Geometry, any>>

要移除的圖形 () 、圖形識別碼 () ，或要移除的功能 ()

removeById(number | string | Array<number | string>)

根據資料來源的識別碼，從資料來源中移除一或多個圖形。

function removeById(id: number | string | Array<number | string>)

參數

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

設定資料來源選項。 資料來源會針對提供的選項中未指定的任何選項保留其目前值。

function setOptions(options: DataSourceOptions)

參數

options

DataSourceOptions

要設定的 DataSourceOptions

setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)

使用新的圖形陣列覆寫資料來源中的所有圖形。

function setShapes(shape: FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)

參數

shape

FeatureCollection | Array<Feature<Geometry, any> | Geometry | Shape>

要更新的新圖形

toJson()

會傳回 GeoJSON FeatureCollection，其中包含資料來源中的所有圖形資料。

function toJson(): FeatureCollection

傳回

FeatureCollection

繼承的方法的詳細資料

getId()

取得資料來源的識別碼

function getId(): string

傳回

string

繼承自Source.getId