com.scanash.content.image Documentation (EN)

main object

An image uploaded for a site.standard.document body. Held on the record (nested in the markdown content's `images` list) so the PDS retains the blob.

Properties

alt string Optional

Alt text describing the image for accessibility.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes

aspectRatio ref #aspectRatio Optional

Intrinsic pixel dimensions, so the renderer can reserve space and avoid layout shift.

image blob Required

No description available.

maxSize: 5.0 MB

View raw schema

{
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxLength": 10000,
      "description": "Alt text describing the image for accessibility.",
      "maxGraphemes": 1000
    },
    "image": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 5000000
    },
    "aspectRatio": {
      "ref": "#aspectRatio",
      "type": "ref",
      "description": "Intrinsic pixel dimensions, so the renderer can reserve space and avoid layout shift."
    }
  },
  "description": "An image uploaded for a site.standard.document body. Held on the record (nested in the markdown content's `images` list) so the PDS retains the blob."
}

aspectRatio object

Intrinsic dimensions of the image in pixels.

Properties

height integer Required

No description available.

minimum: 1

width integer Required

No description available.

minimum: 1

View raw schema

{
  "type": "object",
  "required": [
    "width",
    "height"
  ],
  "properties": {
    "width": {
      "type": "integer",
      "minimum": 1
    },
    "height": {
      "type": "integer",
      "minimum": 1
    }
  },
  "description": "Intrinsic dimensions of the image in pixels."
}