topic Re: Python Toolbox-populate drop-down with field values in Python Questions

Python Toolbox-populate drop-down with field values

BrianKaplan — Mon, 04 Jan 2016 04:36:05 GMT

Hi,

There are a few discussions on this topic but I'm not finding the solution I need or it is right in front of my face and I'm missing it completely.

I'm using Desktop 10.3. I'm am trying to create a geoprocessing tool with the input dialogue box requesting the user to select:

1. Feature class e.g US States

2. Field with the States name in the Feature Class e.g. stateNames

3. A drop-down of the 50 states where the user can select one of the states.

I'm trying to use the python toolbox tool template (portion shown below). I'm able to populate a drop-down of the fields and now need to have the user select a value from the field.

Any suggestions?

Thanks

Brian

class tool(object):

def __init__(self):

"""Define the tool (tool name is the name of the class)."""

self.label = "tool"

self.description = ""

self.canRunInBackground = True

def getParameterInfo(self):

# first paramter

in_feature = arcpy.Parameter(

displayName = "Feature with States",

name = "in_feature",

datatype = "Feature Layer",

parameterType = "Required",

direction = "Input")

stateField = arcpy.Parameter(

displayName = "Field with State Names",

name = "stateField",

datatype = "Field",

parameterType = "Required",

direction = "Input")

stateField.filter.list = ['Text']

stateField.parameterDependencies = [in_feature.name]

stateName = arcpy.Parameter(

displayName = "Select one State",

name = "stateName",

datatype = "GPValueTable",

parameterType = "Required",

direction = "Input")

return

def updateParameters(self, parameters):

"""Modify the values and properties of parameters before internal

validation is performed. This method is called whenever a parameter

has been changed."""

return

Re: Python Toolbox-populate drop-down with field values

Luke_Pinner — Fri, 10 Dec 2021 21:07:01 GMT

I thought there was a way to do this easily with parameterDependencies, but can't get that to work. But below is another way:

class Tool(object):
    def __init__(self):
        """Define the tool (tool name is the name of the class)."""
        self.label = "Tool"
        self.description = ""
        self.canRunInBackground = False

    def getParameterInfo(self):
        """Define parameter definitions"""

        in_feature = arcpy.Parameter(
           displayName = "Feature with States",
           name = "in_feature",
           datatype = "Feature Layer",
           parameterType = "Required",
           direction = "Input")

        stateField = arcpy.Parameter(
           displayName = "Field with State Names",
           name = "stateField",
           datatype = "Field",
           parameterType = "Required",
           direction = "Input")

        stateField.parameterDependencies = [in_feature.name]

        stateName = arcpy.Parameter(
           displayName = "Select one State",
           name = "stateName",
           datatype = "GPString",
           parameterType = "Required",
           direction = "Input")

        stateName.filter.type = "ValueList"
        stateName.filter.list = []

        return [in_feature, stateField, stateName]

    def updateParameters(self, parameters):
        """Modify the values and properties of parameters before internal
        validation is performed.  This method is called whenever a parameter
        has been changed."""
        if parameters[1].value:
            with arcpy.da.SearchCursor(parameters[0].valueAsText, parameters[1].valueAsText) as rows:
                parameters[2].filter.list = sorted(list(set([row[0] for row in rows])))
        else:
            parameters[2].filter.list = []

        return

Re: Python Toolbox-populate drop-down with field values

BrianKaplan — Tue, 05 Jan 2016 03:56:05 GMT

Luke, Thank you so very much. It works great. Brian

Re: Python Toolbox-populate drop-down with field values

Yuriko — Mon, 29 Apr 2019 22:38:33 GMT

Thanks for this!

Re: Python Toolbox-populate drop-down with field values

jaykapalczynski — Mon, 17 May 2021 14:50:56 GMT

I am new to this....how is the class called from Python and used?

Is there a simply example of this code in its entirety where when you run it you just see the dropdown and the populated list?