Struct FigureElem 

pub struct FigureElem {
    pub body: Content,
    pub alt: Settable<FigureElem, 1>,
    pub placement: Settable<FigureElem, 2>,
    pub scope: Settable<FigureElem, 3>,
    pub caption: Settable<FigureElem, 4>,
    pub kind: Settable<FigureElem, 5>,
    pub supplement: Settable<FigureElem, 6>,
    pub numbering: Settable<FigureElem, 7>,
    pub gap: Settable<FigureElem, 8>,
    pub outlined: Settable<FigureElem, 9>,
    pub counter: Option<Option<Counter>>,
    pub locale: Option<Locale>,
}

A figure with an optional caption.

Fields

body: Content

alt: Settable<FigureElem, 1>

placement: Settable<FigureElem, 2>

scope: Settable<FigureElem, 3>

caption: Settable<FigureElem, 4>

kind: Settable<FigureElem, 5>

supplement: Settable<FigureElem, 6>

numbering: Settable<FigureElem, 7>

gap: Settable<FigureElem, 8>

outlined: Settable<FigureElem, 9>

counter: Option<Option<Counter>>

locale: Option<Locale>

Implementations

impl FigureElem

pub fn new(body: Content) -> FigureElem

Create a new instance of the element.

pub fn with_alt(self, alt: Option<EcoString>) -> FigureElem

Builder-style setter for the alt field.

pub fn with_placement(self, placement: Option<Smart<VAlignment>>) -> FigureElem

Builder-style setter for the placement field.

pub fn with_scope(self, scope: PlacementScope) -> FigureElem

Builder-style setter for the scope field.

pub fn with_caption(self, caption: Option<Packed<FigureCaption>>) -> FigureElem

Builder-style setter for the caption field.

pub fn with_kind(self, kind: Smart<FigureKind>) -> FigureElem

Builder-style setter for the kind field.

pub fn with_supplement( self, supplement: Smart<Option<Supplement>>, ) -> FigureElem

Builder-style setter for the supplement field.

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

Builder-style setter for the numbering field.

pub fn with_gap(self, gap: Length) -> FigureElem

Builder-style setter for the gap field.

pub fn with_outlined(self, outlined: bool) -> FigureElem

Builder-style setter for the outlined field.

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

Builder-style setter for the counter field.

pub fn with_locale(self, locale: Locale) -> FigureElem

Builder-style setter for the locale field.

impl FigureElem

pub const body: Field<FigureElem, 0>

pub const alt: Field<FigureElem, 1>

pub const placement: Field<FigureElem, 2>

pub const scope: Field<FigureElem, 3>

pub const caption: Field<FigureElem, 4>

pub const kind: Field<FigureElem, 5>

pub const supplement: Field<FigureElem, 6>

pub const numbering: Field<FigureElem, 7>

pub const gap: Field<FigureElem, 8>

pub const outlined: Field<FigureElem, 9>

pub const counter: Field<FigureElem, 10>

pub const locale: Field<FigureElem, 11>

impl FigureElem

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

Retrieves the locale separator.

Trait Implementations

impl Clone for FigureElem

fn clone(&self) -> FigureElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for FigureElem

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

Construct an element from the arguments.

impl Debug for FigureElem

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

Formats the value using the given formatter.

impl Hash for FigureElem

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

where __H: Hasher,

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 FigureElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl NativeScope for FigureElem

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl RefableProperty<1> for FigureElem

impl RefableProperty<2> for FigureElem

impl RefableProperty<3> for FigureElem

impl RefableProperty<4> for FigureElem

impl RefableProperty<5> for FigureElem

impl RefableProperty<6> for FigureElem

impl RefableProperty<7> for FigureElem

impl RefableProperty<8> for FigureElem

impl RefableProperty<9> for FigureElem

impl RequiredField<0> for FigureElem

const FIELD: RequiredFieldData<FigureElem, 0>

type Type = Content

impl Set for FigureElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<1> for FigureElem

const FIELD: SettableFieldData<FigureElem, 1>

type Type = Option<EcoString>

impl SettableField<2> for FigureElem

const FIELD: SettableFieldData<FigureElem, 2>

type Type = Option<Smart<VAlignment>>

impl SettableField<3> for FigureElem

const FIELD: SettableFieldData<FigureElem, 3>

type Type = PlacementScope

impl SettableField<4> for FigureElem

const FIELD: SettableFieldData<FigureElem, 4>

type Type = Option<Packed<FigureCaption>>

impl SettableField<5> for FigureElem

const FIELD: SettableFieldData<FigureElem, 5>

type Type = Smart<FigureKind>

impl SettableField<6> for FigureElem

const FIELD: SettableFieldData<FigureElem, 6>

type Type = Smart<Option<Supplement>>

impl SettableField<7> for FigureElem

const FIELD: SettableFieldData<FigureElem, 7>

type Type = Option<Numbering>

impl SettableField<8> for FigureElem

const FIELD: SettableFieldData<FigureElem, 8>

type Type = Length

impl SettableField<9> for FigureElem

const FIELD: SettableFieldData<FigureElem, 9>

type Type = bool

impl SynthesizedField<10> for FigureElem

const FIELD: SynthesizedFieldData<FigureElem, 10>

type Type = Option<Counter>

impl SynthesizedField<11> for FigureElem

const FIELD: SynthesizedFieldData<FigureElem, 11>

type Type = Locale