Freigeben über


DataSource class

Eine Datenquellenklasse, die das Verwalten von Shapes-Daten erleichtert, die auf der Karte angezeigt werden. Eine Datenquelle muss einer Ebene hinzugefügt werden, bevor sie auf der Karte sichtbar ist. Die DataSource-Klasse kann mit SymbolLayer, LineLayer, PolygonLayer, BubbleLayer und HeatMapLayer verwendet werden.

Extends

Konstruktoren

DataSource(string, DataSourceOptions)

Eine Datenquellenklasse, die das Verwalten von Shapes-Daten erleichtert, die auf der Karte angezeigt werden. Eine Datenquelle muss einer Ebene hinzugefügt werden, bevor sie auf der Karte sichtbar ist. Die DataSource -Klasse kann mit , SymbolLayerLineLayer, PolygonLayerBubbleLayer, und HeatMapLayerverwendet werden.

Methoden

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

Fügt der Datenquelle Shapes hinzu. GeoJSON-Objekte werden in einer Shape-Klasse umschlossen, um sie einfacher zu verwalten. Geben Sie optional einen Index an, um das Feature zwischen anderen Formen/Features in den Ebenen einzufügen.

clear()

Entfernt alle Daten in der Datenquelle.

dispose()

Bereinigt alle Ressourcen, die dieses Objekt verbraucht.

getClusterChildren(number)

Ruft die untergeordneten Elemente des angegebenen Clusters für den nächsten Zoomfaktor ab. Dies kann eine Kombination aus Formen und Teilclustern sein. Die Teilcluster sind Features mit Eigenschaften, die mit ClusteredProperties übereinstimmen.

getClusterExpansionZoom(number)

Berechnet einen Zoomfaktor, bei dem der Cluster mit der Erweiterung oder Unterteilung beginnt.

getClusterLeaves(number, number, number)

Ruft Shapes ab, die sich innerhalb des Clusters befinden.

getOptions()

Ruft die von der Datenquelle verwendeten Optionen ab.

getShapeById(string | number)

Ruft ein Shape mit der angegebenen ID ab. Wenn in der Datenquelle kein Shape mit der angegebenen ID enthalten ist, wird NULL zurückgegeben.

getShapes()

Gibt alle Shapes zurück, die sich in der DataSource befinden.

importDataFromUrl(string)

Lädt ein GeoJSON-Dokument herunter und importiert seine Daten in die Datenquelle. Das GeoJSON-Dokument muss sich in derselben Domäne befinden oder über CORS zugänglich sein.

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

Entfernt ein oder mehrere Shapes aus der Datenquelle. Wenn eine Zeichenfolge übergeben wird, wird davon ausgegangen, dass es sich um eine ID handelt. Wenn eine Zahl übergeben wird, entfernt die Form an diesem Index.

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

Entfernt ein oder mehrere Shapes basierend auf ihrer ID aus der Datenquelle.

setOptions(DataSourceOptions)

Legt die Datenquellenoptionen fest. Die Datenquelle behält ihre aktuellen Werte für alle Optionen bei, die nicht in den angegebenen Optionen angegeben sind.

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

Überschreibt alle Shapes in der Datenquelle mit dem neuen Array von Shapes.

toJson()

Gibt eine GeoJSON-FeatureCollection zurück, die alle Shape-Daten enthält, die sich in der Datenquelle befinden.

Geerbte Methoden

getId()

Ruft die ID der Datenquelle ab.

Details zum Konstruktor

DataSource(string, DataSourceOptions)

Eine Datenquellenklasse, die das Verwalten von Shapes-Daten erleichtert, die auf der Karte angezeigt werden. Eine Datenquelle muss einer Ebene hinzugefügt werden, bevor sie auf der Karte sichtbar ist. Die DataSource -Klasse kann mit , SymbolLayerLineLayer, PolygonLayerBubbleLayer, und HeatMapLayerverwendet werden.

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

Parameter

id

string

