Skip to content

Latest commit

 

History

History
201 lines (110 loc) · 4.43 KB

geoshape.schema.md

File metadata and controls

201 lines (110 loc) · 4.43 KB

Geo Shape Schema

http://schema.org/GeoShape

The geographic shape of a place. Based on schema.org.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted external/schema/geoshape.schema.json

Schema Hierarchy

  • Geo Shape http://schema.org/GeoShape

Geo Shape Example

{
  "@id": "https://data.adobe.io/entities/geo/shapeid123",
  "schema:description": "GeoCircle of New York Metro",
  "schema:circle": {
    "@id": "https://data.adobe.io/entities/geo/circleid123",
    "schema:description": "New York Metro",
    "schema:coordinates": {
      "@id": "https://data.adobe.io/entities/geo/111",
      "schema:description": "New York",
      "schema:latitude": 37.3308953,
      "schema:longitude": -121.8939894,
      "schema:elevation": 31.0896
    },
    "schema:radius": 80000
  }
}

Geo Shape Properties

Property Type Required Defined by
@id string Optional Geo Shape (this schema)
schema:box Geo Coordinates Optional Geo Shape (this schema)
schema:circle Geo Circle Optional Geo Shape (this schema)
schema:description string Optional Geo Shape (this schema)
schema:elevation number Optional Geo Shape (this schema)
schema:polygon Geo Coordinates Optional Geo Shape (this schema)
xdm:ceiling number Optional Geo Shape (this schema)
* any Additional this schema allows additional properties

@id

Shape ID

The unique identifier of the shape.

@id

  • is optional
  • type: string
  • defined in this schema

@id Type

string

schema:box

Box

The area enclosed by the rectangle formed by two coordinates. The first coordinate is the lower corner and the second coordinate is the upper corner of a rectangle.

schema:box

  • is optional
  • type: Geo Coordinates
  • between 2 and 2 items in the array
  • defined in this schema

schema:box Type

Array type: Geo Coordinates

All items must be of the type:

schema:circle

Circle

A circular region with a specific radius centered on a geographic coordinate.

schema:circle

  • is optional
  • type: Geo Circle
  • defined in this schema

schema:circle Type

schema:description

Description

A description of what the shape is defining.

schema:description

  • is optional
  • type: string
  • defined in this schema

schema:description Type

string

schema:elevation

Elevation

The specific or minimum elevation of the shape. This value conforms to the WGS84 datum and is measured in meters. In combination with ceiling, this property can be used to express a three-dimensional bounding box for a location.

schema:elevation

  • is optional
  • type: number
  • defined in this schema

schema:elevation Type

number

schema:polygon

Polygon

A series of four or more coordinates where the first and final coordinates are identical. In schema.org, this is a plain text. In XDM, it is a structured array instead.

schema:polygon

  • is optional
  • type: Geo Coordinates
  • at least 4 items in the array
  • defined in this schema

schema:polygon Type

Array type: Geo Coordinates

All items must be of the type:

xdm:ceiling

Ceiling

The maximum elevation of the shape. Only valid when used in combination with elevation. This value conforms to the WGS84 datum and is measured in meters. This value is not part of the schema.org spec. In combination with elevation, this property can be used to express a three-dimensional bounding box for a location.

xdm:ceiling

  • is optional
  • type: number
  • defined in this schema

xdm:ceiling Type

number