A room within the model, this acts as a container for other information.
- type ModelRoom implements LayeredElement {
- : ID!
- # The layer the Room is associated with
- : ModelLayer
- # A user displayable label for the room.
- : String
- # Cortex generated classifiers for the room.
- : [String]
- # Estimate of the dimensions of the room.
- #
- # @deprecated 05/17/2023
- #
- # Arguments
- # units: undefined
- (: Units): Dimension
- # Dimension estimates based on room boundary data.
- #
- # Arguments
- # units: undefined
- (: Units): Dimensions
- # The primary floor this room is located on.
- : ModelFloor
- # Lists the measurements that have been taken in this room.
- #
- # @error model.inactive: If the model is inactive (archived).
- #
- # Arguments
- # includeDisabled: Include measurements which are currently
- # disabled in the public view of the model.
- # Default: false
- (: Boolean): [Measurement!]!
- # Lists the measurement paths that have at least one point in this room.
- #
- # @error model.inactive: If the model is inactive (archived).
- #
- # Arguments
- # includeDisabled: Include measurement paths which are currently
- # disabled in the public view of the model.
- # Default: false
- (: Boolean): [MeasurementPath!]!
- # Lists the notes associated with this model room.
- #
- # @error model.inactive: If the model is inactive (archived).
- #
- # Arguments
- # includeDisabled: Include notes which are currently disabled in
- # the public view of the model.
- # Default: false
- # resolutionStatus: Only include notes whose resolutions matches
- # the provided status.
- (: Boolean, : [ResolutionStatus!]): [Note!]
- # @beta This is part of the Property Insights Beta
- #
- # The overhead view of the room's boundaries (e.g. walls, doors, etc.).
- # This defines the perimeter of a room.
- : BoundedRegion
- # @beta This is part of the Property Insights Beta
- #
- # Any holes within the boundary of this ModelRoom
- # (e.g. a room within the room, or a hollow space
- # surrounded by walls like a chimney flue).
- #
- # Holes are spaces within rooms which do not contribute
- # to their bounded area.
- : [BoundedRegion!]
- # @beta This is part of the Property Insights Beta
- #
- # The room's classifications. A list of possible classifications
- # available on this model can be found at Model.roomClassifications
- # in this graph API.
- : [RoomClassification!]
- # @beta This is part of the Property Insights Beta
- #
- # The room's keywords. By default, this will be populated by the union of it's
- # 'classifications.defaultKeywords'.
- # A patchRoom mutation including the 'keywords' field will override and replace
- # this default.
- : [String!]
- # Locations of interest within a room. This is generally used to render
- # waypoints to navigate through a model.
- #
- # @error model.inactive: If the model is inactive (archived).
- #
- # Arguments
- # ids: If specified only locations with the given ids will be
- # included.
- # If the same id is repeated the location will only appear in the result list
- # once.
- # If no location with a given id exists there will be no corresponding entry in
- # the list.
- # tags: If specified only locations that contain all the
- # specified tags will be included.
- (: [String!], : [String!]): [AnchorLocation!]
- # Locations within the room that have a panoramic image associated with them.
- # The location is the position of the camera showing the panorama and is usually
- # associated with an anchor location that should be used for navigation.
- #
- # @error model.inactive: If the model is inactive (archived).
- #
- # Arguments
- # ids: If specified only locations with the given ids will be
- # included.
- # If the same id is repeated the location will only appear in the result list
- # once.
- # If no location with a given id exists there will be no corresponding entry in
- # the list.
- # variants: If specified only return locations that match one of
- # the specified variants.
- (: [String!], : [String!]): [PanoramicImageLocation!]
- }