Generate Tessellations

binType

(Required)

Specifies the tessellation shape. Bin options are as follows:

• Diamond
• Hexagon
• Square—This is the default.
• TransverseHexagon
• Triangle
• H3_Hexagon—Available in ArcGIS Online and ArcGIS Enterprise 11.2 or later.

Example: "binType" : "Hexagon"

binSize

Required if binType is not H3_Hexagon

The size of each bin. Cell size can be determined by specifying square units or by specifying a distance that is calculated using the following measurements in which d = Distance:

Square
Hexagon
Transverse Hexagon
Triangle
Diamond

Example: "binSize" : 100

binSizeUnit

Required if binType is not H3_Hexagon

Specifies the linear or areal unit to be used with the value specified in binSize.

Values: Meters | Kilometers | Feet | Miles | NauticalMiles | Yards | SquareKilometers | Hectares | SquareMeters | SquareMiles | Acres | SquareYards | SquareFeet | SquareInches

The default is SquareKilometers.

Example: "binSizeUnit" : "Miles"

extentLayer

The extent that the tessellations will cover.

Syntax: As described in detail in the Feature input topic, this parameter can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features
• A feature collection

Examples:

• {"url": <feature service layer url>, "filter": <where clause>}
• {"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

intersectStudyArea

A Boolean value that specifies whether only tessellations that intersect with the extent layer (extentLayer) will be kept. The default is false.

This parameter is only applied if an extent layer has been provided.

false
true

Values: true | false

binResolution

Required if binType is H3_Hexagon

The H3 resolution of the tessellations. The resolution can range from 0 to 15. With each increasing resolution size, the area of the polygons will decrease to one-seventh the size at the lower resolution.

Learn more about H3 resolution

This parameter is available in ArcGIS Online and ArcGIS Enterprise 11.2 or later.

REST examples

1
2
//REST scripting example
"binResolution": 2

outputName

If provided, the task will create a feature service of the results. You define the name of the service. If an outputName value is not provided, the task will return a feature collection.

Syntax:

1
2
3
4
5
{
  "serviceProperties": {
    "name": "<service name>"
  }
}

In ArcGIS Online or ArcGIS Enterprise 10.9.1 and later, you can overwrite an existing feature service by providing the itemId value of the existing feature service and setting the overwrite property to true. Including the serviceProperties parameter is optional. As described in the Feature output topic, you must either be the owner of the feature service or have administrative privileges to perform the overwrite.

Syntax:

1
2
3
4
5
6
7
{

  "itemProperties": {
			"itemId": "<itemID of the existing feature service>",
			"overwrite": true
	}
}

or

1
2
3
4
5
6
7
8
9
{
"serviceProperties": {
    "name": "<existing service name>"
  },
"itemProperties": {
				"itemId": "<itemID of the existing feature service>",
				"overwrite": true
	}
}

context

The Context parameter contains the following additional settings that affect task operation:

• Extent (extent)—A bounding box that defines the analysis area. Only input features that intersect the bounding box will be analyzed.
• Output spatial reference (outSR)—The output features will be projected into the output spatial reference.

Syntax:

1
2
3
4
{
  "extent" : {extent},
  "outSR" : {spatial reference}
}

f

The response format. The default response format is html.

Values: html | json

tessellationLayer

tessellationLayer will always contain polygon features.

Request example:

1
{"url":"http://<analysis url>/GenerateTessellations/jobs/<jobId>/results/tessellationLayer"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter value provided in the initial request.

• If an outputName value was provided, value contains the URL to the feature service layer.

1
2
3
4
5
{
"paramName":"tessellationLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice layer url>"}
}

• If no outputName value was provided, value contains a feature collection.

1
2
3
4
5
{
"paramName":"tessellationLayer",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}  }
}

See Feature output for more information about how the result layer or collection is accessed.