Array (arcpy)

Summary

The array object can contain any number of geoprocessing objects such as points, geometries, or spatial references.

Syntax

Array ({items})
ParameterExplanationData Type
items

Items can include a list, a Point object, or another Array object.

Object

Properties

PropertyExplanationData Type
count
(Read Only)

The element count of the array.

Integer

Method Overview

MethodExplanation
add (value)

Adds a point or array object to the end of the array

append (value)

Appends an object to the array in the last position.

clone (point_object)

Clone the point object.

extend (items)

Extends the array by appending elements.

getObject (index)

Returns the object at the given index position in the array.

insert (index, value)

Adds an object to the array at the specified index.

next ()

Returns the next object at the current index.

remove (index)

Removes the object at the specified index position from the array.

removeAll ()

Removes all values and creates an empty object.

replace (index, value)

Replaces the object at the specified index position in the array.

reset ()

Sets the current enumeration index (used by the next method) back to the first element.

Methods

add (value)
ParameterExplanationData Type
value

Either a point or array object can be appended to the array.

Object
append (value)
ParameterExplanationData Type
value

Either a point or array object can be appended to the array.

Object
clone (point_object)
ParameterExplanationData Type
point_object

A point object.

Point
extend (items)
ParameterExplanationData Type
items

Extends the array by adding strings, integers, or lists.

Object
getObject (index)
ParameterExplanationData Type
index

The index position of the array.

Integer
Return Value
Data TypeExplanation
Object

The array or point object at the index position.

insert (index, value)
ParameterExplanationData Type
index

The index position of the array.

Integer
value

Either a point or array object can be inserted into the array.

Object
next ()
Return Value
Data TypeExplanation
Object

The next object at the current index.

remove (index)
ParameterExplanationData Type
index

The index position that will be removed.

Integer
removeAll ()
replace (index, value)
ParameterExplanationData Type
index

The index position that will be replaced.

Integer
value

The new point or array object to be added to the array.

Object
reset ()

Code Sample

Array example

Create a polyline feature class from scratch.

import arcpy

# A list of features and coordinate pairs
feature_info = [[[1, 2], [2, 4], [3, 7]],
                [[6, 8], [5, 7], [7, 2], [9, 5]]]

# A list that will hold each of the Polyline objects
features = []

for feature in feature_info:
    # Create a Polyline object based on the array of points
    # Append to the list of Polyline objects
    features.append(
        arcpy.Polyline(
            arcpy.Array([arcpy.Point(*coords) for coords in feature])))

# Persist a copy of the Polyline objects using CopyFeatures
arcpy.CopyFeatures_management(features, "c:/geometry/polylines.shp")

Related Topics

2/5/2014