DataSource class

パッケージ:

azure-maps-control

マップに表示される図形データを簡単に管理できるようにするデータ ソース クラス。 データ ソースは、マップに表示される前にレイヤーに追加する必要があります。 DataSource クラスは、SymbolLayer、LineLayer、PolygonLayer、BubbleLayer、HeatMapLayer と共に使用できます。

Extends

Source<DataSourceEvents>

コンストラクター

DataSource(string, DataSourceOptions)

マップに表示される図形データを簡単に管理できるようにするデータ ソース クラス。 データ ソースは、マップに表示される前にレイヤーに追加する必要があります。 クラスはDataSource、および と共PolygonLayerBubbleLayerSymbolLayerLineLayerにHeatMapLayer使用できます。

メソッド

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>>)	データ ソースから 1 つ以上の図形を削除します。 文字列が渡された場合、ID と見なされます。数値が渡された場合は、そのインデックスにある図形を削除します。
removeById(number | string | Array<number | string>)	ID に基づいて、データソースから 1 つ以上の図形を削除します。
setOptions(DataSourceOptions)	データ ソース オプションを設定します。 データ ソースは、指定されたオプションで指定されていないオプションの現在の値を保持します。
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	データ ソース内のすべての図形を新しい図形の配列で上書きします。
toJson()	データ ソース内のすべての図形データを含む GeoJSON FeatureCollection を返します。

継承されたメソッド

getId()

データ ソースの ID を取得します

コンストラクターの詳細

DataSource(string, DataSourceOptions)

マップに表示される図形データを簡単に管理できるようにするデータ ソース クラス。 データ ソースは、マップに表示される前にレイヤーに追加する必要があります。 クラスはDataSource、および と共PolygonLayerBubbleLayerSymbolLayerLineLayerにHeatMapLayer使用できます。

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

返される特徴の最大数。 すべての図形を返すには、Infinity に設定します。

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

データ ソースから 1 つ以上の図形を削除します。 文字列が渡された場合、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 に基づいて、データソースから 1 つ以上の図形を削除します。

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 から継承