你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DataSource class

包:

azure-maps-control

一个数据源类，使管理将在地图上显示的形状数据变得容易。 必须先将数据源添加到图层中，然后才能在地图上显示数据源。 DataSource 类可与 SymbolLayer、LineLayer、PolygonLayer、BubbleLayer 和 HeatMapLayer 一起使用。

Extends

Source<DataSourceEvents>

构造函数

DataSource(string, DataSourceOptions)

一个数据源类，使管理将在地图上显示的形状数据变得容易。 必须先将数据源添加到图层中，然后才能在地图上显示数据源。 类DataSource可与 、、LineLayer、PolygonLayerBubbleLayer、 和 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)	检索具有指定 ID 的形状。如果数据源中不包含具有指定 ID 的形状，则将返回 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>>)	从数据源中删除一个或多个形状。 如果传入字符串，则假定它是 ID。如果传入数字，则删除该索引处的形状。
removeById(number | string | Array<number | string>)	根据数据源的 ID 从数据源中删除一个或多个形状。
setOptions(DataSourceOptions)	设置数据源选项。 数据源将为未在提供的选项中指定的任何选项保留其当前值。
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	使用新的形状数组覆盖数据源中的所有形状。
toJson()	返回一个 GeoJSON FeatureCollection，其中包含数据源中的所有形状数据。

继承的方法

getId()

获取数据源的 ID

构造函数详细信息

DataSource(string, DataSourceOptions)

一个数据源类，使管理将在地图上显示的形状数据变得容易。 必须先将数据源添加到图层中，然后才能在地图上显示数据源。 类DataSource可与 、、LineLayer、PolygonLayerBubbleLayer、 和 HeatMapLayer一起使用SymbolLayer。

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

参数

id

string

用户分配给数据源的唯一 ID。 如果未指定，则会自动为数据源分配 ID。

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)

检索具有指定 ID 的形状。如果数据源中不包含具有指定 ID 的形状，则将返回 null。

function getShapeById(id: string | number): Shape

参数

id

string | number

要返回的形状的 ID。

返回

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>>)

从数据源中删除一个或多个形状。 如果传入字符串，则假定它是 ID。如果传入数字，则删除该索引处的形状。

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>>

要删除的形状 () 、形状 ID () 或特征 ()

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

根据数据源的 ID 从数据源中删除一个或多个形状。

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()

获取数据源的 ID

function getId(): string

返回

string

继承自Source.getId