<Map>.DisplayPosition (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Map>.DisplayPosition (Function)

In french: <Carte>.AffichePosition

Centers the map displayed in a Map control on a geographical position or on a specific location. An animation is automatically performed.

At the end of the animation, the event "Whenever changing position" of the Map control will be run. This event will not be run if the positioning on the map is canceled by the user before the end of the animation.

Remark: This function is available in the Android emulator and in the Android simulator.

Versions 18 and later

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available for iPhone/iPad applications.

Versions 20 and later

This function is now available for WINDEV applications in Windows.

This function is now available in Browser code.

This function is now available for WEBDEV sites in Windows and Linux.

This function is now available for PHP sites.

New in version 20

This function is now available for WINDEV applications in Windows.

This function is now available in Browser code.

This function is now available for WEBDEV sites in Windows and Linux.

This function is now available for PHP sites.

This function is now available for WINDEV applications in Windows.

This function is now available in Browser code.

This function is now available for WEBDEV sites in Windows and Linux.

This function is now available for PHP sites.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// Centers the map displayed by the "MAP_Position" control on a geographical position
MyPosition is geoPosition
MAP_Position.DisplayPosition(MyPosition)

// Equivalent syntax (without animation): MAP_Position = MyPosition

// Centers the map displayed by the "MAP_Position" control on a city identified by its name
MAP_Position.DisplayPosition("Montpellier, France")

// Centers the map displayed by the "MAP_Position" control on a monument identified by its name
MAP_Position.DisplayPosition("Eiffel Tower")

Syntax

Displaying a geographical location Hide the details

<Result> = <Map control>.DisplayPosition(<Position>)

<Result>: Boolean

True if the map was positioned on the specified position,
False otherwise. To get the details of the error, use ErrorInfo.
<Result> is always set to True, even if an error occurs. There is no way to find out whether the positioning was successfully performed.

<Map control>: Control name

Name of Map control to use.

<Position>: geoPosition variable or character string

Description of the location on which the map will be centered. This description can correspond to:
the name of the Variable of type geoPosition describing the geographical position on which the map will be centered.
a character string containing an address, a city, the name of a monument, ...
Using a character string may involve an inconsistent position via the mapping service of Bing Map.
an Address variable.

Versions 20 and later

Displaying a geographical location with check procedure Hide the details

<Map control>.DisplayPosition(<Position> [, <WLanguage procedure>])

<Map control>: Control name

Name of Map control to use.

<Position>: geoPosition variable or character string

Description of the location on which the map will be centered. This description can correspond to:
the name of the Variable of type geoPosition describing the geographical position on which the map will be centered.
a character string containing an address, a city, the name of a monument, ...
Using a character string may involve an inconsistent position via the mapping service of Bing Map.
to an Variable of type Address.

<WLanguage procedure>: Optional procedure name

Name of the WLanguage procedure ("callback" procedure) called once the new geographical position is displayed. This procedure has the following format:

PROCEDURE <Procedure name> (<Change performed>)

where <Change performed> is a boolean:
True if the position was modified,
False otherwise.
This parameter is not available.

New in version 20

Displaying a geographical location with check procedure Hide the details

<Map control>.DisplayPosition(<Position> [, <WLanguage procedure>])

<Map control>: Control name

Name of Map control to use.

<Position>: geoPosition variable or character string

Description of the location on which the map will be centered. This description can correspond to:
the name of the Variable of type geoPosition describing the geographical position on which the map will be centered.
a character string containing an address, a city, the name of a monument, ...
Using a character string may involve an inconsistent position via the mapping service of Bing Map.
to an Variable of type Address.

<WLanguage procedure>: Optional procedure name

Name of the WLanguage procedure ("callback" procedure) called once the new geographical position is displayed. This procedure has the following format:

PROCEDURE <Procedure name> (<Change performed>)

where <Change performed> is a boolean:
True if the position was modified,
False otherwise.
This parameter is not available.

Displaying a geographical location with check procedure Hide the details

<Map control>.DisplayPosition(<Position> [, <WLanguage procedure>])

<Map control>: Control name

Name of Map control to use.

<Position>: geoPosition variable or character string

Description of the location on which the map will be centered. This description can correspond to:
the name of the Variable of type geoPosition describing the geographical position on which the map will be centered.
a character string containing an address, a city, the name of a monument, ...
Using a character string may involve an inconsistent position via the mapping service of Bing Map.
to an Variable of type Address.

<WLanguage procedure>: Optional procedure name

Name of the WLanguage procedure ("callback" procedure) called once the new geographical position is displayed. This procedure has the following format:

PROCEDURE <Procedure name> (<Change performed>)

where <Change performed> is a boolean:
True if the position was modified,
False otherwise.
This parameter is not available.

Remarks

<Map>.DisplayPosition uses Google's geolocation service (or Bing Map for Universal Windows 10 App). The positions define from the description of a location depend on the quantity and on the precision of the information supplied in this description. If the same description correspond to several locations, the geolocation service will return the most suitable correspondences.
The cartography service used differs according to the version of the mobile device or tablet:
- before iOS 6, the service used was Google's geolocation service.
- after iOS 6, the service used was Apple's geolocation service.
We advise you to use the syntax 2 "Displaying a geographical position with check procedure".
The zoom level of the map is not modified when changing position.
To center the map on a specific position without performing the animation, you have the ability to assign a geoPosition variable to the Value property of a Map control.
To retrieve the list of addresses corresponding to the description of a place or a geographic location, use geoGetAddress.
To find out the position currently displayed in the center of the Map control, use <Map>.GetPosition.
Versions 21 and later
The Map control is using the Bing Map service.
Caution: The use of the Map control is subject to specific terms and conditions. A Bing key must be used (MapLicenseBing). Check the Bing license before deploying your applications.
New in version 21
The Map control is using the Bing Map service.
Caution: The use of the Map control is subject to specific terms and conditions. A Bing key must be used (MapLicenseBing). Check the Bing license before deploying your applications.
The Map control is using the Bing Map service.
Caution: The use of the Map control is subject to specific terms and conditions. A Bing key must be used (MapLicenseBing). Check the Bing license before deploying your applications.

Related Examples:

Unit examples (WEBDEV): The Map control

[ + ] This example explains how to use the Map control of WEBDEV.
It can be used to display a map that includes markers as well as an itinerary.

Unit examples (WINDEV): The Map control

[ + ] Using the Map control of WINDEV.
It is used to display a map that includes markers as well as an itinerary.

Component: wd260obj.dll