Class: Landmark

new Landmark()

Source: gemapi.js, line 2324

Methods

getAddress() → {string}

Get formated text of Address.

Source: gemapi.js, line 2399

Returns:

Type:: string

getAddressField(addressField) → {string}

Get Address field content by name

Parameters:

Name	Type	Description
`addressField`	gem.core.EAddressField	field type

Source: gemapi.js, line 2407

Returns:

Type:: string

getBoundingBox() → {gem.core.BoundingBox}

get bounding box for the geographic area.

Source: gemapi.js, line 2371

Returns:

Type:: gem.core.BoundingBox

getContactInfo() → {string}

Get formated text contact info

Source: gemapi.js, line 2378

Returns:

Type:: string

getCoordinates() → {gem.core.Coordinates}

Gets the centroid coordinates.

Source: gemapi.js, line 2358

Returns:

On return the parameter is set to the actual value. The coordinates may be invalid. This aspect needs to be checked by the API user.

Type:: gem.core.Coordinates

getCountryFlagImage(bitmapContainer) → {boolean}

Get the country flag for the landmark.

Parameters:

Name	Type	Description
`bitmapContainer`	gem.core.BitmapContainer	output image

Source: gemapi.js, line 2489

Returns:

true if the flag was found, false otherwise

Type:: boolean

getCountryIsoCode() → {string}

Get Country ISO code

Source: gemapi.js, line 2481

Returns:

Type:: string

getDescription() → {string}

Get the description of this landmark.

Source: gemapi.js, line 2392

Returns:

Type:: string

getExtraInfo() → {string}

Get formated text extra info,each info separated by ','

Source: gemapi.js, line 2385

Returns:

Type:: string

getFormatedDetails() → {string}

Get formatted details

Source: gemapi.js, line 2458

Returns:

Type:: string

getFormatedName() → {string}

Get formatted name

Source: gemapi.js, line 2451

Returns:

Type:: string

getImage(bitmapContainer)

Parameters:

Name	Type	Description
`bitmapContainer`	gem.core.BitmapContainer	output for Landmark image

Source: gemapi.js, line 2421

getLandmarkId() → {number}

Returns the landmark ID.

Source: gemapi.js, line 2364

Returns:

ID >= 0 Success.

Type:: number

getName() → {string}

Get the name of this landmark.

Source: gemapi.js, line 2351

Returns:

On return the parameter is set to the field value. It may be empty.

Type:: string

getUrl() → {string}

Get page url or booking url or Wikipedia page

Source: gemapi.js, line 2414

Returns:

url

Type:: string

getValueForExtraInfo(extrakey) → {string}

Get value for extra info key string

Parameters:

Name	Type	Description
`extrakey`	string	key string

Source: gemapi.js, line 2466

Returns:

Type:: string

hasWikipediaInfo(externalInfo) → {boolean}

Returns if landmark has wikipedia info

Parameters:

Name	Type	Description
`externalInfo`	gem.core.ExternalInfo	object to handle external info

Source: gemapi.js, line 2474

Returns:

Type:: boolean

requestWikipediaInfo(callbackfunction, externalInfo) → {gem.core.WikiDescriptionListener}

Request wikipedia info. asnyc function

Parameters:

Name	Type	Description
`callbackfunction`	wikipediainfocallback
`externalInfo`	gem.core.ExternalInfo	object to handle external info

Source: gemapi.js, line 2441

Returns:

wikipedia listener object. Please use delete method on this object, after wikipedia

Type:: gem.core.WikiDescriptionListener

setCoordinates(coordinates)

Sets the coordinates for the landmark.

Parameters:

Name	Type	Description
`coordinates`	gem.core.Coordinates	The new coordinates for the landmark.

Source: gemapi.js, line 2513

setDescription(description)

Sets the description for the landmark.

Parameters:

Name	Type	Description
`description`	string	The new description for the landmark.

Source: gemapi.js, line 2529

setImage(usableIconId)

Sets the image for the landmark using an icon ID.

Parameters:

Name	Type	Description
`usableIconId`	number	The ID of the icon to use as the image.

Source: gemapi.js, line 2496

setImageByString(imageString)

Sets the image for the landmark using an image string.

Parameters:

Name	Type	Description
`imageString`	string	The image string to use as the image.

Source: gemapi.js, line 2537

setName(name)

Sets the name for the landmark.

Parameters:

Name	Type	Description
`name`	string	The new name for the landmark.

Source: gemapi.js, line 2521

setWaypointTrackData(pathData)

Sets the waypoint track data for the landmark.

Parameters:

Name	Type	Description
`pathData`	gem.d3Scene.Path	The new waypoint track data for the landmark.

Source: gemapi.js, line 2545