注意 当サイトは、Typst v0.13.1 公式ドキュメントを、日本語コミュニティが非公式に翻訳したものです。誤訳・未訳・古い情報が含まれている可能性があるため、公式ドキュメント との併用を推奨します。このサイトの内容に誤りを発見された方は、GitHubリポジトリまでご報告を頂けましたら幸いです。我々のコミュニティにご興味のある方は、ぜひ非公式Discordサーバー「くみはんクラブ」にご参加ください。
Warning: This site provides an unofficial translation of the Typst v0.13.1 documentation by the Japanese Community. Please note that there may be some inaccuracies, untranslated sections or outdated information. We highly recommend referring to the latest official documentation as well. If you find any errors in the content, please let us know through our GitHub repository. If you are interested in our community, feel free to join our unofficial Discord server, “Kumihan Club.”
Typst ドキュメント日本語版

image Element
Element functions can be customized with set and show rules.

A raster or vector graphic.

You can wrap the image in a figure to give it a number and caption.

Like most elements, images are block-level by default and thus do not integrate themselves into adjacent paragraphs. To force an image to become inline, put it into a box.

Example

#figure(
  image("molecular.jpg", width: 80%),
  caption: [
    A step in the molecular testing
    pipeline of our lab.
  ],
)
Preview

引数
Parameters are the inputs to a function. They are specified in parentheses after the function name.

source
str bytes
RequiredPositional
Positional parameters are specified in order, without names.

A path to an image file or raw bytes making up an image in one of the supported formats.

Bytes can be used to specify raw pixel data in a row-major, left-to-right, top-to-bottom format.

View example
#let original = read("diagram.svg")
#let changed = original.replace(
  "#2B80FF", // blue
  green.to-hex(),
)

#image(bytes(original))
#image(bytes(changed))
Preview

format
auto str dictionary
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

The image's format.

By default, the format is detected automatically. Typically, you thus only need to specify this when providing raw bytes as the source (even then, Typst will try to figure out the format automatically, but that's not always possible).

Supported formats are "png", "jpg", "gif", "svg" as well as raw pixel data. Embedding PDFs as images is not currently supported.

When providing raw pixel data as the source, you must specify a dictionary with the following keys as the format:

The pixel width multiplied by the height multiplied by the channel count for the specified encoding must then match the source data.

Default:auto

View example
#image(
  read(
    "tetrahedron.svg",
    encoding: none,
  ),
  format: "svg",
  width: 2cm,
)

#image(
  bytes(range(16).map(x => x * 16)),
  format: (
    encoding: "luma8",
    width: 4,
    height: 4,
  ),
  width: 2cm,
)
Preview

width
auto relative
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

The width of the image.

Default:auto

height
auto relative fraction
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

The height of the image.

Default:auto

alt
none str
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

A text describing the image.

Default:none

fit
str
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

How the image should adjust itself to a given area (the area is defined by the width and height fields). Note that fit doesn't visually change anything if the area's aspect ratio is the same as the image's one.

Default:"cover"

View example
#set page(width: 300pt, height: 50pt, margin: 10pt)
#image("tiger.jpg", width: 100%, fit: "cover")
#image("tiger.jpg", width: 100%, fit: "contain")
#image("tiger.jpg", width: 100%, fit: "stretch")
Preview

scaling
auto str
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

A hint to viewers how they should scale the image.

When set to auto, the default is left up to the viewer. For PNG export, Typst will default to smooth scaling, like most PDF and SVG viewers.

Note: The exact look may differ across PDF viewers.

Default:auto

icc
auto str bytes
Settable
Settable parameters can be customized for all following uses of the function with a set rule.

An ICC profile for the image.

ICC profiles define how to interpret the colors in an image. When set to auto, Typst will try to extract an ICC profile from the image.

Default:auto

定義
Functions and types and can have associated definitions. These are accessed by specifying the function or type, followed by a period, and then the definition's name.

decode

Decode a raster or vector graphic from bytes or a string.

data
str bytes
RequiredPositional
Positional parameters are specified in order, without names.

The data to decode as an image. Can be a string for SVGs.

format

The image's format. Detected automatically by default.

width

The width of the image.

height

The height of the image.

alt

A text describing the image.

fit
str

How the image should adjust itself to a given area.

scaling

A hint to viewers how they should scale the image.