Nutrient Web SDK

ReferenceTemplateImageValue

Type Alias TemplateImageValue

Describes an image value used by image template markers ({{%name}}, {{%%name}}).

Type Alias

Indexable

  • [key: string]: unknown

    Additional vendor-specific options passed through to GdPicture.

Properties

_type

"image"

Discriminator for template image values.

altText

Optional
string

Alternative text for accessibility metadata.

borderColor

Optional
string

Border color in hex/rgb form supported by GdPicture.

borderStyle

Optional
string

Border style supported by GdPicture.

borderWidth

Optional
number

Border width in pixels.

caption

Optional
string

Caption text.

captionLabel

Optional
string

Caption label/prefix text.

captionPosition

Optional
string

Caption position supported by GdPicture.

data

Optional
string

Base64 payload or data URL when source is base64 / dataUrl.

format

Optional
TemplateImageFormat

Explicit image format, required for some raw base64 payloads.

height

Optional
number

Height in pixels, required for some sizing modes.

pageNumber

Optional
number

1-based page index for multipage image sources.

path

Optional
string

Legacy alias for url in URL-based payloads (not a local filesystem path).

rotation

Optional
number

Rotation in degrees.

sizing

Optional
TemplateImageSizing

Image sizing mode.

source

TemplateImageSource

Source type of the image payload.

title

Optional
string

Image title metadata.

url

Optional
string

HTTP(S) URL when source is url.

width

Optional
number

Width in pixels, required for some sizing modes.