Back to Top

Alphabetical list of arcpy.mp constants

In this topic

  1. arcpy.mp constants

Below is a list of arcpy.mp parameter constants. Many of these parameters are used with multiple arcpy.mp functions and/or methods. Most of these parameters are optional—those surrounded by curly brackets ({})—and when appropriate, the default values are indicated next to the value. This document is intended to serve as a quick reference. For more specific information on what the parameter values mean, refer to the function or method documentation by using the links provided next to the parameter name.

arcpy.mp constants

{add_position}—Used by addLayer, addLayerToGroup and addItem methods on the LayerFile, LegendElement and Map classes.

  • "AUTO_ARRANGE"—Default
  • "BOTTOM"
  • "TOP"

—

anchor—Used by the setAnchor method on the GraphicElement, GroupElement, LegendElement, MapFrame, MapSurroundElement, PictureElement, TableFrameElement, and TextElement classes.

  • "BOTTOM_LEFT_CORNER"
  • "BOTTOM_MID_POINT"
  • "BOTTOM_RIGHT_CORNER"
  • "CENTER_POINT"
  • "LEFT_MID_POINT"
  • "RIGHT_MID_POINT"
  • "TOP_LEFT_CORNER"
  • "TOP_MID_POINT"
  • "TOP_RIGHT_CORNER"

—

{arrangement}—Defined on the LegendItem class.

  • "PatchLabelDescription"
  • "PatchDescriptionLabel"
  • "LabelPatchDescription"
  • "LabelDescriptionPatch"
  • "DescriptionPatchLabel"
  • "DescriptionLabelPatch"

—

{bmp_color_mode}—Used by the exportToBMP method on the Layout, MapFrame, and MapView classes.

  • "24-BIT_TRUE_COLOR"- Default
  • "8-BIT_ADAPTIVE_PALETTE"
  • "8-BIT_GRAYSCALE"

{bmp_image_compression}—Used by the exportToBMP method on the Layout, MapFrame, and MapView classes.

  • "NONE"- Default
  • "RLE"

—

cim_version—Used by the getDefinition method on the GraphicElement, GroupElement, LabelClass, Layer, Layout, LegendElement, Map, MapFrame, MapSurroundElement, PictureElement, Report, Table, TableFrameElement and TextElementclasses.

  • "V2"
  • "V3"

—

{color_mode}—Used by exportToPNG and exportToTIFF methods on the Layout, MapFrame and MapView classes.

  • "8-BIT_ADAPTIVE_PALETTE"
  • "8-BIT_GRAYSCALE"
  • "24-BIT_TRUE_COLOR"—Default
  • "32-BIT_WITH_ALPHA"
  • "32-BIT_CMYK_TRUE_COLOR"
  • "40-BIT_CMYK_WITH_ALPHA"

—

{colorizer_name}—Used by the updateColorizer method on the Symbology class.

  • "RasterClassifyColorizer"
  • "RasterStretchColorizer"
  • "RasterUniqueValueColorizer"

—

{element_type}—Used by the listElements method on the Layout class.

  • ""—Default
  • "GRAPHIC_ELEMENT"
  • "GROUP_ELEMENT"
  • "LEGEND_ELEMENT"
  • "MAPFRAME_ELEMENT"
  • "MAPSURROUND_ELEMENT"
  • "PICTURE_ELEMENT"
  • "TABLEFRAME_ELEMENT"
  • "TEXT_ELEMENT"

—

{encryption}—Used by the updateDocSecurity method on the PDFDocument class.

  • "RC4"
  • "AES-256"—Default
  • "AES-256-R5"
  • "AES-128"

—

{extrusion_type}—Used by the extrusion method on the Layer class.

  • "ABSOLUTE_HEIGHT"
  • "BASE_HEIGHT"
  • "MAX_HEIGHT"
  • "MIN_HEIGHT"
  • "NONE"—Default

—

{fittingStrategy}—Defined on the LegendElement class.

  • "AdjustFontSize"
  • "AdjustColumns"
  • "AdjustColumnsAndFont"
  • "AdjustFrame"
  • "ManualColumns"—Default

—

{gif_color_mode}—Used by the exportToGIF method on the Layout, MapFrame, and MapView classes.

  • "8-BIT_GRAYSCALE"
  • "8-BIT_ADAPTIVE_PALETTE" - Default

—

{group_type}—Used by the setGroupType method on the Layer class.

  • "CHECKBOX"
  • "RADIO"

—

