Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageArticleBody

An image inside an article's body.

Hierarchy

Index

Properties

alt

alt: string

Text used for describing the image to non-sighted users

Optional aspectRatio

aspectRatio: "square" | "regulare" | "landscape" | "headline" | "vertical" | "auto"

The aspect ratio to use for drawing the image

Optional aspects

aspects: object

The object should have keys representing aspect names (belgrade|landscape|headline|regular|square|vertical|full), each an aspect object, with the following keys: { width, height, x, y }

Type declaration

contentId

contentId: string

A unique content id

Optional contentName

contentName: string

The content's instance name Will often be used as the title of a Content item, for instance an Author's name or an Articls's title.

Optional credit

credit: string

The image's credit information

Optional description

description: string

Image Text: the text used as part of the image's caption

Optional imageLayoutPosition

imageLayoutPosition: ImageLayoutPosition

The layout position of an image inside an article's body

imageType

imageType: "image" | "infographic"

Text for the title attribute. Shows up as a tooltip when the mouse hovers above the image

imgArray

imgArray: ImgArrayItem[]

Data about each individual image asociated with the different use cases

inputTemplate

inputTemplate: string

The name of the content type, e.g., 'youtubeVideoEmbed'

isAnimated

isAnimated: boolean

Whether the image object is an animated gif

Generated using TypeDoc