Landmark

The following table describes the properties of a landmark object. Properties enclosed in brackets are optional in method calls.

Table: Landmark object properties

Property

Description

Type

Value

[LandmarkName]

Specifies the name of the landmark. The name need not be unique within the database.

string

Maximum length 255 characters

[id]

Specifies the unique ID of the landmark. This ID is unique only within the database to which the landmark belongs.

The ID is generated automatically when the landmark is added to the database.

Note: This property must not be specified when a new landmark is added to a database.

string

 

[CategoryInfo]

Specifies the IDs of the landmark categories to which the landmark belongs.

array of strings

 

[LandmarkDesc]

Contains a text description for the landmark.

string

Maximum length 4095 characters

[LandmarkPosition]

Specifies the location of the landmark, expressed as a set of geographical coordinates.

object

See Table: LandmarkPosition object properties.

[CoverageRadius]

Specifies the coverage radius in meters from the coordinates defined in LandmarkPosition. This indicates the physical area covered by the landmark, for example a city or town.

The landmark can be thought of as a circular area with a center expressed as LandmarkPosition and a radius expressed as CoverageRadius.

number

 

[IconFile]

Specifies the full path and file name of the icon file that contains the icon associated with the landmark.

Note: Only mbm files are supported.

string

Maximum length 255 characters

[IconIndex]

Specifies the index of the icon within the icon file.

number

 

[IconMaskIndex]

Specifies the index of the icon mask within the icon file.

number

 

[LandmarkFields]

Specifies additional location information about the landmark.

object

See Table: LandmarkFields object properties.

Table: LandmarkPosition object properties

Property

Description

Type

Value

LandmarkPosition.Latitude

Specifies the latitude of the landmark location in WGS 84 datum format. This must be specified in decimal degrees.

The normal value range is [-90.00, +90.00]. Out-of-range values are normalized to the range as per standards. Negative degrees indicate west latitude, while positive degrees indicate east latitude.

number

[-90.00, +90.00]

LandmarkPosition.Longitude

Specifies the longitude of the landmark location in WGS 84 datum format. This must be specified in decimal degrees.

The normal value range is [-180.00, +180.00]. Out-of-range values are normalized to the range as per standards. Negative degrees indicate south longitude, while positive degrees indicate north longitude.

number

[-180.00, +180.00]

[LandmarkPosition.Altitude]

Specifies the altitude of the landmark location in WGS 84 datum format. The altitude is in meters.

number

 

[LandmarkPosition.HAccuracy]

Specifies the error estimate for horizontal accuracy to [Latitude, Longitude, and Altitude] in meters.

number

 

[LandmarkPosition.VAccuracy]

Specifies the error estimate for vertical accuracy to [Latitude, Longitude, and Altitude] in meters.

number

 
Table: LandmarkFields object properties

Property

Description

Type

Value

[LandmarkFields.Street]

Specifies the street name of the landmark.

string

Maximum length 255 characters

[LandmarkFields.BuildingName]

Specifies the building name of the landmark.

string

Maximum length 255 characters

[LandmarkFields.District]

Specifies the district to which the landmark belongs.

string

Maximum length 255 characters

[LandmarkFields.City]

Specifies the city to which the landmark belongs.

string

Maximum length 255 characters

[LandmarkFields.AreaCode]

Specifies the area code of the landmark.

string

Maximum length 255 characters

[LandmarkFields.Telephone]

Specifies the contact number of the landmark.

string

Maximum length 255 characters

[LandmarkFields.Country]

Specifies the country to which the landmark belongs.

string

Maximum length 255 characters