OpeningDetails

open_in_new

@beta This is part of the Property Insights Beta Used to create and patch bounded region edge openings.

GraphQL Schema definition

  • input OpeningDetails {
  • # Create: If this field is set, it will serve as the ID for the new Opening,
  • # otherwise a new ID will be generated.
  • # Patch: This id field represents the ID of the opening to patch the data of.
  • id: ID
  • # @deprecated Opening's layerId is tied directly to it's edge's layer. It can not
  • # be patched directly.
  • layerId: ID
  • height: Float
  • width: Float
  • lowerElevation: Float
  • # Openings are understood relative to the edges they are defined on.
  • # The 'relativeCenter' is the fractional length (between 0 and 1) of the center of
  • # the opening along the edge
  • # coincident with the first listed vertex on the edge if set to 0, halfway along
  • # the edge if set to .5, etc.
  • relativeCenter: Float
  • # The type of opening in the boundary edge.
  • # e.g. doorway, window, etc.
  • type: OpeningType
  • # The units of length for 'height', 'width', and 'lowerElevation' on this
  • # mutation.
  • units: Units
  • }