Differences

This shows you the differences between two versions of the page.

--- en:help:v2:maps:on-demand-create [2021/03/27 11:22] – [Custom variables] alpinequest
+++ en:help:v2:maps:on-demand-create [2021/05/03 18:02] – [Basic example] alpinequest
@@ Line 35: / Line 35: @@
 Note that the application will recognize the ''**{$x}**'', ''**{$y}**'' and ''**{$z}**'' variable and replace them with correct values.
-The source ''"**id**"'' field must be unique in the file, and contains only characters and numbers. It is used internally by the application to identify the data storage of the map.
+The source ''"**id**"'' field must be unique in the file, and should only contain characters and numbers. It is used internally by the application to identify the data storage of the map.
 \\
@@ Line 75: / Line 75: @@
 </aqx>
 </file>
+The optional ''"**type**"'' attribute allows to define the type of the map. If no preview is available, the application will use common preview based on the map type. Can be one of ''"**roads**"'', ''"**topo**"'', ''"**satellite**"'', ''"**hybrid**"'', ''"**nautical**"'', ''"**aeronautical**"'', ''"**historical**"'', ''"**hillshade**"'', ''"**contours**"''.
 An ''**<outline>**'' tag (pairs of longitudes/latitudes, space separated) can be used to define the area covered by the map. When the map is selected while another area is displayed, the application will ask the user if he wants to move the map over the covered area.
@@ Line 83: / Line 85: @@
 The ''**<update-delay>**'' tag indicates after how many time the stored map data should be updated if it's used again. The default is ''**None**'', meaning the application will never try to update the stored data. Must end with ''**D**'' (number of days), ''**W**'' (weeks), ''**M**'' (months) or ''**Y**'' (years). For example, ''**3M**'' means 3 months. Use ''**0D**'' to force the application to update the data on each display.
-The optional ''"**type**"'' attribute allows to define the type of the map. If no preview is available, the application will use common preview based on the map type. Can be one of ''"**roads**"'', ''"**topo**"'', ''"**satellite**"'', ''"**hybrid**"'', ''"**nautical**"'', ''"**aeronautical**"'', ''"**historical**"'', ''"**hillshade**"'', ''"**contours**"''.
+You can limit the number of threads used to download the map using the ''**<max-threads>**'' tag. The default and maximum value is ''**3**''.
+The ''**<key-url>**'' tag can be used to provide a link to the key (legend) of the map. The map key is available from the menu of a map.
+The ''**<user-agent>**'' and ''**<referer>**'' tags allow you to specify what is sent in the HTTP get headers when contacting the map server.
 ==== Map layer ====
@@ Line 114: / Line 121: @@
   </source>
 </code>
