DataSource class

Paquet:

azure-maps-control

Classe de source de données qui facilite la gestion des données de formes qui seront affichées sur la carte. Une source de données doit être ajoutée à une couche avant d’être visible sur la carte. La classe DataSource peut être utilisée avec SymbolLayer, LineLayer, PolygonLayer, BubbleLayer et HeatMapLayer.

Extends

Source<DataSourceEvents>

Constructeurs

DataSource(string, DataSourceOptions)

Classe de source de données qui facilite la gestion des données de formes qui seront affichées sur la carte. Une source de données doit être ajoutée à une couche avant d’être visible sur la carte. La DataSource classe peut être utilisée avec , SymbolLayerLineLayer, PolygonLayer, BubbleLayeret HeatMapLayer.

Méthodes

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)	Ajoute des formes à la source de données. Les objets GeoJSON seront encapsulés dans une classe Shape pour faciliter leur gestion. Spécifiez éventuellement un index pour insérer la fonctionnalité entre d’autres formes/caractéristiques dans les couches.
clear()	Supprime toutes les données de la source de données.
dispose()	Nettoie toutes les ressources consommées par cet objet.
getClusterChildren(number)	Récupère les enfants du cluster donné sur le niveau de zoom suivant. Il peut s’agir d’une combinaison de formes et de sous-clusters. Les sous-clusters seront des fonctionnalités avec des propriétés correspondant à ClusteredProperties.
getClusterExpansionZoom(number)	Calcule un niveau de zoom à partir duquel le cluster commence à se développer ou à se décomposer.
getClusterLeaves(number, number, number)	Récupère les formes qui se trouvent dans le cluster.
getOptions()	Obtient les options utilisées par la source de données.
getShapeById(string | number)	Récupère une forme avec l’ID spécifié. Si aucune forme avec l’ID spécifié n’est contenue dans la source de données, la valeur Null est retournée.
getShapes()	Retourne toutes les formes qui se trouvent dans la source de données.
importDataFromUrl(string)	Télécharge un document GeoJSON et importe ses données dans la source de données. Le document GeoJSON doit se trouver sur le même domaine ou être accessible à l’aide de CORS.
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	Supprime une ou plusieurs formes de la source de données. Si une chaîne est passée, elle est supposée être un ID. Si un nombre est passé, supprime la forme à cet index.
removeById(number | string | Array<number | string>)	Supprime une ou plusieurs formes de la source de données en fonction de son ID.
setOptions(DataSourceOptions)	Définit les options de source de données. La source de données conserve ses valeurs actuelles pour toute option non spécifiée dans les options fournies.
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	Remplace toutes les formes de la source de données par le nouveau tableau de formes.
toJson()	Renvoie un FeatureCollection GeoJSON qui contient toutes les données de forme qui se trouve dans la source de données.

Méthodes héritées

getId()

Obtient l’ID de la source de données

Détails du constructeur

DataSource(string, DataSourceOptions)

Classe de source de données qui facilite la gestion des données de formes qui seront affichées sur la carte. Une source de données doit être ajoutée à une couche avant d’être visible sur la carte. La DataSource classe peut être utilisée avec , SymbolLayerLineLayer, PolygonLayer, BubbleLayeret HeatMapLayer.

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

Paramètres

id

string

id unique que l’utilisateur affecte à la source de données. Si ce n’est pas spécifié, un ID est automatiquement attribué à la source de données.

options

DataSourceOptions

options de la source de données.

Détails de la méthode

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

Ajoute des formes à la source de données. Les objets GeoJSON seront encapsulés dans une classe Shape pour faciliter leur gestion. Spécifiez éventuellement un index pour insérer la fonctionnalité entre d’autres formes/caractéristiques dans les couches.

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)

Paramètres

data

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

index

number

clear()

Supprime toutes les données de la source de données.

function clear()

dispose()

Nettoie toutes les ressources consommées par cet objet.

function dispose()

getClusterChildren(number)

Récupère les enfants du cluster donné sur le niveau de zoom suivant. Il peut s’agir d’une combinaison de formes et de sous-clusters. Les sous-clusters seront des fonctionnalités avec des propriétés correspondant à ClusteredProperties.

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

Paramètres

clusterId

number

Retours

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

getClusterExpansionZoom(number)

Calcule un niveau de zoom à partir duquel le cluster commence à se développer ou à se décomposer.

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

Paramètres

clusterId

number

Retours

Promise<number>

getClusterLeaves(number, number, number)

Récupère les formes qui se trouvent dans le cluster.

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

Paramètres

clusterId

number

limit

number

Nombre maximal de fonctionnalités à retourner. Définissez sur Infini pour renvoyer toutes les formes.

offset

number

Nombre de formes à ignorer. Vous permet de parcourir les formes du cluster.

Retours

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

getOptions()

Obtient les options utilisées par la source de données.

function getOptions(): DataSourceOptions

Retours

DataSourceOptions

getShapeById(string | number)

Récupère une forme avec l’ID spécifié. Si aucune forme avec l’ID spécifié n’est contenue dans la source de données, la valeur Null est retournée.

function getShapeById(id: string | number): Shape

Paramètres

id

string | number

ID de la forme à retourner.

Retours

Shape

getShapes()

Retourne toutes les formes qui se trouvent dans la source de données.

function getShapes(): Shape[]

Retours

Shape[]

importDataFromUrl(string)

Télécharge un document GeoJSON et importe ses données dans la source de données. Le document GeoJSON doit se trouver sur le même domaine ou être accessible à l’aide de CORS.

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

Paramètres

url

string

Retours

Promise<void>

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

Supprime une ou plusieurs formes de la source de données. Si une chaîne est passée, elle est supposée être un ID. Si un nombre est passé, supprime la forme à cet index.

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

Paramètres

shape

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

Forme(s), ID(s) de forme ou caractéristique(s) à supprimer

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

Supprime une ou plusieurs formes de la source de données en fonction de son ID.

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

Paramètres

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Définit les options de source de données. La source de données conserve ses valeurs actuelles pour toute option non spécifiée dans les options fournies.

function setOptions(options: DataSourceOptions)

Paramètres

options

DataSourceOptions

DataSourceOptions à définir

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

Remplace toutes les formes de la source de données par le nouveau tableau de formes.

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

Paramètres

shape

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

les nouvelles formes à mettre à jour

toJson()

Renvoie un FeatureCollection GeoJSON qui contient toutes les données de forme qui se trouve dans la source de données.

function toJson(): FeatureCollection

Retours

FeatureCollection

Détails de la méthode héritée

getId()

Obtient l’ID de la source de données

function getId(): string

Retours

string

Hérité deSource.getId