figure
Element
Element functions can be customized with set
and show
rules.
set
and show
rules.任意でキャプションを持つ図表。
自動的にその種類を検出し、それぞれに応じて番号付けします。 例えば、画像を含む図表は表を含む図表とは別々に番号が付けられます。
Examples
以下の例は、画像を含む基本的な図表を示しています。
@glacier shows a glacier. Glaciers
are complex systems.
#figure(
image("glacier.jpg", width: 80%),
caption: [A curious figure.],
) <glacier>
図表に tables を挿入してキャプションを付けることもできます。 図表は表を含むこと検出し、自動的に別のカウンターを使用します。
#figure(
table(
columns: 4,
[t], [1], [2], [3],
[y], [0.3s], [0.4s], [0.8s],
),
caption: [Timing results],
)
この動作は、図表の種類である kind
を明示的に指定することで上書き可能です。
同じ種類の図表はすべて共通のカウンターを共有します。
図表の動作
デフォルトでは、図表はコンテンツの流れの中に配置されます。
図表をページの上部または下部に配置するには、placement
引数を使用します。
図表が大きすぎてその内容がページをまたいで分割可能な場合(例えば大きな表が含まれている場合)、このshowルールで図表自体もページをまたいで分割可能です。
#show figure: set block(breakable: true)
分割できるブロックと分割できないブロックの詳細については、blockのドキュメントを参照してください。
キャプションの改変
図表のキャプションの外観は、関連するキャプション機能で改変できます。 以下の例では、すべてのキャプションを斜体で強調しています。
#show figure.caption: emph
#figure(
rect[Hello],
caption: [I am emphasized!],
)
where
セレクターを使うことで、このようなルールを特定の種類の図表に適用可能です。
例えば、図表の種類が表の場合はキャプションを表の上に配置し、他の種類ではキャプションを下に配置するには、次のようなshow-setルールを記述します。
#show figure.where(
kind: table
): set figure.caption(position: top)
#figure(
table(columns: 2)[A][B][C][D],
caption: [I'm up here],
)
Parameters
Parameters are the inputs to a function. They are specified in parentheses after the function name.
body
図表の内容。imageを含むことが多いです。
placement
ページ上における図表の配置。
none
: 他のコンテンツと同様に書かれた場所に置かれる。auto
:top
かbottom
の近い方に置かれる。top
: ページの上部に置かれる。bottom
: ページの下部に置かれる。
本文のコンテンツと図表の間隔はplace
関数の clearance
引数によって制御します。
Default:none
View example
#set page(height: 200pt)
= Introduction
#figure(
placement: bottom,
caption: [A glacier],
image("glacier.jpg", width: 60%),
)
#lorem(60)
scope
Settable
Settable parameters can be customized for all following uses of the function with a set
rule.
set
rule.どの包含スコープに対して図を配置するか。
これを"parent"
に設定すると、段組みをまたいで、ページの幅をすべて使用した図表を作成します。
もしplacement
をnone
とした場合には、何の効果もありません。
-
"column"
Place into the current column.
-
"parent"
Place relative to the parent, letting the content span over all columns.
Default:"column"
View example
#set page(height: 250pt, columns: 2)
= Introduction
#figure(
placement: bottom,
scope: "parent",
caption: [A glacier],
image("glacier.jpg", width: 60%),
)
#lorem(60)
caption
図表のキャプション。
Default:none
kind
図表の種類。
同じ種類のすべての図表は共通のカウンターを共有します。
auto
に設定された場合、図形はその中で記述されているものの種類に基づいて、自動的にその種類の決定を試みます。
自動的に検出される種類は、tableとcodeです。
それ以外の場合はimageと推測されます。
これを auto
以外に設定すると、自動検出が上書きされます。
以下のような場合に便利です。
種類は、エレメント関数または文字列に設定できます。
table
、raw
、image
以外のエレメント関数に設定した場合は、図表の補足(supplement)を手動で指定する必要があります。
Default:auto
View example
#figure(
circle(radius: 10pt),
caption: [A curious atom.],
kind: "atom",
supplement: [Atom],
)
supplement
図表の補足。
auto
に設定すると、図表は、種類やテキスト言語に基づいて、正しい補足を自動的に決定しようとします。
独自の図表タイプを使用している場合は、補足を手動で指定する必要があります。
関数が指定された場合、その関数は指定された種類の最初の子孫要素(通常は図の本体)に渡され、内容を返す必要があります。
Default:auto
View example
#figure(
[The contents of my figure!],
caption: [My custom figure],
supplement: [Bar],
kind: "foo",
)
numbering
番号の付け方。番号付けのパターンや関数を受け付けます。
Default:"1"
gap
Settable
Settable parameters can be customized for all following uses of the function with a set
rule.
set
rule.本文とキャプションの間の垂直方向の隙間。
Default:0.65em
outlined
Settable
Settable parameters can be customized for all following uses of the function with a set
rule.
set
rule.図表をoutline
に表示するかどうか。
Default:true
Definitions
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.
caption
図のキャプション。 この要素は、すべての図や特定の種類の図のキャプションの外観を改変するために、 setルールやshowルールで使用可能です。
キャプションは、pos
とbody
に加えて、図のkind
やsupplement
、counter
、numbering
もフィールドとして提供します。
これらの要素をwhereセレクタやshowルールで使用することで、独自のキャプションを構築できます。
View example
#show figure.caption: emph
#figure(
rect[Hello],
caption: [A rectangle],
)
position
図表の仲のキャプションの位置。top
やbottom
を入力してください。
Default:bottom
View example
#show figure.where(
kind: table
): set figure.caption(position: top)
#figure(
table(columns: 2)[A][B],
caption: [I'm up here],
)
#figure(
rect[Hi],
caption: [I'm down here],
)
#figure(
table(columns: 2)[A][B],
caption: figure.caption(
position: bottom,
[I'm down here too!]
)
)
separator
番号とキャプション名の間に表示する区切り文字。
auto
に設定すると、区切り文字は
languageとregionに応じて決まります。
Default:auto
View example
#set figure.caption(separator: [ --- ])
#figure(
rect[Hello],
caption: [A rectangle],
)
body
キャプション名。
独自のキャプションに改変するために
kind
、supplement
、counter
、numbering
、location
が同時に使えます。
View example
#show figure.caption: it => [
#underline(it.body) |
#it.supplement
#context it.counter.display(it.numbering)
]
#figure(
rect[Hello],
caption: [A rectangle],
)