Struct FigureCaption 

pub struct FigureCaption {
    pub position: Settable<Self, 0u8>,
    pub separator: Settable<Self, 1u8>,
    pub body: Content,
    pub kind: Option<FigureKind>,
    pub supplement: Option<Option<Content>>,
    pub numbering: Option<Option<Numbering>>,
    pub counter: Option<Option<Counter>>,
    pub figure_location: Option<Option<Location>>,
}

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

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

Fields

position: Settable<Self, 0u8>

separator: Settable<Self, 1u8>

body: Content

kind: Option<FigureKind>

supplement: Option<Option<Content>>

numbering: Option<Option<Numbering>>

counter: Option<Option<Counter>>

figure_location: Option<Option<Location>>

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.

impl FigureCaption

pub const position: Field<Self, 0u8>

pub const separator: Field<Self, 1u8>

pub const body: Field<Self, 2u8>

pub const kind: Field<Self, 3u8>

pub const supplement: Field<Self, 4u8>

pub const numbering: Field<Self, 5u8>

pub const counter: Field<Self, 6u8>

pub const figure_location: Field<Self, 7u8>

impl FigureCaption

pub fn realize( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> SourceResult<Content>

Realizes the textual caption content.

Trait Implementations

impl Clone for FigureCaption

fn clone(&self) -> FigureCaption

Returns a duplicate 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 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 NativeElement for FigureCaption

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

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 RequiredField<2> for FigureCaption

const FIELD: RequiredFieldData<Self, 2u8>

type Type = Content

impl Set for FigureCaption

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for FigureCaption

const FIELD: SettableFieldData<Self, 0u8>

type Type = OuterVAlignment

impl SettableField<1> for FigureCaption

const FIELD: SettableFieldData<Self, 1u8>

type Type = Smart<Content>

impl SynthesizedField<3> for FigureCaption

const FIELD: SynthesizedFieldData<Self, 3u8>

type Type = FigureKind

impl SynthesizedField<4> for FigureCaption

const FIELD: SynthesizedFieldData<Self, 4u8>

type Type = Option<Content>

impl SynthesizedField<5> for FigureCaption

const FIELD: SynthesizedFieldData<Self, 5u8>

type Type = Option<Numbering>

impl SynthesizedField<6> for FigureCaption

const FIELD: SynthesizedFieldData<Self, 6u8>

type Type = Option<Counter>

impl SynthesizedField<7> for FigureCaption

const FIELD: SynthesizedFieldData<Self, 7u8>

type Type = Option<Location>

impl RefableProperty<0> for FigureCaption

impl RefableProperty<1> for FigureCaption