Skip to content

Attribute

Describes data attached to an Element.

Each Element can have zero or more attributes, each attached to different parts of the element and each containing different types of data. On a set of points, one attribute might contain gold assay results and another rock-type classifications.

Fields

data: AttributeData
The attribute data.
description: string
Optional attribute description.
location: Location

Selects which part of the element the attribute is attached to.

See the documentation for each Geometry variant for a list of what locations are valid.

metadata: object
Attribute metadata.
name: string
Attribute name. Should be unique within the containing element.
units: string

Optional unit of the attribute data, default empty.

OMF does not currently attempt to standardize the strings you can use here, but our recommendations are:

  • Use full names, so "kilometers" rather than "km". The abbreviations for non-metric units aren't consistent and complex units can be confusing.

  • Use plurals, so "feet" rather than "foot".

  • Avoid ambiguity, so "long tons" rather than just "tons".

  • Accept American and British spellings, so "meter" and "metre" are the same.

Schema

{
  "type": "object",
  "required": [
    "data",
    "location",
    "name"
  ],
  "properties": {
    "data": {
      "$ref": "#/definitions/AttributeData"
    },
    "description": {
      "type": "string"
    },
    "location": {
      "$ref": "#/definitions/Location"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true
    },
    "name": {
      "type": "string"
    },
    "units": {
      "type": "string"
    }
  }
}