Name | Description |
---|---|
Chaining Commands | In some cases a sequence of commands is necessary in order to
achieve the desired result. For example given a set of waypoints
it may be desirable to optimize the order of the points, get text
instructions to travel to each point, and also display the points
on a map. Since these commands are all asynchronous each one
has to complete before the next can be initiated. Command chaining is the concept of calling one method, with instructions to chain to the other commands when this one completes. |
Latitude Longitude |
The system used to identify every position on the planet. In the
NetMaps classes these values are REALs, indicating degrees. Latitude are lines north and south of the equator. Valid values for Latitude are -90 (south pole) to +90 (north pole). Longitude are lines west and east of the Greenwich Meridian (a line that goes through Greenwich, London, England). Valid values for Longitude are -180 to +180. |
Mouse Wheel Zooming | The Zoom of the map determines how far (or how close) the viewer is to the surface of the Map. If the application has WinEvent enabled then the zoom value of the map can be altered by simply moving the mouse over the map and rotating the mouse wheel forward or backward. If WinEvent is not available then the zoom property can be manipulated in other ways (like letting the user edit the value on the screen) to change the zoom of the map. |
Provider | The web service that provides the root mapping services is known as the Map Provider. |
Tiles | Each map is broken into small graphic squares, based on the latitude, longitude and zoom level of the map. Each of these small squares is known as a Tile. Ultimately each map is made up of one, or more, tiles. Each change to the map location, zoom level, or map type will result in more tiles being fetched from with the cache, or from the tile provider. |
Zoom | The zoom is a measure of the distance from the viewer to the map. A low zoom value (1) means the viewer is "far away" and the details on the map are very coarse. High zoom values (20) mean the user is very close to the ground, and the map is very detailed. The Valid values for zoom are 1 to 20. 1 is the "furthest" away while 20 is closest to the ground. |
Method | Description |
---|---|
AppId and AppCode | The original authentication system. As a HERE developer you add your project to your list of projects, and generate an App ID and App Code. This system is considered by HERE to be a legacy system and new projects will no longer generate AppCodes. Use the ApiKey system for new projects, and switch existing projects to the ApiKey system |
ApiKey | The currently preferred approach. On the HERE site generate a REST API KEY for your application. Enter this on the NetTalk Global Extension, Options tab. (Hint: use the REST ApiKey not the JavaScript API key). |
AuthToken | Not supported yet. |
Property | DeDescription |
---|---|
APIBusy | The object is currently busy processing a request for the host object. |
Maps &NetMapsBase |
A pointer to the host NetMapsBase object (or object derived from the NetMapsBase class). |
Qid | The location of this object in the host NetMapsBase object ClientsQueue. This is the unique id number for this WebClient object, to distinguish it from all the other web client objects. |
Request | The URL for the most recent request done by the object. |
Method | Description |
---|---|
PageReceived | Incoming data received from the remote server. Passed to the parent NetMapsBase class, PageReceived method. |
ErrorTrap | Incoming Errors received from the remote server. Passed to the parent NetMapsBase class, ErrorTrap method. |
NetMapManeuverQueueType | |
---|---|
Field | Description |
ID (string) | |
Latitude (real) | |
Longitude (real) | |
InstructionHTML (string) | |
InstructionText (string) | |
TravelTime (long) | |
Length (long) |
NetMapCoordinatesQueueType | |
---|---|
Field | Description |
LatitudeY | A real value containing the Latitude of the point. |
LongitudeX | A real value containing the Longitude of the point. |
Property | DeDescription |
---|---|
AddressQueue &NetMapAddressQueueType |
A queue of addresses returned after doing a GetAutoComplete command. |
AutoCompleting | A A request to auto-complete a partial address is currently underway. Additional requests to autocomplete a partial address will be rejected until the current operation is finished. |
CacheExpiryDays long |
The number of days a (non traffic) map tile can be in the cache and considered valid. If set to 0 then cached files never expire. The default value is 30 days. This setting does not apply to traffic tiles which will become invalid after 15 minutes. See Caching. |
CacheFolder string |
The folder containing the cached tiles. Use the SetCacheFolder method to set this property. See Caching. |
ClientsQueue &NetMapClientsQueueType |
A queue of _NetMapsWebClient objects. Multiple objects means hat multiple requests can be handled at the same time. As soon as a WebClient is available a command from the CommandQueue is passed to that object for processing. This parallel processing allows for maximum performance when a number of requests (eg a number of tiles) are created at the same time. |
CommandQueue &NetMapCommandQueueType | A queue of commands. The queue declaration is in netmaps.inc. When commands need to be sent to a provider for processing, then they are added to the CommandQueue. The Next method passes waiting commands to available web client objects (ie clients in the ClientsQueue). |
ForceNoCache long |
If this is set to true then incoming files will not be saved to the cache. See Caching. . This setting is not recommended. |
InfoBackgroundColor long |
The color of the information box that can appear near markers. |
InfoBorderColor long |
The color of the border around the information box that can appear near markers. |
InfoDescriptionFontColor long |
The color of the font used for the description text in an information box. |
InfoTitleFontColor long |
Tthe color of the font used for the title text in an information box. |
LockPosition long |
If set to true then the map cannot be moved with the mouse. It can still be moved with calls to GetMap. |
LockZoom long |
If set to true then the map cannot be zoomed with the mouse wheel. It can still be zoomed with calls to GetMap. |
MapStyle long |
One of net:day, net:night. Use the SetMapType method to set this property. |
MapType long |
One of Net:Map, Net:Satellite, Net:Traffic, Net:TrafficHybrid, Net:Hybrid, Net:Panoramic, Net:Weather, Net:Terrain, Net:Pedestrian .Use the SetMapType method to set this property. |
ManeuverQueue &NetMapManeuverQueueType | A queue containing the maneuvering instructions returned by a call to GetRoute. Can be used inside the RouteFound method. |
MarkerQueue &NetMapMarkerQueueType | A queue of the markers currently on the map. Note that not all markers may be visible, some may be off the map boundaries. |
net &_NetMapsClient |
The WebClient object that was used to fetch the request. Not usually needed, but can be inspected in any of the Found methods. |
RefreshCache long |
If this is set to true then files will not be used from the cache, but will be re-fetched from the provider. If you set this to true then you will need to set it back to false when the object can use the cache again or it will continue to re-fetch files from the provider, not the cache. See Caching. |
TestServer | Can be true or false. Default value is false. Set to true if the account should use the provider's test server. (The HERE provider calls this the CIT server.) Often used for demo accounts and so on. |
ThisPage StringTheory |
The complete response received by from the provider. Use only in methods where it is indicated to be in scope. |
WaypointsQueue &NetMapWaypointsQueueType |
A queue of positions. This queue can be fed into various methods, like OptimizeRoute, GetRoute and so on. |
Zoom long |
The current zoom level of the map. Use the SetZoom method to set this property. |
Method | Description |
---|---|
AddressFound | Called when the reply to a GetAddress command is received. |
Authenticate | Sets the authentication properties in the class. |
AutoCompleteFound | Called when the reply to a GetAutoComplete command is received. |
Cached | Determines if a valid file is in the disk cache. |
ClearTile | Clears a tile space on the map. |
CommandQueueChanged | Called whenever a command is added to, or removed from, the command queue. |
CopyrightFound | Called when the reply to a GetCopyright command is received. |
DeleteMarker | Deletes a marker from the icons queue. |
DeleteRoute | Deletes a route from the routes queue. |
Distance | Calculates the crow-flies distance between two points. |
DrawMarkers | Draws all the visible icons in the icons queue on the map image. |
DrawRoutes | Draws all the visible route legs on the map image. |
DrawTile | Draws a tile on the map. Called when tiles are received from the provider, or when tiles are found in the cache. |
ErrorTrap | Called when there is an error communicating with the provider. |
Get | Calls the Get method of the current _NetMapsWebClient object. |
GetAddress | Given a latitude and longitude, get an address for the location. This method is asynchronous. When the result is returned the AddressFound method is called. |
GetAutoComplete | Given a partial address, return a list of suggested complete addresses. |
GetCopyright | Get copyright information from the provider. This method is asynchronous. When the result is returned the CopyrightFound method is called. |
GetFileName | Returns an appropriate name for a tile based on the current map type, zoom, factor, location and so on. |
GetLocation | Given an address, get a latitude and longitude for the address. This method is asynchronous. When the result is returned the LocationFound method is called. |
GetMap | Gets a map from the provider based on many possible parameters. |
GetMouseLatitude | Gets the Latitude of the current mouse position over the map. |
GetMouseLongitude | Gets the Longitude of the current mouse position over the map. |
GetRoute | Given a queue of Waypoints, get text (or HTML) instructions for moving from each waypoint to the next. |
GetSearch | Search for an item on the displayed map. |
Init | Calls the Init method for all the _NetMapsWebClient objects. |
Kill | Calls the Kill method for all the _NetMapsWebClient objects. |
LocationFound | A location has been determined from an address. Optionally redraw the map to this location. |
MapClicked | Called when the user clicks on the map. If the user clicked on an Icon then the ID of the marker is passed into the method. |
MouseOverMarker | Returns the ID of a marker if the mouse is currently over a marker. |
Move | Moves the map my a specified number of deltaX and deltaY pixels. |
MoveMouseToCenter | Moves the map so that the clicked position is now the center of the map. |
Next | Finds the next waiting command in the CommandQueue and passes it to the next available _NetMapsWebClient object. |
OnMap | Determines if a specific latitude and longitude is currently visible on the map, given the current map coordinates and zoom level. |
OptimizeRoute | Given a queue of Waypoints, determine the best route that covers all the points. |
PageReceived | Called when data is received from the provider. |
Refresh | Redraws the map and all other items associated with the map (Markers, routes and so on) |
RefreshExtras | Redraws all the ancillary map items - markers, routes, areas and so on. |
RoundUp | Rounds a real value to the next integer value. |
RouteFound | A route was found. |
RouteOptimized | A route was optimized. |
SetCacheFolder | Sets the folder name for the cached tiles. If the folder does not exist it will be created. |
SetMarker | Adds an marker to the MarkerQueue property. |
SetMarkerDescription | Adds description text to a marker, for displaying in an info box. |
SetMarkerImage | Adds an image to a marker for displaying in an info box. |
SetMapControl | Binds the map object to an image control on the window. A region control is also created to get events. |
SetMapType | Sets the MapType and MapStyle properties for the map. |
SetRoute | Sets a route, or route leg. |
SetZoom | Sets the Zoom property for the map. |
Start | Return the properties of the object back to their default state. |
TakeEvent | Processes windows events and handles events that affect the map. |
WatchControls | Sets various properties in the object to match controls on the window, so they can be monitored and the map changed automatically. |
Parameter | Description |
---|---|
pFirstAddress | The first address in the list of most likely addresses for this location. |
pDistance | The distance (in meters) from the location to the address. |
Parameter | Description |
---|---|
pAppId | The app ID as provided by the provider. |
pAppCode | The AppCode as provided by the provider. |
pApiKey | An alternative to the App Code and App Id is the API Key. Use this parameter if you have it. If this parameter exists it will be used in preference to the AppCode AppId combination. |
pAuthToken | Not used yet. |
Parameter | Description |
---|---|
pChange | One of net:InsertRecord or net:DeleteRecord. this indicates if the call was made because a record was added or deleted. |
Parameter | Description |
---|---|
pID | The ID of the icon being removed. If this parameter is omitted, or blank , then all the icons in the queue are removed. |
Parameter | Description |
---|---|
pID | The ID of the route being removed. If this parameter is omitted, or blank , then all the routes in the queue are removed. |
Parameter | Description |
---|---|
pLatitudeA | The latitude of the first point. |
pLongitudeA | The longitude of the first point. |
pLatitudeB | The latitude of the second point. |
pLongitudeB | The longitude of the second point. |
pUnit | One of net:yards, net:miles, net:kilometres, net:metres |
Parameter | Description |
---|---|
pDisplay | If this is true then the map, and hence image control are DISPLAYed at the end of this call. If this call is being made before the ACCEPT command for the window, it's preferable to set this parameter to false so the window will not be prematurely displayed. |
Parameter | Description |
---|---|
pDisplay | If this is true then the map, and hence image control are DISPLAYed at the end of this call. If this call is being made before the ACCEPT command for the window, it's preferable to set this parameter to false so the window will not be prematurely displayed. |
Parameter | Description |
---|---|
pLatitude | The latitude of the address |
pLongitude | The longitude of the address. |
pDistance | The maximum distance (in meters) from the location to the address. |
pMode | Provider dependant. HERE: One of nhm:mode_retrieveAddresses, nhm:mode_retrieveAreas, nhm:mode_retrieveLandmarks, nhm:mode_retrieveAll, nhm:mode_trackPosition. Defaults to nhm:mode_retrieveAddresses. |
pType | The data type. Can be one of net:json or net:xml. Defaults to net:json. |
pURLParameters | And additional parameters that should be used when sending the request to the provider. |
Parameter | DDescription |
---|---|
pSearchText | The text containing the partial address. |
pMaxResults | An optional value from 1 to 20. The default value is 10. This determines how many suggestions are returned. |
pCountry Codes | An optional, comma separated list, of ISO 3 Country Codes. Use this to limit the address search to a particular country. |
pURLParameters | Any additional parameters required by the specific provider. |
pSearchTextEncoding | Identifies the encoding of the pSearchText parameter. By
default this value is st:EncodeAnsi.
If it is then it is converted to utf-8 before sending to the
service. The codePage property is used to determine the ANSI
code page. Valid values for this parameter are; st:EncodeAnsi, stEncodeUtf8, st:EncodeUtf16 |
Parameter | Description |
---|---|
pSearchText | The text containing the address. |
pChainCommand | If set to Net:GetMap then once the location has been found, the map will draw at that position. |
pMode | |
pType | One of net:json, net:xml. Indicates the preferred response type from the server. |
pURLParameters | Any additional parameters required by the specific provider. |
pSearchTextEncoding | Identifies the encoding of the pSearchText parameter. By
default this value is st:EncodeAnsi.
If it is then it is converted to utf-8 before sending to the
service. The codePage property is used to determine the ANSI
code page. Valid values for this parameter are; st:EncodeAnsi, stEncodeUtf8, st:EncodeUtf16 |
Parameter | Description |
---|---|
pLatitude | The latitude of the center of the map. |
pLongitude | The longitude of the center of the map. |
pZoom | The zoom value for the map. To maintain the current value use self.zoom. In the address version of the call this field can be omitted. |
pAddress | A text address. Can be used in place of latitude and longitude. |
pLatitudeBottom, pLatitudeTop, pLongitudeLeft, pLongitudeRight |
Bottom Left and Top right corners of an area to be included in the map. If this call is used then the zoom factor is automatically calculated to the highest value that includes the desired rectangle. |
pIconQueue, pWaypointsQueue |
Automatically calculates the optimal parameters for the map so that all the items in the queue are visible. |
pMinZoom pMaxZoom |
Restrict the automatic zooming to these boundaries. |
Parameter | Description |
---|---|
pID | An ID for the route. Any value can be used. This is the value that will be passed to the DeleteRoute method if the route needs to be deleted. |
pChainCommand | If set to Net:GetMap then the map will be drawn, once the route has been fetched. |
pIcon | If set, then the waypoints will be added to the map as icons. |
pMode | Provider dependant. HERE: Defaults to 'fastest;car;traffic:enabled' |
pTime | The time when the trip will take place. |
pDate | The date when the trip will take place. |
pDepartArrive | Set to one of net:depart (the default) or net:arrive. This refers to the above date and time being either the date and time of departure or arrival. |
pType | Set to one of net:json or net:xml. This determines the formatting of the return values. |
pURLParameters | Any additional parameters required by the specific provider. |
pMetric | Set to either net:metric (the default) or net:imperial. Controls whether the distances in the instructions in the reply is either kilometers (metric) or miles (imperial). |
Parameter | Description |
---|---|
pSearchText | The text that will be searched for. |
pIcon | An Icon to use to mark the search results. If the icon is omitted then the value MapSearch.Ico will be used. |
pMaxResults | The maximum number of results to get back. The default is 100. |
pURLParameters | Any additional parameters required by the specific provider. |
pSearchTextEncoding | Identifies the encoding of the pSearchText parameter. By
default this value is st:EncodeAnsi.
If it is then it is converted to utf-8 before sending to the
service. The codePage property is used to determine the ANSI
code page. Valid values for this parameter are; st:EncodeAnsi, stEncodeUtf8, st:EncodeUtf16 |
Parameter | Description |
---|---|
pAddress | The address that was used in the call to GetLocation. |
pLatitude | The latitude of the location. |
pLongitude | The longitude of the location. |
pGetMap | Set by the call to GetLocation. If true then the map will automatically go to this position. |
Parameter | Description |
---|---|
pLatitude | The latitude of the click . |
pLongitude | The longitude of the click. |
Parameter | Description |
---|---|
pLatitude | The latitude of the position. |
pLongitude | The longitude of the position. |
Parameter | Description |
---|---|
pChainCommand | If set to Net:GetRoute then the
GetRoute method will be called once the route has been
optimized. If set to Net:GetMap then the map will be drawn, once the route has been fetched. This is an additive parameter - ie this can be set to Net:GetRoute + Net:GetMap |
pIcon | If set, then the waypoints will be added to the map as icons. |
pMode | Provider dependent. HERE: Defaults to 'fastest;car;traffic:enabled' |
pTime | The time when the trip will take place. |
pDate | The date when the trip will take place. |
pDepartArrive | Set to one of net:depart (the default) or net:arrive. This refers to the above date and time being either the date and time of departure or arrival. |
pType | Set to one of net:json or net:xml. This determines the formatting of the return values. |
pURLParameters | Any additional parameters required by the specific provider. |
pMetric | Set to either net:metric (the default) or net:imperial. Controls whether the distances in the instructions in the reply is either kilometers (metric) or miles (imperial). |
Parameter | Description |
---|---|
pChainCommand | The pChainCommand from the original call to GetRoute. ie whatever was passed into GetRoute ccomes out here. |
Parameter | Description |
---|---|
pChainCommand | The pChainCommand from the original call to OptimizeRoute. ie whatever was passed into OptimizeRoute comes out here. |
Parameter | Description |
---|---|
pFolder | The folder to use as the cache folder for tiles. If the folder does not exist then this method will create the folder. |
Parameter | Description |
---|---|
pID | The ID of the Marker. This is the ID that will be returned by the MapClicked method if the user clicks on an icon. |
pLatitude | The latitude of the icon. |
pLongitude | The longitude of the icon. |
pIcon | The name of the icon. Use a ~ as the first character of the name if the icon is a resource in the DLL or EXE. If no ~ is used then the icon will be read off disk. |
pIconIndex | If the icon contains multiple images, then the desired image can be set here. |
pPointX | The x-offset, from the left, identifying the "point" of the icon. |
pPointY | the y-offset from the top, identifying the "point" of the icon. |
pHide | If true then the icon is not displayed. |
Parameter | Description |
---|---|
pID | The ID of the Marker. This is the ID that will be returned by the MapClicked method if the user clicks on an icon. |
pTitle | The Title text to appear in the Info box. |
pDescription | The description text to appear in the info box. |
pPosition | The preferred position of the info box relative to the point on the map. If the info box will not fit in this position then another position is used. Valid values are net:North, net:NorthEast, net:East, net:SouthEast, net:South, net:SouthWest, net:West, net:NorthWest. |
pHide | If true then the info box is not displayed. It will be displayed if the user moves the mouse over the marker. |
Parameter | Description |
---|---|
pID | The ID of the Marker. This is the ID that will be returned by the MapClicked method if the user clicks on an icon. |
pImage | The name, and if necessary path, of the image to display. |
pWidth | The width the image should draw to. If 0 then the actual image width is used. |
pHeight | The height the image should draw to. If 0 then the aspect ratio of the original image is preserved. |
pPosition | The preferred position of the info box relative to the point on the map. If the info box will not fit in this position then another position is used. Valid values are net:North, net:NorthEast, net:East, net:SouthEast, net:South, net:SouthWest, net:West, net:NorthWest. |
pHide | If true then the image is not displayed in the info box. |
Parameter | Description |
---|---|
pMapType | One of Net:Map, Net:Satellite, Net:Traffic, Net:TrafficHybrid, Net:Hybrid, Net:Panoramic, Net:Weather, Net:Terrain, Net:Pedestrian . If this parameter is omitted then the property is unchanged. |
pMapStyle | One of net:night, net:day. If this parameter is omitted then the property is unchanged. |
Parameter | Description |
---|---|
pID | The ID of the Route. This is the ID that will be passed to DeleteRoute if you want to delete a route. |
pRouteQueue | A queue, of type NetMapCoordinatesQueueType which contains all the legs for the route. If this form of the method is used then multiple legs are added to the route at the same time. |
pLeg | The leg number for the leg of the route being added. If this form of the method is used only one leg is added to the route. |
pLatitude | The latitude of the next waypoint in the route. |
pLongitude | The longitude of the next waypoint in the route. |
pColor | The color of the route, or route leg, when displayed on the map. |
Parameter | Description |
---|---|
pZoom | the desired zoom level. This value should be in the range 1 (furthest away) to 20 (closest to the ground.) |
pLatitude | If omitted (or set to 1000) then the current latitude of the map is used. |
Property | Description |
---|---|
There are no properties declared for this class. However all the properties for the base class are in scope. |
Method | Description |
---|---|
APIGetAddress | Makes a request to the provider for the nearest address to a specific latitude, longitude position. This method is asynchronous. When the result is returned it is passed to the appropriate ParseReverseGeoCodeReply method for processing. The AddressFound method in the parent class is then called. |
APIGetCopyright | Makes a request to the provider for copyright information. This method is asynchronous. When the result is returned it is passed to the appropriate ParseCopyrightReply method for processing. The AddressFound method in the parent class is then called. |
APIGetLocation | Makes a request to the provider for a specific latitude and longitude, based on an address. This method is asynchronous. When the result is returned it is passed to the appropriate ParseGeoCodeReply method for processing. The LocationFound method in the parent class is then called. |
APIGetTile | Makes a request to the provider for a specific tile. This method is asynchronous. When the tile arrives it is passed to the PageReceived method of the parent class. |
APIGetRoute | Makes a request to the provider for specific route information. This method is asynchronous. When the result is returned it is passed to the appropriate ParseCalcRouteReply method for processing. The RouteFound method in the parent class is then called. |
ParseCalcRouteReplyJSON | Parses the reply from the specific provider, incoming data is JSON. |
ParseCalcRouteReplyXML | Parses the reply from the specific provider, incoming data is XML. |
ParseCopyrightReplyJSON | Parses the reply from the specific provider, incoming data is JSON. |
ParseCopyrightReplyXML | Parses the reply from the specific provider, incoming data is XML. |
ParseGeocodeReplyJSON | Parses the reply from the specific provider, incoming data is JSON. |
ParseGeocodeReplyXML | Parses the reply from the specific provider, incoming data is XML. |
ParseReverseGeocodeReplyJSON | Parses the reply from the specific provider, incoming data is JSON. |
ParseReverseGeocodeReplyXML | Parses the reply from the specific provider, incoming data is XML. |