{image_compression}—Used by the exportToPDF method on the BookmarkMapSeries, Layout, MapFrame, MapSeries and MapView classes.

  • "ADAPTIVE"—Default
  • "DEFLATE"
  • "JPEG"
  • "JPEG2000"
  • "LZW"
  • "NONE"
  • "RLE"

—

{image_quality}—Used by the exportToPDF method on the BookmarkMapSeries, Layout, MapFrame, MapSeries and MapView classes.

  • "BEST"—Default
  • "BETTER"
  • "FASTER"
  • "FASTEST"
  • "NORMAL"

—

{insert_position}—Used by the insertLayer and moveLayer methods on the LayerFile and Map classes.

  • "AFTER"
  • "BEFORE"—Default

—

—

{interval_units}—Used by the timeStep method on the MapTime class.

  • "CENTURIES"
  • "DAYS"
  • "DECADES"
  • "HOURS"
  • "MILLISECONDS"
  • "MINUTES"
  • "MONTHS"
  • "SECONDS"
  • "WEEKS"
  • "YEARS"

{jpeg_color_mode}—Used by exportToJPEG method on the Layout, MapFrame and MapView classes.

  • "8-BIT_GRAYSCALE"
  • "24-BIT_TRUE_COLOR"—Default

—

{labelclass_language}—Used by the createLabelClass method on the Layer class.

  • "ARCADE"—Default
  • "JSCRIPT"
  • "PYTHON"
  • "VBSCRIPT"

—

{layer_property}—Used by the supports method on the Layer class.

  • "BRIGHTNESS"
  • "CONNECTIONPROPERTIES"
  • "CONTRAST"
  • "DATASOURCE"
  • "DEFINITIONQUERY"
  • "IS3DLAYER"
  • "ISBASEMAP"
  • "ISBROKEN"
  • "ISFEATURELAYER"
  • "ISGRAPHICSLAYER"
  • "ISGROUPLAYER"
  • "ISNETWORKANALSYTLAYER"
  • "ISNETWORKDATASETLAYER"
  • "ISPARCELFABRICLAYER"
  • "ISRASTERLAYER"
  • "ISSCENELAYER"
  • "ISTIMEENABLED"
  • "ISWEBLAYER"
  • "LONGNAME"
  • "MAXTHRESHOLD"
  • "METADATA"
  • "MINTHRESHOLD"
  • "NAME"
  • "SHOWLABELS"
  • "SYMBOLOGY"
  • "TIME"
  • "TRANSPARENCY"
  • "URI"
  • "VISIBLE"

—

{layers_attributes}—Used by the ExportToPDF method on the BookmarkMapSeries, Layout, MapFrame, MapSeries and MapView classes.

  • "LAYERS_AND_ATTRIBUTES"
  • "LAYERS_ONLY"—Default
  • "NONE"

—

mapsurround_type—Used by the createMapSurroundElement method on the Layout class.

  • "LEGEND"
  • "NORTH_ARROW"
  • "SCALE_BAR"

—

{map_type}—Used by the createMap method on the ArcGISProject class.

  • "GLOBE"
  • "MAP"—Default
  • "SCENE"

—

{method}—Used by the setSelectionSet method on the Layer and Table classes.

  • "DIFFERENCE"
  • "INTERSECT"
  • "NEW"—Default
  • "SYMDIFFERENCE"
  • "UNION"

—

{multiple_files}—Used by the ExportToPDF method on the MapSeries and BookmarkMapSeries classes.

  • "PDF_MULTIPLE_FILES_PAGE_NAME"
  • "PDF_MULTIPLE_FILES_PAGE_NUMBER"
  • "PDF_SINGLE_FILE"—Default

—

{page_range_type}—Used by the ExportToPDF method on the MapSeries and BookmarkMapSeries classes.

  • "ALL"
  • "CURRENT"
  • "RANGE"—Default
  • "SELECTED"—does not apply to bookmark map series.

—

page_units—Used by the createLayout method on the ArcGISProject class.

  • "CENTIMETER"
  • "INCH"
  • "MILLIMETER"
  • "POINT"

—

{pdf_layout}—Used by the updateDocProperties method on the PDFDocument class.

  • "ONE_COLUMN"
  • "SINGLE_PAGE"—Default
  • "TWO_COLUMN_LEFT"
  • "TWO_COLUMN_RIGHT"
  • "TWO_PAGE_LEFT"
  • "TWO_PAGE_RIGHT"
  • "VIEWER_DEFAULT"

—

