| 标注 | 说明 | 数据类型 |
输出要素类 | 生成的面索引要素的要素类。 输出要素类的坐标系按照以下方法确定：
| Feature Class |
输入要素 (可选) | 输入要素可用于定义将创建的面格网的范围。 | Feature Layer; Raster Layer |
生成与输入要素图层或数据集相交的面格网 (可选) | 指定是否将输出格网要素类限制为与输入要素图层或数据集相交的区域。输入要素的交集将用作创建索引要素。
| Boolean |
使用页面单位和比例 (可选) | 指定索引面的大小输入是否使用页面单位。
| Boolean |
地图比例 (可选) | 地图比例。如果索引面的高度和宽度要使用页面单位来计算，则必须指定比例。如果该工具在活动 ArcGIS Pro 会话以外使用，则默认比例值为 1。 | Long |
面宽度 (可选) | 使用地图单位或页面单位指定的索引面的宽度。如果使用页面单位，则默认值为 1 英寸。如果使用地图单位，则默认值为 1 度。 | Linear Unit |
面高度 (可选) | 使用地图单位或页面单位指定的索引面的高度。如果使用页面单位，则默认值为 1 英寸。如果使用地图单位，则默认值为 1 度。 | Linear Unit |
面格网原点坐标 (可选) | 输出格网要素类的左下角原点的坐标值。如果输入要素已指定，则默认值由这些要素的范围的并集来确定。如果未指定输入要素，则默认坐标为 0 和 0。 | Point |
行数 (可选) | 沿原点的 y 方向创建的行数。默认值为 10。 | Long |
列数 (可选) | 沿原点的 x 方向创建的列数。默认值为 10。 | Long |
起始页码 (可选) | 各格网索引要素将分配到连续的页码，起始页码需要指定。默认值为 1。 | Long |
从原点开始标注 (可选) | 指定页码（标注）的开始位置。
| Boolean |
摘要
创建一个可用作索引的矩形面要素格网，以在空间地图系列中指定页面。可创建一个仅包含与另一要素图层相交的面要素的格网。
使用情况
输出要素类的坐标系按照以下方法确定：
- 如果坐标系是通过输出坐标系环境指定的，则输出要素类将使用此坐标系。
- 如果坐标系不是通过输出坐标系环境指定的，则输出要素类将使用活动地图或地图框的坐标系。
- 如果坐标系不是通过输出坐标系环境指定的，并且没有活动地图（ArcGIS Pro 未打开），则输出要素类将使用第一个输入要素的坐标系。
- 如果坐标系不是通过输出坐标系环境指定的，并且没有活动地图（ArcGIS Pro 未打开），也没有指定的输入要素，则输出要素类的坐标系将为未知。
输入要素参数可以是点、线、面或栅格。
如果使用使用页面单位和比例参数，则需要地图比例参数。
使用工具对话框时，如果在已指定面格网原点坐标参数的情况下更改面的宽度或高度值，则行数和列数将自动更改。基于要素类范围的格网原点坐标，自动计算行和列。如果原点 x,y 坐标通过扩大总范围的方式进行修改，则更新相应的行和列数量。如果减少总范围，将忽略更改并使用要素的完整范围
当添加输入要素参数时，将自动计算面格网原点坐标参数值。
如果已选中使用页面单位和比例，则面宽度和面高度的单位将自动更改为在活动地图框中设置的页面单位。如果在 ArcGIS Pro 会话以外使用该工具，则单位默认为英寸。尽管可以指定地图单位（如米或英里），但最好还是使用适合页面的单位。
如果已选中使用页面单位和比例，地图比例将默认为页面布局上的活动地图框的比例值。如果在 ArcGIS Pro 会话以外使用该工具，则比例默认为 1。
为得到最佳结果，所有输入要素图层和要素类都应使用和地图或地图框相同的坐标系，或者如果在 ArcGIS Pro 会话以外使用该工具，则所有输入要素图层和要素类都应使用和列表中第一个输入要素图层或要素类相同的坐标系。
参数
arcpy.cartography.GridIndexFeatures(out_feature_class, {in_features}, {intersect_feature}, {use_page_unit}, {scale}, {polygon_width}, {polygon_height}, {origin_coord}, {number_rows}, {number_columns}, {starting_page_number}, {label_from_origin})| 名称 | 说明 | 数据类型 |
out_feature_class | 生成的面索引要素的要素类。 输出要素类的坐标系按照以下方法确定：
| Feature Class |
in_features [in_features,...] (可选) | 输入要素可用于定义将创建的面格网的范围。 | Feature Layer; Raster Layer |
intersect_feature (可选) | 将输出格网要素类限制为与输入要素图层或数据集相交的区域。输入要素的交集将用作创建索引要素。
| Boolean |
use_page_unit (可选) | 指定索引面的大小输入是否使用页面单位。
| Boolean |
scale (可选) | 地图比例。如果索引面的高度和宽度要使用页面单位来计算，则必须指定比例。如果该工具在活动 ArcGIS Pro 会话以外使用，则默认比例值为 1。 | Long |
polygon_width (可选) | 使用地图单位或页面单位指定的索引面的宽度。如果使用页面单位，则默认值为 1 英寸。如果使用地图单位，则默认值为 1 度。 | Linear Unit |
polygon_height (可选) | 使用地图单位或页面单位指定的索引面的高度。如果使用页面单位，则默认值为 1 英寸。如果使用地图单位，则默认值为 1 度。 | Linear Unit |
origin_coord (可选) | 输出格网要素类的左下角原点的坐标值。如果输入要素已指定，则默认值由这些要素的范围的并集来确定。如果未指定输入要素，则默认坐标为 0 和 0。 | Point |
number_rows (可选) | 沿原点的 y 方向创建的行数。默认值为 10。 | Long |
number_columns (可选) | 沿原点的 x 方向创建的列数。默认值为 10。 | Long |
starting_page_number (可选) | 各格网索引要素将分配到连续的页码，起始页码需要指定。默认值为 1。 | Long |
label_from_origin (可选) | 指定页码（标注）的开始位置。
| Boolean |
代码示例
在如下示例中，将通过输入要素的交集和以地图单位指定的索引要素的大小来创建格网索引要素。
import arcpy
arcpy.env.workspace = "C:\data\ProjectData.gdb"
arcpy.GridIndexFeatures_cartography("gridIndexFeatures","poly", "", "", "",
"1000 meters", "1000 meters")在如下示例中，将通过输入要素的整个范围和以页面单位指定的索引要素的大小来创建格网索引要素。
import arcpy
arcpy.env.workspace = "C:\data\ProjectData.gdb"
arcpy.GridIndexFeatures_cartography("gridIndexFeatures","poly",
"NO_INTERSECTFEATURE", "USEPAGEUNIT",
"100000", "5 inches", "5 inches")在如下示例中，将通过输入要素的交集、以地图单位指定的索引要素的大小以及起始页码 5 来创建格网索引要素。
import arcpy
arcpy.env.workspace = "C:\data\ProjectData.gdb"
arcpy.GridIndexFeatures_cartography("gridIndexFeatures","poly", "", "", "",
"1000 meters", "1000 meters", "", "",
"", "5")在如下示例中，将通过指定原点坐标、使用地图单位的索引要素尺寸、行数和列数来创建格网索引要素。
import arcpy
arcpy.env.workspace = "C:\data\ProjectData.gdb"
arcpy.GridIndexFeatures_cartography("gridIndexFeatures", "", "", "", "",
"1000 meters","1000 meters",
"-6000000 -1600000", "15", "20")在如下示例中，将通过指定原点坐标、使用页面单位的索引要素尺寸、行数、列数、起始页码 5 以及将在原点开始的标注来创建格网索引要素。
import arcpy
arcpy.env.workspace = "C:\data\ProjectData.gdb"
arcpy.GridIndexFeatures_cartography("gridIndexFeatures", "", "", "USEPAGEUNIT",
"100000", "5 inches", "5 inches",
"-6000000 -1600000", "15", "20", "5",
"LABELFROMORIGIN")在如下示例中，将通过输入要素的交集和以地图单位指定的索引要素的大小来创建格网索引要素。
# gridindexfeatures_example1.py
# Description: Creates Grid Index Features using the intersection of input
# features and specified index feature dimensions in map units
# Author: ESRI
# Import system modules
import arcpy
from arcpy import env
# Set environment settings
arcpy.env.workspace = "C:\data\ProjectData.gdb"
# Set local variables
outFeatureClass = "gridIndexFeatures"
inFeatures = "poly"
polygonWidth = "1000 meters"
polygonHeight= "1000 meters"
# Execute GridIndexFeatures
arcpy.GridIndexFeatures_cartography(outFeatureClass,inFeatures, "", "", "",
polygonWidth, polygonHeight)在如下示例中，将通过输入要素的整个范围和以页面单位指定的索引要素的大小来创建格网索引要素。
# gridindexfeatures_example2.py
# Description: Creates Grid Index Features using the entire extent of input
# features and specified index feature dimensions in page units
# Author: ESRI
# Import system modules
import arcpy
from arcpy import env
# Set environment settings
arcpy.env.workspace = "C:\data\ProjectData.gdb"
# Set local variables
outFeatureClass = "gridIndexFeatures"
inFeatures = "poly"
noIntersect = "NO_INTERSECTFEATURE"
usePageUnit = "USEPAGEUNIT"
scale = "100000"
polygonWidth = "5 inches"
polygonHeight= "5 inches"
# Execute GridIndexFeatures
arcpy.GridIndexFeatures_cartography(outFeatureClass, inFeatures, noIntersect,
usePageUnit, scale, polygonWidth,
polygonHeight)在如下示例中，将通过输入要素的交集、以地图单位指定的索引要素的大小以及起始页码 5 来创建格网索引要素。
# gridindexfeatures_example3.py
# Description: Creates Grid Index Features using the intersection of input
# features, specified index feature dimensions in map units and 5 as the
# starting page number
# Author: ESRI
# Import system modules
import arcpy
from arcpy import env
# Set environment settings
arcpy.env.workspace = "C:\data\ProjectData.gdb"
# Set local variables
outFeatureClass = "gridIndexFeatures"
inFeatures = "poly"
polygonWidth = "1000 meters"
polygonHeight= "1000 meters"
startingPageNum = "5"
# Execute GridIndexFeatures
arcpy.GridIndexFeatures_cartography(outFeatureClass,inFeatures, "", "", "",
polygonWidth, polygonHeight, "", "", "",
startingPageNum)在如下示例中，将通过指定原点坐标、使用地图单位的索引要素尺寸、行数和列数来创建格网索引要素。
# gridindexfeatures_example4.py
# Description: Creates Grid Index Features by specifying the origin
# coordinates, the index feature dimensions in map units, the number of
# rows and the number of columns
# Author: ESRI
# Import system modules
import arcpy
from arcpy import env
# Set environment settings
env.workspace = "C:\data\ProjectData.gdb"
env.outputCoordinateSystem = arcpy.SpatialReference("North America Albers Equal Area Conic.prj")
# Set local variables
outFeatureClass = "gridIndexFeatures"
polygonWidth = "1000 meters"
polygonHeight= "1000 meters"
originCoord = "-6000000 -1600000"
numberRows = "15"
numberColumns = "20"
# Execute GridIndexFeatures
arcpy.GridIndexFeatures_cartography(outFeatureClass, "", "", "", "",
polygonWidth, polygonHeight, originCoord,
numberRows, numberColumns)在如下示例中，将通过指定原点坐标、使用页面单位的索引要素尺寸、行数、列数、起始页码 5 以及将在原点开始的标注来创建格网索引要素。
# gridindexfeatures_example5.py
# Description: Creates Grid Index Features by specifying the origin
# coordinates, the index feature dimensions in page units, the number of
# rows, the number of columns, 5 as the starting page number and labeling
# to start at the origin
# Author: ESRI
# Import system modules
import arcpy
from arcpy import env
# Set environment settings
env.workspace = "C:\data\ProjectData.gdb"
env.outputCoordinateSystem = arcpy.SpatialReference("North America Albers Equal Area Conic.prj")
# Set local variables
outFeatureClass = "gridIndexFeatures"
usePageUnit = "USEPAGEUNIT"
scale = "100000"
polygonWidth = "1000 meters"
polygonHeight= "1000 meters"
originCoord = "-6000000 -1600000"
numberRows = "15"
numberColumns = "20"
startingPageNum = "5"
labeling = "LABELFROMORIGIN"
# Execute GridIndexFeatures
arcpy.GridIndexFeatures_cartography(outFeatureClass, "", "", usePageUnit,
scale, polygonWidth, polygonHeight,
originCoord, numberRows, numberColumns,
startingPageNum, labeling)许可信息
- Basic: 是
- Standard: 是
- Advanced: 是