ModelAssets

open_in_new

A container for all of the assets associated with a model. The elements within this will generally implement Asset and/or AssetBundle in order to provide links for downloading the Asset. Once these links are generated they will often only be valid for a short period of time (which may be checked via validUntil) so they should be downloaded immediately or a new request for the url should be sent.

GraphQL Schema definition

  • type ModelAssets {
  • # The panoramic images associated with the model.
  • #
  • # Arguments
  • # resolutions: If specified only return resolutions matching one
  • # in this list
  • panos(resolutions: [String!]): [PanoramicImage!]!
  • # Video clips associated with the model.
  • clips: [Clip!]!
  • # Retrieves a single floorplan matching the
  • # specified criteria.
  • #
  • # @error not.found If there are no floorplans matching the given criteria.
  • #
  • # Arguments
  • # provider: The provider that generated the floorplan.
  • # If not specified this will match floorplans from all providers.
  • # format: The file format of the asset, options currently include
  • # 'png', 'jpg', 'dxf' and 'zip'
  • # although not all floorplans support all formats, and formats may be added in the
  • # future.
  • # If not specified this will match floorplans of all formats.
  • # floor: The ID of the floor that the floorplan should correspond
  • # to.
  • # If not specified this will match floorplans for all floors.
  • # flags: A set of flags that the floorplan must have.
  • floorplan(
  • provider: String,
  • format: String,
  • floor: ID,
  • flags: [FloorplanFlag!]
  • ): Floorplan!
  • # Retrieves all floorplans matching the
  • # specified criteria. If no criteria are provided this will
  • # return all available floorplans. If no floorplans match the criteria
  • # an empty array will be returned.
  • #
  • # Arguments
  • # provider: The provider that generated the floorplan.
  • # If not specified this will match floorplans from all providers.
  • # formats: The file format of the asset, options currently
  • # include 'png', 'jpg', 'dxf' and 'zip'
  • # although not all floorplans support all formats, and formats may be added in the
  • # future.
  • # If not specified this will match floorplans of all formats.
  • # floors: The IDs of the floors that the floorplans should
  • # correspond to.
  • # If not specified this will match floorplans for all floors.
  • # flags: A set of flags that the floorplan must have to be
  • # included in the list of results.
  • floorplans(
  • provider: String,
  • formats: [String!],
  • floors: [ID!],
  • flags: [FloorplanFlag!]
  • ): [Floorplan!]
  • # A single snapshot associated with the model.
  • #
  • # @error not.found If there is no image with the given id.
  • #
  • # Arguments
  • # id: undefined
  • photo(id: ID!): Photo
  • # Snapshots associated with the model.
  • photos: [Photo!]!
  • # The 3D geometries associated with the model.
  • #
  • # Arguments
  • # formats: undefined
  • # resolutions: undefined
  • meshes(formats: [String!], resolutions: [String!]): [Mesh!]!
  • # Texture maps that may be overlaid on the 3D geometries to form a 3D image.
  • #
  • # Arguments
  • # qualities: undefined
  • # resolutions: undefined
  • textures(qualities: [TextureQuality!], resolutions: [String!]): [Texture!]!
  • # Additional assets associated with the model.
  • #
  • # Arguments
  • # format: undefined
  • resources(format: [String]): [Asset]
  • # Estimate of the total size of the requested asset type.
  • sizeEstimates: ScanEstimates!
  • }

Require by