[Map:]
Inserts a map into the report.
Compatibility
The macro can be used in all input document types and in Report Studio.
Parameters
(26)
Behaviour (9)
| Parameter | Type | Presence | Purpose | Options | Default |
| List<ExecutionResult> | Optional | If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: 'Unknown', 'Success', 'MacroError', 'WorkerStopped', 'Running', 'Warning', 'NeverRun', 'Cancelled', 'Pending', 'Paused', 'SystemError', 'Deferred' and 'Stopped'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| String | Optional | If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type. | N/A | N/A | |
| String | Optional | If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared. | N/A | N/A | |
| String | Optional | The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z')". | N/A | true | |
| Boolean | Optional | Whether to skip markers where no location can be resolved. |
|
true | |
| MacroMode | Optional | The mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
Legacy | |
| ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |
| String | Optional | If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression. | N/A | N/A |
Formatting (4)
| Parameter | Type | Presence | Purpose | Options | Default |
| Int32 | Optional | The map height in pixels, as laid out in the document. The number of pixels actually rendered is this multiplied by the scale parameter. |
|
640 | |
| Double | Optional | The percentage width of the page to fill with the graph. |
|
100 | |
| Int32 | Optional | The map width in pixels, as laid out in the document. The number of pixels actually rendered is this multiplied by the scale parameter. |
|
640 | |
| Int32 | Optional | The zoom level. |
|
10 |
Chart (4)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The marker color to use (unless overridden). You need to specify the markers parameter before this parameter will apply. |
|
red | |
| Char | Optional | Default marker label (unless overridden). You need to specify the markers parameter before this parameter will apply. Options are a-z, A-Z, 0-9 and full stop (.) | N/A | . | |
| List<String> | Optional | markers: A semicolon-separated list of markers for locations of interest. These can be any location that resolves (town names, postcodes/zip codes etc). It is also possible to specify marker color, label and size by adding carats ('^') as follows: Rome^red^R^mid, where Rome is the location, red is the colour, and mid is the marker size. Supported colours (Default is red):
Using the caret separator format may override markerColor, markerSize and markerLabel for the marker specified. |
N/A | N/A | |
| MapMarkerSize | Optional | The default marker size (unless overridden). You need to specify the markers parameter before this parameter will apply. |
|
Mid |
Output (2)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |
| String | Optional | The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message. | N/A | N/A |
General (7)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Mandatory | The location to display. This must resolve to a location (regardless of the ignoreUnknownLocations parameter). | N/A | N/A | |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
| String | Optional | The description for visually-impaired users: the image's alternative text in Word and PDF output. A PDF viewer also shows it when the mouse hovers over the image. | N/A | N/A | |
| MapType | Optional | The map type (hybrid(default), roadmap, satellite, terrain). Note that satellite and hybrid render the road style: no openly-licensed global satellite imagery exists. |
|
Hybrid | |
| List<String> | Optional | Undocumented feature. | N/A | N/A | |
| Int32 | Optional | The pixel density multiplier. The map is rendered at width x scale by height x scale pixels, but is still laid out at width by height, so a higher scale gives a sharper map at the same size on the page. Use 2 for print-quality output. The rendered area may not exceed 8 megapixels. |
|
2 | |
| String | Optional | The image title for visually-impaired users. | N/A | N/A |
Examples (9)
Example 1
[Map: location=London]Example 2
[Map: location=Sheffield, width=640, height=400]Example 3
A print-quality map: laid out at 640x400 on the page, but rendered at 1280x800 pixels.
[Map: location=Sheffield, width=640, height=400, scale=2]Example 4
A large map for a full-page layout.
[Map: location=Sheffield, width=1600, height=1000, scale=1]Example 5
[Map: location=SL6 3JA, zoom=15]Example 6
[Map: location=Lauterbrunnen, zoom=13, mapType=terrain]Example 7
[Map: location=Schiphol, zoom=14, pageWidthPercent=50]Example 8
[Map: location=Europe, markers=York;Warsaw;Paris;Madrid;Rome;Berlin;Bern;Oslo;Greece, zoom=3, height=400, markerColor=white, markerLabel=C]Example 9
[Map: location=Europe, markers=York^yellow^Y^;Warsaw^white^W^small;Paris^purple^P^tiny;Madrid^brown^M^tiny;Rome^red^R^mid;Berlin^blue^B^small;Bern^black^^tiny;Oslo^orange^O^;Greece^green^^, zoom=3,height=400]
