Workflow Activity Pack Documentation

⌘K
  1. Home
  2. Docs
  3. Workflow Activity Pack Do...
  4. Turf Activity Reference
  5. Utilities | Mask

Utilities | Mask

Description

Mask takes any type of Polygon FeatureSet and an optional polygon mask and returns a polygon exterior ring with holes.

Offline Support

Supported. Please contact us directly to license for offline support and installation instructions.

Example Workflow and Output Files

To open the sample workflow in Workflow Designer:

    • In Workflow Designer, click File in the sidebar
    • Click Open by URL and past in the following url:
      https://www.arcgis.com/home/item.html?id=ecdb71caea7c4dcdb160c6418332e9a2
    • To Save, click File in the Workflow Designer sidebar, and click Save.

Inputs

FeatureSet

Required
Type: Object
Object Type: esri.FeatureSet

The Polygon FeatureSet used as interior rings or holes.

Mask

Optional
Type: Object
Object Type: Feature

The Polygon used as the exterior ring. Defaults to world extent.

Outputs

Result

Type: Object
Properties:
success: Type: Boolean
graphic:  Type: Graphic
feature:  Type: Feature
error:  Type: String

A response object containing a success boolean, graphic, and a feature.

Properties

ID

Optional

The activity’s ID, which is used in other activities to access the activity’s output. The ID must be unique across the entire workflow and it’s subworkflows – two activities cannot have the same ID.

You might want to change the ID to shorten it. Shorter IDs make expressions more compact.

Display Name

Optional

The activity’s name in Workflow Designer. The display name appears at the top of the activity on the design surface. The default display name for this activity is Feature to Spreadsheet.

You might want to change the display name to a name that describes what the activity does in the context of your workflow. Description names make workflows easier to understand and maintain.

Description

Optional

A description of what the activity does. The description appears below the activity’s display name.

Use the description to record what the activity does in the context of the workflow. Descriptions make workflows easier to understand and maintain.