Linear reference

DatatypeDraftv1.0.0-rc.2

A linear reference: a place stated as a distance along a line, such as a kilometre post on a pipeline. As in ISO 19148.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/LinearReference.json

Fields

lineRequired
Id ofany record
The id of the record that has the line, such as a pipeline or a road. Its geometry is a LineString or a MultiLineString.
distanceRequired
DatatypeValue
The distance along the line, as the owner of the line counts it, from the start of the line or from the referent.
referent
textnot empty
The marked point on the line that the distance starts from, such as KP 12. Leave it out when the distance starts from the start of the line.
offset
DatatypeValue
The distance to the side of the line: positive to the right of the line's direction, negative to the left. Leave it out when the place is on the line.

Links

Held by Records that embed this one, with their field that holds it.

LocationDatatypelinearReferenceOne place, as a point with the heights that matter for it. A location can also state the place in other ways, such as a legal land description or a distance along a line, and a place that has no coordinates has only those. Coordinates are in GeoJSON order (x, y): longitude then latitude…

Examples

An id that another example defines opens that record.

Example 2

{
  "line": "feature-pipeline",
  "distance": {
    "amount": 400,
    "unit": "m"
  },
  "referent": "KP 12",
  "offset": {
    "amount": -15,
    "unit": "m"
  }
}

Show 1 more example

Example 1

{
  "line": "feature-pipeline",
  "distance": {
    "amount": 12.4,
    "unit": "km"
  }
}

Changes and file

Changes

0.1.0 First version.

Schema file

Show the JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/LinearReference.json",
  "title": "Linear reference",
  "description": "A linear reference: a place stated as a distance along a line, such as a kilometre post on a pipeline. As in ISO 19148.",
  "type": "object",
  "properties": {
    "line": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "*",
      "description": "The id of the record that has the line, such as a pipeline or a road. Its `geometry` is a LineString or a MultiLineString."
    },
    "distance": {
      "$ref": "Value.json",
      "description": "The distance along the line, as the owner of the line counts it, from the start of the line or from the referent."
    },
    "referent": {
      "type": "string",
      "minLength": 1,
      "description": "The marked point on the line that the distance starts from, such as `KP 12`. Leave it out when the distance starts from the start of the line."
    },
    "offset": {
      "$ref": "Value.json",
      "description": "The distance to the side of the line: positive to the right of the line's direction, negative to the left. Leave it out when the place is on the line."
    }
  },
  "required": [
    "line",
    "distance"
  ],
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "line": "feature-pipeline",
      "distance": {
        "amount": 12.4,
        "unit": "km"
      }
    },
    {
      "line": "feature-pipeline",
      "distance": {
        "amount": 400,
        "unit": "m"
      },
      "referent": "KP 12",
      "offset": {
        "amount": -15,
        "unit": "m"
      }
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "datatype",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}