SourceManager interface
Um gestor para as origens do controlo de mapa. Exposto através da propriedade sources do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
Métodos
add(Source | Source[]) | Adiciona uma ou mais origens de dados ao mapa. O mapa tem de estar pronto para que uma origem possa ser adicionada. Utilize o método map.events.add com o tipo de evento "ready". |
clear() | Remove todas as origens do mapa. |
get |
Obtém uma origem com o ID especificado. |
get |
Obtém o estado de uma funcionalidade |
get |
Devolve todas as funcionalidades de formas compostas numa origem que correspondem a um filtro especificado. Se a origem for uma origem de mosaico de vetor, é necessário especificar um nome de camada de origem. |
get |
Obtém todas as origens que foram adicionadas ao mapa. |
is |
Devolve um valor booleano que indica se a origem está carregada ou não. |
remove(string | Source | Array<string | Source>) | Remove uma ou mais origens do mapa ao especificar o ID de origem ou ao fornecer a própria origem. |
remove |
Remove o estado ou um valor de chave única do estado de uma funcionalidade. |
set |
Define o estado da funcionalidade ao transmitir um objeto de par de valor chave. |
Detalhes de Método
add(Source | Source[])
Adiciona uma ou mais origens de dados ao mapa. O mapa tem de estar pronto para que uma origem possa ser adicionada. Utilize o método map.events.add com o tipo de evento "ready".
function add(source: Source | Source[])
Parâmetros
clear()
Remove todas as origens do mapa.
function clear()
getById(string)
Obtém uma origem com o ID especificado.
function getById(id: string): Source
Parâmetros
- id
-
string
Devoluções
getFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string)
Obtém o estado de uma funcionalidade
function getFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string): object
Parâmetros
- source
-
string | Source
o ID da origem
- sourceLayer
-
string
o ID da camada
Devoluções
object
getRenderedShapes(string | Source, Expression, string)
Devolve todas as funcionalidades de formas compostas numa origem que correspondem a um filtro especificado. Se a origem for uma origem de mosaico de vetor, é necessário especificar um nome de camada de origem.
function getRenderedShapes(source: string | Source, filter?: Expression, sourceLayer?: string): Array<Feature<atlas.data.Geometry, any> | Shape>
Parâmetros
- source
-
string | Source
origem a consultar
- filter
- Expression
um filtro para limitar a consulta
- sourceLayer
-
string
a camada em que as formas e as funcionalidades são correspondidas
Devoluções
getSources()
Obtém todas as origens que foram adicionadas ao mapa.
function getSources(): Source[]
Devoluções
Source[]
isSourceLoaded(string | Source)
Devolve um valor booleano que indica se a origem está carregada ou não.
function isSourceLoaded(source: string | Source): boolean
Parâmetros
- source
-
string | Source
O ID de uma origem ou de um objeto de Origem.
Devoluções
boolean
remove(string | Source | Array<string | Source>)
Remove uma ou mais origens do mapa ao especificar o ID de origem ou ao fornecer a própria origem.
function remove(source: string | Source | Array<string | Source>)
Parâmetros
removeFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string, string)
Remove o estado ou um valor de chave única do estado de uma funcionalidade.
function removeFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string, key?: string)
Parâmetros
- source
-
string | Source
o ID da origem
- sourceLayer
-
string
o ID da camada
- key
-
string
a chave no estado da funcionalidade a atualizar
setFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, object, string)
Define o estado da funcionalidade ao transmitir um objeto de par de valor chave.
function setFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, state: object, sourceLayer?: string)
Parâmetros
- source
-
string | Source
o ID da origem
- state
-
object
- sourceLayer
-
string
o ID da camada