Apply Building Offsets (Topographic Production Tools)

Summary

Aligns, moves, and hides building features or calculates offset values for bridge features based on product specification rules defined in an .xml file.

If this tool is run with a building offset XML rule file, it aligns, moves, and hides building marker symbols based on product specification rules defined in an .xml file.

If this tool is run with a bridge offset XML rule file, it calculates the offset values necessary to properly display bridges at a given location. These values can be calculated for bridge features with line or point geometry.

Line bridge feature offsets will be calculated for the width of a bridge based on the overpassing feature that runs through the bridge
Point bridge features offsets include the following:
- The rotation angle of a bridge based on its overpassing feature
- The position of the bridge if the original position is not coincident with the overpassing feature

Note:

A product file installer is available for ArcGIS Topographic Mapping. The product files contain predefined XML rule files that can be used for cartographic production.

Learn more about product files

Usage

The feature layers referenced in the rule file must have their symbology defined pursuant to the product specification using ArcGIS Arcade expressions.
The layers must have attribute-driven symbology enabled for marker symbols.
The tool will create an ABO_Rotation field in the Buildings table if one does not already exist and connect the rotation property of building marker symbols to this attribute.

Label	Explanation	Data type
Input Map	The map that contains the layers with proper symbology. This can be a map in the application or an `.mapx` file on disk.	Map
Rule File	An `.xml` file containing the offset rules that define how features will be aligned and refined in case of any conflict.	File

Derived output

Label	Explanation	Data type
Updated Map	The updated map with modified building features and symbology.	Map

arcpy.topographic.ApplyBuildingOffsets(in_map, rule_file)

Name	Explanation	Data type
in_map	The map that contains the layers with proper symbology. This can be a map in the application or an `.mapx` file on disk.	Map
rule_file	An `.xml` file containing the offset rules that define how features will be aligned and refined in case of any conflict.	File

Derived output

Name	Explanation	Data type
updated_map	The updated map with modified building features and symbology.	Map

Code sample

ApplyBuildingOffsets example (Python window)

The following Python window script demonstrates how to use the ApplyBuildingOffsets function to align, move, and hide building marker symbols based on the MGCP XML rule file.

# Name: ApplyBuildingOffsets_sample.py
# Description: This script tool aligns, moves, and hides building marker symbols based
# on product specification rules defined in a rule xml file

# Import System Modules
import arcpy

# Setting the environment
arcpy.env.overwriteOutput = 1

# Setting Local Variables
in_map = r'C:\Data\MGCP_TRD_4_4.mapx'
rule_file = r'C:\Data\MTM50_TRD_4_4_BuildingOffsets.xml'

# Calling the Apply Building Offsets tool to align, move, and hide building marker symbols based
# on product specification rules defined in a rule xml file
arcpy.topographic.ApplyBuildingOffsets(in_map, rule_file)

# Getting all messages, warnings, and errors from the tool run and printing the results back to the user
messages = arcpy.GetMessages(0)
warnings = arcpy.GetMessages(1)
errors = arcpy.GetMessages(2)
arcpy.AddMessage('Tool Messages: {}\nTool Warnings: {}\nTool Errors{}\n'.format(messages, warnings, errors))

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: No
Advanced: Requires Topographic Mapping

Apply Building Offsets (Topographic Production Tools)

Summary

Note:

Usage

Parameters

Derived output

Environments

Licensing information

Related topics