DataSource class

Pakiet:

azure-maps-control

Klasa źródła danych, która ułatwia zarządzanie danymi kształtów, które będą wyświetlane na mapie. Źródło danych należy dodać do warstwy, zanim będzie widoczne na mapie. Klasa DataSource może być używana z elementami SymbolLayer, LineLayer, PolygonLayer, BubbleLayer i HeatMapLayer.

Extends

Source<DataSourceEvents>

Konstruktory

DataSource(string, DataSourceOptions)

Klasa źródła danych, która ułatwia zarządzanie danymi kształtów, które będą wyświetlane na mapie. Źródło danych należy dodać do warstwy, zanim będzie widoczne na mapie. Klasa DataSource może być używana z klasą SymbolLayer, , LineLayer, BubbleLayerPolygonLayeri HeatMapLayer.

Metody

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)	Dodaje kształty do źródła danych. Obiekty GeoJSON zostaną opakowane w klasie Kształt, aby ułatwić zarządzanie nimi. Opcjonalnie określ indeks, aby wstawić funkcję między innymi kształtami/funkcjami w warstwach.
clear()	Usuwa wszystkie dane w źródle danych.
dispose()	Czyści wszystkie zasoby, z których korzysta ten obiekt.
getClusterChildren(number)	Pobiera elementy podrzędne danego klastra na następnym poziomie powiększenia. Może to być kombinacja kształtów i podklas. Podklasy będą zawierać funkcje z właściwościami pasującymi do właściwości ClusteredProperties.
getClusterExpansionZoom(number)	Oblicza poziom powiększenia, na którym klaster zacznie się rozszerzać lub rozbijać.
getClusterLeaves(number, number, number)	Pobiera kształty znajdujące się w klastrze.
getOptions()	Pobiera opcje używane przez źródło danych.
getShapeById(string | number)	Pobiera kształt z określonym identyfikatorem. Jeśli żaden kształt o określonym identyfikatorze nie jest zawarty w źródle danych, wartość null zostanie zwrócona.
getShapes()	Zwraca wszystkie kształty, które znajdują się w źródle danych.
importDataFromUrl(string)	Pobiera dokument GeoJSON i importuje dane do źródła danych. Dokument GeoJSON musi znajdować się w tej samej domenie lub być dostępny przy użyciu mechanizmu CORS.
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	Usuwa jeden lub więcej kształtów ze źródła danych. Jeśli ciąg zostanie przekazany, przyjmuje się, że jest to identyfikator. Jeśli liczba zostanie przekazana, usunie kształt w tym indeksie.
removeById(number | string | Array<number | string>)	Usuwa jeden lub więcej kształtów ze źródła danych na podstawie jego identyfikatora.
setOptions(DataSourceOptions)	Ustawia opcje źródła danych. Źródło danych zachowa bieżące wartości dla każdej opcji, która nie jest określona w podanych opcjach.
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	Zastępuje wszystkie kształty w źródle danych nową tablicą kształtów.
toJson()	Zwraca funkcję GeoJSON FeatureCollection zawierającą wszystkie dane kształtu, które znajdują się w źródle danych.

Metody dziedziczone

getId()

Pobiera identyfikator źródła danych

Szczegóły konstruktora

DataSource(string, DataSourceOptions)

Klasa źródła danych, która ułatwia zarządzanie danymi kształtów, które będą wyświetlane na mapie. Źródło danych należy dodać do warstwy, zanim będzie widoczne na mapie. Klasa DataSource może być używana z klasą SymbolLayer, , LineLayer, BubbleLayerPolygonLayeri HeatMapLayer.

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

Parametry

id

string

unikatowy identyfikator, który użytkownik przypisuje do źródła danych. Jeśli to nie zostanie określone, źródło danych zostanie automatycznie przypisane do identyfikatora.

options

DataSourceOptions

opcje źródła danych.

Szczegóły metody

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

Dodaje kształty do źródła danych. Obiekty GeoJSON zostaną opakowane w klasie Kształt, aby ułatwić zarządzanie nimi. Opcjonalnie określ indeks, aby wstawić funkcję między innymi kształtami/funkcjami w warstwach.

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)

Parametry

data

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

index

number

clear()

Usuwa wszystkie dane w źródle danych.

function clear()

dispose()

Czyści wszystkie zasoby, z których korzysta ten obiekt.

function dispose()

getClusterChildren(number)

Pobiera elementy podrzędne danego klastra na następnym poziomie powiększenia. Może to być kombinacja kształtów i podklas. Podklasy będą zawierać funkcje z właściwościami pasującymi do właściwości ClusteredProperties.

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

Parametry

clusterId

number

Zwraca

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

getClusterExpansionZoom(number)

Oblicza poziom powiększenia, na którym klaster zacznie się rozszerzać lub rozbijać.

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

Parametry

clusterId

number

Zwraca

Promise<number>

getClusterLeaves(number, number, number)

Pobiera kształty znajdujące się w klastrze.

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

Parametry

clusterId

number

limit

number

Maksymalna liczba funkcji do zwrócenia. Ustaw wartość Nieskończoność, aby zwrócić wszystkie kształty.

offset

number

Liczba kształtów do pominięcia. Umożliwia stronicowanie kształtów w klastrze.

Zwraca

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

getOptions()

Pobiera opcje używane przez źródło danych.

function getOptions(): DataSourceOptions

Zwraca

DataSourceOptions

getShapeById(string | number)

Pobiera kształt z określonym identyfikatorem. Jeśli żaden kształt o określonym identyfikatorze nie jest zawarty w źródle danych, wartość null zostanie zwrócona.

function getShapeById(id: string | number): Shape

Parametry

id

string | number

Identyfikator kształtu do zwrócenia.

Zwraca

Shape

getShapes()

Zwraca wszystkie kształty, które znajdują się w źródle danych.

function getShapes(): Shape[]

Zwraca

Shape[]

importDataFromUrl(string)

Pobiera dokument GeoJSON i importuje dane do źródła danych. Dokument GeoJSON musi znajdować się w tej samej domenie lub być dostępny przy użyciu mechanizmu CORS.

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

Parametry

url

string

Zwraca

Promise<void>

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

Usuwa jeden lub więcej kształtów ze źródła danych. Jeśli ciąg zostanie przekazany, przyjmuje się, że jest to identyfikator. Jeśli liczba zostanie przekazana, usunie kształt w tym indeksie.

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

Parametry

shape

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

Kształty, identyfikatory kształtów lub funkcje do usunięcia

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

Usuwa jeden lub więcej kształtów ze źródła danych na podstawie jego identyfikatora.

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

Parametry

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Ustawia opcje źródła danych. Źródło danych zachowa bieżące wartości dla każdej opcji, która nie jest określona w podanych opcjach.

function setOptions(options: DataSourceOptions)

Parametry

options

DataSourceOptions

zestaw DataSourceOptions

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

Zastępuje wszystkie kształty w źródle danych nową tablicą kształtów.

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

Parametry

shape

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

nowe kształty do zaktualizowania

toJson()

Zwraca funkcję GeoJSON FeatureCollection zawierającą wszystkie dane kształtu, które znajdują się w źródle danych.

function toJson(): FeatureCollection

Zwraca

FeatureCollection

Szczegóły metody dziedziczonej

getId()

Pobiera identyfikator źródła danych

function getId(): string

Zwraca

string

Dziedziczone z plikuSource.getId