The arcpy.mapping classes provide access to various methods and properties for the different object types found within a map document (.mxd) or layer file (.lyr). This document is intended to serve as a quick reference. For more specific information, use the links to jump to the individual help pages.
arcpy.mapping classes
- Methods
- exportToPDF(out_pdf, {page_range_type}, {page_range_string}, {multiple_files}, {resolution}, {image_quality}, {colorspace}, {compress_vectors}, {image_compression}, {picture_symbol}, {convert_markers}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality}, {show_selection_symbology})
- getPageIDFromName(page_name)
- printPages({printer_name}, {page_range_type}, {page_range_string}, {out_print_file}, {show_selection_symbology})
- refresh()
- Properties
- currentPageIDâRead/Write; Long
- dataFrameâRead-only; DataFrame object
- indexLayerâRead-only; Layer object
- pageCountâRead-only; Long
- pageNameFieldâRead-only; GP Field object
- pageRowâRead-only; GP Row object
- selectedPagesâRead-only; Python list of index numbers
- Methods
- panToExtent(extent)
- zoomToSelectedFeatures()
- Properties
- creditsâRead/Write; String
- descriptionâRead/Write; String
- displayUnitsâRead/Write; String
- elementHeightâRead/Write; Double
- elementPositionXâRead/Write; Double
- elementPositionYâRead/Write; Double
- elementWidthâRead/Write; String
- extentâRead/Write; GP Extent object
- geographicTransformationsâRead/Write; Python list of strings
- mapUnitsâRead-only; String
- nameâRead/Write; String
- referenceScaleâRead/Write; Double
- rotationâRead/Write; Double
- scaleâRead/Write; Double
- spatialReferenceâRead/Write; GP Spatial Reference object
- timeâRead-only; DataFrameTime object
- typeâRead-only; String
- Methods
- resetTimeExtent()
- Properties
- currentTimeâRead/Write; Python datetime object
- endTimeâRead/Write; Python datetime object
- startTimeâRead/Write; Python datetime object
- timeStepIntervalâRead-only; Python timedelta object
- timeWindowâRead/Write; Double
- timeWindowUnitsâRead/Write; String
- Methods
- reclassify()
- Properties
- classBreakDescriptionsâRead/Write; Python list of strings
- classBreakLabelsâRead/Write; Python list of strings
- classBreakValuesâRead/Write; Python list of strings
- normalizationâRead/Write; String
- numClassesâRead/Write; Long
- valueFieldâRead/Write; String
- Methods
- reclassify()
- Properties
- classBreakDescriptionsâRead/Write; Python list of strings
- classBreakLabelsâRead/Write; Python list of strings
- classBreakValuesâRead/Write; Python list of strings
- normalizationâRead/Write; String
- numClassesâRead/Write; Long
- valueFieldâRead/Write; String
- Methods
- clone({suffix})
- delete()
- Properties
- elementHeightâRead/Write; Double
- elementPositionXâRead/Write; Double
- elementPositionYâRead/Write; Double
- elementWidthâRead/Write; String
- isGroupâ Read-only; Boolean
- nameâRead/Write; String
- typeâRead-only; String
- Properties
- classNameâRead/Write; String
- expressionâRead/Write; String
- showClassLabelsâRead/Write; Boolean
- SQLQueryâRead/Write; String
- Methods
- findAndReplaceWorkspacePath(find_workspace_path, replace_workspace_path, {validate})
- getExtent({symbolized_extent})
- getSelectedExtent({symbolized_extent})
- getSelectionSet()
- replaceDataSource(workspace_path, workspace_type, dataset_name, {validate})
- save()
- saveACopy(file_name, {version})
- setSelectionSet(method, oidList)
- supports(layer_property)
- updateLayerFromJSON(json_layer_definition)
- Properties
- brightnessâRead/Write; Long
- contrastâRead/Write; Long
- creditsâRead/Write; String
- datasetNameâRead-only; String
- dataSourceâRead-only; String
- definitionQueryâRead/Write; String
- descriptionâRead/Write; String
- isBasemapLayerâRead-only; Boolean
- isBrokenâRead-only; Boolean
- isFeatureLayerâRead-only; Boolean
- isGroupLayerâRead-only; Boolean
- isNetworkAnalystLayerâRead-only; Boolean
- isRasterizingLayerâRead-only; Boolean
- isRasterLayerâRead-only; Boolean
- isServiceLayerâRead-only; Boolean
- labelClassesâRead/Write; List of LabelClass objects
- longNameâRead-only; String
- maxScaleâRead/Write; Double
- minScaleâRead/Write; Double
- nameâRead/Write; String
- servicePropertiesâRead-only; Dictionary of property sets
- showLabelsâRead/Write; Boolean
- symbologyâRead-only; Layer symbology object
- symbologyTypeâRead-only; String
- timeâRead-only; Layer time object
- transparencyâRead/Write; Long
- visibleâRead/Write; Boolean
- workspacePathâRead-only; String
- Properties
- daylightSavingsâRead-only; Boolean
- displayDataCumulativelyâRead-only; Boolean
- endTimeâRead-only; Python datetime object
- endTimeFieldâRead-only; String
- isTimeEnabledâRead-only; Boolean
- startTimeâRead-only; Python datetime object
- startTimeFieldâRead-only; String
- timeFormatâRead-only; String
- timeOffsetâRead-only; Python timedelta object
- timeStepIntervalâRead-only; Python timedelta object
- timeZoneâRead-only; String
- Methods
- adjustColumnCount(column_count)
- listLegendItemLayers()
- removeItem(legend_item_layer, {index})
- updateItem(legend_item_layer, {legend_item_style_item}, {preserve_item_sizes}, {use_visible_extent}, {show_feature_count}, {use_ddp_extent}, {index})
- Properties
- autoAddâRead/Write; Boolean
- elementHeightâRead/Write; Double
- elementPositionXâRead/Write; Double
- elementPositionYâRead/Write; Double
- elementWidthâRead/Write; String
- isOverflowingâRead-only; Boolean
- itemsâRead-only; Python list of strings
- nameâRead/Write; String
- parentDataFrameNameâRead-only; String
- titleâRead/Write; String
- typeâRead-only; String
- Methods
- deleteThumbnail()
- findAndReplaceWorkspacePaths(find_workspace_path, replace_workspace_path, {validate})
- makeThumbnail()
- replaceWorkspaces(old_workspace_path, old_workspace_type, new_workspace_path, new_workspace_type, {validate})
- save()
- saveACopy(file_name, {version})
- Properties
- activeDataFrameâRead-only; DataFrame object
- activeViewâRead/Write; String
- authorâRead/Write; String
- creditsâRead-only; String
- dataDrivenPagesâRead-only; DataDrivenPages object
- dateExportedâRead-only; Python datetime object
- datePrintedâRead-only; Python datetime object
- dateSavedâRead-only; Python datetime object
- descriptionâRead/Write; String
- filePathâRead-only; String
- hyperlinkBaseâRead/Write; String
- isDDPEnabledâRead-only; Boolean
- pageSizeâRead-only; Python named tuple
- relativePathsâRead/Write; Boolean
- summaryâRead/Write; String
- tagsâRead/Write; String
- titleâRead/Write; String
- Properties
- elementHeightâRead/Write; Double
- elementPositionXâRead/Write; Double
- elementPositionYâRead/Write; Double
- elementWidthâRead/Write; String
- nameâRead/Write; String
- parentDataFrameNameâRead-only; String
- typeâRead-only; String
- Methods
- appendPages(pdf_path, {input_pdf_password})
- attachFile(file_path, {description})
- deletePages(page_range)
- insertPages(pdf_path, {before_page_number}, {input_pdf_password})
- saveAndClose()
- updateDocProperties({pdf_title}, {pdf_author}, {pdf_subject}, {pdf_keywords}, {pdf_open_view}, {pdf_layout})
- updateDocSecurity({new_master_password}, {new_user_password}, {encryption}, {permissions})
- Properties:
- pageCountâRead-only; Long
- Properties
- elementHeightâRead/Write; Double
- elementPositionXâRead/Write; Double
- elementPositionYâRead/Write; Double
- elementWidthâRead/Write; String
- nameâRead/Write; String
- sourceImageâRead/Write; String
- typeâRead-only; String
- Methods
- reclassify()
- Properties
- classBreakDescriptionsâRead/Write; Python list of strings
- classBreakLabelsâRead/Write; Python list of strings
- classBreakValuesâRead/Write; Python list of strings
- excludedValuesâRead/Write; String
- normalizationâRead/Write; String
- numClassesâRead/Write; Long
- valueFieldâRead/Write; String
- Properties
- itemNameâRead-only; String
- itemCategoryâRead-only; String
- styleFolderNameâRead-only; String
- Methods
- findAndReplaceWorkspacePath(find_workspace_path, replace_workspace_path, {validate})
- getSelectionSet()
- replaceDataSource(workspace_path, workspace_type, dataset_name, {validate})
- setSelectionSet(method, oidList)
- Properties
- datasetNameâRead-only; String
- dataSourceâRead-only; String
- definitionQueryâRead/Write; String
- isBrokenâRead-only; Boolean
- nameâRead/Write; String
- workspacePathâRead-only; String
- Methods
- clone({suffix})
- delete()
- Properties
- elementHeightâRead/Write; Double
- elementPositionXâRead/Write; Double
- elementPositionYâRead/Write; Double
- elementWidthâRead/Write; String
- fontSizeâRead/Write; Double
- nameâRead/Write; String
- textâRead/Write; String
- typeâRead-only; String
- Methods
- addAllValues()
- Properties
- classDescriptionsâRead/Write; Python list of strings
- classLabelsâRead/Write; Python list of strings
- classValuesâRead/Write; Python list of strings
- showOtherValuesâRead/Write; Boolean
- valueFieldâRead/Write; String