MapDetails |
|
|
|
|
MapDetails |
|
|
|
MapDetails |
|
|
|
|
MapDetails |
|
|
|
A MapDetails record consists of the following variables:-
Name |
Type |
Content |
|---|---|---|
MapWidth |
Integer |
The Width of the required map in pixels, minimum is 128 maximum is 2048 |
MapHeight |
Integer |
The Height of the required map in pixels, minimum is 128 maximum is 1920 |
DisplayFlags |
Long |
The display flags used to configure the map see the explanation under this table |
ArgbOceanColour |
String |
The colour of the Ocean area of the map in ARGB format, see below |
ArgbLandColour |
Double |
The colour of the Land area of the map in ARGB format, see below |
ArgbLandBorderColour |
Double |
The colour of the Land border in ARGB format, see below |
ArgbRhumbLineColour |
Double |
The colour of the Rhumb line legs of the distance in ARGB format, see below |
ArgbGcLineColour |
Double |
The colour of the Greate Circle line legs of the distance in ARGB format, see below |
RouteLineWidth |
Integer |
The width of the route lines in pixels |
PortNameFont |
String |
The name of the font to use for the Port names. |
PortNameFontSize |
Integer |
The size of the font in points |
ArgbPortNameFontColour |
String |
The colour of the font in ARGB format, see below |
DisplayFlags
The individual 'bits' of this 32 bit long value are used to control various map properties. The demo program has a class that wraps this single value.
If you do have this capability in your programming interface, the values for each flag are displayed below.
Numeric Value |
Flag |
|---|---|
1 |
Show the (S)ECA map overlay |
2 |
Show the Loadline Zone overlay |
4 |
Reserved |
8 |
Reserved |
16 |
Show the from and to port names |
32 |
Show significant waypoints |
64 |
Zoom the map to the extent of the route |
128 |
Return the map in Jpeg format |
256 |
Return the map in Gif format |
512 |
Return the map in PNG format |
1024 |
Show the Indian Ocean Piracy Zone overlay |
As an example, assuming we want a map zoomed to the route, showing the Sec/Eca areas, Port names and the waypoints and have the map returned as a GIF image, we would pass a value of 369 which is 1 + 16 + 32 + 64 + 256
All values are in the range 0 - 255
The RGB colour model is an additive colour model in which red, green, and blue light is added together in various ways to reproduce a broad array of colours. The name of the model comes from the initials of the three additive primary colours, Red, Green, and Blue.
The ARGB format extends this by adding an Alpha value that controls opacity. 0 is fully transparent whilst 255 is fully opaque.
The web service supports both the RGB format and the ARGB format, thus for fully opaque colours the string will consist of 3 values separated by commas, adding the Alpha component would mean 4 numbers separated by commas with the Alpha component coming first.
Examples:-
Solid RED colour |
255,0,0 |
Solid GREEN colour |
0,255,0 |
Solid BLUE colour |
0,0,255 |
Semi transparent BLUE/GREEN colour |
127,0,255,255 |
Lightly transparent BROWN colour |
192,166,164,117 |
