BoundaryOutput interface

  • Reference
Package:
@azure-rest/maps-search

GeoJSON GeocodingFeature object that describe the boundaries of a geographical area. Geometry of the feature is described with GeoJSON GeometryCollection.

Please note, the service typically returns a GeometryCollection with Polygon or MultiPolygon sub-types.

Extends

GeoJsonFeatureOutputParent,BoundaryPropertiesOutput

Properties

type

Inherited Properties

bbox

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.
copyright

The copyright string.
copyrightURL

A URL that lists many of the data providers for Azure Maps and their related copyright information.
featureType

The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.
geometriesCopyright

A collection of copyright information for each geometry of the Boundary object in the same order they appear.
geometry

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.
id

Identifier for the feature.
name

The name associated with the geographical area.
properties

Properties can contain any additional metadata about the Feature. Value can be any JSON object or a JSON null value

Property Details

type 

type: "Boundary"

Property Value

"Boundary"

Inherited Property Details

bbox

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

bbox?: number[]

Property Value

number[]

Inherited From GeoJsonFeatureOutputParent.bbox

The copyright string.

copyright?: string

Property Value

string

Inherited From BoundaryPropertiesOutput.copyright

copyrightURL

A URL that lists many of the data providers for Azure Maps and their related copyright information.

copyrightURL?: string

Property Value

string

Inherited From BoundaryPropertiesOutput.copyrightURL

featureType

The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.

featureType?: string

Property Value

string

Inherited From GeoJsonFeatureOutputParent.featureType

geometriesCopyright

A collection of copyright information for each geometry of the Boundary object in the same order they appear.

geometriesCopyright?: GeometryCopyrightOutput[]

Property Value

GeometryCopyrightOutput[]

Inherited From BoundaryPropertiesOutput.geometriesCopyright

geometry

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.

geometry: GeoJsonGeometryOutput

Property Value

GeoJsonGeometryOutput

Inherited From GeoJsonFeatureOutputParent.geometry

id

Identifier for the feature.

id?: string

Property Value

string

Inherited From GeoJsonFeatureOutputParent.id

name

The name associated with the geographical area.

name?: string

Property Value

string

Inherited From BoundaryPropertiesOutput.name

properties

Properties can contain any additional metadata about the Feature. Value can be any JSON object or a JSON null value

properties?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited From GeoJsonFeatureOutputParent.properties