Partager via


SourceManager interface

Un gestionnaire pour les sources du contrôle de carte. Exposé via la propriété sources de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

Méthodes

add(Source | Source[])

Ajoute une ou plusieurs sources de données à la carte. La carte doit être prête pour qu’une source puisse être ajoutée. Utilisez la méthode map.events.add avec le type d’événement « ready ».

clear()

Supprime toutes les sources de la carte.

getById(string)

Récupère une source avec l’ID spécifié.

getFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string)

Obtient l’état d’une fonctionnalité

getRenderedShapes(string | Source, Expression, string)

Retourne toutes les fonctionnalités de forme rendues dans une source qui correspondent à un filtre spécifié. Si la source est une source de vignette vectorielle, un nom de couche source doit être spécifié.

getSources()

Récupère toutes les sources qui ont été ajoutées à la carte.

isSourceLoaded(string | Source)

Retourne une valeur booléenne indiquant si la source est chargée ou non.

remove(string | Source | Array<string | Source>)

Supprime une ou plusieurs sources de la carte en spécifiant l’ID source ou en fournissant la source elle-même.

removeFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string, string)

Supprime l’état ou une seule valeur de clé de l’état d’une fonctionnalité.

setFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, object, string)

Définit l’état de la fonctionnalité en transmettant un objet de paire de valeurs de clé.

Détails de la méthode

add(Source | Source[])

Ajoute une ou plusieurs sources de données à la carte. La carte doit être prête pour qu’une source puisse être ajoutée. Utilisez la méthode map.events.add avec le type d’événement « ready ».

function add(source: Source | Source[])

Paramètres

source

Source | Source[]

clear()

Supprime toutes les sources de la carte.

function clear()

getById(string)

Récupère une source avec l’ID spécifié.

function getById(id: string): Source

Paramètres

id

string

Retours

getFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string)

Obtient l’état d’une fonctionnalité

function getFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string): object

Paramètres

feature

string | Shape | Feature<Geometry, any>

ID de la fonctionnalité

source

string | Source

ID de la source

sourceLayer

string

ID de la couche

Retours

object

getRenderedShapes(string | Source, Expression, string)

Retourne toutes les fonctionnalités de forme rendues dans une source qui correspondent à un filtre spécifié. Si la source est une source de vignette vectorielle, un nom de couche source doit être spécifié.

function getRenderedShapes(source: string | Source, filter?: Expression, sourceLayer?: string): Array<Feature<atlas.data.Geometry, any> | Shape>

Paramètres

source

string | Source

source à interroger

filter
Expression

un filtre pour limiter la requête

sourceLayer

string

couche dans laquelle les formes et les fonctionnalités sont mises en correspondance

Retours

Array<Feature<Geometry, any> | Shape>

getSources()

Récupère toutes les sources qui ont été ajoutées à la carte.

function getSources(): Source[]

Retours

Source[]

isSourceLoaded(string | Source)

Retourne une valeur booléenne indiquant si la source est chargée ou non.

function isSourceLoaded(source: string | Source): boolean

Paramètres

source

string | Source

ID d’une source ou d’un objet Source.

Retours

boolean

remove(string | Source | Array<string | Source>)

Supprime une ou plusieurs sources de la carte en spécifiant l’ID source ou en fournissant la source elle-même.

function remove(source: string | Source | Array<string | Source>)

Paramètres

source

string | Source | Array<string | Source>

removeFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string, string)

Supprime l’état ou une seule valeur de clé de l’état d’une fonctionnalité.

function removeFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string, key?: string)

Paramètres

feature

string | Shape | Feature<Geometry, any>

ID de la fonctionnalité

source

string | Source

ID de la source

sourceLayer

string

ID de la couche

key

string

clé dans l’état de la fonctionnalité à mettre à jour

setFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, object, string)

Définit l’état de la fonctionnalité en transmettant un objet de paire de valeurs de clé.

function setFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, state: object, sourceLayer?: string)

Paramètres

feature

string | Shape | Feature<Geometry, any>

ID de la fonctionnalité

source

string | Source

ID de la source

state

object

sourceLayer

string

ID de la couche