12.7 Images

An image is a link to an image file¹¹⁷ that does not have a description part, for example

./img/cat.jpg

If you wish to define a caption for the image (see Captions) and maybe a label for internal cross references (see Internal Links), make sure that the link is on a line by itself and precede it with ‘CAPTION’ and ‘NAME’ keywords as follows:

#+CAPTION: This is the caption for the next figure link (or table)
#+NAME:   fig:SED-HR4049
[[./img/a.jpg]]

Such images can be displayed within the buffer with the following command:

C-c C-x C-v (org-toggle-inline-images) ¶

Toggle the inline display of linked images. When called with a prefix argument, also display images that do have a link description. You can ask for inline images to be displayed at startup by configuring the variable org-startup-with-inline-images¹¹⁸.

By default, Org mode displays inline images according to their actual width. You can customize the displayed image width using org-image-actual-width variable (globally) or ‘ORG-IMAGE-ACTUAL-WIDTH’ property (subtree-level)¹¹⁹. Their value can be the following:

• (default) Non-nil, use the actual width of images when inlining them.
• When set to a number, use imagemagick (when available) to set the image’s width to this value.
• When set to a number in a list, try to get the width from any ‘#+ATTR.*’ keyword if it matches a width specification like:

  #+ATTR_HTML: :width 300px
  

  and fall back on that number if none is found.

• When set to nil, try to get the width from an ‘#+ATTR.*’ keyword and fall back on the original width if none is found.

Inline images can also be displayed when cycling the folding state. When custom option org-cycle-inline-images-display is set, the visible inline images under subtree will be displayed automatically.