DataSource class

Pacote:

azure-maps-control

Uma classe de fonte de dados que facilita o gerenciamento de dados de formas que serão exibidos no mapa. Uma fonte de dados deve ser adicionada a uma camada antes de ficar visível no mapa. A classe DataSource pode ser usada com SymbolLayer, LineLayer, PolygonLayer, BubbleLayer e HeatMapLayer.

Extends

Source<DataSourceEvents>

Construtores

DataSource(string, DataSourceOptions)

Uma classe de fonte de dados que facilita o gerenciamento de dados de formas que serão exibidos no mapa. Uma fonte de dados deve ser adicionada a uma camada antes de ficar visível no mapa. A DataSource classe pode ser usada com , SymbolLayerLineLayer, PolygonLayer, BubbleLayere 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)	Adiciona formas à fonte de dados. Os objetos GeoJSON serão encapsulados em uma classe Shape para facilitar o gerenciamento. Opcionalmente, especifique um índice para inserir o recurso entre outras formas/recursos nas camadas.
clear()	Remove todos os dados na fonte de dados.
dispose()	Limpa todos os recursos que este objeto está consumindo.
getClusterChildren(number)	Recupera os filhos do cluster fornecido no próximo nível de zoom. Isso pode ser uma combinação de formas e sub clusters. Os sub clusters serão recursos com propriedades correspondentes a ClusteredProperties.
getClusterExpansionZoom(number)	Calcula um nível de zoom no qual o cluster começará a se expandir ou separar.
getClusterLeaves(number, number, number)	Recupera formas que estão dentro do cluster.
getOptions()	Obtém as opções usadas pela fonte de dados.
getShapeById(string | number)	Recupera uma forma com a ID especificada. Se nenhuma forma com a ID especificada estiver contida na fonte de dados, nulo será retornado.
getShapes()	Retorna todas as formas que estão no DataSource.
importDataFromUrl(string)	Baixa um documento GeoJSON e importa seus dados para a fonte de dados. O documento GeoJSON deve estar no mesmo domínio ou acessível usando CORS.
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	Remove uma ou mais formas da fonte de dados. Se uma cadeia de caracteres for passada, presume-se que seja uma ID. Se um número for passado, removerá a forma nesse índice.
removeById(number | string | Array<number | string>)	Remove uma ou mais formas da fonte de dados com base em sua ID.
setOptions(DataSourceOptions)	Define as opções de fonte de dados. A fonte de dados manterá seus valores atuais para qualquer opção não especificada nas opções fornecidas.
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	Substitui todas as formas na fonte de dados com a nova matriz de formas.
toJson()	Retorna um FeatureCollection GeoJSON que contém todos os dados de forma que estão na fonte de dados.

Métodos herdados

getId()

Obtém a ID da fonte de dados

Detalhes do construtor

DataSource(string, DataSourceOptions)

Uma classe de fonte de dados que facilita o gerenciamento de dados de formas que serão exibidos no mapa. Uma fonte de dados deve ser adicionada a uma camada antes de ficar visível no mapa. A DataSource classe pode ser usada com , SymbolLayerLineLayer, PolygonLayer, BubbleLayere HeatMapLayer.

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

Parâmetros

id

string

uma ID exclusiva que o usuário atribui à fonte de dados. Se isso não for especificado, a fonte de dados receberá automaticamente uma ID.

options

DataSourceOptions

as opções para a fonte de dados.

Detalhes do 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)

Adiciona formas à fonte de dados. Os objetos GeoJSON serão encapsulados em uma classe Shape para facilitar o gerenciamento. Opcionalmente, especifique um índice para inserir o recurso entre outras formas/recursos nas camadas.

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()

Remove todos os dados na fonte de dados.

function clear()

dispose()

Limpa todos os recursos que este objeto está consumindo.

function dispose()

getClusterChildren(number)

Recupera os filhos do cluster fornecido no próximo nível de zoom. Isso pode ser uma combinação de formas e sub clusters. Os sub clusters serão recursos com propriedades correspondentes a ClusteredProperties.

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

Parâmetros

clusterId

number

Retornos

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

getClusterExpansionZoom(number)

Calcula um nível de zoom no qual o cluster começará a se expandir ou separar.

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

Parâmetros

clusterId

number

Retornos

Promise<number>

getClusterLeaves(number, number, number)

Recupera formas que estão dentro do cluster.

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

Parâmetros

clusterId

number

limit

number

O número máximo de recursos a serem retornados. Defina como Infinito para retornar todas as formas.

offset

number

O número de formas a serem ignoradas. Permite que você faça a página pelas formas no cluster.

Retornos

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

getOptions()

Obtém as opções usadas pela fonte de dados.

function getOptions(): DataSourceOptions

Retornos

DataSourceOptions

getShapeById(string | number)

Recupera uma forma com a ID especificada. Se nenhuma forma com a ID especificada estiver contida na fonte de dados, nulo será retornado.

function getShapeById(id: string | number): Shape

Parâmetros

id

string | number

A ID da forma a ser retornada.

Retornos

Shape

getShapes()

Retorna todas as formas que estão no DataSource.

function getShapes(): Shape[]

Retornos

Shape[]

importDataFromUrl(string)

Baixa um documento GeoJSON e importa seus dados para a fonte de dados. O documento GeoJSON deve estar no mesmo domínio ou acessível usando CORS.

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

Parâmetros

url

string

Retornos

Promise<void>

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

Remove uma ou mais formas da fonte de dados. Se uma cadeia de caracteres for passada, presume-se que seja uma ID. Se um número for passado, removerá a forma nesse í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>>

As formas, as IDs da forma ou os recursos a serem removidos

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

Remove uma ou mais formas da fonte de dados com base em sua ID.

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

Parâmetros

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Define as opções de fonte de dados. A fonte de dados manterá seus valores atuais para qualquer opção não especificada nas opções fornecidas.

function setOptions(options: DataSourceOptions)

Parâmetros

options

DataSourceOptions

o DataSourceOptions a ser definido

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

Substitui todas as formas na fonte de dados com a nova 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>

as novas formas a serem atualizadas

toJson()

Retorna um FeatureCollection GeoJSON que contém todos os dados de forma que estão na fonte de dados.

function toJson(): FeatureCollection

Retornos

FeatureCollection

Detalhes do método herdado

getId()

Obtém a ID da fonte de dados

function getId(): string

Retornos

string

Herdado deSource.getId