Map (Functions and Variables Available in the Reports)

Map

ExportMap - this function creates and saves a map cutout.

Syntax:

  $ExportMap( mapSourceIndex or "mapSourceName", destinationImagePath, lonWest, lonEast, latSouth, latNorth, width, height )

Parameters:

mapSourceIndex or "mapSourceName" - the ID value or the full name of the map provider that can be found in the mapproviders.xml located in the installation folder.

destinationImagePath - path relative to attachment folder or path in format global://globalPathToFile

lonWest - the west longitude coordinate value that is going to create a boundary for a map cutout ( lonWest cannot be the same as lonEast)

lonEast - the east longitude coordinate value that is going to create a boundary for a map cutout ( lonEast cannot be the same as lonWest)

latSouth - the south latitude coordinate value that is going to create a boundary for a map cutout (-90 <= latSouth, latNorth <= 90, latSouth < latNorth)

latNorth - the north latitude coordinate value that is going to create a boundary for a map cutout (-90 <= latSouth, latNorth <= 90, latSouth < latNorth)

width - width of the map image

height - height of the map image

GetExportedMapInfo - this function creates and saves a map cutout.

Syntax:

  $GetExportedMapInfo( mapFilepath, anyText )

Parameters:

mapFilePath or "mapSourceName" - path to the map saved in this report export session. Should be the same path as used in ExportMap.

Available variables:

requestedWest - the west longitude coordinate value that was set to create a boundary for a map cutout

requestedEast - the east longitude coordinate value that was set to create a boundary for a map cutout

requestedSouth - the south latitude coordinate value that was set to create a boundary for a map cutout

requestedNorth - the north latitude coordinate value that was set to create a boundary for a map cutout

exportedWest - the west longitude coordinate value that creates a boundary of the exported map

exportedEast - the east longitude coordinate value that creates a boundary of the exported map

exportedSouth - the south latitude coordinate value that creates a boundary of the exported map

exportedNorth - the north latitude coordinate value that creates a boundary of the exported map

Available expression functions

MapProviderCredentialsAreValid - result is a BOOL value (true/false). In case the provider is valid, returns value "true".

Syntax:

  MapProviderCredentialsAreValid( mapSourceIndex or "mapSourceName" )

Parameters:

mapSourceIndex or "mapSourceName" - the ID value or the full name of the map provider that can be found in the mapproviders.xml located in the installation folder.

MapProviderCredentialsAreNeeded - result is a BOOL value (true/false). In case the credentials are needed, returns value "true".

Syntax:

  MapProviderCredentialsAreNeeded( mapSourceIndex or "mapSourceName" )

Parameters:

mapSourceIndex or "mapSourceName" - the ID value or the full name of the map provider that can be found in the mapproviders.xml located in the installation folder.

Scripting Report Basics

Learn how to create custom report templates

Function Sets

Functions sets and their functions, expressions and variables

Basic Functions

Project information, exporter scope, and basic function set

Images Scope

Learn how to export information about project images

Components Scope

Component export functions and variables

Camera Scope

Learn how to get information about cameras

Scene Structure Scope

Learn how to add custom point statics to reports

Control Points and Constraints Scope

Check the list of control points and constraints functionalities

Models Scope

Learn how to generate model reports

Ortho Projection Scope

See the list of ortho projection export functions