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

ListGrids

Available with Standard or Advanced license.

Available with Production Mapping license.

  • Summary
  • Discussion
  • Syntax
  • Code sample

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})
ParameterExplanationData 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 TypeExplanation
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')

Related topics

  • Grid
  • 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