ReportMagic

[Map:]

Inserts a map into the report.

Compatibility

The macro can be used in all input document types and in Report Studio.

Parameters (25)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
location	String	The location to display. This must resolve to a location in Google Maps (regardless of the ignoreUnknownLocations parameter).	N/A	N/A

Behaviour (5)

Parameter	Type	Presence	Purpose	Options	Default
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
if	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
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed theObject, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	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 UkTown DeviceName Company IpAddress PrivateIpAddress	None
warning	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
height	Int32	Optional	The image height in pixels	From 100 to 640	640
pageWidthPercent	Double	Optional	The percentage width of the page to fill with the graph.	From 1 to 300	100
width	Int32	Optional	The image width in pixels	From 100 to 640	640
zoom	Int32	Optional	The zoom level.	From 0 to 21	10

Chart (4)

Parameter	Type	Presence	Purpose	Options	Default
markerColor	String	Optional	The marker color to use (unless overridden). You need to specify the markers parameter before this parameter will apply.	red black blue brown gray green orange purple white yellow	red
markerLabel	Char	Optional	Default marker label (unless overridden). You need to specify the markers parameter before this parameter will apply. Note that marker labels are not shown for tiny and small markers. Options are a-z, A-Z, 0-9 and full stop (.)	N/A	.
markers	List<String>	Optional	markers: A semicolon-separated list of markers for locations of interest. These can be any location that resolves in Google Maps (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): black brown green purple yellow blue gray orange red white Supported sizes (Default is Mid): tiny mid small Supported labels (default '.'): . (default) A-Z 0-9 Using the caret separator format may override markerColor, markerSize and markerLabel for the marker specified.	N/A	N/A
markerSize	MarkerSize	Optional	The default marker size (unless overridden). You need to specify the markers parameter before this parameter will apply.	Mid Small Tiny	Mid

Output (2)

Parameter	Type	Presence	Purpose	Options	Default
failureText	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
failureVariable	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 (10)

Parameter	Type	Presence	Purpose	Options	Default
location	String	Mandatory	The location to display. This must resolve to a location in Google Maps (regardless of the ignoreUnknownLocations parameter).	N/A	N/A
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
description	String	Optional	The description for visually-impaired users. This text also displays when the user hovers the mouse over the image in Word or a PDF viewer.	N/A	N/A
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, 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, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
expectedType	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
expectedValue	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
ignoreUnknownLocations	Boolean	Optional	Whether to skip markers where no location can be resolved.	true false	true
mapType	MapType	Optional	The map type (hybrid(default), roadmap, satellite, terrain)	Hybrid Roadmap Satellite Terrain	Hybrid
paths	List<String>	Optional	Undocumented feature.	N/A	N/A
title	String	Optional	The image title for visually-impaired users.	N/A	N/A

Examples (7)

Example 1

[Map: location=London]

Example 2

[Map: location=Sheffield, width=640, height=400]

Example 3

[Map: location=SL6 3JA, zoom=15]

Example 4

[Map: location=Lauterbrunnen, zoom=13, mapType=terrain]

Example 5

[Map: location=Schiphol, zoom=14, pageWidthPercent=50]

Example 6

[Map: location=Europe, markers=York;Warsaw;Paris;Madrid;Rome;Berlin;Bern;Oslo;Greece, zoom=3, height=400, markerColor=white, markerLabel=C]

Example 7

[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]