Class DetailedMapData<MVFData>`Abstract`

Type Parameters

MVFData extends MVFFeature<Geometry, { details?: Details; externalId?: string; id: string }>

Hierarchy (View Summary)

default
- DetailedMapData

Index

Properties

Accessors

description externalId geoJSON geoJSONBoundingBox icon images links locationProfiles name

Properties

`Readonly`id

id: string

The identity of the map data.

Accessors

description

get description(): string
Gets the description of the map feature.

Returns string
The description of the map feature, or an empty string if no description exists.

externalId

get externalId(): string
Gets the external identifier of the map feature.

Returns string
The external ID of the map feature, or an empty string if no external ID exists.

geoJSON

get geoJSON(): Feature<Polygon | MultiPolygon | Point | LineString, null>
Returns Feature<Polygon | MultiPolygon | Point | LineString, null>
Inherited from BaseMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): BBox | undefined
Gets the bounding box of the geoJSON geometry.

Returns BBox | undefined
The bounding box of the geoJSON geometry

Inherited from BaseMapData.geoJSONBoundingBox

icon

get icon(): ImageMetaData | undefined
Gets the URL of the icon for the map feature.

Returns ImageMetaData | undefined
The icon of the map feature.

images

get images(): ImageMetaData[]
Gets the array of ImageMetaDatas associated with this map feature.

Returns ImageMetaData[]
An array of Image objects, or an empty array if no images exist.

links

get links(): Hyperlink[]
Gets the array of Hyperlinks associated with this map feature.

Returns Hyperlink[]
An array of Hyperlink objects, or an empty array if no links exist.

locationProfiles

get locationProfiles(): LocationProfile[]
Gets the LocationProfiles attached to this feature.

Returns LocationProfile[]
An array of location profiles.

Remarks
Data Source: Maker - This property is only populated when using Maker credentials (API keys starting with mik_). Returns an empty array when using CMS/Enterprise credentials. For Enterprise data, use Space.enterpriseLocations or MapObject.enterpriseLocations instead.

name

get name(): string
Gets the name of the map feature.

Returns string
The name of the map feature.