SpatialDataSet class

Package:

azure-maps-spatial-io

A data object that contains a set of features and/or kml ground overlays. This is an extension of the FeatureCollection class thus allowing it to easily be added to a data source.

Properties

bbox	Bounding box of all the data in the data set.
features	GeoJSON features within the data set.
groundOverlays	An array of KML GroundOverlays.
icons	A set of icon URL's. Key = icon name, Value = URL.
properties	Property information provided at the document level of a spatial data set.
stats	Statistics about the content and processing time of a spatial data set.
type

Methods

computeStats(SpatialDataSet)	Calculates the stats for a spatial data set.
enrich(SpatialDataSet)	Enriches a data set by calculating its bounds, stats, and generating summary information if not already available.
getBounds(SpatialDataSet)	Retrieves the bounding box of the data set. If not set on the data set, will calculate it.
merge(SpatialDataSet, SpatialDataSet)	Merges one spatial data set into the other.

Property Details

bbox

Bounding box of all the data in the data set.

bbox: azmaps.data.BoundingBox

Property Value

azmaps.data.BoundingBox

features

GeoJSON features within the data set.

features: Array<azmaps.data.Feature<azmaps.data.Geometry, SimpleStyleProperties>>

Property Value

Array<azmaps.data.Feature<azmaps.data.Geometry, SimpleStyleProperties>>

groundOverlays

An array of KML GroundOverlays.

groundOverlays: Array<azmaps.layer.ImageLayer | OgcMapLayer>

Property Value

Array<azmaps.layer.ImageLayer | OgcMapLayer>

icons

A set of icon URL's. Key = icon name, Value = URL.

icons: Record<string, string>

Property Value

Record<string, string>

properties

Property information provided at the document level of a spatial data set.

properties: any

Property Value

any

stats

Statistics about the content and processing time of a spatial data set.

stats: SpatialDataSetStats

Property Value

SpatialDataSetStats

type

type: "FeatureCollection" = "FeatureCollection"

Property Value

"FeatureCollection"

Method Details

computeStats(SpatialDataSet)

Calculates the stats for a spatial data set.

static function computeStats(data: SpatialDataSet)

Parameters

data

SpatialDataSet

The data set to calculate the stats for.

enrich(SpatialDataSet)

Enriches a data set by calculating its bounds, stats, and generating summary information if not already available.

static function enrich(data: SpatialDataSet)

Parameters

data

SpatialDataSet

The data set to enrich.

getBounds(SpatialDataSet)

Retrieves the bounding box of the data set. If not set on the data set, will calculate it.

static function getBounds(data: SpatialDataSet): azmaps.data.BoundingBox

Parameters

data

SpatialDataSet

The data set to calculate the bounding box for.

Returns

azmaps.data.BoundingBox

merge(SpatialDataSet, SpatialDataSet)

Merges one spatial data set into the other.

static function merge(a: SpatialDataSet, b: SpatialDataSet)

Parameters

a

SpatialDataSet

The primary data set to merge the data into.

b

SpatialDataSet

The secondary data set to merge into the primary data set.