pub struct FigureCaption {
pub body: Content,
/* private fields */
}
Expand description
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§
Source§impl FigureCaption
impl FigureCaption
Sourcepub fn with_position(self, position: OuterVAlignment) -> Self
pub fn with_position(self, position: OuterVAlignment) -> Self
Builder-style setter for the position
field.
Sourcepub fn with_separator(self, separator: Smart<Content>) -> Self
pub fn with_separator(self, separator: Smart<Content>) -> Self
Builder-style setter for the separator
field.
Sourcepub fn with_kind(self, kind: FigureKind) -> Self
pub fn with_kind(self, kind: FigureKind) -> Self
Builder-style setter for the kind
field.
Sourcepub fn with_supplement(self, supplement: Option<Content>) -> Self
pub fn with_supplement(self, supplement: Option<Content>) -> Self
Builder-style setter for the supplement
field.
Sourcepub fn with_numbering(self, numbering: Option<Numbering>) -> Self
pub fn with_numbering(self, numbering: Option<Numbering>) -> Self
Builder-style setter for the numbering
field.
Sourcepub fn with_counter(self, counter: Option<Counter>) -> Self
pub fn with_counter(self, counter: Option<Counter>) -> Self
Builder-style setter for the counter
field.
Sourcepub fn with_figure_location(self, figure_location: Option<Location>) -> Self
pub fn with_figure_location(self, figure_location: Option<Location>) -> Self
Builder-style setter for the figure-location
field.
Sourcepub fn push_position(&mut self, position: OuterVAlignment)
pub fn push_position(&mut self, position: OuterVAlignment)
Setter for the position
field.
Sourcepub fn push_separator(&mut self, separator: Smart<Content>)
pub fn push_separator(&mut self, separator: Smart<Content>)
Setter for the separator
field.
Sourcepub fn push_kind(&mut self, kind: FigureKind)
pub fn push_kind(&mut self, kind: FigureKind)
Setter for the kind
field.
Sourcepub fn push_supplement(&mut self, supplement: Option<Content>)
pub fn push_supplement(&mut self, supplement: Option<Content>)
Setter for the supplement
field.
Sourcepub fn push_numbering(&mut self, numbering: Option<Numbering>)
pub fn push_numbering(&mut self, numbering: Option<Numbering>)
Setter for the numbering
field.
Sourcepub fn push_counter(&mut self, counter: Option<Counter>)
pub fn push_counter(&mut self, counter: Option<Counter>)
Setter for the counter
field.
Sourcepub fn push_figure_location(&mut self, figure_location: Option<Location>)
pub fn push_figure_location(&mut self, figure_location: Option<Location>)
Setter for the figure-location
field.
Sourcepub fn position(&self, styles: StyleChain<'_>) -> OuterVAlignment
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!]
)
)
Sourcepub fn separator(&self, styles: StyleChain<'_>) -> Smart<Content>
pub fn separator(&self, styles: StyleChain<'_>) -> Smart<Content>
Sourcepub fn kind(&self) -> Option<&FigureKind>
pub fn kind(&self) -> Option<&FigureKind>
The figure’s supplement.
Sourcepub fn supplement(&self) -> Option<&Option<Content>>
pub fn supplement(&self) -> Option<&Option<Content>>
The figure’s supplement.
Sourcepub fn figure_location(&self) -> Option<&Option<Location>>
pub fn figure_location(&self) -> Option<&Option<Location>>
The figure’s location.
Sourcepub fn position_in(styles: StyleChain<'_>) -> OuterVAlignment
pub fn position_in(styles: StyleChain<'_>) -> OuterVAlignment
Access the position
field in the given style chain.
Sourcepub fn separator_in(styles: StyleChain<'_>) -> Smart<Content>
pub fn separator_in(styles: StyleChain<'_>) -> Smart<Content>
Access the separator
field in the given style chain.
Sourcepub fn set_position(position: OuterVAlignment) -> Property
pub fn set_position(position: OuterVAlignment) -> Property
Create a style property for the position
field.
Sourcepub fn set_separator(separator: Smart<Content>) -> Property
pub fn set_separator(separator: Smart<Content>) -> Property
Create a style property for the separator
field.
Trait Implementations§
Source§impl Capable for FigureCaption
impl Capable for FigureCaption
Source§impl Clone for FigureCaption
impl Clone for FigureCaption
Source§fn clone(&self) -> FigureCaption
fn clone(&self) -> FigureCaption
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Construct for FigureCaption
impl Construct for FigureCaption
Source§impl Debug for FigureCaption
impl Debug for FigureCaption
Source§impl Fields for FigureCaption
impl Fields for FigureCaption
Source§fn field(&self, id: u8) -> Result<Value, FieldAccessError>
fn field(&self, id: u8) -> Result<Value, FieldAccessError>
Source§fn field_with_styles(
&self,
id: u8,
styles: StyleChain<'_>,
) -> Result<Value, FieldAccessError>
fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>
Source§fn field_from_styles(
id: u8,
styles: StyleChain<'_>,
) -> Result<Value, FieldAccessError>
fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>
Source§fn materialize(&mut self, styles: StyleChain<'_>)
fn materialize(&mut self, styles: StyleChain<'_>)
Source§impl FromValue for FigureCaption
impl FromValue for FigureCaption
Source§fn from_value(value: Value) -> HintedStrResult<Self>
fn from_value(value: Value) -> HintedStrResult<Self>
Self
.Source§impl Hash for FigureCaption
impl Hash for FigureCaption
Source§impl IntoValue for FigureCaption
impl IntoValue for FigureCaption
Source§fn into_value(self) -> Value
fn into_value(self) -> Value
Source§impl NativeElement for FigureCaption
impl NativeElement for FigureCaption
Source§impl PartialEq for FigureCaption
impl PartialEq for FigureCaption
Source§impl Reflect for FigureCaption
impl Reflect for FigureCaption
Source§impl Repr for FigureCaption
impl Repr for FigureCaption
Auto Trait Implementations§
impl Freeze for FigureCaption
impl !RefUnwindSafe for FigureCaption
impl Send for FigureCaption
impl Sync for FigureCaption
impl Unpin for FigureCaption
impl !UnwindSafe for FigureCaption
Blanket Implementations§
Source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
Source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
Source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
Source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
Source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
Source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
Source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
Source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.Source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
Source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
Source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.Source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
Source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.Source§impl<T> FromValue<Spanned<Value>> for Twhere
T: FromValue,
impl<T> FromValue<Spanned<Value>> for Twhere
T: FromValue,
Source§fn from_value(value: Spanned<Value>) -> Result<T, HintedString>
fn from_value(value: Spanned<Value>) -> Result<T, HintedString>
Self
.Source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
Source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.Source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
Source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.Source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.Source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
Source§fn into_color(self) -> U
fn into_color(self) -> U
Source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
Source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoResult for Twhere
T: IntoValue,
impl<T> IntoResult for Twhere
T: IntoValue,
Source§fn into_result(self, _: Span) -> Result<Value, EcoVec<SourceDiagnostic>>
fn into_result(self, _: Span) -> Result<Value, EcoVec<SourceDiagnostic>>
Source§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
Source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
Source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.Source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
Source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
Source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more