MattertagPatch

open_in_new

GraphQL Schema definition

  • input MattertagPatch {
  • # The ID of the floor the Mattertag is on
  • floorId: ID
  • # If this is set to false this Mattertag should not be shown
  • # by players. See Model.mattertags(enabled)
  • enabled: Boolean
  • # An RGB hex string representing the highlight color for the Mattertag.
  • color: String
  • # A short label for the Mattertag, 60 character limit.
  • label: String
  • # A longer description of the Mattertag, 2,000 character limit.
  • description: String
  • # The type of media available at the given url.
  • # If this is specified, then mediaUrl must be set either by
  • # this request or previously.
  • mediaType: MattertagMediaType
  • # A URL to external media to associate with the Mattertag.
  • mediaUrl: String
  • # The position of the Mattertag anchor.
  • anchorPosition: IPoint3D
  • # Whether or not to show a line from the anchor
  • # to the Mattertag disc.
  • # Default: true if stemNormal is specified, false otherwise.
  • stemEnabled: Boolean
  • # The normalized unit vector of the line from the Mattertag anchor
  • # to the Mattertag disc.
  • stemNormal: IPoint3D
  • # The length of the line from the Mattertag anchor
  • # to the Mattertag disc.
  • stemLength: Float
  • # @deprecated Deprecated after v2020.05.04, renamed to anchorPosition for clarity.
  • position: IPoint3D
  • # @deprecated Deprecated after v2020.05.04, split into stemNormal and stemLength
  • # for clarity.
  • stemDirection: IPoint3D
  • # An optional icon name for the Mattertag.
  • #
  • # The valid values and associated images
  • # are listed at
  • # https://matterport.github.io/showcase-sdk/tags_icons_reference.html
  • #
  • # A patch with the empty string "" may be used to clear the icon, unspecified or
  • # null will not update the value.
  • #
  • # Use of any string other than what is documented above may fail to render.
  • icon: String
  • # Keywords associated with this mattertag.
  • keywords: [String!]
  • }