Skip to main content
Cartegraph Campus

Map Parameters in Reports

Adding a map to a report allows for different display parameters. Default values are used when the parameters are not added; however, adding these optional parameters allows for:

  • Different types of maps to be printed
  • Various height and width combinations
  • Quality of the map
  • Printing of nearby assets
  • Printing of related assets

Parameter Text

Copy this parameter text into the Advanced Report Designer if you want adjust settings for the map display in the report:

 

Drawing(Tasks.MAP+"&quality=3&height=5&width=7.5&type=street")

/* Drawing(Tasks.MAP) will use all default values. To use parameters, add + "&parameter=value&parameter=value" after MAP as shown above.

 

Parameters can be configured in any order and are not required. There cannot be any spaces between the quotation marks.

Available parameters and values:

Quality: 1, 2, 3, 4, 5, 6, 7 (Default is 3)

Height: Must be between 1-11 inches (Default is 4 inches)

Width: Must be between 1-11 inches (Default is 4 inches)

Type: street, imagery, topo, dark, light, natgeo (Default is street)

 

Parameter Definitions and Examples

The Drawing(recordset.MAP) field allows for printing a Map on a report. To use parameters add

+ "&parameter=value&parameter=value" after MAP, as shown in the samples that follow. 

The following sections list the various map parameters and possible values. These parameters can be added in any order and are not required: 

Basemap Type

  • Street (default)
  • Imagery
  • Topo
  • Dark
  • Light
  • Natgeo

Height in Inches

  • Must be 1 through 11.
  • Default is 4.0.
  • If height is not specified or contains a value less than 1 or greater than 11, the default value of 4.0 is used.
  • Decimals can be used up to four places after the decimal point.

Width in Inches

  • Must be 1 through 11.
  • Default is 4.0.
  • If width is not specified or contains a value less than 1 or greater than 11, the default value of 4.0 is used.
  • Decimals can be used up to four places after the decimal point.

Resolution Quality of the Map (DPI)

  • Valid values are 1 through 7.
  • Default is 3.
  • The higher the dpi value, the crisper the image, but the labels on the basemaps get smaller.
  • If quality is not specified or is a value anything other than 1 through 7, the default value of 3 is used (100 dpi).

Setting

DPI Value

1

50

2

75

3 (default)

100

4

125

5

150

6

175

7

200

NearbyAssets

  • Valid values are True or False with the default value being False.
  • Applies to Asset maps only.
  • When the value is True, the map displays up to 100 records of the same asset type on the map.

 When the setting is True:

  • Up to 100 records of the same asset type that are within the map boundary display. These display with 50% opacity, and the designated asset color in OMS—Asset Color Management.
  • The selected asset displays as magenta with no opacity.

 When the setting is False:

  • No other records of the same asset type display.
  • The selected asset displays with the designated asset color in OMS, if no other objects are displayed (other objects may display when using a separate setting such as relatedAssets).

RelatedAssets

  • Valid values are True or False with the default value being False.
  • Applies to Asset maps only.
  • When the value is True, the map displays up to 100 records of related assets on the map. Related assets are Component assets or Linked assets.

 When the setting is True:

  • Up to 100 related asset records  that are within the map boundary display. These display with 50% opacity and the designated asset color in OMS—Asset Color Management.
  • The selected asset displays as magenta with no opacity.

 When the setting is False:

  • No related records display.
  • The selected asset displays with the designated asset color in OMS if no other objects are displayed (other objects may display when using a separate setting such as nearbyAssets).

Sample Map Parameters

Drawing(Tasks.MAP+"&type=dark&height=5&width=6&quality=4")

Drawing(Tasks.MAP+"&height=3&type=imagery&width=3&relatedAssets=true&quality=5")

Drawing(Tasks.MAP+"&type=natgeo&height=10&width=7&nearbyAssets=true")

  • Was this article helpful?