ModelFloor

open_in_new

Represents a floor within the model. This is generally used as a navigation helper as well as a container for rooms, locations and annotations.

GraphQL Schema definition

  • type ModelFloor implements LayeredElement {
  • id: ID!
  • # The layer the Floor is associated with
  • layer: ModelLayer
  • # The floor's name as labeled in workshop/showcase.
  • label: String
  • # Gets the dimensions of the floor, if available,
  • # in the specified units. If no units are specified
  • # the configured account setting will be used.
  • #
  • # @deprecated 05/17/2023
  • #
  • # Arguments
  • # units: undefined
  • dimensions(units: Units): Dimension
  • # @beta This is part of the Property Insights Beta
  • # Dimension estimates based on the collected data from rooms on this floor.
  • #
  • # Arguments
  • # units: undefined
  • dimensionEstimates(units: Units): Dimensions
  • # Lists the rooms on this floor, optionally filtering
  • # by id and/or tags.
  • #
  • # @error model.inactive: If the model is inactive (archived).
  • #
  • # Arguments
  • # ids: undefined
  • # tags: undefined
  • rooms(ids: [ID], tags: [String]): [ModelRoom]
  • # The floor's sequence in the vertical order of floors (spatially lowest floor
  • # starts at sequence 0, next is 1, etc.)
  • sequence: Int!
  • # Lists the Mattertags that are on this floor.
  • #
  • # @error model.inactive: If the model is inactive (archived).
  • #
  • # Arguments
  • # includeDisabled: Include Mattertags which are currently
  • # disabled in the public view of the model.
  • # Default: false
  • mattertags(includeDisabled: Boolean): [Mattertag!]!
  • # Lists the measurements that have been taken on this floor.
  • #
  • # @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
  • measurements(includeDisabled: Boolean): [Measurement!]!
  • # Lists the measurement paths that have at least one point on this floor.
  • #
  • # @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
  • measurementPaths(includeDisabled: Boolean): [MeasurementPath!]!
  • # Lists the notes associated with this model floor.
  • #
  • # @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.
  • notes(includeDisabled: Boolean, resolutionStatus: [ResolutionStatus!]): [Note!]
  • # @beta This is part of the Property Insights Beta
  • # Bounded region vertices available on this floor.
  • #
  • # Arguments
  • # includeUsed: Include vertices already associated with rooms on
  • # the floor.
  • # default: true
  • vertices(includeUsed: Boolean): [Vertex!]
  • # @beta This is part of the Property Insights Beta
  • # Bounded region edges available on this floor.
  • #
  • # Arguments
  • # includeUsed: Include edges already associated with rooms on the
  • # floor.
  • # default: true
  • edges(includeUsed: Boolean): [Edge!]
  • # Locations of interest on a floor. 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.
  • locations(ids: [String!], tags: [String!]): [AnchorLocation!]
  • # Locations on a floor 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.
  • panoLocations(ids: [String!], variants: [String!]): [PanoramicImageLocation!]
  • }

Require by