Skip to content

Configures attachments in popup elements.

Referenced by: popupElement

Properties

Property Details
attachmentKeywords[] An array of strings used to identify attachment(s). When attachments are displayed, this property is used to query attachments using an exact match on the keywords provided.
attachmentTypes[] An array of strings representing MIME types. When attachments are displayed, this property is used to query attachments based on MIME type. Valid values: application, audio, image, model, text, and video.
description An optional string value describing the element in detail.
displayType This property applies to elements of type attachments. A string value indicating how to display the attachment. If list is specified, attachments show as links. If preview is specified, attachments expand to the width of the pop-up. The default auto setting allows applications to choose the most suitable default experience.
Valid values:
  • auto
  • list
  • preview
orderByFields[] Array of orderByField objects indicating the display order for the attachments, and whether they should be sorted in ascending 'asc' or descending 'desc' order.
title An optional string value indicating what the element represents.
type
Valid value of this property attachments

Example

{
  "type": "attachments",
  "displayType": "list",
  "attachmentTypes": [
    "image",
    "video"
  ],
  "attachmentKeywords": [
    "front_damage",
    "back_damage"
  ],
  "title": "Damage assessment",
  "description": "Photos and videos showing the damage to the front and back of a building.",
  "orderByFields": [
    {
      "field": "id",
      "order": "desc"
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.