{pdf_open_view}—Used by the updateDocProperties method on the PDFDocument class.

  • "ATTACHMENT"
  • "FULL_SCREEN"
  • "LAYERS"
  • "USE_BOOKMARKS"
  • "USE_NONE"
  • "USE_THUMBS"—Default
  • "VIEWER_DEFAULT"

—

{permissions}—Used by the updateDocSecurity method on the PDFDocument class.

  • "ALL"—Default
  • "ALL_MASTER"
  • "COPY"
  • "DOC_ASSEMBLY"
  • "EDIT"
  • "EDIT_NOTES"
  • "FILL_AND_SIGN"
  • "HIGH_PRINT"
  • "PRINT"

—

{query_rows}—Used by the setQuery method on the TableFrameElement class.

  • "ALL_ROWS"—Default
  • "MAPSERIES_ROWS"
  • "VISIBLE_ROWS"

—

{renderer_name}—Used by the updateRenderer method on the Symbology class.

  • "GraduatedColorsRenderer"
  • "GraduatedSymbolsRenderer"
  • "SimpleRenderer"
  • "UnclassedColorsRenderer"
  • "UniqueValueRenderer"

—

{selection}—Used by the clipLayers method on the Map class.

  • "ALL"
  • "SELECTED"

—

{server_type}—Used by the CreateWebLayerSDDraft function.

  • "MY_HOSTED_SERVICES"—Default

—

{server_type}—Used by the getWebLayerSharingDraft method on the Map class.

  • "HOSTING_SERVER"
  • "FEDERATED_SERVER"

—

{service_type}—Used by the CreateWebLayerSDDraft function.

  • "FEATURE_ACCESS"—Default
  • "TILED"

—

{service_type}—Used by the getWebLayerSharingDraft method on the Map class.

  • "FEATURE"
  • "MAP_IMAGE"
  • "TILE"

—

{shape_type}—Used by the createPredefinedGraphicElement method on the ArcGISProject class.

  • "CIRCLE"
  • "CLOUD"
  • "CROSS"
  • "ELLIPSE"
  • "HALF_CIRCLE"
  • "RECTANGLE"
  • "RIGHT_TRIANGLE"
  • "ROUNDED_RECTANGLE"
  • "TRIANGLE"
  • "X"

—

{style_class}—Used by the listStyleItems method on the ArcGISProject class.

  • "LEGEND"
  • "LEGEND_ITEM"
  • "LINE"
  • "NORTH_ARROW"
  • "POINT"
  • "POLYGON"
  • "SCALE_BAR"
  • "TABLE_FRAME"
  • "TEXT"

—

{styling}—Used by the createReport method on the ArcGISProject class.

  • "BLACK_AND_WHITE"—Default
  • "COOL_TONES"
  • "NO_STYLING"
  • "WARM_TINES"

—

{template}—Used by the createReport method on the ArcGISProject class.

  • "ATTR_LIST"—Default
  • "ATTR_LIST_GROUP"
  • "BASIC_SUM"
  • "BASIC_SUM_GROUP"
  • "PAGE_PER_FEATURE"

—

{text_type}—Used by the createTextElement method on the ArcGISProject class.

  • "CIRCLE"
  • "ELLIPSE"
  • "LINE"
  • "POINT"
  • "POLYGON"

—

{tiff_compression}—Used by the exportToTIFF method on the Layout, MapFrame and MapView classes.

  • "DEFLATE"
  • "JPEG"
  • "LZW"
  • "NONE"—Default
  • "PACK_BITS"

—

{time_inclusion}—Used by the setTimeInclusion method on the MapTime class.

  • "EXCLUDE_START_AND_END"
  • "INCLUDE_ONLY_END"
  • "INCLUDE_ONLY_START"
  • "INCLUDE_START_AND_END"

—

{timeUnits}—Used by multiple properties in the LayerTime and MapTime classes.

  • "MILLISECONDS"
  • "SECONDS"
  • "MINUTES"
  • "HOURS"
  • "DAYS"
  • "WEEKS"
  • "MONTHS"
  • "YEARS"
  • "DECADES"
  • "CENTURIES"

—

{view_type}—Used by the closeViews method on the ArcGISProject class.

  • "LAYOUTS"
  • "MAPS"
  • "MAPS_AND_LAYOUTS"—Default
  • "REPORTS"

—

{web_service_type}—Used by the addDataFromPath method on the Map class.

  • "ARCGIS_SERVER_WEB"
  • "AUTOMATIC"—Default
  • "KML"
  • "VECTOR_TILE"
  • "WMS"

Feedback on this topic?

In this topic
  1. arcpy.mp constants