-\\
-===== Custom variables =====
-\\
-In addition to the variables provided by default, you can create your own variables defined by mathematical expressions:
-<code xml>
-  <source id="MAP03">
-    <name>Custom Variables Map Example</name>
-    <zoom-levels z="3,5,7,8,9,10,11,12,13,14,15,16,17">
-      <expression set="my_variable" type="int">iif( z>10, x*y, x+y )</expression>
-      <server><![CDATA[https://map.example.com/tiles/{$my_variable}.png]]></server>
-    </zoom-levels>
-  </source>
-</code>
-The ''"**set**"'' attribute defines the name of the custom variable, the ''"**type**"'' attribute tells how to display the variable (either ''"**int**"'', ''"**long**"'', ''"**float**"'' or ''"**double**"'').
-Most common functions and operators can be used, for example ''"**abs(x)**"'', ''"**sqrt(x)**"'', ''"**hypot(x,y)**"'', ''"**cos(x)**"'', ''"**charat(str,index)**"'', ''"**replace(str,target,replace)**"'', ''"**deg_to_rad(x)**"'', ''"**dist_eucl(x1,y1,x2,y2)**"'', ''"**md5(str)**"'', ''"**rand_uni()**"'', ''"**quadtree(x,y,z)**"'', etc.
 \\
@@ Line 202: / Line 189: @@
 ===== Advanced features =====
-==== How to make a color or a color range transparent? ====
+==== Custom variables ====
+\\
+In addition to the variables provided by default, you can create your own variables defined by mathematical expressions:
+<code xml>
+  <source id="MAP03">
+    <name>Custom Variables Map Example</name>
+    <zoom-levels z="3,5,7,8,9,10,11,12,13,14,15,16,17">
+      <expression set="my_variable" type="int">iif( z>10, x*y, x+y )</expression>
+      <server><![CDATA[https://map.example.com/tiles/{$my_variable}.png]]></server>
+    </zoom-levels>
+  </source>
+</code>
+The ''"**set**"'' attribute defines the name of the custom variable, the ''"**type**"'' attribute tells how to display the variable (either ''"**int**"'', ''"**long**"'', ''"**float**"'' or ''"**double**"'').
+Most common functions and operators can be used, for example ''"**abs(x)**"'', ''"**sqrt(x)**"'', ''"**hypot(x,y)**"'', ''"**cos(x)**"'', ''"**charat(str,index)**"'', ''"**replace(str,target,replace)**"'', ''"**deg_to_rad(x)**"'', ''"**dist_eucl(x1,y1,x2,y2)**"'', ''"**md5(str)**"'', ''"**rand_uni()**"'', ''"**quadtree(x,y,z)**"'', etc.
+[[en:help:v2:maps:on-demand-create#inline_expressions|See here for more details on available operators and functions.]]
+\\
+==== Global parameters ====
+\\
+You can declare parameters at the file level, which may be useful to store a key or a token that is used in multiple places within the file.
+<code xml>
+<?xml version="1.0" encoding="utf-8" ?>
+<aqx version="9">
+  <name>Test global parameter</name>
+  <param name="key">8451-5814-5311</param>
+  <source id="MAP01">
+    <name>Map 1</name>
+    <zoom-levels z="5,6,7,8,9,10,11,12,13,14,15">
+      <server><![CDATA[https://example.server.com/style1/{$z}/{$x}/{$y}?token={$param:key}]]></server>
+    </zoom-levels>
+  </source>
+  <source id="MAP02">
+    <name>Map 2</name>
+    <zoom-levels z="5,6,7,8,9,10,11,12,13,14,15">
+      <server><![CDATA[https://example.server.com/style2/{$z}/{$x}/{$y}?token={$param:key}]]></server>
+    </zoom-levels>
+  </source>
+</aqx>
+</code>
+\\
+==== Make a color or a color range transparent ====
 \\
 You can make a color become transparent (erase the color) of any map. Just specify the RGB values of the color:
@@ Line 230: / Line 270: @@
 \\
+==== Send cookies or headers to the map server ====
-==== How to send cookies or headers to the map server? ====
 \\
 You can send headers using the ''**<header>**''" tag and cookies using the ''**<cookies>**'' tag, as shown in the example below:
@@ Line 261: / Line 300: @@
 \\
-=== List of available operators ===
+=== List of operators ===
 ^ Operator  ^ Note  ^
@@ Line 269: / Line 309: @@
 |  ''**/**''  | Division operator.  |
 |  ''**%**''  | Remainder operator.  |
+|  ''**^**''  | Power operator.  |
 |  ''**==**''  | Equal to operator (also used for string).  |
-|  ''**>=**''  | Greater than or equal to operator.  |
+|  ''**!=**'' <sup>1</sup>  | Not equal to operator (also used for string).  |
-|  ''**-**''  | Subtraction operator.  |
+|  ''**>**''  | Greater than operator.  |
-|  ''**-**''  | Subtraction operator.  |
+|  ''**> =**''  | Greater than or equal to operator.  |
-|  ''**-**''  | Subtraction operator.  |
+|  ''**<**''  | Less than operator.  |
-|  ''**-**''  | Subtraction operator.  |
+|  ''**< =**''  | Less than or equal to operator.  |
+|  ''**&&**''  | Conditional AND operator.  |
+|  ''**||**''  | Conditional OR operator.  |
+|  ''**!**''  | Logical complement operator.  |
+|  ''**< <**''  | Signed left shift operator.  |
+|  ''**> >**''  | Signed right shift operator.  |
+<sup>1. Available from AQ 2.2.8c</sup>
-\\
+=== List of variables ===
+^ Variable  ^ Note  ^
+|  ''**c**''  | The speed of light in vacuum.  |
+|  ''**e**''  | Euler's number.  |
+|  ''**h**''  | Planck's constant.  |
+|  ''**k**''  | Boltzmann's constant.  |
+|  ''**pi**''  | The number ''π''.  |
+|  ''**q**''  | The elementary charge.  |
-=== List of available functions ===
+=== List of common functions ===
 ^ Function  ^ Return type  ^ Note  ^
@@ Line 302: / Line 358: @@
 | ''**replace**(string,string,string)''  | ''string''  | Replaces each substring of a string (first parameter) that matches the literal target sequence (second parameter) with the specified literal replacement sequence (third parameter).  |
 | ''**round**(double)''  | ''long''  | Returns the closest long to the argument, with ties rounding to positive infinity.  |
-| ''**sin**(double)<sup>1</sup>''  | ''double''  | Returns the trigonometric sine of an angle.  |
+| ''**sin**(double)'' <sup>1</sup>  | ''double''  | Returns the trigonometric sine of an angle.  |
 | ''**sqrt**(double)''  | ''double''  | Returns the correctly rounded positive square root of a double value.  |
 | ''**substr**(string,long)''  | ''string''  | Returns a string that is a substring of the string given in the first parameter. The substring begins with the character at the index specified by the second parameter and extends to the end of the string.  |
@@ Line 315: / Line 371: @@
 | ''**valueAt**(long,mixed...)''  | ''mixed''  | Returns the value at the index (starting from zero after the first parameter) specified by the first parameter.  |
 <sup>1. Available from AQ 2.2.8c</sup>
+=== List of specialized functions ===
+^ Function  ^ Return type  ^ Note  ^
+| ''**deg_to_rad**(double)''  | ''double''  | Converts from degrees to radians.  |
+| ''**dist_eucl**(double,double,double,double)''  | ''double''  | Computes the Euclidean distance between to points ''x1'' (first parameter), ''y1'' (second parameter) and ''x2'' (third parameter), ''y2'' (fourth parameter) as defined by ''hypot( (x2-x1), (y2-y1) )''.  |
+| ''**md5**(string)''  | ''string''  | Returns the [[https://en.wikipedia.org/wiki/MD5|MD5 hash]] of the string parameter.  |
+| ''**quadtree**(long,long,long)''  | ''string''  | Combines the x (first parameter), x (second parameter) and zoom (third parameter) values into a one-dimensional [[https://docs.microsoft.com/en-us/bingmaps/articles/bing-maps-tile-system?redirectedfrom=MSDN#tile-coordinates-and-quadkeys|quadtree key string]].  |
+| ''**rad_to_deg**(double)''  | ''double''  | Converts from radians to degrees.  |
+| ''**rand_uni**()''  | ''double''  | Returns a double value with a positive sign, greater than or equal to ''0.0'' and less than ''1.0''. Returned values are chosen pseudorandomly with (approximately) uniform distribution from that range.  |