DataSource class

Paquete:

azure-maps-control

Una clase de origen de datos que facilita la administración de los datos de formas que se mostrarán en el mapa. Se debe agregar un origen de datos a una capa antes de que sea visible en el mapa. La clase DataSource se puede usar con SymbolLayer, LineLayer, PolygonLayer, BubbleLayer y HeatMapLayer.

Extends

Source<DataSourceEvents>

Constructores

DataSource(string, DataSourceOptions)

Una clase de origen de datos que facilita la administración de los datos de formas que se mostrarán en el mapa. Se debe agregar un origen de datos a una capa antes de que sea visible en el mapa. La DataSource clase se puede usar con , SymbolLayerLineLayer, PolygonLayer, BubbleLayery HeatMapLayer.

Métodos

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)	Agrega formas al origen de datos. Los objetos GeoJSON se ajustarán dentro de una clase Shape para que sean más fáciles de administrar. Opcionalmente, especifique un índice para insertar la característica entre otras formas o características en las capas.
clear()	Quita todos los datos del origen de datos.
dispose()	Limpia los recursos que consume este objeto.
getClusterChildren(number)	Recupera los elementos secundarios del clúster especificado en el siguiente nivel de zoom. Puede tratarse de una combinación de formas y sub-clústeres. Los sub clústeres serán características con propiedades que coincidan con ClusteredProperties.
getClusterExpansionZoom(number)	Calcula un nivel de zoom en el que el clúster empezará a expandirse o separarse.
getClusterLeaves(number, number, number)	Recupera las formas que están dentro del clúster.
getOptions()	Obtiene las opciones usadas por el origen de datos.
getShapeById(string | number)	Recupera una forma con el identificador especificado. Si no hay ninguna forma con el identificador especificado en el origen de datos, se devolverá null.
getShapes()	Devuelve todas las formas que se encuentran en dataSource.
importDataFromUrl(string)	Descarga un documento GeoJSON e importa sus datos en el origen de datos. El documento GeoJSON debe estar en el mismo dominio o accesible mediante CORS.
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	Quita una o varias formas del origen de datos. Si se pasa una cadena, se supone que es un identificador. Si se pasa un número, quita la forma en ese índice.
removeById(number | string | Array<number | string>)	Quita una o varias formas del origen de datos en función de su identificador.
setOptions(DataSourceOptions)	Establece las opciones del origen de datos. El origen de datos conservará sus valores actuales para cualquier opción que no se especifique en las opciones proporcionadas.
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	Sobrescribe todas las formas del origen de datos con la nueva matriz de formas.
toJson()	Devuelve un FeatureCollection de GeoJSON que contiene todos los datos de formas que se encuentra en el origen de datos.

Métodos heredados

getId()

Obtiene el identificador del origen de datos.

Detalles del constructor

DataSource(string, DataSourceOptions)

Una clase de origen de datos que facilita la administración de los datos de formas que se mostrarán en el mapa. Se debe agregar un origen de datos a una capa antes de que sea visible en el mapa. La DataSource clase se puede usar con , SymbolLayerLineLayer, PolygonLayer, BubbleLayery HeatMapLayer.

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

Parámetros

id

string

un identificador único que el usuario asigna al origen de datos. Si no se especifica, al origen de datos se le asignará automáticamente un identificador.

options

DataSourceOptions

las opciones del origen de datos.

Detalles del método

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

Agrega formas al origen de datos. Los objetos GeoJSON se ajustarán dentro de una clase Shape para que sean más fáciles de administrar. Opcionalmente, especifique un índice para insertar la característica entre otras formas o características en las capas.

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)

Parámetros

data

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

index

number

clear()

Quita todos los datos del origen de datos.

function clear()

dispose()

Limpia los recursos que consume este objeto.

function dispose()

getClusterChildren(number)

Recupera los elementos secundarios del clúster especificado en el siguiente nivel de zoom. Puede tratarse de una combinación de formas y sub-clústeres. Los sub clústeres serán características con propiedades que coincidan con ClusteredProperties.

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

Parámetros

clusterId

number

Devoluciones

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

getClusterExpansionZoom(number)

Calcula un nivel de zoom en el que el clúster empezará a expandirse o separarse.

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

Parámetros

clusterId

number

Devoluciones

Promise<number>

getClusterLeaves(number, number, number)

Recupera las formas que están dentro del clúster.

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

Parámetros

clusterId

number

limit

number

Número máximo de características que se van a devolver. Establezca en Infinity para devolver todas las formas.

offset

number

Número de formas que se van a omitir. Permite paginar las formas del clúster.

Devoluciones

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

getOptions()

Obtiene las opciones usadas por el origen de datos.

function getOptions(): DataSourceOptions

Devoluciones

DataSourceOptions

getShapeById(string | number)

Recupera una forma con el identificador especificado. Si no hay ninguna forma con el identificador especificado en el origen de datos, se devolverá null.

function getShapeById(id: string | number): Shape

Parámetros

id

string | number

Identificador de la forma que se va a devolver.

Devoluciones

Shape

getShapes()

Devuelve todas las formas que se encuentran en dataSource.

function getShapes(): Shape[]

Devoluciones

Shape[]

importDataFromUrl(string)

Descarga un documento GeoJSON e importa sus datos en el origen de datos. El documento GeoJSON debe estar en el mismo dominio o accesible mediante CORS.

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

Parámetros

url

string

Devoluciones

Promise<void>

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

Quita una o varias formas del origen de datos. Si se pasa una cadena, se supone que es un identificador. Si se pasa un número, quita la forma en ese índice.

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

Parámetros

shape

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

Las formas, los identificadores de forma o las características que se van a quitar

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

Quita una o varias formas del origen de datos en función de su identificador.

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

Parámetros

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Establece las opciones del origen de datos. El origen de datos conservará sus valores actuales para cualquier opción que no se especifique en las opciones proporcionadas.

function setOptions(options: DataSourceOptions)

Parámetros

options

DataSourceOptions

DataSourceOptions que se va a establecer

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

Sobrescribe todas las formas del origen de datos con la nueva matriz de formas.

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

Parámetros

shape

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

las nuevas formas que se van a actualizar

toJson()

Devuelve un FeatureCollection de GeoJSON que contiene todos los datos de formas que se encuentra en el origen de datos.

function toJson(): FeatureCollection

Devoluciones

FeatureCollection

Detalles de los métodos heredados

getId()

Obtiene el identificador del origen de datos.

function getId(): string

Devoluciones

string

Heredado deSource.getId