SourceManager interface

Um gerente para as fontes do controle de mapa. Exposto por meio da propriedade sources do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.

Métodos

add(Source | Source[])

Adiciona uma ou mais fontes de dados ao mapa. O mapa deve estar pronto antes que uma origem possa ser adicionada. Use o método map.events.add com o tipo de evento 'ready'.

clear()

Remove todas as fontes do mapa.

getById(string)

Recupera uma origem com a ID especificada.

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

Obtém o estado de um recurso

getRenderedShapes(string | Source, Expression, string)

Retorna todos os recursos de forma renderizados em uma origem que correspondem a um filtro especificado. Se a origem for uma fonte de bloco de vetor, um nome de camada de origem precisará ser especificado.

getSources()

Recupera todas as fontes que foram adicionadas ao mapa.

isSourceLoaded(string | Source)

Retorna um booliano que indica se a origem está carregada ou não.

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

Remove uma ou mais fontes do mapa especificando a ID de origem ou fornecendo a própria origem.

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

Remove o estado ou um único valor de chave do estado de um recurso.

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

Define o estado do recurso passando um objeto de par de valor de chave.

Detalhes do método

add(Source | Source[])

Adiciona uma ou mais fontes de dados ao mapa. O mapa deve estar pronto antes que uma origem possa ser adicionada. Use o método map.events.add com o tipo de evento 'ready'.

function add(source: Source | Source[])

Parâmetros

source

Source | Source[]

clear()

Remove todas as fontes do mapa.

function clear()

getById(string)

Recupera uma origem com a ID especificada.

function getById(id: string): Source

Parâmetros

id

string

Retornos

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

Obtém o estado de um recurso

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

Parâmetros

feature

string | Shape | Feature<Geometry, any>

a ID do recurso

source

string | Source

a ID da origem

sourceLayer

string

a ID da camada

Retornos

object

getRenderedShapes(string | Source, Expression, string)

Retorna todos os recursos de forma renderizados em uma origem que correspondem a um filtro especificado. Se a origem for uma fonte de bloco de vetor, um nome de camada de origem precisará ser especificado.

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

Parâmetros

source

string | Source

fonte a ser consultada

filter
Expression

um filtro para limitar a consulta

sourceLayer

string

a camada em que as formas e os recursos são correspondidos

Retornos

Array<Feature<Geometry, any> | Shape>

getSources()

Recupera todas as fontes que foram adicionadas ao mapa.

function getSources(): Source[]

Retornos

Source[]

isSourceLoaded(string | Source)

Retorna um booliano que indica se a origem está carregada ou não.

function isSourceLoaded(source: string | Source): boolean

Parâmetros

source

string | Source

A ID de uma origem ou de um objeto Source.

Retornos

boolean

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

Remove uma ou mais fontes do mapa especificando a ID de origem ou fornecendo a própria origem.

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

Parâmetros

source

string | Source | Array<string | Source>

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

Remove o estado ou um único valor de chave do estado de um recurso.

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

Parâmetros

feature

string | Shape | Feature<Geometry, any>

a ID do recurso

source

string | Source

a ID da origem

sourceLayer

string

a ID da camada

key

string

a chave no estado do recurso a ser atualizado

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

Define o estado do recurso passando um objeto de par de valor de chave.

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

Parâmetros

feature

string | Shape | Feature<Geometry, any>

a ID do recurso

source

string | Source

a ID da origem

state

object

sourceLayer

string

a ID da camada