DataSource class

Balíček:

azure-maps-control

Třída zdroje dat, která usnadňuje správu dat obrazců, která se zobrazí na mapě. Zdroj dat musí být přidán do vrstvy, aby byl viditelný na mapě. Třída DataSource lze použít s SymbolLayer, LineLayer, PolygonLayer, BubbleLayer a HeatMapLayer.

Extends

Source<DataSourceEvents>

Konstruktory

DataSource(string, DataSourceOptions)

Třída zdroje dat, která usnadňuje správu dat obrazců, která se zobrazí na mapě. Zdroj dat musí být přidán do vrstvy, aby byl viditelný na mapě. Třídu DataSource lze použít s SymbolLayer, LineLayer, PolygonLayer, BubbleLayera 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)	Přidá obrazce do zdroje dat. Objekty GeoJSON budou zabaleny v rámci třídy Shape, aby se usnadnila jejich správa. Volitelně můžete zadat index pro vložení prvku mezi jiné obrazce nebo prvky ve vrstvách.
clear()	Odebere všechna data ve zdroji dat.
dispose()	Vyčistí všechny prostředky, které tento objekt využívá.
getClusterChildren(number)	Načte podřízené položky daného clusteru na další úrovni přiblížení. Může se jednat o kombinaci obrazců a dílčích shluků. Dílčí clustery budou funkce s vlastnostmi, které odpovídají ClusteredProperties.
getClusterExpansionZoom(number)	Vypočítá úroveň přiblížení, při které se cluster začne rozšiřovat nebo oddělovat.
getClusterLeaves(number, number, number)	Načte obrazce, které jsou v clusteru.
getOptions()	Získá možnosti používané zdrojem dat.
getShapeById(string | number)	Načte obrazec se zadaným ID. Pokud zdroj dat neobsahuje žádný obrazec se zadaným ID, vrátí se hodnota null.
getShapes()	Vrátí všechny obrazce, které jsou ve zdroji dat.
importDataFromUrl(string)	Stáhne dokument GeoJSON a naimportuje jeho data do zdroje dat. Dokument GeoJSON musí být ve stejné doméně nebo musí být přístupný pomocí CORS.
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	Odebere jeden nebo více obrazců ze zdroje dat. Pokud se řetězec předá, předpokládá se, že se jedná o ID. Pokud je předáno číslo, odebere obrazec v daném indexu.
removeById(number | string | Array<number | string>)	Odebere jeden nebo více obrazců ze zdroje dat na základě jeho ID.
setOptions(DataSourceOptions)	Nastaví možnosti zdroje dat. Zdroj dat si zachová aktuální hodnoty pro všechny možnosti, které nejsou zadané v zadaných možnostech.
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	Přepíše všechny obrazce ve zdroji dat novým polem obrazců.
toJson()	Vrátí funkci GeoJSON FeatureCollection, která obsahuje všechna data obrazce, která je ve zdroji dat.

Zděděné metody

getId()

Získá ID zdroje dat.

Podrobnosti konstruktoru

DataSource(string, DataSourceOptions)

Třída zdroje dat, která usnadňuje správu dat obrazců, která se zobrazí na mapě. Zdroj dat musí být přidán do vrstvy, aby byl viditelný na mapě. Třídu DataSource lze použít s SymbolLayer, LineLayer, PolygonLayer, BubbleLayera HeatMapLayer.

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

Parametry

id

string

jedinečné ID, které uživatel přiřadí ke zdroji dat. Pokud to není zadané, pak se zdroji dat automaticky přiřadí ID.

options

DataSourceOptions

možnosti pro zdroj dat.

Podrobnosti metody

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

Přidá obrazce do zdroje dat. Objekty GeoJSON budou zabaleny v rámci třídy Shape, aby se usnadnila jejich správa. Volitelně můžete zadat index pro vložení prvku mezi jiné obrazce nebo prvky ve vrstvách.

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

Odebere všechna data ve zdroji dat.

function clear()

dispose()

Vyčistí všechny prostředky, které tento objekt využívá.

function dispose()

getClusterChildren(number)

Načte podřízené položky daného clusteru na další úrovni přiblížení. Může se jednat o kombinaci obrazců a dílčích shluků. Dílčí clustery budou funkce s vlastnostmi, které odpovídají ClusteredProperties.

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

Parametry

clusterId

number

Návraty

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

getClusterExpansionZoom(number)

Vypočítá úroveň přiblížení, při které se cluster začne rozšiřovat nebo oddělovat.

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

Parametry

clusterId

number

Návraty

Promise<number>

getClusterLeaves(number, number, number)

Načte obrazce, které jsou v clusteru.

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

Parametry

clusterId

number

limit

number

Maximální počet funkcí, které se mají vrátit. Nastavením na Nekonečno vrátíte všechny obrazce.

offset

number

Počet obrazců, které se mají přeskočit. Umožňuje stránkovat obrazce v clusteru.

Návraty

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

getOptions()

Získá možnosti používané zdrojem dat.

function getOptions(): DataSourceOptions

Návraty

DataSourceOptions

getShapeById(string | number)

Načte obrazec se zadaným ID. Pokud zdroj dat neobsahuje žádný obrazec se zadaným ID, vrátí se hodnota null.

function getShapeById(id: string | number): Shape

Parametry

id

string | number

ID obrazce, který se má vrátit.

Návraty

Shape

getShapes()

Vrátí všechny obrazce, které jsou ve zdroji dat.

function getShapes(): Shape[]

Návraty

Shape[]

importDataFromUrl(string)

Stáhne dokument GeoJSON a naimportuje jeho data do zdroje dat. Dokument GeoJSON musí být ve stejné doméně nebo musí být přístupný pomocí CORS.

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

Parametry

url

string

Návraty

Promise<void>

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

Odebere jeden nebo více obrazců ze zdroje dat. Pokud se řetězec předá, předpokládá se, že se jedná o ID. Pokud je předáno číslo, odebere obrazec v daném indexu.

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

Obrazce, ID obrazce nebo funkce, které se mají odebrat

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

Odebere jeden nebo více obrazců ze zdroje dat na základě jeho ID.

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

Parametry

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Nastaví možnosti zdroje dat. Zdroj dat si zachová aktuální hodnoty pro všechny možnosti, které nejsou zadané v zadaných možnostech.

function setOptions(options: DataSourceOptions)

Parametry

options

DataSourceOptions

Možnosti zdroje dat, které se mají nastavit

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

Přepíše všechny obrazce ve zdroji dat novým polem obrazců.

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

Parametry

shape

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

nové obrazce, které se mají aktualizovat

toJson()

Vrátí funkci GeoJSON FeatureCollection, která obsahuje všechna data obrazce, která je ve zdroji dat.

function toJson(): FeatureCollection

Návraty

FeatureCollection

Podrobnosti zděděných metod

getId()

Získá ID zdroje dat.

function getId(): string

Návraty

string

Zděděno zSource.getId