In a Python toolbox, the parameter's datatype property is set using the Parameter class in the getParameterInfo method.
def getParameterInfo(self): #Define parameter definitions # First parameter param0 = arcpy.Parameter( displayName="Input workspace", name="in_workspace", datatype="DEWorkspace", parameterType="Required", direction="Input")
Composite data types
Occasionally, the need arises for a parameter to accept multiple data types, often referred to as a composite data type. In a Python toolbox, composite data types are defined by assigning a list of data types to the parameter's datatype property. In the following example, a parameter is defined that accepts a raster dataset or a raster catalog:
def getParameterInfo(self): #Define parameter definitions # First parameter param0 = arcpy.Parameter( displayName="Input Raster Dataset", name="in_rasterdataset", datatype=["DERasterDataset", "DERasterCatalog"], parameterType="Required", direction="Input")
Every tool parameter has an associated data type.
|Data type||datatype keyword||Description|
A dataset used for geocoding that stores the address attributes, associated indexes, and rules that define the process for translating nonspatial descriptions of places to spatial data.
Analysis Cell Size
The cell size used by raster tools.
A data type that accepts any value.
A file that contains one map, its layout, and its associated layers, tables, charts, and reports.
An areal unit type and value, such as square meter or acre.
A Boolean value.
CAD Drawing Dataset
A vector data source mixed with feature types and symbology. The dataset is not usable for feature class-based queries or analysis.
A calculator expression.
A collection of references to different data types. The data types can be from different locations and are managed and visualized dynamically as layers based on location, time, and other attributes.
The top-level node in the Catalog tree.
The cell size used by the ArcGIS Spatial Analyst extension.
Cell Size XY
Defines the two sides of a raster cell.
A reference to several children layers, including symbology and rendering properties.
Specifies the type of compression used for a raster.
A reference framework, such as the UTM system consisting of a set of points, lines, or surfaces, and a set of rules used to define the positions of points in two- and three-dimensional space.
Coordinate Systems Folder
A folder on disk storing coordinate systems.
A coverage dataset, a proprietary data model for storing geographic features as points, arcs, and polygons with associated feature attribute tables.
Coverage Feature Class
A coverage feature class, such as point, arc, node, route, route system, section, polygon, and region.
A dataset visible in ArcCatalog.
A data file.
The database connection folder in ArcCatalog.
A collection of related data, usually grouped or stored together.
A date value.
Attribute data stored in dBASE format.
Specifies a subset of nodes of a TIN to create a generalized version of that TIN.
A diagram layer.
An access path to a data storage device.
Any floating-point number stored as a double precision, 64-bit value.
Encrypted string for passwords.
The coordinate pairs that define the minimum bounding rectangle in which the data source falls.
The scale value range and increment value applied to inputs in a weighted overlay operation.
Specifies the coordinate pairs that define the minimum bounding rectangle (x-minimum, y-minimum and x-maximum, y-maximum) of a data source. All coordinates for the data source fall in this boundary.
An extract values parameter.
A collection of spatial data with the same shape type: point, multipoint, polyline, and polygon.
A collection of feature classes that share a common geographic area and the same spatial reference system.
A reference to a feature class, including symbology and rendering properties.
Interactive features that draw the features when the tool is run.
A column in a table that stores the values for a single attribute.
The details about a field in a field map.
A collection of fields in one or more input tables.
A file on disk.
Specifies a location on disk where data is stored.
A raster surface whose cell values are represented by a formula or constant.
Specifies the algorithm used in fuzzification of an input raster.
A collection of data with a common theme in a geodatabase.
A coarse-grained object that references a geodatabase.
A linear network represented by topologically connected edge and junction features. Feature connectivity is based on their geometric coincidence.
A reference to a geostatistical data source, including symbology and rendering properties.
Geostatistical Search Neighborhood
Defines the searching neighborhood parameters for a geostatistical layer.
Geostatistical Value Table
A collection of data sources and fields that define a geostatistical layer.
A Globe server.
A geoprocessing server.
Graph Data Table
A graph data table.
A collection of layers that appear and act as a single layer. Group layers make it easier to organize a map, assign advanced drawing order options, and share layers for use in other maps.
The relationship between the horizontal cost factor and the horizontal relative moving angle.
An image service.
A data structure used to speed the search for records in geographic datasets and databases.
A syntax for defining and manipulating data in an INFO table.
An item in an INFO table.
A table in an INFO database.
Internet Tiled Layer
An internet tiled layer.
A KML layer.
A LAS dataset stores reference to one or more LAS files on disk as well as to additional surface features. A LAS file is a binary file that stores airborne lidar data.
LAS Dataset Layer
A layer that references a LAS dataset on disk. This layer can apply filters on lidar files and surface constraints referenced by a LAS dataset.
A reference to a data source, such as a shapefile, coverage, geodatabase feature class, or raster, including symbology and rendering properties.
A layer file stores a layer definition, including symbology and rendering properties.
A shape, straight or curved, defined by a connected series of unique x,y-coordinate pairs.
A linear unit type and value such as meter or feet.
An integer number value.
A range of lowest and highest possible value for m-coordinates.
An ArcGIS Pro map.
A map server.
Map Server Layer
A map server layer.
A collection of raster and image data that allows you to store, view, and query the data. It is a data model in the geodatabase used to manage a collection of raster datasets (images) stored as a catalog and viewed as a mosaicked image.
A layer that references a mosaic dataset.
The shape of the area around each cell used to calculate statistics.
Network Analyst Class FieldMap
Mapping between location properties in a Network Analyst layer (such as stops, facilities, and incidents) and a point feature class.
Network Analyst Hierarchy Settings
A hierarchy attribute that divides hierarchy values of a network dataset into three groups using two integers. The first integer sets the ending value of the first group; the second number sets the beginning value of the third group.
Network Analyst Layer
A special group layer used to express and solve network routing problems. Each sublayer held in memory in a Network Analyst layer represents some aspect of the routing problem and the routing solution.
Network Data Source
A network data source can be a local dataset specified either using its catalog path or a layer from a map, or it can be a URL to a portal.
A collection of topologically connected network elements (edges, junctions, and turns), derived from network sources and associated with a collection of network attributes.
Network Dataset Layer
A reference to a network dataset, including symbology and rendering properties.
Network Travel Mode
A dictionary of travel mode objects.
Parcel Fabric For ArcMap
A parcel fabric is a dataset for the storage, maintenance, and editing of a continuous surface of connected parcels or parcel network.
Parcel Fabric Layer
A layer referencing a parcel fabric on disk. This layer works as a group layer organizing a set of related layers under a single layer.
A pair of x,y-coordinates.
A connected sequence of x,y-coordinate pairs, where the first and last coordinate pair are the same.
A file storing coordinate system information for spatial data.
Specifies whether pyramids are built.
Specifies which surrounding points are used for interpolation.
Random Number Generator
Specifies the seed and the generator to use when creating random values.
A layer in a raster dataset.
Raster Calculator Expression
A raster calculator expression.
A collection of raster datasets defined in a table. Each table record defines an individual raster dataset in the catalog.
Raster Catalog Layer
A reference to a raster catalog, including symbology and rendering properties.
Raster Data Layer
A raster data layer.
A single dataset built from one or more rasters.
A reference to a raster, including symbology and rendering properties.
Specifies whether raster statistics build.
Raster data is added to a mosaic dataset by specifying a raster type. The raster type identifies metadata, such as georeferencing, acquisition date, and sensor type, with a raster format.
Interactive table; type in the table values when the tool is run.
The details about the relationship between objects in the geodatabase.
A table that defines how raster cell values are reclassified.
Route Measure Event Properties
Specifies the fields on a table that describe events measured by a linear reference route system.
Scene Service Layer
A scene service layer.
A schematic dataset contains a collection of schematic diagram templates and schematic feature classes that share the same application domain, for example, water or electrical.
A schematic diagram.
Schematic Diagram Class
A schematic diagram class.
A schematic folder.
A schematic layer is a composite layer composed of feature layers based on the schematic feature classes associated with the template on which the schematic diagram is based.
Specifies the distance and direction representing two locations used to quantify autocorrelation.
A server connection.
Spatial data in a shapefile format.
The coordinate system used to store a spatial dataset, including the spatial domain.
A syntax for defining and manipulating data from a relational database.
A text value.
A string that is masked by * characters.
The text is not encrypted when used in scripting.
A representation of tabular data for viewing and editing purposes, stored in memory or on disk.
A reference to a terrain, including symbology and rendering properties. It’s used to draw a terrain.
A text file.
Specifies the width and the height of data stored in block.
Specifies the time periods used for calculating solar radiation at specific locations.
A time unit type and value such as minutes or hours.
A vector data structure that partitions geographic space into contiguous, nonoverlapping triangles. The vertices of each triangle are sample data points with x-, y-, and z-values.
A reference to a TIN, including topological relationships, symbology, and rendering properties.
A geoprocessing tool.
A geoprocessing toolbox.
Features that are input to the interpolation.
A topology that defines and enforces data integrity rules for spatial data.
A reference to a topology, including symbology and rendering properties.
A Spatial Analyst transformation function.
A layer that references a trajectory dataset.
A utility network.
Utility Network Layer
A utility network layer.
A collection of columns of values.
A data value that can contain any basic type: Boolean, date, double, long, and string.
Vector Tile Layer
A vector tile layer.
Specifies the relationship between the vertical cost factor and the vertical, relative moving angle.
Spatial data stored in Vector Product Format.
Attribute data stored in Vector Product Format.
Web Coverage Service (WCS) is an open specification for sharing raster datasets on the web.
Weighted Overlay Table
A table with data to combine multiple rasters by applying a common measurement scale of values to each raster, weighing each according to its importance.
Specifies data for overlaying several rasters, each multiplied by their given weight and summed.
A WMS map.
A container such as a geodatabase or folder.
A range of lowest and highest possible values for x,y-coordinates.
A range of lowest and highest possible values for z-coordinates.