SourceManager interface
Administrador de los orígenes del control de mapa. Expuesto a través de la propiedad sources del atlas. Clase de mapa. No se puede crear una instancia del usuario.
Métodos
add(Source | Source[]) | Agrega uno o varios orígenes de datos al mapa. El mapa debe estar listo para poder agregar un origen. Use el método map.events.add con el tipo de evento "ready". |
clear() | Quita todos los orígenes del mapa. |
get |
Recupera un origen con el identificador especificado. |
get |
Obtiene el estado de una característica. |
get |
Devuelve todas las características de formas representadas en un origen que coinciden con un filtro especificado. Si el origen es un origen de mosaico vectorial, debe especificarse un nombre de capa de origen. |
get |
Recupera todos los orígenes que se han agregado al mapa. |
is |
Devuelve un valor booleano que indica si el origen está cargado o no. |
remove(string | Source | Array<string | Source>) | Quita uno o varios orígenes del mapa especificando el identificador de origen o proporcionando el propio origen. |
remove |
Quita el estado o un único valor de clave del estado de una característica. |
set |
Establece el estado de la característica pasando un objeto de par clave-valor. |
Detalles del método
add(Source | Source[])
Agrega uno o varios orígenes de datos al mapa. El mapa debe estar listo para poder agregar un origen. Use el método map.events.add con el tipo de evento "ready".
function add(source: Source | Source[])
Parámetros
clear()
Quita todos los orígenes del mapa.
function clear()
getById(string)
Recupera un origen con el identificador especificado.
function getById(id: string): Source
Parámetros
- id
-
string
Devoluciones
getFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string)
Obtiene el estado de una característica.
function getFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string): object
Parámetros
- source
-
string | Source
el identificador del origen
- sourceLayer
-
string
el identificador de la capa
Devoluciones
object
getRenderedShapes(string | Source, Expression, string)
Devuelve todas las características de formas representadas en un origen que coinciden con un filtro especificado. Si el origen es un origen de mosaico vectorial, debe especificarse un nombre de capa de origen.
function getRenderedShapes(source: string | Source, filter?: Expression, sourceLayer?: string): Array<Feature<atlas.data.Geometry, any> | Shape>
Parámetros
- source
-
string | Source
origen que se va a consultar
- filter
- Expression
un filtro para limitar la consulta
- sourceLayer
-
string
la capa en la que se coinciden las formas y las características
Devoluciones
getSources()
Recupera todos los orígenes que se han agregado al mapa.
function getSources(): Source[]
Devoluciones
Source[]
isSourceLoaded(string | Source)
Devuelve un valor booleano que indica si el origen está cargado o no.
function isSourceLoaded(source: string | Source): boolean
Parámetros
- source
-
string | Source
Identificador de un origen o un objeto Source.
Devoluciones
boolean
remove(string | Source | Array<string | Source>)
Quita uno o varios orígenes del mapa especificando el identificador de origen o proporcionando el propio origen.
function remove(source: string | Source | Array<string | Source>)
Parámetros
removeFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string, string)
Quita el estado o un único valor de clave del estado de una característica.
function removeFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string, key?: string)
Parámetros
- source
-
string | Source
el identificador del origen
- sourceLayer
-
string
el identificador de la capa
- key
-
string
la clave en el estado de la característica que se va a actualizar
setFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, object, string)
Establece el estado de la característica pasando un objeto de par clave-valor.
function setFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, state: object, sourceLayer?: string)
Parámetros
- source
-
string | Source
el identificador del origen
- state
-
object
- sourceLayer
-
string
el identificador de la capa