DataSource class

Pacote:

azure-maps-control

Uma classe de origem de dados que facilita a gestão de dados de formas que serão apresentados no mapa. Uma origem de dados tem de ser adicionada a uma camada antes de ser visível no mapa. A classe DataSource pode ser utilizada com o SymbolLayer, LineLayer, PolygonLayer, BubbleLayer e HeatMapLayer.

Extends

Source<DataSourceEvents>

Construtores

DataSource(string, DataSourceOptions)

Uma classe de origem de dados que facilita a gestão de dados de formas que serão apresentados no mapa. Uma origem de dados tem de ser adicionada a uma camada antes de ser visível no mapa. A DataSource classe pode ser utilizada com , SymbolLayer, LineLayer, 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 à origem de dados. Os objetos GeoJSON serão moldados numa classe Forma para facilitar a gestão dos mesmos. Opcionalmente, especifique um índice para inserir a funcionalidade entre outras formas/funcionalidades nas camadas.
clear()	Remove todos os dados na origem de dados.
dispose()	Limpa todos os recursos que este objeto está a consumir.
getClusterChildren(number)	Obtém os subordinados do cluster especificado no próximo nível de zoom. Esta pode ser uma combinação de formas e subgrupos. Os subgrupos serão funcionalidades com propriedades correspondentes a ClusteredProperties.
getClusterExpansionZoom(number)	Calcula um nível de zoom no qual o cluster começará a expandir-se ou a separar-se.
getClusterLeaves(number, number, number)	Obtém formas que estão dentro do cluster.
getOptions()	Obtém as opções utilizadas pela origem de dados.
getShapeById(string | number)	Obtém uma forma com o ID especificado. Se nenhuma forma com o ID especificado estiver contida na origem de dados, será devolvido nulo.
getShapes()	Devolve todas as formas que estão no DataSource.
importDataFromUrl(string)	Transfere um documento GeoJSON e importa os respetivos dados para a origem de dados. O documento GeoJSON tem de estar no mesmo domínio ou acessível através do 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 origem de dados. Se for transmitida uma cadeia, assume-se que é um ID. Se for transmitido um número, remove a forma nesse índice.
removeById(number | string | Array<number | string>)	Remove uma ou mais formas da origem de dados com base no respetivo ID.
setOptions(DataSourceOptions)	Define as opções de origem de dados. A origem de dados irá manter os valores atuais de 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 origem de dados com a nova matriz de formas.
toJson()	Devolve uma Funcionalidade GeoJSONCollection que contém todos os dados da forma que estão na origem de dados.

Métodos Herdados

getId()

Obtém o ID da origem de dados

Detalhes do Construtor

DataSource(string, DataSourceOptions)

Uma classe de origem de dados que facilita a gestão de dados de formas que serão apresentados no mapa. Uma origem de dados tem de ser adicionada a uma camada antes de ser visível no mapa. A DataSource classe pode ser utilizada com , SymbolLayer, LineLayer, PolygonLayer, BubbleLayere HeatMapLayer.

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

Parâmetros

id

string

um ID exclusivo que o utilizador atribui à origem de dados. Se esta opção não for especificada, será automaticamente atribuído um ID à origem de dados.

options

DataSourceOptions

as opções para a origem de dados.

Detalhes de 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 à origem de dados. Os objetos GeoJSON serão moldados numa classe Forma para facilitar a gestão dos mesmos. Opcionalmente, especifique um índice para inserir a funcionalidade entre outras formas/funcionalidades 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 origem de dados.

function clear()

dispose()

Limpa todos os recursos que este objeto está a consumir.

function dispose()

getClusterChildren(number)

Obtém os subordinados do cluster especificado no próximo nível de zoom. Esta pode ser uma combinação de formas e subgrupos. Os subgrupos serão funcionalidades com propriedades correspondentes a ClusteredProperties.

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

Parâmetros

clusterId

number

Devoluções

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

getClusterExpansionZoom(number)

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

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

Parâmetros

clusterId

number

Devoluções

Promise<number>

getClusterLeaves(number, number, number)

Obtém 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 funcionalidades a devolver. Defina como Infinito para devolver todas as formas.

offset

number

O número de formas a ignorar. Permite-lhe analisar as formas no cluster.

Devoluções

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

getOptions()

Obtém as opções utilizadas pela origem de dados.

function getOptions(): DataSourceOptions

Devoluções

DataSourceOptions

getShapeById(string | number)

Obtém uma forma com o ID especificado. Se nenhuma forma com o ID especificado estiver contida na origem de dados, será devolvido nulo.

function getShapeById(id: string | number): Shape

Parâmetros

id

string | number

O ID da forma a devolver.

Devoluções

Shape

getShapes()

Devolve todas as formas que estão no DataSource.

function getShapes(): Shape[]

Devoluções

Shape[]

importDataFromUrl(string)

Transfere um documento GeoJSON e importa os respetivos dados para a origem de dados. O documento GeoJSON tem de estar no mesmo domínio ou acessível através do CORS.

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

Parâmetros

url

string

Devoluções

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 origem de dados. Se for transmitida uma cadeia, assume-se que é um ID. Se for transmitido um número, remove 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, os ID(s) da forma ou as funcionalidades a remover

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

Remove uma ou mais formas da origem de dados com base no respetivo ID.

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

Parâmetros

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Define as opções de origem de dados. A origem de dados irá manter os valores atuais de qualquer opção não especificada nas opções fornecidas.

function setOptions(options: DataSourceOptions)

Parâmetros

options

DataSourceOptions

dataSourceOptions a definir

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

Substitui todas as formas na origem 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 atualizar

toJson()

Devolve uma Funcionalidade GeoJSONCollection que contém todos os dados da forma que estão na origem de dados.

function toJson(): FeatureCollection

Devoluções

FeatureCollection

Detalhes do Método Herdado

getId()

Obtém o ID da origem de dados

function getId(): string

Devoluções

string

Herdado deSource.getId