ArcMap

Map Series Report

Available with Business Analyst license.

Summary

Generates a series of maps based on one or more features of a trade area.

Usage

  • The output will be based the Data View or Layout View set in ArcMap.

  • All reports will inherit the same scale and properties of the View set in ArcMap.

  • All formatting of the reports will reflect the page and print setup properties from the File-Page and Print Setup menu in ArcMap.

Syntax

arcpy.ba.MapSeriesReport(InputBoundaryLayer, All_Or_Single_Or_Selected, IDField, ReportMapSeriesHeadersAndFields, HideInactiveTAs, {ByID_Or_ByName}, {Single_Site}, {CreateReport}, {ReportTitle}, {OutputFolder}, {ExportToImages}, {ImagesFormat}, {ImagesFormatResolution}, {OutputFolderImages}, ReportMapSeriesLandscapeOrientation, {ReportFormats})
ParameterExplanationData Type
InputBoundaryLayer

The input feature class that contains the boundaries that will be embedded into the report.

Feature Layer
All_Or_Single_Or_Selected

Runs a Map Series Report on one or more features.

  • ALL —Runs the report on all the features in the boundary layer.
  • SINGLE —Runs the report only a single selected feature in the boundary layer.
String
IDField

The ID of each boundary which will be reported. These IDs will be located at the top of the report when it is output.

Field
ReportMapSeriesHeadersAndFields

Select from a list of available fields in the Boundary Layer to appear as headers in the report.

Value Table
HideInactiveTAs

Removes all features in the boundary layer from being displayed in the report except for the selected feature.

  • TRUE —Removes all features from being displayed in the report except for the selected feature.
  • FALSE —Includes all features for display in the report. This is the default.
Boolean
ByID_Or_ByName
(Optional)

Field used to select a feature.

  • ID —Selects a feature using the boundary ID field.
  • Name —Selects a feature using the boundary NAME field.
String
Single_Site
(Optional)

Identifies the single feature ID or name to be used in the report.

String
CreateReport
(Optional)

Generates an output report.

  • TRUE —Creates a map series report. This is the default.
  • FALSE —Does not create a map series report.
Boolean
ReportTitle
(Optional)

Creates a title for the report.

String
OutputFolder
(Optional)

The output directory that will contain the report.

Folder
ExportToImages
(Optional)

Exports the images in the map series report to a specified folder.

  • TRUE —Outputs images to folder.
  • FALSE —Does not output images to folder. This is the default.
Boolean
ImagesFormat
(Optional)

The units used with the distance values. By default, the units defined in the Business Analyst preferences will be selected.

  • JPEG
  • BMP
  • GIF
  • EMF
  • PNG
  • TIFF
String
ImagesFormatResolution
(Optional)

Enter the dots per inch (DPI) for each exported map image.

Double
OutputFolderImages
(Optional)

The output directory that the boundary images will be saved to.

Folder
ReportMapSeriesLandscapeOrientation

Locator report page orientation.

  • LANDSCAPE —Generates a landscape-oriented report.
  • PORTRAIT —Generates a portrait-oriented report.
String
ReportFormats
[ReportFormats,...]
(Optional)

Select the desired report output format.

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSX
  • Stripped XLSX
String

Code sample

MapSeriesReport example (stand-alone script)

# Name: MapSeriesReport.py
# Description: Creates a mapping report using predefined drive times.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.8\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")

try:     
# Acquire extension license
  arcpy.CheckOutExtension("Business")
     
# Define input and output parameters for the Map Series Report tool

  BoundaryInput = "C:/My Output Data/Projects/Default Project/TradeAreas/DriveTime/US_Drive_Times.shp"
  Id = "ID"
  ReportName = "Map Series Report"
  ReportOut = "C:/My Output Data/Projects/Default Project/Reports/Map Series.shp"
	   	   
# Create the Map Series Report
  arcpy.MapSeriesReport_ba(BoundaryInput, ALL, "#", "#", Id, false, true, ReportName, ReportOut)
 
# Release extension license 
arcpy.CheckInExtension("Business")

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: Requires Business Analyst
  • Standard: Requires Business Analyst
  • Advanced: Requires Business Analyst

Related topics