IMAGE Property Type

The IMAGE property type loads relative or absolute image paths, file icons, file types, and SF Symbols.

"image": {
  "type": "file",
  "src": "animage.png"
}

Properties

size
OBJECT

The optional preferred size of this image. It's possible to only set either the width or height which will automatically derive the height or width.

width
INTEGER
Default: 0

The width of the image, use 0 for automatic.

height
INTEGER
Default: 0

The height of the image, use 0 for automatic.

type
"file" | "fileicon" | "filetypeicon" | "symbol"
Default: "file"

The type of image data expected in the src field.

Value Description
"file" Load src as the image at the given path e.g. image.png.
"fileicon" Load the file icon at the given src path.
"filetypeicon" Load the file type icon for the file at the given src path.
"symbol" Load the SF Symbol image with the given src name.
src
STRING
Required

The source of the given type e.g. a file path or symbol name.