Struct FigureCaption

pub struct FigureCaption {
    pub body: Content,
    /* private fields */
}

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 pos 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 figure.caption: emph

#figure(
  rect[Hello],
  caption: [A rectangle],
)

Fields

body: Content

Implementations

impl FigureCaption

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_position(self, position: OuterVAlignment) -> Self

Builder-style setter for the position field.

pub fn with_separator(self, separator: Smart<Content>) -> Self

Builder-style setter for the separator field.

pub fn with_kind(self, kind: FigureKind) -> Self

Builder-style setter for the kind field.

pub fn with_supplement(self, supplement: Option<Content>) -> Self

Builder-style setter for the supplement field.

pub fn with_numbering(self, numbering: Option<Numbering>) -> Self

Builder-style setter for the numbering field.

pub fn with_counter(self, counter: Option<Counter>) -> Self

Builder-style setter for the counter field.

pub fn with_figure_location(self, figure_location: Option<Location>) -> Self

Builder-style setter for the figure-location field.

pub fn push_position(&mut self, position: OuterVAlignment)

Setter for the position field.

pub fn push_separator(&mut self, separator: Smart<Content>)

Setter for the separator field.

pub fn push_kind(&mut self, kind: FigureKind)

Setter for the kind field.

pub fn push_supplement(&mut self, supplement: Option<Content>)

Setter for the supplement field.

pub fn push_numbering(&mut self, numbering: Option<Numbering>)

Setter for the numbering field.

pub fn push_counter(&mut self, counter: Option<Counter>)

Setter for the counter field.

pub fn push_figure_location(&mut self, figure_location: Option<Location>)

Setter for the figure-location field.

pub fn position(&self, styles: StyleChain<'_>) -> OuterVAlignment

The caption’s position in the figure. Either {top} or {bottom}.

#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!]
  )
)

pub fn separator(&self, styles: StyleChain<'_>) -> Smart<Content>

The separator which will appear between the number and body.

If set to {auto}, the separator will be adapted to the current language and region.

#set figure.caption(separator: [ --- ])

#figure(
  rect[Hello],
  caption: [A rectangle],
)

pub fn kind(&self) -> Option<&FigureKind>

The figure’s supplement.

pub fn supplement(&self) -> Option<&Option<Content>>

The figure’s supplement.

pub fn numbering(&self) -> Option<&Option<Numbering>>

How to number the figure.

pub fn counter(&self) -> Option<&Option<Counter>>

The counter for the figure.

pub fn figure_location(&self) -> Option<&Option<Location>>

The figure’s location.

pub fn position_in(styles: StyleChain<'_>) -> OuterVAlignment

Access the position field in the given style chain.

pub fn separator_in(styles: StyleChain<'_>) -> Smart<Content>

Access the separator field in the given style chain.

pub fn set_position(position: OuterVAlignment) -> Property

Create a style property for the position field.

pub fn set_separator(separator: Smart<Content>) -> Property

Create a style property for the separator field.

Trait Implementations

impl Capable for FigureCaption

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for FigureCaption

fn clone(&self) -> FigureCaption

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Construct for FigureCaption

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for FigureCaption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Fields for FigureCaption

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl FromValue for FigureCaption

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for FigureCaption

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for FigureCaption

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for FigureCaption

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for FigureCaption

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for FigureCaption

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for FigureCaption

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for FigureCaption

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.