A point in the model for users to comment and attach other media.

GraphQL Schema definition

  • type Note implements Annotation {
  • id: ID!
  • created: DateTime!
  • modified: DateTime!
  • label: String
  • enabled: Boolean!
  • # The user who created the note.
  • createdBy: UserMetadata!
  • # The resolution status of the note. Resolved notes are typically hidden.
  • resolution: ResolutionStatus!
  • # The model this note is associated with.
  • model: Model
  • # The floor this note is on.
  • floor: ModelFloor
  • # The room the note is located in.
  • room: ModelRoom
  • # An RGB hex string representing the highlight color for the note.
  • color: String
  • # The note anchor's position.
  • anchorPosition: Point
  • # The position of the icon marking the note.
  • discPosition: Point
  • # The normalized unit vector of the stem's direction from the anchor to the note's
  • # icon.
  • stemNormal: Point
  • # The length of the note stem.
  • stemLength: Float
  • # Whether or not to show a stem or line from the anchor
  • # to the note icon.
  • stemEnabled: Boolean
  • firstCommentAt: DateTime
  • lastCommentAt: DateTime
  • totalComments: Int!
  • # Comments made on this note, ordered by created date.
  • #
  • # Arguments
  • # sortBy: How to sort the list of comments.
  • # pageSize: The number of comments to return per page.
  • # offset: The page offset. This should be undefined for the
  • # first page.
  • comments(sortBy: CommentSort, pageSize: Int, offset: String): CommentResultList
  • }