ArcGIS Desktop

  • ArcGIS Pro
  • ArcMap

  • My Profile
  • Help
  • Sign Out
ArcGIS Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS Desktop

A complete professional GIS

ArcGIS Enterprise

GIS in your enterprise

ArcGIS Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

ArcMap

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • Extensions

EnableLayerMasking

Available with Production Mapping license.

  • Summary
  • Discussion
  • Syntax
  • Code sample

Summary

Enables or disables masking functionality on a data frame.

Discussion

EnableLayerMasking performs the same operation as opening the Advanced Drawing Options dialog box and checking or unchecking the Draw using masking options specified below check box.

Syntax

EnableLayerMasking (data_frame, use_masking)
ParameterExplanationData Type
data_frame

The DataFrame object that will have masking enabled or disabled.

DataFrame
use_masking

Controls whether masking is enabled or disabled for the DataFrame object.

(The default value is None)

Boolean

Code sample

EnableLayerMasking example 1

This sample enables masking on a data frame.

import arcpy
import arcpyproduction

# Check out Production Mapping license
arcpy.CheckOutExtension("Foundation")

# Get reference to CURRENT mxd
mxd = arcpy.mapping.MapDocument('CURRENT')

# Get reference to active data frame
df = mxd.activeDataFrame

# Enable masking on the active data frame
arcpyproduction.mapping.EnableLayerMasking(df,'true')

# Check in Production Mapping license
arcpy.CheckInExtension("Foundation")
EnableLayerMasking example 2

This sample disables masking on a data frame.

import arcpy
import arcpyproduction

# Check out Production Mapping license
arcpy.CheckOutExtension("Foundation")

# Get reference to CURRENT mxd
mxd = arcpy.mapping.MapDocument('CURRENT')

# Get reference to active data frame
df = mxd.activeDataFrame

# Enable masking on the active data frame
arcpyproduction.mapping.EnableLayerMasking(df,'false')


# Check in Production Mapping license
arcpy.CheckInExtension("Foundation")

Related topics

  • MaskLayer
  • Introduction to arcpyproduction.mapping

ArcGIS Desktop

  • Home
  • Documentation
  • Support

ArcGIS

  • ArcGIS Online
  • ArcGIS Desktop
  • ArcGIS Enterprise
  • ArcGIS
  • ArcGIS Developer
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Esri Blog
  • User Conference
  • Developer Summit
Esri
Tell us what you think.
Copyright © 2021 Esri. | Privacy | Legal