Tms FNC Maps: Developers Guide
Tms FNC Maps: Developers Guide
October 2021
Copyright © 2021 by tmssoftware.com bvba
Web: http://www.tmssoftware.com
Email: [email protected]
1
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Index
Availability ............................................................................................................................................... 4
Online references .................................................................................................................................... 4
Description .............................................................................................................................................. 4
Getting Started ........................................................................................................................................ 5
TTMSFNCMaps ........................................................................................................................................ 6
Initialization ......................................................................................................................................... 7
Dynamic switching............................................................................................................................... 8
Performance ........................................................................................................................................ 8
Markers ............................................................................................................................................... 8
PolyElements ....................................................................................................................................... 9
Loading GPX/GeoJSON ...................................................................................................................... 12
Popups ............................................................................................................................................... 19
Interaction ......................................................................................................................................... 20
Customization.................................................................................................................................... 21
Events ................................................................................................................................................ 25
Common Types .................................................................................................................................. 26
TTMSFNCGoogleMaps ........................................................................................................................... 29
Dragging Markers .............................................................................................................................. 29
Editing Polyelements ......................................................................................................................... 30
Loading KML Layers ........................................................................................................................... 31
Clusters .............................................................................................................................................. 31
Events ................................................................................................................................................ 35
OverlayViews ..................................................................................................................................... 35
Properties .......................................................................................................................................... 35
Events ................................................................................................................................................ 36
StreetView ......................................................................................................................................... 40
Events ................................................................................................................................................ 40
Geodesic Polylines ............................................................................................................................. 41
Traffic & Bicycling .............................................................................................................................. 42
Integrated Directions......................................................................................................................... 42
TTMSFNCOpenLayers ............................................................................................................................ 44
TileServer ........................................................................................................................................... 44
2
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TileLayers ........................................................................................................................................... 44
Polyline & Polygon labels .................................................................................................................. 45
TTMSFNCMapKit ................................................................................................................................... 45
Map Rotation..................................................................................................................................... 45
Integrated Directions......................................................................................................................... 46
TTMSFNCMapBox .................................................................................................................................. 47
Map Style ........................................................................................................................................... 47
TTMSFNCTomTom ................................................................................................................................. 47
Map Style ........................................................................................................................................... 47
TTMSFNCGeocoding .............................................................................................................................. 49
TTMSFNCDirections ............................................................................................................................... 53
TTMSFNCLocation ................................................................................................................................. 56
TTMSFNCElevation ................................................................................................................................ 58
TTMSFNCTollCost .................................................................................................................................. 60
TTMSFNCStaticMap ............................................................................................................................... 63
TTMSFNCMapsImage ............................................................................................................................ 65
TTMSFNCTimeZone ............................................................................................................................... 66
TTMSFNCRouteCalculator ..................................................................................................................... 68
TMS FNC Maps Book ............................................................................................................................. 76
Content .............................................................................................................................................. 76
How to order ..................................................................................................................................... 77
Terms of use .......................................................................................................................................... 78
Limited warranty ................................................................................................................................... 78
3
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Availability
Important Notice: TMS FNC Maps requires TMS FNC Core (separately available at the My Products
page)
Online references
Description
TMS FNC Maps is a cross-framework, cross-platform and cross-service mapping component library. It
includes an abstract map (TTMSFNCMaps) that is capable of rendering polygons (including rectangles
and circles), polylines, markers, show HTML formatted popups and many more. It has events for
mouse interaction as well as some basic options to configure the look and feel. Optionally, the
underlying JavaScript can be modified to allow additional customization options. Also included is a
component for calculating directions between 2 coordinates or addresses (TTMSFNCDirections), the
ability to convert a coordinate to an address or vice versa (TTMSFNCGeoCoding) and retrieving your
current location (TTMSFNCLocation). Below is a list of services that are currently supported.
- OpenLayers (OpenStreetMaps)
- TomTom
- Google Maps
- Here Maps
- MapBox
- MapKit JS
4
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Getting Started
After installing TMS FNC Core, please follow instructions on getting the TTMSFNCWebBrowser up and
running, which is the underlying component for TMS FNC Maps. More information about the browser
and its capabilities can be found at the following link:
http://www.tmssoftware.biz/Download/Manuals/TMSFNCWebBrowserDevGuide.pdf
After installing TMS FNC Maps, the first thing that needs to be done is acquiring an API key (except
for OpenLayers which is free and doesn’t require an API key). Steps to obtain an API key for
enabling the map as well as using directions, geocoding and location services can be found at the
following page:
https://www.tmssoftware.com/site/cloudkey.asp
Click on the service you are using and follow the steps to obtain an API key. The API key that is
requested can be used for all features that are available after installing TMS FNC Maps:
5
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCMaps
TTMSFNCMaps is an abstract layer on top of the services that are listed under the “Description”
chapter. It serves a way to display / manipulate and retrieve information of the chosen service in an
abstract way, which means that whenever you are switching to another service, the code that was
written will be 100% compatible and will behave exactly the same as the service you were originally
been using, ofcourse under the disclaimer that the service does not change the underlying APIs.
6
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Initialization
When dropping an instance of TTMSFNCMaps (after successful installation of TMS FNC Core and
TTMSFNCWebBrowser) on the form you’ll notice the designtime message indicating that Google
Maps can’t be displayed because the API key is not set. Changing the Service property will show a
different message depending on the chosen service. Please enter a value under the API key property
after selecting the component at designtime, or specify an API key at runtime that matches the
service selected under the Service property. Also note that the only selectable area (for moving,
resizing) is the area at the top. The blue area is actually a real life mapping instance, so entering
the API key at designtime will show you a live preview of the map.
After setting the API key, you should see the map of the service of choice.
7
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Dynamic switching
A feature of TTMSFNCMaps is dynamic switching. It allows switching to another service even though
you have already added markers, polygons, polylines, ... The only settings that are not persisted are
the default location and zoom which are re-initialized to the default values. Switching or initializing
a specific service can be done with the following code:
procedure TForm1.ChangeService;
begin
TMSFNCMaps1.Service := msBingMaps;
end;
Performance
When using the maps, adding markers, polyelements or changing existing properties of an object
that has been added to the map it is always a good practice to wrap the code with
BeginUpdate/EndUpdate. This ensures the JavaScript calls are bundled and this will lower execution
times, which automatically increases performance. Below is a sample that demonstrates how to use
BeginUpdate & EndUpdate calls for speeding up the process.
TMSFNCMaps1.BeginUpdate;
//add markers, polyelements, load GPX, GeoJSON file, …
TMSFNCMaps1.EndUpdate;
Markers
Markers identify a location on the map. Each service has its own marker icon that can (optionally)
be changed. A marker is tied to a specific location (coordinate) on the map. The default location is
the Statue of Liberty in New York (Latitude = 40.689247, Longitude = -74.044502). Below is a piece
of sample code that adds a marker, and the result shown on the map. The marker class is
TTMSFNCMapsMarker.
TMSFNCMaps1.BeginUpdate;
TMSFNCMaps1.AddMarker(DefaultCoordinate, 'First Marker!');
TMSFNCMaps1.EndUpdate;
The title of the marker can optionally be set, in this case the marker title is being shown as a hint in
Google Maps. In Here Maps for example, the marker can be clicked when a Title is set which will
show the value in a popup:
8
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
When a marker has been added, changing properties will automatically update the marker, such as
changing the coordinate property to relocate the marker or specifying another title.
The marker icon can also be customized. Below is a sample that changes the default Google Maps
icon to a custom icon.
TMSFNCMaps1.BeginUpdate;
TMSFNCMaps1.AddMarker(DefaultCoordinate, 'First Marker!',
'http://myIconURL.png');
TMSFNCMaps1.EndUpdate;
Please note that AddMarker is a helper function that accesses the Marker collection. The marker
collection can also be accessed via
TMSFNCMaps1.Markers.Add;
PolyElements
PolyElements can be added in the same way as adding Markers. PolyElements include one of the
following types:
- TTMSFNCMapsPolyline
9
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
- TTMSFNCMapsPolygon
- TTMSFNCMapsRectangle
- TTMSFNCMapsCircle
Adding a polyline and polygon is done with AddPolyline and AddPolygon respectively. Both calls
accept an array of coordinates (TTMSFNCMapsCoordinateRec). Both TTMSFNCMapsPolyline and
TTMSFNCMapsPolygon have the ability to specify a stroke color, width and opacity. The
TTMSFNCMapsPolygon has the ability to specify a fill color, width and opacity. The following sample
demonstrates how to add a polygon that represents the Bermuda triangle. The code can also be
replaced by AddPolyline, but without access to the Fill* properties.
procedure TForm1.AddMarkerToMap;
var
arr: TTMSFNCMapsCoordinateRecArray;
pg: TTMSFNCMapsPolygon;
begin
SetLength(arr, 3);
arr[0] := CreateCoordinate(25.789106, -80.226529);
arr[1] := CreateCoordinate(18.4663188, -60.1057427);
arr[2] := CreateCoordinate(32.294887, -64.781380);
TMSFNCMaps1.BeginUpdate;
pg := TMSFNCMaps1.AddPolygon(arr);
pg.FillColor := gcOrange;
pg.FillOpacity := 0.5;
pg.StrokeColor := gcGreen;
pg.StrokeWidth := 4;
TMSFNCMaps1.EndUpdate;
end;
Adding a circle (TTMSFNCMapsCircle) is done by specifying a center coordinate and a radius (in
meter). TTMSFNCMapsCircle inherits from TTMSFNCMapsPolygon and therefore also can specify fill
and stroke properties.
Below is a sample that demonstrates how adding a circle is done with a radius of 200 km.
procedure TForm1.AddCircleToMap;
var
c: TTMSFNCMapsCircle;
begin
TMSFNCMaps1.BeginUpdate;
10
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
c := TMSFNCMaps1.AddCircle(DefaultCoordinate, 200000);
c.FillColor := gcOrange;
c.FillOpacity := 0.5;
c.StrokeColor := gcGreen;
c.StrokeWidth := 4;
TMSFNCMaps1.EndUpdate;
end;
Adding a rectangle (TTMSFNCMapsRectangle) is done with the AddRectangle call which accepts a
bounds (TTMSFNCMapsBoundsRec). This is defined by a NorthEast and SouthWest coordinate. Below
is a sample that demonstrates this.
procedure TForm1.AddRectangleToMap;
var
c: TTMSFNCMapsRectangle;
b: TTMSFNCMapsBoundsRec;
ne, sw: TTMSFNCMapsCoordinateRec;
begin
TMSFNCMaps1.BeginUpdate;
ne := CalculateCoordinate(DefaultCoordinate, 45, 100000);
sw := CalculateCoordinate(DefaultCoordinate, 225, 100000);
b := CreateBounds(ne.Latitude, ne.Longitude, sw.Latitude, sw.Longitude);
c := TMSFNCMaps1.AddRectangle(b);
c.FillColor := gcOrange;
c.FillOpacity := 0.5;
c.StrokeColor := gcGreen;
c.StrokeWidth := 4;
TMSFNCMaps1.EndUpdate;
end;
11
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
There is a little more explanation necessary for this piece of code that adds a rectangle. The
rectangle is 200km wide. The coordinates are calculated based on the center of the rectangle and
the bearing (0-360).
To calculate the northeast coordinate, we need to take the center coordinate and traval into the 45
degrees’ direction. The parameter “Distance” is determining how far we actually travel. The
CalculateCoordinate is a helper function in the *.TMSFNCMapsCommonTypes unit that calculates the
coordinate based on these parameters. The same applies to the SouthWest coordinate, which lies in
the 225 degrees’ direction. Finally, we are able to create a bounds rectangle with these coordinate
and plot it on the map.
Loading GPX/GeoJSON
Loading GPX/ GeoJSON is done with a single call. Specify the GPX/GeoJSON file that you wish to
load and the map will render the polyelements/lines that are retrieved inside the GPX/GeoJSON
file. The optional parameters are to AutoDisplay the data that is loaded and to automatically zoom
to the bounds of the data that has been entered. The AutoDisplay and ZoomToBounds parameters
are both true by default. Below is a sample with a GPX file.
GPX
TMSFNCMaps1.BeginUpdate;
TMSFNCMaps1.LoadGPXFromFile('run.gpx');
TMSFNCMaps1.EndUpdate;
12
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Changing the line that has automatically been added is as simply as taking the last element from the
Polylines collection.
procedure TForm1.LoadGPX;
var
pl: TTMSFNCMapsPolyline;
begin
TMSFNCMaps1.BeginUpdate;
TMSFNCMaps1.LoadGPXFromFile('run.gpx');
pl := TMSFNCMaps1.Polylines[TMSFNCMaps1.Polylines.Count - 1];
pl.StrokeColor := gcRed;
pl.StrokeWidth := 5;
pl.StrokeOpacity := 0.5;
TMSFNCMaps1.AddMarker(pl.Coordinates[0].Coordinate.ToRec);
TMSFNCMaps1.AddMarker(pl.Coordinates[pl.Coordinates.Count -
1].Coordinate.ToRec);
TMSFNCMaps1.EndUpdate;
end;
13
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
For each Track found in the GPX file, the OnCreateGPXTrack event is triggered and for each
Coordinate found, the OnCreateGPXSegment event.
The OnCreateGPXTrack AEventData parameter contains Data.Name/Segments information as well as
the full XML node, so if extra data is available this can be parsed manually.
The OnCreateGPXSegment AEventData parameter contains
Data.Longitude/Latitude/Elevation/TimeStamp information as well as the full XML node, so if extra
data is available this can be parsed manually.
Examples:
14
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
If a given gpx file contains extra data beyond the standard available data, this can be parsed
manually through AEventData.Node.
In this example the gpx file contains a heartrate value for each coordinate. The heartrate is
extracted from the XML and a marker is added on the map along the route each time the value is
above 190.
Code:
If a GPX file contains elevation and/or timestamp data, this data will also be available in the result
of the LoadGPXFromFile call.
15
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Elevation data can optionally be displayed with the ADisplayElevation parameter. This is achieved
by adding multiple color coded polylines to the map. The colors to use can be provided in the
AElevationColors parameter. If a single color is provided, the polyline will be displayed darker for
lower parts and lighter for higher parts of the path. If no colors are provided, the AStrokeColor is
used. If no AStrokeColor is provided, the default color is used.
Timestamp data can optionally be displayed through markers along the polyline path with the
ADisplayTimeStamp parameter. To limit the amount of markers, the
AMinSecondsBetweenTimeStamps can be used to set the minimum time between displayed markers.
16
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
GeoJSON
GeoJSON has multiple types of data, called “Features”, such as Point, Line, Polygon, etc … Below is
a sample of a GeoJSON that is being loaded in the TTMSFNCMaps instance.
procedure TForm1.LoadGeoJSON;
var
pl: TTMSFNCMapsPolygon;
I: Integer;
begin
TMSFNCMaps1.BeginUpdate;
TMSFNCMaps1.LoadGeoJSONFromFile('data.geojson');
for I := 0 to TMSFNCMaps1.Polygons.Count - 1 do
begin
pl := TMSFNCMaps1.Polygons[I];
pl.FillColor := gcBlue;
pl.FillOpacity := 0.2;
pl.StrokeColor := gcBlue;
pl.StrokeOpacity := 0.5;
end;
TMSFNCMaps1.EndUpdate;
end;
17
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
18
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Popups
Popups are informative messages that can be shown anywhere on the map. They are tied to a
specific coordinate and can be shown and hidden programmatically in various cases, such as clicking
on a marker, hovering over a circle, etc… A popup is capable of displaying HTML formatted text.
Below is a sample that shows how to display a popup at the default coordinate with information on
the Statue of Liberty in New York.
procedure TForm1.AddPopupToMap;
const
s = '<div width="300"><h3>Liberty Enlightening the World<h3>' + LB +
'"The Statue of Liberty Enlightening the World" was a gift of friendship
from the people of ' + LB +
'France to the United States and is recognized as a universal symbol of
freedom and democrac' + LB +
'y. The Statue of Liberty was dedicated on October 28, 1886. It was
designated as a National' + LB +
' Monument in 1924. Employees of the National Park Service have been
caring for the colossal copper statue since 1933.<br/><br/>' + LB +
'<img height="100"
src="http://myserver.com/images/StatueOfLiberty.jpg"></img></div>';
begin
TMSFNCMaps1.ShowPopup(DefaultCoordinate, s)
end;
Optional parameters are to offset the popup in pixels based on the default coordinate. When
showing a popup, the return value is an ID, which can be used to close it with the ClosePopup
method. The close all popups that are opened in the map, use CloseAllPopups;
19
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Locale
The map is capable of changing the language that is displayed at some elements such as the
maptype and the street/city names. Not all maps support a full translation and not all maps support
every language. Please look up the languages that are supported depending on the chosen service.
The way the map language is translated is based on the Locale string property which is set to en-US
by default. A couple of examples of locales are:
Applying this to the map is as simple as assigning a value to the Options.Locale property:
TMSFNCMaps1.Options.Locale := 'pt-BR';
TMSFNCMaps1.ReInitialize;
Note that a ReInitialize call is necessary to make sure the map is properly initialized.
Interaction
The map supports panning, zooming changing map type, scrolling with the mouse or keyboard and
many more. Also programmatically, you are able to go to a specific location, zoom to a specific map
bounds. Below is a list of methods that can be used to programmatically interact with the map.
TMSFNCMaps1.ZoomToBounds
The ZoomToBounds method has a couple of overloads to specify an array of coordinates, a bounds
record, or a northeast/southwest coordinate. ZoomToBounds will automatically navigate to a
specific area determined by the northeast and southwest coordinates either coming directly from
the bounds parameter or automatically calculated based on an array of coordinates.
TMSFNCMaps1.SetCenterCoordinate
20
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
The SetCenterCoordinate will navigate to a specific location on the map without changing the zoom
level.
TMSFNCMaps1.SetZoomLevel
The SetZoomLevel method can be used to set a specific zoom level at the current location on the
map.
Some maps expose a zoom control and/or maptype control that allows changing the zoom level or
switch to another map type such as a night mode or a satellite view depending on the chosen
service. The properties to enable/disable these controls are available under Options. By default,
the values are true for both properties. Below is a sample what happens when setting them to false
like the code below.
TMSFNCMaps1.Options.ShowMapTypeControl := false;
TMSFNCMaps1.Options.ShowZoomControl := false;
Customization
Each service is implemented in a specific way so the polyelements, markers, rectangles, circles and
every other aspect of the abstract TTMSFNCMaps class is working as expected even when switching
to another service. If you are missing a particular feature/event or you want to change existing
features, you have access to a series of customization events that allow you to change what
happens. Through JavaScript there are a series of constants defined to get access to objects inside
JavaScript. A complete list of variables is found in the *.TMSFNCMaps.pas unit below the version
number. Below is a list of events that allow customization.
OnCustomizeCSS
Event to customize the CSS, style information that is tied to the map, or to other objects in the map
such as popups.
OnCustomizeJavaScript
Event that is called to completely customize all JavaScript that is used to render the map and
add/update markers, polyelements and many more.
OnCustomizeMap
Event called when the map is being loaded. Additional map settings can be added here. The map
identifier that can be used is the MAPVAR constant defined in the TMSFNCMaps unit.
21
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
OnCustomizeGlobalVariables
Event called when global variables are defined, which can be accessed from each JavaScript call
that is available to the map.
OnCustomizeMarker
Event called when a marker is added or updated. This event can be used to customize markers. The
variable that is initialized when working with markers is MARKERVAR.
OnCustomizePopup
Event called when a popup is added. This event can be used to customize popups. The variable that
is initialized when working with popups is POPUPVAR.
OnCustomizeOptions
Event called when map options are changed such as the showing or hiding the zoom control or map
type control. Add any options you want to change to the map in this event.
OnCustomizePolyElement
Event called when a polyelement is added (polyline, polygon, circle, rectangle). This event can be
used to customize a polyelement. The variable that is initialized when working with popups is
POLYELEMENTVAR.
OnGetDefaultHTMLMessage
Event called when the map is being loaded but no API key is set. This message is to inform users
about that an API key is missing by default. This message can be changed through this event.
OnCustomEvent
Event called when a custom event is added and triggered from inside the map, following the rules
to call the proper communication sequence. Below is a sample that demonstrates this.
To better demonstrate how the custom events are working, a couple of examples.
Sample 1) Initializing the default map with custom maptype control (Google Maps):
22
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
opt := '{' + LB +
' restriction:{' + LB +
' latLngBounds: NEW_ZEALAND_BOUNDS,' + LB +
' strictBounds: false' + LB +
' }' + LB +
'}';
23
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
24
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Events
OnZoomChanged;
Event called when zoom has changed. An OnZoomChanged event can occur when zooming with the
mouse, keyboard or with the map controls.
OnMapTypeChanged;
Event called when the map type has changed. An OnMapTypeChanged event can occur when the
map type is changed via the map type control.
OnMapClick;
Event called when the map is clicked.
OnMapDblClick;
Event called when the map is double clicked.
OnMapMouseUp;
Event called when the mouse is up on the map. (Occurs after an OnMapMouseDown event).
OnMapMouseDown;
Event called when the mouse is down on the map.
OnMapMouseMove;
Event called when the mouse is moved inside the map.
OnMapMouseEnter;
Event called when the mouse enters the map.
OnMapMouseLeave;
Event called when the mouse leaves the map.
OnMapMoveStart;
Event called when a map move actions is started.
OnMapMoveEnd;
Event called when a map move actions has ended.
25
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
OnMarkerClick;
Event called when a marker is clicked.
OnMarkerDblClick;
OnMarkerMouseUp;
Event called when the mouse is up on a marker. (Occurs after an OnMarkerMouseUp event).
OnMarkerMouseDown;
Event called when the mouse is down on a marker.
OnMarkerMouseEnter;
Event called when the mouse enters a marker.
OnMarkerMouseLeave;
Event called when the mouse leaves a marker.
OnPolyElementClick;
Event called when a polyelement (polygon, polyline, circle, rectangle) is clicked.
OnPolyElementDblClick;
OnPolyElementMouseUp;
Event called when the mouse is up on a polyelement. (Occurs after an OnPolyElementMouseUp
event).
OnPolyElementMouseDown;
Event called when the mouse is down on a polyelement.
OnPolyElementMouseEnter;
Event called when the mouse enters a polyelement.
OnPolyElementMouseLeave;
Event called when the mouse leaves a polyelement.
OnMapInitialized;
Event called when the map is initialized.
Common Types
During the development of your application with TTMSFNCMaps you’ll encounter the following
record types:
TTMSFNCMapsCoordinateRec
TTMSFNCMapsBoundsRec
26
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
They are types that allow easy conversion from the class type equivalents to pass through or
retrieve data from the map. They are defined inside the *.TMSFNCCommonTypes.pas unit and they
also come with a set of helper methods:
function CreateBounds(ACoordinatesArray:
TTMSFNCMapsCoordinateRecArrayArray): TTMSFNCMapsBoundsRec; overload;
Method that creates a bounds record based on an array of an array of coordinates (multi-array). This
is helpful when wanting to combine arrays of coordinates from different collections such as
combining markers & polylines.
function CreateBounds(ACoordinatesArrayArray:
TTMSFNCMapsCoordinateRecArrayArrayArray): TTMSFNCMapsBoundsRec; overload;
Method that creates a bounds record based on an array of an array of an array of coordinates (multi-
array of array). This is helpful when wanting to combine arrays of coordinates from different
collections such as combining markers & polylines.
27
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
28
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCGoogleMaps
Dragging Markers
After adding markers with the AddMarker function or directly through the Markers collection the
basic properties that can be set in the abstract TTMSFNCMaps class are the Visible, Title and
Coordinate properties. On top of that, the Google Maps API has the ability to add a drop animation,
make the marker draggable, clickable. For testing purposes we have added code that demonstrates
how to make a marker draggable.
procedure TForm1.AddDraggableMarker;
var
m: TTMSFNCGoogleMapsMarker;
begin
m :=
TTMSFNCGoogleMapsMarker(TMSFNCGoogleMaps1.AddMarker(DefaultCoordinate));
m.Draggable := True;
end;
When holding the mouse/finger down on the marker, a cross appears beneath and you are able to
freely drag around the marker. Releasing the mouse/finger will drop the marker to the new location
and trigger the OnMarkerDragEnd event.
In the OnMarkerDragEnd event you have 2 choices. Either leave the original coordinate store inside
the marker collection item, or synchronize. The synchronization will help in updating markers that
are already added to the map. When setting the coordinate of the marker to the new location, each
following update will not reset the marker to the original location, but to the new location. Leaving
out the code will reset the marker to the original location when another property changes.
29
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Editing Polyelements
Polyelements such as a polygon, polyline, rectangle and circle can be edited. To allow editing of a
polyelement, add the polyelement to the map as demonstrated in the previous chapter of adding
polyelements. Make sure to also specify the Editable property.
procedure TForm1.AddRectangleToMap;
var
c: TTMSFNCGoogleMapsRectangle;
b: TTMSFNCMapsBoundsRec;
ne, sw: TTMSFNCMapsCoordinateRec;
begin
TMSFNCGoogleMaps1.BeginUpdate;
ne := CalculateCoordinate(DefaultCoordinate, 45, 100000);
sw := CalculateCoordinate(DefaultCoordinate, 225, 100000);
b := CreateBounds(ne.Latitude, ne.Longitude, sw.Latitude, sw.Longitude);
c := TTMSFNCGoogleMapsRectangle(TMSFNCGoogleMaps1.AddRectangle(b));
c.Editable := True;
c.FillColor := gcOrange;
c.FillOpacity := 0.5;
c.StrokeColor := gcGreen;
c.StrokeWidth := 4;
TMSFNCGoogleMaps1.EndUpdate;
end;
When adding the rectangle to the map, you’ll notice that handles appear. These handles can be
used to change the rectangle. Whenever a change is detected the OnPolyElementEditEnd is called.
As this polyelement is a rectangle, the data is stored in the CustomData property of the
TTMSFNCMapsEventData object as it contains more than only a coordinate. The CustomData
contains an array of coordinates that can be mapped to the bounds property of the rectangle as
demonstrated in the code below. The CustomData is always JSON.
30
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Loading of KML layers is supported out of the box in Google Maps. Simply specify the URL of the KML
layer and Google Maps will do the rest. Below is a sample and the output of adding a KML layer.
TMSFNCGoogleMaps1.AddKMLLayer('https://developers.google.com/maps/documenta
tion/javascript/examples/kml/westcampus.kml');
An optional parameter (true by default) is to automatically zoom to the bounds of the loaded KML
layer. When executing the above code this is the result:
Clusters
Clustering is a nice feature of Google Maps that comes with a separate library
(MarkerClustererPlus). The library can be used to cluster markers together. To get started adding
clusters, first add a set of markers.
procedure TForm1.AddClusters;
var
locations: array of TTMSFNCMapsCoordinateRec;
I: Integer;
begin
locations := [
CreateCoordinate(-31.563910, 147.154312),
CreateCoordinate(-33.718234, 150.363181),
CreateCoordinate(-33.727111, 150.371124),
CreateCoordinate(-33.848588, 151.209834),
CreateCoordinate(-33.851702, 151.216968),
CreateCoordinate(-34.671264, 150.863657),
31
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
CreateCoordinate(-35.304724, 148.662905),
CreateCoordinate(-36.817685, 175.699196),
CreateCoordinate(-36.828611, 175.790222),
CreateCoordinate(-37.750000, 145.116667),
CreateCoordinate(-37.759859, 145.128708),
CreateCoordinate(-37.765015, 145.133858),
CreateCoordinate(-37.770104, 145.143299),
CreateCoordinate(-37.773700, 145.145187),
CreateCoordinate(-37.774785, 145.137978),
CreateCoordinate(-37.819616, 144.968119),
CreateCoordinate(-38.330766, 144.695692),
CreateCoordinate(-39.927193, 175.053218),
CreateCoordinate(-41.330162, 174.865694),
CreateCoordinate(-42.734358, 147.439506),
CreateCoordinate(-42.734358, 147.501315),
CreateCoordinate(-42.735258, 147.438000),
CreateCoordinate(-43.999792, 170.463352)];
TMSFNCGoogleMaps1.BeginUpdate;
for I := 0 to Length(locations) - 1 do
begin
TMSFNCGoogleMaps1.AddMarker(locations[I]);
end;
TMSFNCGoogleMaps1.EndUpdate;
end;
The second step is to add a cluster and bind the markers to a cluster. To add a cluster, use the
Clusters.Add method. Additionally, we also use a ZoomToBounds to visualize the clusters on the
map.
procedure TForm1.AddClusters;
var
locations: array of TTMSFNCMapsCoordinateRec;
I: Integer;
m: TTMSFNCGoogleMapsMarker;
begin
locations := [
CreateCoordinate(-31.563910, 147.154312),
32
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
CreateCoordinate(-33.718234, 150.363181),
CreateCoordinate(-33.727111, 150.371124),
CreateCoordinate(-33.848588, 151.209834),
CreateCoordinate(-33.851702, 151.216968),
CreateCoordinate(-34.671264, 150.863657),
CreateCoordinate(-35.304724, 148.662905),
CreateCoordinate(-36.817685, 175.699196),
CreateCoordinate(-36.828611, 175.790222),
CreateCoordinate(-37.750000, 145.116667),
CreateCoordinate(-37.759859, 145.128708),
CreateCoordinate(-37.765015, 145.133858),
CreateCoordinate(-37.770104, 145.143299),
CreateCoordinate(-37.773700, 145.145187),
CreateCoordinate(-37.774785, 145.137978),
CreateCoordinate(-37.819616, 144.968119),
CreateCoordinate(-38.330766, 144.695692),
CreateCoordinate(-39.927193, 175.053218),
CreateCoordinate(-41.330162, 174.865694),
CreateCoordinate(-42.734358, 147.439506),
CreateCoordinate(-42.734358, 147.501315),
CreateCoordinate(-42.735258, 147.438000),
CreateCoordinate(-43.999792, 170.463352)];
TMSFNCGoogleMaps1.BeginUpdate;
TMSFNCGoogleMaps1.Clusters.Add;
for I := 0 to Length(locations) - 1 do
begin
m :=
TTMSFNCGoogleMapsMarker(TMSFNCGoogleMaps1.AddMarker(locations[I]));
m.Cluster := TMSFNCGoogleMaps1.Clusters[0];
end;
TMSFNCGoogleMaps1.ZoomToBounds(TMSFNCGoogleMaps1.Markers.ToCoordinateArray)
;
TMSFNCGoogleMaps1.EndUpdate;
end;
33
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
To optionally use a custom text instead of the number of markers on a cluster icon, the Text
property can be used. Use %d to insert the marker count and the HTML character to avoid
word wrapping.
Example:
m.Clusters[0].Text := 'Markers: %d';
To optionally use custom images for clusters, the ImagePath property can be used.
Make sure the provided path is pointing to a folder that contains 5 png image files with the
following names: 1.png, 2.png, 3.png, 4.png and 5.png
Example:
The screensho shows 2 clusters that both contain 2 markers. One is displayed with the default image
(blue) and the other one is displayed with a custom image (orange).
34
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Events
OnClusterClick;
Event called when a cluster is clicked.
OnClusterMouseEnter;
Event called when the mouse enters a cluster.
OnClusterMouseLeave;
Event called when the mouse leaves a cluster.
OverlayViews
An overlayview is a layer that is placed on top of the map that contains HTML code. The overlayview
can be displayed at a specific location or within specific bounds to make it adapt to the map’s zoom
level.
Additionally, when connected to a marker, the overlayview can function as a marker label.
To connect an overlay to a marker, use the markers’ AddOverlayView and/or OverlayView property.
Properties
Bounds
Set the bounds NorthEast and SouthWest coordinates. Only used when Mode is set to omBounds.
BorderColor
Set the border color of the overlayview.
BackgroundColor
Set the backgroundcolor of the overlayview.
Clickable
Set if the OnOverlayViewClick event is triggered when the overlayview is clicked.
Coordinate
Set the location at which the overlayview is displayed. Only used when Mode is set to omCoordinate
and no marker is connected.
35
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
CoordinatePosition
Set the position of the overlayview relative to the Coordinate. Available options are: TopLeft,
TopCenter, TopRight, BottomLeft, BottomCenter, BottomRight, CenterLeft, CenterCenter,
CenterRight, Custom. Only used when Mode is set to omCoordinate.
CoordinateOffsetTop
Set the top offset relative to the overlayview’s position. Only used when Mode is set to
omCoordinate.
CoordinateOffsetLeft
Set the left offset relative to the overlayview’s position. Only used when Mode is set to
omCoordinate.
Font
Set the font color, name, size and style.
Height
Set the height of the overlayview. If set to -1 the height will autosize to the content.
Mode
Sets if the overlayview is displayed within the specified bounds (Bounds property) or at a specific
coordinate (Coordinate property). When a marker is connected this must be set to omCoordinate.
Padding
Sets the padding between the overlayview’s border and content.
Visible
Show or hide the overlayview.
Width
Set the width of the overlayview. If set to -1 the width will autosize to the content.
Events
OnOverlayViewClick;
Event called when an overlayview is clicked.
- Sample using OverlayView Bounds. The image remains within the specified bounds
regardless of map zoom level.
36
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
var
ov: TTMSFNCGoogleMapsOverlayView;
begin
TMSFNCGoogleMaps1.BeginUpdate;
37
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
ov := TMSFNCGoogleMaps1.AddOverlayView;
ov.Text := '<img src="https://storage.googleapis.com/geo-devrel-public-
buckets/newark_nj_1922-661x516.jpeg"
style="position:absolute;width:100%;height:100%;">';
ov.Bounds.NorthEast.Latitude := 40.773941;
ov.Bounds.NorthEast.Longitude := -74.12544;
ov.Bounds.SouthWest.Latitude := 40.712216;
ov.Bounds.SouthWest.Longitude := -74.22655;
ov.Mode := omBounds;
ov.Padding := 0;
ov.BackgroundColor := gcNull;
ov.BorderColor := gcNull;
TMSFNCGoogleMaps1.EndUpdate;
var
m: TTMSFNCGoogleMapsMarker;
ov: TTMSFNCGoogleMapsOverlayView;
begin
TMSFNCGoogleMaps1.BeginUpdate;
ov := TMSFNCGoogleMaps1.AddOverlayView;
ov.Text := 'Marker Label';
m :=
TTMSFNCGoogleMapsMarker(TMSFNCGoogleMaps1.AddMarker(TMSFNCGoogleMaps1.Optio
ns.DefaultLatitude, TMSFNCGoogleMaps1.Options.DefaultLongitude));
38
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
m.AddOverlayView('Marker Label');
TMSFNCGoogleMaps1.EndUpdate;
var
ov: TTMSFNCGoogleMapsOverlayView;
begin
TMSFNCGoogleMaps1.BeginUpdate;
ov := TMSFNCGoogleMaps1.AddOverlayView;
ov.Mode := omCoordinate;
ov.Coordinate.Latitude := 40.71;
ov.Coordinate.Longitude := -74.22;
ov.Width := 500;
ov.Text := '' +
'<h1 id="firstHeading" class="firstHeading">Uluru</h1>'+
'<div id="bodyContent">'+
'<p><b>Uluru</b>, also referred to as <b>Ayers Rock</b>, is a large '
+
'sandstone rock formation in the southern part of the '+
'Northern Territory, central Australia. It lies 335 km
(208 mi) '+
'south west of the nearest large town, Alice Springs; 450 km '+
'(280 mi) by road. Kata Tjuta and Uluru are the two major '+
'features of the Uluru - Kata Tjuta National Park. Uluru is '+
'sacred to the Pitjantjatjara and Yankunytjatjara, the '+
'Aboriginal people of the area. It has many springs, waterholes, '+
39
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TMSFNCGoogleMaps1.EndUpdate;
StreetView
Events
OnStreetViewChange
Event called each time the StreetView position changes.
The data is stored in the CustomData property of the TTMSFNCMapsEventData object as it contains
more than only a coordinate. The CustomData contains the updated values for the Heading, Pitch
and Zoom properties. The CustomData is always JSON.
40
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Geodesic Polylines
The Polyline’s Geodesic boolean property can be used to display a polyline as a geodesic line.
41
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Map Style
When using TTMSFNCGoogleMaps, you are able to specify a style to change the visuals of the map.
By default, the Options.MapStyle is empty. To specify a style, you need to assign JSON to the
Options.MapStyle property. There is a predefined night style available that can be used. To create
your own style, use the Map Style Creator at https://mapstyle.withgoogle.com/
TMSFNCGoogleMaps1.Options.MapStyle := MAPSTYLENIGHT;
Enabling traffic and bicycling layers is as simple as using the code below.
TMSFNCGoogleMaps1.Options.ShowTraffic := True;
TMSFNCGoogleMaps1.Options.ShowBicycling := True;
Integrated Directions
When using TTMSFNCGoogleMaps, it is possible to calculate step by step directions between two
locations.
42
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
AddDirections
Calculates and displays directions between “Origin” and “Destination” location specified with a
string address or a latitude and longitude coordinate.
Parameters:
Directions
Collection containing a list of previous requested directions.
Removing an item in the collection will automatically remove it from the map.
OnRetrievedDirectionsData
Event triggered when directions calculation was successful. A subset of the directions data is
available in ADirectionsData. The full directions data is available in AEventData.CustomData as a
JSON object.
43
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCOpenLayers
TileServer
When using TTMSFNCOpenLayers, you are able to specify a custom tileserver URL.
Options.TileServer
Specifies a custom tileserver URL used to display the map.
TileLayers
When using TTMSFNCOpenLayers, you are able to specify a list of tilelayers to display top of the
map layer.
TileLayers
A collection of tilelayers with an URL value and an optional Opacity value.
44
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
When using TTMSFNCOpenLayers, you are able to specify a label text for polylines and polygons.
The label text is displayed in the center of the polyline by default.
Label.Text
Sets the text of the label
Label.FontColor
Sets the font color of the label text
Label.FontSize
Sets the font size of the label text
Label.OffsetX
Sets the label’s X offset in pixels
Label.OffsetY
Sets the label’s Y offset in pixels
TTMSFNCMapKit
TTMSFNCMapKit is a descendant of TTMSFNCMaps and exposes extra functionality specific for the
MapKit JS API.
Map Rotation
Options.MapRotation
45
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
OnMapRotationChanged
Event triggered when the map’s rotation has changed. The new map rotation value is available in
AEventData.CustomData.
Integrated Directions
When using TTMSFNCMapKit, it is possible to calculate step by step directions between two
locations.
AddDirections
Calculates and displays directions between “Origin” and “Destination” location specified with a
string address or a latitude and longitude coordinate.
Parameters:
Directions
Collection containing a list of previous requested directions.
Removing an item in the collection will automatically remove it from the map.
OnRetrievedDirectionsData
Event triggered when directions calculation was successful. A subset of the directions data is
available in ADirectionsData. The full directions data is available in AEventData.CustomData as a
JSON object.
46
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCMapBox
TTMSFNCMapBox is a descendant of TTMSFNCMaps and exposes extra functionality specific for the
MapBox API.
Map Style
When using TTMSFNCMapBox, you are able to specify a style to change the visuals of the map.
Options.MapStyle
Programmatically set a specific map style.
TTMSFNCTomTom
TTMSFNCTomTom is a descendant of TTMSFNCMaps and exposes extra functionality specific for the
TomTom Maps API.
Map Style
When using TTMSFNCTomTom, you are able to specify a style to change the visuals of the map.
47
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Options.MapStyle
Programmatically set a specific map style.
48
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCGeocoding
Usage
Google
Here
Azure
Bing
TomTom
MapBox
OpenStreetMap Nominatim
Authorization information
Organisation
Properties
APIKey
Sets the API Key for the service
GeocodingRequests
Holds a list of geocoding/reversegeocoding results
Service
Indicates which service to use to retrieve geocoding/reversegeocoding information
Methods
Events
OnGetGeocoding
Triggered after calling GetGeocoding. Contains the results of the geocoding action. The
ARequest.Status and ARequest.ErrorMessage values can be used to review the status and error
message (if any) returned by the selected service. In case of multiple Geocoding calls, the
ARequest.ID value can be used to determine which call the results are associated with.
The data returned from the request can be found in the ARequest.Items collection.
49
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
OnGetReverseGeocoding
Triggered after calling GetReverseGeocoding. Contains the results of the reversegeocoding action.
The ARequest.Status and ARequest.ErrorMessage values can be used to review the status and error
message (if any) returned by the selected service. In case of multiple GetReverseGeocoding calls,
the ARequest.ID value can be used to determine which call the results are associated with.
The data returned from the request can be found in the ARequest.Items collection.
OnGetGeocodingResult
Triggered after calling GetGeocoding. Contains the results of the geocoding action.
The data returned from the request can be found in the AResult.Items collection.
OnGetReverseGeocodingResult
Triggered after calling GetReverseGeocoding. Contains the results of the reversegeocoding action.
The data returned from the request can be found in the AResult.Items collection.
Sample
public
TTMSFNCGeocoding1: TTMSFNCGeocoding;
procedure TTMSFNCGeocoding1GetGeocoding(Sender: TObject; const ARequest:
TTMSFNCGeocodingRequest; const ARequestResult:
TTMSFNCCloudBaseRequestResult);
50
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
public
TTMSFNCGeocoding1: TTMSFNCGeocoding;
TTMSFNCGeocoding1.GetGeocoding('New York',
procedure(const ARequest: TTMSFNCGeocodingRequest; const ARequestResult:
TTMSFNCCloudBaseRequestResult)
begin
FStartAddress := ARequest.Items[0].Coordinate.ToRec;
end
);
TTMSFNCGeocoding1.GetGeocoding('Philadelphia',
procedure(const ARequest: TTMSFNCGeocodingRequest; const ARequestResult:
TTMSFNCCloudBaseRequestResult)
begin
FEndAddress := ARequest.Items[0].Coordinate.ToRec;
end
);
end;
51
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCUtils.Log(AResult.Items[0].City);
TTMSFNCUtils.Log(AResult.Items[0].PostalCode);
TTMSFNCUtils.Log(AResult.Items[0].Region);
TTMSFNCUtils.Log(AResult.Items[0].Country);
end;
end;
52
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCDirections
Usage
TTMSFNCDirections is a component for retrieving directions, route information and step by step
instructions for origin and destination coordinates by using an existing REST API service. The
component can be used in combination with TTMSFNCGeocoding to retrieve directions between an
origin and destination address.
Google
Here
Azure
Bing
TomTom
MapBox
Note: Google Directions is not supported on WEB due to technical limitations of the service.
Authorization information
API Key
Organisation
Properties
APIKey
Sets the API Key for the service
DirectionsRequests
Holds a list of directions results
Service
Indicates which service to use to retrieve directions
Methods
Optional parameters:
AAlternatives: indicates if alternative routes are included in the results
- tmDriving
53
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
- tmWalking
- tmBicycling (only available for Azure, Google, Here, MapBox, TomTom)
- tmPublicTransport (only available for Bing, Google, Here)
- tmTruck (only available for Azure, Here, TomTom)
If a TravelMode is selected that is unavailable for the currently active service, the option will revert
to the default mode (tmDriving). The TravelMode that was used is returned in the OnGetDirections
event.
Events
OnGetDirections
Triggered after calling GetDirections. Contains the results of the directions request. The
ARequest.Status and ARequest.ErrorMessage values can be used to review the status and error
message (if any) returned by the selected service. In case of multiple GetDirections calls, the
ARequest.ID value can be used to determine which call the results are associated with.
The TravelMode that was used to determine the directions is returned in the
ARequestResult.TravelMode value.
Sample
public
TTMSFNCDirections1: TTMSFNCDirections;
procedure TMSFNCDirections1GetDirections(Sender: TObject; const ARequest:
TTMSFNCDirectionsRequest; const ARequestResult:
TTMSFNCCloudBaseRequestResult);
54
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
its: TTMSFNCDirectionsItems;
it: TTMSFNCDirectionsItem;
I: Integer;
begin
TMSFNCMaps1.BeginUpdate;
its := ARequest.Items;
for I := 0 to its.Count - 1 do
begin
it := its[I];
if ARequest.ID = 'myroute' then
begin
if it.Coordinates.Count > 0 then
TMSFNCMaps1.AddPolyline(it.Coordinates.ToArray).StrokeColor :=
gcRed;
end;
end;
TMSFNCMaps1.EndUpdate;
end;
55
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCLocation
Usage
Google
IPStack
Authorization information
API Key
Organisation
Properties
APIKey
Sets the API Key for the service
LocationRequests
Holds a list of location results
Service
Indicates which service to use to retrieve the location
Connection
Indicates if an HTTP or HTTPS connection should be used when the Service is set to IPStack.
Note that the free tier for the IPStack service only supports HTTP.
Methods
Events
OnGetLocation
Triggered after calling GetLocation. Contains the results of the location request. In case of multiple
GetLocation calls, the ARequest.ID value can be used to determine which call the results are
associated with.
Sample
public
TTMSFNCLocation1: TTMSFNCLocation;
56
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
57
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCElevation
Usage
TTMSFNCElevation is a component for retrieving the elevation for a specified geographical location
by using an existing REST API service.
Google
MapQuest
AirMap (no API Key required)
Authorization information
API Key
Organisation
Properties
APIKey
Sets the API Key for the service
ElevationData
Holds a list of elevation results. The data remains available between GetElevation calls until
ClearElevationData is called.
Service
Indicates which service to use to retrieve the elevation
Methods
procedure ClearElevationData;
Removes all data from ElevationData.
Events
OnGetElevation
Triggered after calling GetElevation. The returned data is contained in ElevationData together with
58
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Sample
public
co: TTMSFNCMapsCoordinateRec;
TMSFNCElevation1: TTMSFNCElevation;
procedure TTMSFNCElevation1GetElevation(Sender: TObject; const
ARequest: TTMSFNCElevationRequest; const ARequestResult:
TTMSFNCCloudBaseRequestResult);
TMSFNCElevation1 := TTMSFNCElevation.Create(Self);
TMSFNCElevation1.OnGetElevation := TTMSFNCElevation1GetElevation;
TMSFNCElevation1.APIKey := 'abc123';
TMSFNCElevation1.Service := esGoogle;
TMSFNCElevation1.GetElevation(co);
end;
59
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCTollCost
Usage
TTMSFNCTollCost is a component for retrieving route toll cost information for origin and destination
coordinates by using an existing REST API service. The component can be used in combination with
TTMSFNCGeocoding to retrieve toll cost between an origin and destination address.
Here
PTV xServer
Authorization information
Organisation
Properties
APIKey
Sets the API Key for the service (Here only)
UserName
Sets the username for the service (PTV xServer only)
Token
Sets the token for the service (PTV xServer only)
ServiceEndPoint
Sets a custom endpoint for the service (PTV xServer only). If left empty the default EU test
environment endpoint is used.
TollCostRequests
Holds a list of toll cost results
Notes:
- Prices returned by Here include VAT while prices returned by PTV xServer do not include
VAT
- Currency returned by Here is taken from the GetTollCost ACurrency parameter; PTV xServer
returns the local currency relative to the origin and destination location.
- Steps[].Distance is the actual step distance in meters for Here and the distance in meters
from the starting point for PTV xServer
- Steps[].Duration is the actual step duration in seconds for Here and the duration from the
starting point for PTV xServer
Service
Indicates which service to use to retrieve toll cost information
Methods
60
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Optional parameters:
- tmCar
- tmDeliveryVan
- tmLightTruck
- tmHeavyTruck
Events
OnGetTollCost
Triggered after calling GetTollCost. Contains the results of the toll cost request. The
ARequest.Status and ARequest.ErrorMessage values can be used to review the status and error
message (if any) returned by the selected service. In case of multiple GetTollCost calls, the
ARequest.ID value can be used to determine which call the results are associated with.
Sample
public
TMSFNCTollCost1: TTMSFNCTollCost;
procedure TMSFNCTollCost1GetTollCost(Sender: TObject;
const ARequest: TTMSFNCTollCostRequest;
const ARequestResult: TTMSFNCCloudBaseRequestResult);
61
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
62
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCStaticMap
Usage
TTMSFNCStaticMap is a component for retrieving an URL to a static map image for a specified
geographical location by using an existing API service.
Note: The TTMSFNCMapsImage component can be used to display the static map image URL and/or
to save the image to a local file.
Azure
Bing
Google
Here
MapBox
TomTom
Authorization information
API Key
Organisation
Properties
APIKey
Sets the API Key for the service
Service
Indicates which service to use to retrieve the static map image URL
Methods
function GetStaticMap(AAddress: string; AWidth: Single = 640; AHeight: Single = 480; AZoom: Single
= 10; AShowMarker: Boolean = True; AMapType: TTMSFNCStaticMapType = mtDefault): string;
Returns a static map image URL based on the provided parameter values.
Notes:
- ACoordinate and AAdress are mutually exclusive parameters
- AAddress is only available for Google and Here
- The TTMSFNCGeocoding component can be used to convert a given address to a coordinate
63
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
The minimum and maximum map image size in pixels as indicated by the respective services:
Sample
procedure TForm1.GetCenterCoordinate;
begin
TMSFNCGeocoding1.GeocodingRequests.Clear;
TMSFNCGeocoding1.GetGeocoding('New York');
end;
64
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCMapsImage
Usage
TTMSFNCMapsImage is an Image component that can automatically retrieve an image from an URL
and display it on the form. It supports BMP, PNG, GIF, ICO, JPEG formats.
Organisation
Properties
URL
Sets the URL where to retrieve the image from
Samples
- Save the remote image referenced by the URL property value to a local image file
TMSFNCMapsImage1.GetBitmap.SaveToFile('c:\image.png');
65
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCTimeZone
Usage
TTMSFNCTimeZone is a component for retrieving time zone information for a specified geographical
location by using an existing API service.
Azure
Bing
Google
Here
Authorization information
API Key
Organisation
Properties
APIKey
Sets the API Key for the service
Service
Indicates which service to use
TimeZoneRequests
A collection containing the results of the GetTimeZone calls.
Note
The time zone information content depends on the selected service.
Not all services return a description and/or a DST offset. While Google returns the time offset in
seconds, other services return a formatted time string.
Methods
Initiates a TimeZone request with the selected service based on the provided geographical location.
The OnGetTimeZone event is triggered after the request has finished and the result data is
contained in the TimeZoneRequests collection.
Notes
- ACoordinate and AAdress are mutually exclusive parameters
- AAddress is only available for Here and Bing services
66
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
ACoordinate: Indicates the geographical location to request the time zone for
AAddress: Indicates the address to request the time zone for
ADateTime: Indicates a specific date and time to calculate the time zone for. If no value is specified
the current date and time are used (Google and Bing only)
ALocale: Indicates the locale used for the time zone information (Google only)
Sample
67
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TTMSFNCRouteCalculator
Usage
Azure
Bing
Google
Here
MapBox
68
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Note: Google Directions is not supported on WEB due to technical limitations of the service.
Note
Currently supported mapping services usable in combination with TTMSFNCRouteCalculator are:
Google
Here
OpenLayers
Authorization information
API Key
Organisation
Properties
APIKey
Sets the API Key for the service
Service
Indicates which service to use
Active
Indicates that the TTMSFNCRouteCalculator can be used by interacting with the connected
TTMSFNCMaps
Options
- AvoidTolls: Avoid toll roads when calculating routes
- IncludeAlternativeRoutes: Include alternative routes when calculating routes.
Note:
The alternative routes are returned with the OnGetRouteDirections event, they are not
included in the Routes collection.
69
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Routes
A collection of currently available routes
HistoryManager
Manages the history of the current route.
Use HistoryManager.Undo to reverse the last change and HistoryManager.Redo to restore the last
change that was reversed by Undo.
Methods
Note:
Methods that rely on HTTP requests to a REST API service are executed asynchronously. When the
request is finished an event (see below) is triggered. Alternatively you can use an anonymous
method in combination with the ACallback parameter.
Provide the start and end addres or start and end coordinate to create a new route.
Add an extra segment to an existing route by providing a new end address or end coordinate.
70
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Update the specified segment of an existing route by providing a new start and end address or start
and end coordinate.
Update the specified segment of an existing route by providing a new start address.
Update the specified segment of an existing route by providing a new end address or end
coordinate.
Get directions data for the provided origin and destination coordinates.
71
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Get the current physical location of the device. With AMode set to lmDevice, use a TLocationSensor
to determine the location. With AMode set to lmService, use the Google REST API service to
determine the location.
Export an exsiting route to GPX data stream, file or text. Optionally provide extra metadata.
Events
OnGetGeocoding
Triggered after calling GetGeocoding
OnGetDirections
Triggered after calling GetDirections
OnGetRouteGeocoding
Triggered after geocoding is used in a call to CalculateRoute
OnGetRouteDirections
Triggered after directions are used in a call to CalculateRoute
72
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
OnCalculateRoute
Triggered after a call to CalculateRoute, AddRouteSegment, AddRouteWayPoints,
UpdateRouteSegment and DeleteRouteSegment
OnCreateGPXTrack
Triggered during GPX import each time a track (route) is added
OnCreateGPXSegment
Triggered during GPX import each time a route segment is added
OnLoadGPXRouteComplete
Triggered after GPX import is complete
OnGetLocation
Triggered after a call to GetCurrentLocation
Note
Currently supported mapping services usable in combination with TTMSFNCRouteCalculator are:
Google
Here
OpenLayers
Getting started
Use the TMSFNCMaps.RouteCalculator property to assign a TTMSFNCRouteCalculator component.
Set TMSFNCRouteCalculator.Active to True to enable map interaction.
Set TMSFNCRouteCalculator.Options.EnableHistoryManager to True to enable undo/redo
functionality.
Programmatic usage
Methods
procedure RouteCalculatorPlotRoute(ARoute: TTMSFNCRouteCalculatorRoute); virtual;
Display the provided TTMSFNCRouteCalculatorRoute on the map. If the route is already displayed on
the map it will be updated to reflect the latest route settings.
73
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Events
OnRouteCalculatorWayPointAdded
Triggered when a click on the map occurs and a new waypoint is added to the RouteCalculator
Route or when an existing polyline is dragged to insert a new waypoint.
OnRouteCalculatorWayPointUpdated
Triggered when a waypoint marker is dragged to a new location and an existing RouteCalculator
waypoint is updated.
OnRouteCalculatorPolylineAdded
Triggered when a click on the map occurs and a new segment is added to the RouteCalculator Route
or when an existing polyline is dragged to insert a new waypoint.
OnRouteCalculatorPolylineUpdated
Triggered when a waypoint marker is dragged to a new location and an existing RouteCalculator
segment is updated.
OnRouteCalculatorBeforeDeletePolyline
Triggered when an existing route segment (represented by a polyline on the map) is about to get
deleted.
OnRouteCalculatorAfterDeletePolyline
Triggered after an existing route segment (represented by a polyline on the map) has been deleted.
OnRouteCalculatorBeforeDeleteMarker
Triggered when an existing route waypoint (represented by a marker on the map) is about to get
deleted.
OnRouteCalculatorAfterDeleteMarker
Triggered when an existing route waypoint (represented by a marker on the map) has been deleted.
Properties
RouteCalculatorSelectedMarker
Get the currently selected waypoint (represented by a marker on the map) if any.
RouteCalculatorSelectedPolyline
Get the currently selected segment (represented by a polyline on the map) if any.
74
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Sample
TMSFNCRouteCalculator1.Active := True;
TMSFNCRouteCalculator1.Options.HistoryEnabled := True;
TMSFNCRouteCalculator1.Service := csGoogle;
TMSFNCRouteCalculator1.APIKey := APIKey;
TMSFNCMaps1.RouteCalculator := TMSFNCRouteCalculator1;
TMSFNCMaps1.Service := msGoogleMaps;
TMSFNCMaps1.APIKey := APIKey;
end;
75
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
TMS FNC Maps bundles all our expertise with using mapping services, with writing cross-platform
and cross-framework Delphi code as well as building components for TMS WEB Core web client
applications. From the beginning, we made the radical decision to base this work on the new
operating system browser Edge Chromium from Microsoft for the Windows platform (where we
already use Safari for iOS and macOS and Chrome for Android). From the very beginning of this
development, our chief evangelist Dr. Holger Flick was involved and could play with internal
versions and give feedback and steer the development.
If you want to integrate mapping services' functionality such as from Google Maps, Bing Maps,
Openstreet Maps, Here maps, TomTom maps, Azure maps in a Windows VCL application, a cross
platform FireMonkey application or a TMS WEB Core web client application, TMS FNC Maps addresses
it all and the new book covers developing with TMS FNC Maps in great detail over close to 400
pages.
Content
- Get to know the FNC framework, FNC Core, and FNC Maps in a nutshell.
- Learn about FNC Maps in detail: You will find dozens of hands-on examples from installation
to modern multi-tier applications with large databases, web services, web, and desktop
clients.
- Annotate maps and visualize data using markers with clustering, lines, shapes, pop-up
windows and routes.
- Build applications that can handle any geographical data and interact with other Geographic
Information Services (GIS). Load GPX tracks from GPS devices, GeoJSON shapes, and Google
Earth-specific KML layers.
- Include other mapping services to get directions with turn-by-turn instructions, to geocode
addresses, and to determine your geolocation.
- Create reports with a customizable template based on data from maps and databases.
- Allow users to freely customize maps using events or interactive markers and shapes.
TMS FlexCel
TMS FNC Core
TMS VCL UI Pack
76
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
How to order
Amazon USA
Amazon UK
Amazon Germany
77
TMS SOFTWARE
TMS FNC Maps
DEVELOPERS GUIDE
Terms of use
With the purchase of TMS FNC Maps, you are entitled to our consulting and support services to
integrate the supported services in Delphi applications and with this consulting and support comes
the full source code needed to do this integration. As TMS FNC Maps uses the supported services you
are bound to the terms of these services that can be found at:
TMS software is not responsible for the use of TMS FNC Maps components. The purchase of TMS FNC
Maps does not include any license fee that you might possibly be required to pay to the supported
services. It will depend on your type of usage of these services whether a license fee needs to be
paid.
It is the sole responsibility of the user or company providing the application that integrates the
terms and conditions of the supported services. TMS software does not take any responsibility nor
indemnifies any party violating the terms and conditions of the supported services.
We cannot guarantee that a 3rd party service will approve or allow the use of the services used in
TMS FNC Maps components in your application(s) now or at any time in the future. This is up to the
3rd party service provider to decide and not under our control. In case the 3 rd party service provider
makes changes to the conditions for using the service, the API itself or anything else that causes an
incompatibility with our component implementations, tmssoftware.com will do its best to
accommodate the changes but cannot be forced in any way or within any timeframe to do so and
might be technically limited to do so.
Limited warranty
TMS software cannot guarantee the current or future operation and uptime of the supported
services.
TMS software offers the consulting and support for TMS FNC Maps in good faith that the supported
services are reliable and future-proof.
In no case, TMS software shall offer refunds or any other compensation in case the supported
services terms/operation changes or stops.
78