Furniture

Furniture API calls give you access to a broad furniture library powered by Archilogic.

Namespace: io3d.furniture

Searches the library using a text query. Will return a promise which resolves with a list of furniture objects (without geometry data).

Example

Get a list of max 50 furniture objects related to wood and chair:

  io3d.furniture.search('Wood Chair', { limit: 50 }).then(console.log)
Parameter Type Required? Description
query String Yes An string specifying search options (see below) or null to return random furniture pieces.
options Object No
options.limit Number No How many results will be returned at most.

get

Gets a single furniture piece including its geometry and metadata.

Example

The following snippet reads a single piece of furniture using a specific furniture ID:

  io3d.furniture.get('943357e8-911f-4bb5-8b89-8281385ef08f').then(console.log)
Parameter Type Required? Description
furnitureId String Yes The ID of the furniture piece to retrieve. Obtain furnitureIds from the furniture library: at https://furniture.3d.io

getInfo

Gets metadata information for a single furniture piece. This method skip the loading geometry and therefore uses less bandwith than io3d.furniture.get.

Example

The following snippet reads the metadata of a single piece of furniture using a specific furniture ID:

  io3d.furniture.getInfo('943357e8-911f-4bb5-8b89-8281385ef08f').then(console.log)
Parameter Type Required? Description
furnitureId String Yes The ID of the furniture piece to retrieve. Obtain furnitureIds from the furniture library: at https://furniture.3d.io

Furniture Metadata

Exemplary metadata structure included in io3d.furniture.search, io3d.furniture.get and io3d.furniture.getInfo.

{
  "id": "5b97e7b5-2d13-4489-bf76-013ad70949fe",
  "name": "Basel Chair",
  "description": "With the Basel Chair, Jasper Morrison renews the classic genre of simple wooden chairs, which have been industrially produced over the past 100 years in great quantity and variety.",
  "manufacturer": "Vitra",
  "designer": "Jasper Morrison",
  "indexImage": "https://storage.3d.io/archilogic/interior/vitra/chairs/Basel-Chair/info/3d.png",
  "images": [
    "https://storage.3d.io/archilogic/interior/vitra/chairs/Basel-Chair/info/Basel1.jpg",
    "https://storage.3d.io/archilogic/interior/vitra/chairs/Basel-Chair/info/Basel3.jpg",
    "https://storage.3d.io/archilogic/interior/vitra/chairs/Basel-Chair/info/Basel2.jpg"
  ],
  "url": "https://www.vitra.com/en-gb/product/basel-chair",
  "year": 2008,
  "collectionIds": [ "6f8407e0-9ff2-4bbd-89fb-85946eba9748" ],
  "tags": [ "chair" ],
  "styles": [],
  "categories": [ "seating", "dining" ],
  "colours": [],
  "boundingBox": { "length": 0.42, "width": 0.46, "height": 0.78 },
  "boundingPoints": { "min": [-0.21,0,-0.23], "max": [0.21,0.78,0.23] },
  "updated": "2017-02-23T20:30:09Z"
}