ListGrids (arcpyproduction.mapping)

Summary

Returns a list of Grid objects in a specified feature dataset.

Discussion

Grids created with the Make Grids And Graticules Layer geoprocessing tool or Grids and Graticules Designer are stored in a feature dataset within a workspace. ListGrids returns a list of Grid objects that are stored in the specified feature dataset.

Syntax

ListGrids (feature_dataset, {wildcard})

Parameter	Explanation	Data Type
feature_dataset	The path to the feature dataset that contains Grid objects.	String
wildcard	The wildcard limits the results returned. If no wildcard is specified, all values are returned.	String

Return Value

Data Type	Explanation
String	A list of Grid objects

Code Sample

ListGrids example 1

This sample lists the Grid objects within a specific dataset.

import arcpy
import arcpyproduction

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

# List Grid objects in the Grids dataset
arcpyproduction.mapping.ListGrids(r"C:\Tutorials\CartographicProduction\Austin.gdb\Grids")

# Check in extension
arcpy.CheckInExtension('foundation')

ListGrids example 2

The following script will get the group layer of a grid and add it to current map document as a group layer.

import arcpy
import arcpyproduction

# Check out Production Mapping extension
arcpy.CheckOutExtension('foundation')

# Set the grid workspace
grid_dataset = r"C:\Project\Grids.gdb\WGS84"

# Get the list of grids in the workspace that has name area1
lstGrids = arcpyproduction.mapping.ListGrids(grid_dataset, "area1")

# Get the layer from the grid object in the grid list
grid_layer = lstGrids[0].layer

# Access the current mxd and the first data frame in the mxd
mxd = arcpy.mapping.MapDocument("CURRENT")
df = arcpy.mapping.ListDataFrames(mxd)

# Add the grid group layer as the topmost layer in the first data frame
arcpy.mapping.AddLayer(df[0], grid_layer, "TOP")

# Save the mxd
mxd.save()

# Check in extension
arcpy.CheckInExtension('foundation')