figureElementElementElement functions can be customized with set and show rules.
set and show rules.A figure with an optional caption.
Automatically detects its kind to select the correct counting track. For example, figures containing images will be numbered separately from figures containing tables.
Examples
The example below shows a basic figure with an image:
@glacier shows a glacier. Glaciers
are complex systems.
#figure(
image("glacier.jpg", width: 80%),
caption: [A curious figure.],
) <glacier>
You can also insert tables into figures to give them a caption. The figure will detect this and automatically use a separate counter.
#figure(
table(
columns: 4,
[t], [1], [2], [3],
[y], [0.3s], [0.4s], [0.8s],
),
caption: [Timing results],
)
This behaviour can be overridden by explicitly specifying the figure's
kind. All figures of the same kind share a common counter.
Figure behaviour
By default, figures are placed within the flow of content. To make them
float to the top or bottom of the page, you can use the
placement argument.
If your figure is too large and its contents are breakable across pages (e.g. if it contains a large table), then you can make the figure itself breakable across pages as well with this show rule:
#show figure: set block(breakable: true)
See the block documentation for more information about breakable and non-breakable blocks.
Caption customization
You can modify the appearance of the figure's caption with its associated
caption function. In the example below, we emphasize
all captions:
#show figure.caption: emph
#figure(
rect[Hello],
caption: [I am emphasized!],
)
By using a where selector, we can scope such rules to
specific kinds of figures. For example, to position the caption above
tables, but keep it below for all other kinds of figures, we could write the
following show-set rule:
#show figure.where(
kind: table
): set figure.caption(position: top)
#figure(
table(columns: 2)[A][B][C][D],
caption: [I'm up here],
)
ParameterParameterParameters are input values for functions. Specify them in parentheses after the function name.
bodyRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
The content of the figure. Often, an image.
placement
The figure's placement on the page.
none: The figure stays in-flow exactly where it was specified like other content.auto: The figure pickstoporbottomdepending on which is closer.top: The figure floats to the top of the page.bottom: The figure floats to the bottom of the page.
The gap between the main flow content and the floating figure is
controlled by the clearance argument on the
place function.
Default value: none
Show example
#set page(height: 200pt)
#show figure: set place(
clearance: 1em,
)
= Introduction
#figure(
placement: bottom,
caption: [A glacier],
image("glacier.jpg", width: 60%),
)
#lorem(60)
scopeSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
set rule, changing the default value used thereafter.Relative to which containing scope the figure is placed.
Set this to "parent" to create a full-width figure in a two-column
document.
Has no effect if placement is none.
Available string values:
columnPlace into the current column.
parentPlace relative to the parent, letting the content span over all columns.
Default value: "column"
Show example
#set page(height: 250pt, columns: 2)
= Introduction
#figure(
placement: bottom,
scope: "parent",
caption: [A glacier],
image("glacier.jpg", width: 60%),
)
#lorem(60)
caption
The figure's caption.
Default value: none
kind
The kind of figure this is.
All figures of the same kind share a common counter.
If set to auto, the figure will try to automatically determine its
kind based on the type of its body. Automatically detected kinds are
tables and code. In other cases, the inferred kind is
that of an image.
Setting this to something other than auto will override the
automatic detection. This can be useful if
- you wish to create a custom figure type that is not an image, a table or code,
- you want to force the figure to use a specific counter regardless of its content.
You can set the kind to be an element function or a string. If you set
it to an element function other than table, raw
or image, you will need to manually specify the figure's
supplement.
Default value: auto
Show example
#figure(
circle(radius: 10pt),
caption: [A curious atom.],
kind: "atom",
supplement: [Atom],
)
If you want to modify a counter to skip a number or reset the counter,
you can access the counter of each kind of figure with a
where selector:
- For tables:
counter(figure.where(kind: table)) - For images:
counter(figure.where(kind: image)) - For a custom kind:
counter(figure.where(kind: kind))
#figure(
table(columns: 2, $n$, $1$),
caption: [The first table.],
)
#counter(
figure.where(kind: table)
).update(41)
#figure(
table(columns: 2, $n$, $42$),
caption: [The 42nd table],
)
#figure(
rect[Image],
caption: [Does not affect images],
)
To conveniently use the correct counter in a show rule, you can access
the counter field. There is an example of this in the documentation
of the figure.caption element's body field.
supplement
The figure's supplement.
If set to auto, the figure will try to automatically determine the
correct supplement based on the kind and the active
text language. If you are using a custom figure type, you
will need to manually specify the supplement.
If a function is specified, it is passed the first descendant of the
specified kind (typically, the figure's body) and should return
content.
Default value: auto
Show example
#figure(
[The contents of my figure!],
caption: [My custom figure],
supplement: [Bar],
kind: "foo",
)
numbering
How to number the figure. Accepts a numbering pattern or function taking a single number.
Default value: "1"
gapSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
set rule, changing the default value used thereafter.The vertical gap between the body and caption.
Default value: 0.65em
DefinitionDefinitionThese functions and types can have related definitions. To access a definition, specify the name of the function or type, followed by the definition name separated by a period.
captionElementElementElement functions can be customized with set and show rules.
set and show rules.The caption of a figure. This element can be used in set and show rules to customize the appearance of captions for all figures or figures of a specific kind.
In addition to its position and body, the caption also provides the
figure's kind, supplement, counter, and numbering as fields. These
parts can be used in where selectors and show rules to
build a completely custom caption.
Show example
#show figure.caption: emph
#figure(
rect[Hello],
caption: [A rectangle],
)
positionSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
set rule, changing the default value used thereafter.The caption's position in the figure. Either top or bottom.
Default value: bottom
Show 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
Default value: auto
Show example
#set figure.caption(separator: [ --- ])
#figure(
rect[Hello],
caption: [A rectangle],
)
bodyRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
The caption's body.
Can be used alongside kind, supplement, counter, numbering, and
location to completely customize the caption.
Show example
#show figure.caption: it => [
#underline(it.body) |
#it.supplement
#context it.counter.display(it.numbering)
]
#figure(
rect[Hello],
caption: [A rectangle],
)
