Back to Top

FieldInfo

In this topic

  1. Summary
  2. Syntax
  3. Properties
  4. Method Overview
  5. Methods
  6. Code sample
Related topics
  1. Table View properties
  2. Layer properties

Summary

Provides field info methods and properties for layer and table views.

Syntax

 FieldInfo  ()

Properties

PropertyExplanationData Type
count
(Read Only)

The field count.

Integer

Method Overview

MethodExplanation
addField (field_name, new_field_name, visible, split_rule)

Adds a field info entry

exportToString ()

Exports the object to its string representation.

findFieldByName (field_name)

Finds the field index by field name

findFieldByNewName (field_name)

Finds the field index by new field name.

getFieldName (index)

Gets the field name from the table by index position.

getNewName (index)

Returns the new field name from the table by index position.

getSplitRule (index)

Gets the split rule from the table by index position.

getVisible (index)

Returns the visible flag from the table by index position.

loadFromString (string)

Restore or update the spatial reference object using a WKT string. The exportToString method can be used to export a WKT string representation of the spatial reference.

  • Using a WKT string with a horizontal coordinate system.
    # The following string is the WKT for the 
# Geographic Coordinate system "WGS 1984" (factory code=4326)
wkt = 'GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],\
              PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]];\
              -400 -400 1000000000;-100000 10000;-100000 10000;8.98315284119522E-09;\
              0.001;0.001;IsHighPrecision'

sr = arcpy.SpatialReference()
sr.loadFromString(wkt)
  • Using a WKT string with a horizontal and vertical coordinate system. Note that the vertical coordinate system is defined in the VERTCS section of the WKT.
    # The following string is the WKT for the 
# Geographic Coordinate system "WGS 1984" (factory code=4326), 
# with a vertical coordinate system "WGS 1984" (factory code=115700)

wkt = 'GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],\
              PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],\
              VERTCS["WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],\
              PARAMETER["Vertical_Shift",0.0],PARAMETER["Direction",1.0],UNIT["Meter",1.0]];\
              -400 -400 1000000000;-100000 10000;-100000 10000;8.98315284119522E-09;\
              0.001;0.001;IsHighPrecision'

sr = arcpy.SpatialReference()
sr.loadFromString(wkt)

removeField (index)

Removes a FieldInfo entry from a table.

setFieldName (index, field_name)

Sets the field name into the table.

setNewName (index, new_field_name)

Sets the new field name into the table.

setSplitRule (index, rule)

Sets the split rule into the table.

setVisible (index, visible)

Set the visible flag of a field on the table.

Methods

addField (field_name, new_field_name, visible, split_rule)
ParameterExplanationData Type
field_name

The field name from the input feature class or table.

String
new_field_name

Sets the field name for the new layer or table view.

String
visible

Sets whether the field is visible or hidden.

  • VISIBLE—Field is visible.
  • HIDDEN—Field is hidden.
String
split_rule

Sets the behavior of an attribute's values when a feature is split.

  • NONE—The attributes of the two resulting features take on a copy of the original value.
  • RATIO—The attributes of resulting features are a ratio of the original feature's value. The ratio is based on the division of the original geometry. If the geometry is divided equally, each new feature's attribute gets one-half of the value of the original object's attribute.
String
exportToString ()
Return Value
Data TypeExplanation
String

The WKT string representation of the object. 

findFieldByName (field_name)
ParameterExplanationData Type
field_name

The field name used to find its index position

String
Return Value
Data TypeExplanation
Integer

The index position

findFieldByNewName (field_name)
ParameterExplanationData Type
field_name

The new field name used to find its index position.

String
Return Value
Data TypeExplanation
Integer

The index position. 

getFieldName (index)
ParameterExplanationData Type
index

The index position.

Integer
Return Value
Data TypeExplanation
String

The field name.

getNewName (index)
ParameterExplanationData Type
index

The index position.

Integer
Return Value
Data TypeExplanation
String

The new field name.

getSplitRule (index)
ParameterExplanationData Type
index

The index position.

String
Return Value
Data TypeExplanation
String

The split rule.

  • NONE—The attributes of the two resulting features take on a copy of the original value.
  • RATIO—The attributes of resulting features are a ratio of the original feature's value. The ratio is based on the division of the original geometry. If the geometry is divided equally, each new feature's attribute gets one-half of the value of the original object's attribute.
getVisible (index)
ParameterExplanationData Type
index

The index position.

String
Return Value
Data TypeExplanation
String

The visible flag.

  • VISIBLE—Field is visible.
  • HIDDEN—Field is hidden.
loadFromString (string)
ParameterExplanationData Type
string

The WKT string representation of the object.

String
removeField (index)
ParameterExplanationData Type
index

The index position of the FieldInfo object.

Integer
setFieldName (index, field_name)
ParameterExplanationData Type
index

The index position.

Integer
field_name

The field name to set into the table.

String
setNewName (index, new_field_name)
ParameterExplanationData Type
index

The index position.

None
new_field_name

The new field name to set into the table.

String
setSplitRule (index, rule)
ParameterExplanationData Type
index

The index position.

Integer
rule

The split rule to set into the table.

  • NONE—The attributes of the two resulting features take on a copy of the original value.
  • RATIO—The attributes of resulting features are a ratio of the original feature's value. The ratio is based on the division of the original geometry. If the geometry is divided equally, each new feature's attribute gets one-half of the value of the original object's attribute.
String
setVisible (index, visible)
ParameterExplanationData Type
index

The index position.

Integer
visible

The visible policy to set into the table.

  • VISIBLE—Field is visible.
  • HIDDEN—Field is hidden.
String

Code sample

FieldInfo example

Display FieldInfo properties for a feature layer.

import arcpy

feature_class = "c:/Data/wells.shp"
layer = "temp_layer"
arcpy.MakeFeatureLayer_management(feature_class, layer)

# Create a describe object
desc = arcpy.Describe(layer)

# If a feature layer, continue
if desc.dataType == "FeatureLayer":

    # Create a fieldinfo object
    field_info = desc.fieldInfo

    # Use the count property to iterate through all the fields
    for index in range(0, field_info.count):
        # Print fieldinfo properties
        print("Field Name: {0}".format(field_info.getFieldName(index)))
        print("\tNew Name:   {0}".format(field_info.getNewName(index)))
        print("\tSplit Rule: {0}".format(field_info.getSplitRule(index)))
        print("\tVisible:    {0}".format(field_info.getVisible(index)))

Related topics

  • Table View properties
  • Layer properties

Feedback on this topic?

In this topic
  1. Summary
  2. Syntax
  3. Properties
  4. Method Overview
  5. Methods
  6. Code sample
Related topics
  1. Table View properties
  2. Layer properties