Definition

Features contain geometry and represent an Asset on the map. They are associated with a single Asset by ‘assetId’ and linked to a Project by its projectId

A Feature’s map representation is determined by two things: geometry and styling. A Feature’s geometry ties it to real-world coordinates while the styling decides its appearance on the map.

Geometry Types

  • Point - A shape with a single geographical coordinate (e.g., the location of a telephone pole).
  • LineString - Two or more coordinates and the line(s) between them (e.g., a road or pipeline)
  • Polygon - A closed shape consisting of four or more Points (e.g., a building outline or parcel)
  • Multi-Point - A shape with multiple, disconnected geographical coordinates (e.g., the locations of all homes currently for sale)
  • Multi-LineString - A shape consisting of one or more disconnected LineStrings (e.g., lanes of a divided highway)
  • Multi-Polygon - A shape consisting of one or more disconnected Polygons (e.g., the state of Hawaii)

Attributes

Features have the following attributes:

  • featureId - The unique identifier representing a Feature
  • assetId - An Asset ID associates an Asset with the Feature.
  • projectId - The ID of the Project containing the Feature.
  • creatorId - The ID of the User who created the Feature.
  • featureTypeId - A Feature Type ID associates the Feature with an Asset Type in the Project toolbox.
  • isVisible - This indicates whether the Asset is visible on the map. 0 = Invisible. 1 = Shown.
  • geometry - The Geometry Type and set of coordinates.
  • properties - A JSON object that contains other unique Feature or styling data.
  • createdDateTime - The date and time when a User created the Feature.
  • updatedDateTime - The most recent date and time a User updated the Feature.

Styling for a feature can be defined by associating a FeatureStyle(link) with the feature's FeatureType, (link). Data used in conjunction with the FeatureStyle for runtime styling of a specific feature can be placed in the feature's properties.

A feature's type can be associated with a Toolbox tool by defining a FeatureType. Use the Toolbox's FeatureType to define a geometry at the feature's creation time or to define feature property defaults or styling for all features of that type. Features are associated with a tool in the toolbox by the featureTypeId

How to Use Features

Through the UI

You can modify a Feature’s appearance on the map through the UI if editable properties are defined in the featureType.

A Feature’s appearance can also be linked to a control in its parent Asset in the featureType. For example, a Feature’s icon can change based on the value of a drop-down control in the Asset form. In this case, a worker could finish the installation of an Asset, select “Complete” from a drop-down in the Asset’s form, and see the color of the Asset change from red to green.

Through the API

You can create, modify, and delete Features with the right Role & Permissions.

You can search, filter, and order Features based on their shared properties, such as createdDateTime, updatedDateTime, creator, etc.

You can also search Features by geographic region.

A Note on Styling

You can define styling for a Feature by associating a FeatureStyle with the Feature's FeatureType. If you’re using data in conjunction with the FeatureStyle for runtime styling of a specific Feature, you can place this in the Feature’s properties.

A Feature's type can be associated with an Asset Type by defining a FeatureType. Use the Project’s FeatureType to define a geometry at the Feature's creation time, Feature property defaults, or styling for all Features of that type. Features are associated with an Asset Type in a Project by the featureTypeId.