eine eindeutige ID, die der Benutzer der Datenquelle zuweist. Wenn dies nicht angegeben ist, wird der Datenquelle automatisch eine ID zugewiesen.

options
DataSourceOptions

die Optionen für die Datenquelle.

Details zur Methode

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

Fügt der Datenquelle Shapes hinzu. GeoJSON-Objekte werden in einer Shape-Klasse umschlossen, um sie einfacher zu verwalten. Geben Sie optional einen Index an, um das Feature zwischen anderen Formen/Features in den Ebenen einzufügen.

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)

Parameter

index

number

clear()

Entfernt alle Daten in der Datenquelle.

function clear()

dispose()

Bereinigt alle Ressourcen, die dieses Objekt verbraucht.

function dispose()

getClusterChildren(number)

Ruft die untergeordneten Elemente des angegebenen Clusters für den nächsten Zoomfaktor ab. Dies kann eine Kombination aus Formen und Teilclustern sein. Die Teilcluster sind Features mit Eigenschaften, die mit ClusteredProperties übereinstimmen.

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

Parameter

clusterId

number

Gibt zurück

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

getClusterExpansionZoom(number)

Berechnet einen Zoomfaktor, bei dem der Cluster mit der Erweiterung oder Unterteilung beginnt.

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

Parameter

clusterId

number

Gibt zurück

Promise<number>

getClusterLeaves(number, number, number)

Ruft Shapes ab, die sich innerhalb des Clusters befinden.

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

Parameter

clusterId

number

limit

number

Die maximale Anzahl von Features, die zurückgegeben werden sollen. Legen Sie auf Unendlich fest, um alle Formen zurückzugeben.

offset

number

Die Anzahl der zu überspringenden Shapes. Ermöglicht ihnen das Durchlaufen der Shapes im Cluster.

Gibt zurück

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

getOptions()

Ruft die von der Datenquelle verwendeten Optionen ab.

function getOptions(): DataSourceOptions

Gibt zurück

getShapeById(string | number)

Ruft ein Shape mit der angegebenen ID ab. Wenn in der Datenquelle kein Shape mit der angegebenen ID enthalten ist, wird NULL zurückgegeben.

function getShapeById(id: string | number): Shape

Parameter

id

string | number

Die ID der zurückzugebenden Form.

Gibt zurück

getShapes()

Gibt alle Shapes zurück, die sich in der DataSource befinden.

function getShapes(): Shape[]

Gibt zurück

Shape[]

importDataFromUrl(string)

Lädt ein GeoJSON-Dokument herunter und importiert seine Daten in die Datenquelle. Das GeoJSON-Dokument muss sich in derselben Domäne befinden oder über CORS zugänglich sein.

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

Parameter

url

string

Gibt zurück

Promise<void>

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

Entfernt ein oder mehrere Shapes aus der Datenquelle. Wenn eine Zeichenfolge übergeben wird, wird davon ausgegangen, dass es sich um eine ID handelt. Wenn eine Zahl übergeben wird, entfernt die Form an diesem Index.

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

Parameter

shape

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

Die zu entfernenden Formen, Shape-ID(n) oder Features

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

Entfernt ein oder mehrere Shapes basierend auf ihrer ID aus der Datenquelle.

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

Parameter

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Legt die Datenquellenoptionen fest. Die Datenquelle behält ihre aktuellen Werte für alle Optionen bei, die nicht in den angegebenen Optionen angegeben sind.

function setOptions(options: DataSourceOptions)

Parameter

options
DataSourceOptions

festzulegende DataSourceOptions

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

Überschreibt alle Shapes in der Datenquelle mit dem neuen Array von Shapes.

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

Parameter

shape

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

die neuen zu aktualisierenden Shapes

toJson()

Gibt eine GeoJSON-FeatureCollection zurück, die alle Shape-Daten enthält, die sich in der Datenquelle befinden.

function toJson(): FeatureCollection

Gibt zurück

Details zur geerbten Methode

getId()

Ruft die ID der Datenquelle ab.

function getId(): string

Gibt zurück

string

Geerbt vonSource.getId