Nutrient Web SDK
    Preparing search index...

    Type Alias TemplateImageValue

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

    type TemplateImageValue = {
        _type: "image";
        altText?: string;
        borderColor?: string;
        borderStyle?: string;
        borderWidth?: number;
        caption?: string;
        captionLabel?: string;
        captionPosition?: string;
        data?: string;
        format?: TemplateImageFormat;
        height?: number;
        link?: string;
        pageNumber?: number;
        path?: string;
        rotation?: number;
        sizing?: TemplateImageSizing;
        source: TemplateImageSource;
        title?: string;
        url?: string;
        width?: number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Additional vendor-specific options passed through to GdPicture.

    Index

    Properties

    _type altText? borderColor? borderStyle? borderWidth? caption? captionLabel? captionPosition? data? format? height? link? pageNumber? path? rotation? sizing? source title? url? width?

    Properties

    _type

    _type: "image"

    Discriminator for template image values.

    altText?: string

    Alternative text for accessibility metadata.

    borderColor?: string

    Border color in hex/rgb form supported by GdPicture.

    borderStyle?: string

    Border style supported by GdPicture.

    borderWidth?: number

    Border width in pixels.

    caption?: string

    Caption text.

    captionLabel?: string

    Caption label/prefix text.

    captionPosition?: string

    Caption position supported by GdPicture.

    data?: string

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

    format?: TemplateImageFormat

    Explicit image format, required for some raw base64 payloads.

    height?: number

    Height in pixels, required for some sizing modes.

    link?: string

    Hyperlink URL for the inserted image.

    pageNumber?: number

    1-based page index for multipage image sources.

    path?: string

    Alias for source location in some payloads (file / url).

    rotation?: number

    Rotation in degrees.

    sizing?: TemplateImageSizing

    Image sizing mode.

    source: TemplateImageSource

    Source type of the image payload.

    title?: string

    Image title metadata.

    url?: string

    HTTP(S) URL when source is url.

    width?: number

    Width in pixels, required for some sizing modes.

    Settings

    Member Visibility

    On This Page

    Properties