Struct EquationElem 

pub struct EquationElem {
    pub block: Settable<Self, 0u8>,
    pub numbering: Settable<Self, 1u8>,
    pub number_align: Settable<Self, 2u8>,
    pub supplement: Settable<Self, 3u8>,
    pub alt: Settable<Self, 4u8>,
    pub body: Content,
    pub locale: Option<Locale>,
}

A mathematical equation.

Can be displayed inline with text or as a separate block. An equation becomes block-level through the presence of whitespace after the opening dollar sign and whitespace before the closing dollar sign.

Example

#set text(font: "New Computer Modern")

Let $a$, $b$, and $c$ be the side
lengths of right-angled triangle.
Then, we know that:
$ a^2 + b^2 = c^2 $

Prove by induction:
$ sum_(k=1)^n k = (n(n+1)) / 2 $

By default, block-level equations will not break across pages. This can be changed through {show math.equation: set block(breakable: true)}.

Syntax

This function also has dedicated syntax: Write mathematical markup within dollar signs to create an equation. Starting and ending the equation with whitespace lifts it into a separate block that is centered horizontally. For more details about math syntax, see the main math page.

Fields

block: Settable<Self, 0u8>

numbering: Settable<Self, 1u8>

number_align: Settable<Self, 2u8>

supplement: Settable<Self, 3u8>

alt: Settable<Self, 4u8>

body: Content

locale: Option<Locale>

Implementations

impl EquationElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_block(self, block: bool) -> Self

Builder-style setter for the block field.

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

Builder-style setter for the numbering field.

pub fn with_number_align( self, number_align: SpecificAlignment<OuterHAlignment, VAlignment>, ) -> Self

Builder-style setter for the number-align field.

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

Builder-style setter for the supplement field.

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

Builder-style setter for the alt field.

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

Builder-style setter for the locale field.

impl EquationElem

pub const block: Field<Self, 0u8>

pub const numbering: Field<Self, 1u8>

pub const number_align: Field<Self, 2u8>

pub const supplement: Field<Self, 3u8>

pub const alt: Field<Self, 4u8>

pub const body: Field<Self, 5u8>

pub const size: Field<Self, 6u8>

pub const variant: Field<Self, 7u8>

pub const cramped: Field<Self, 8u8>

pub const bold: Field<Self, 9u8>

pub const italic: Field<Self, 10u8>

pub const class: Field<Self, 11u8>

pub const script_scale: Field<Self, 12u8>

pub const locale: Field<Self, 13u8>

Trait Implementations

impl Clone for EquationElem

fn clone(&self) -> EquationElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for EquationElem

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

Construct an element from the arguments.

impl Debug for EquationElem

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

Formats the value using the given formatter.

impl Hash for EquationElem

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 EquationElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<5> for EquationElem

const FIELD: RequiredFieldData<Self, 5u8>

type Type = Content

impl Set for EquationElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for EquationElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = bool

impl SettableField<1> for EquationElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Option<Numbering>

impl SettableField<2> for EquationElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = SpecificAlignment<OuterHAlignment, VAlignment>

impl SettableField<3> for EquationElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Smart<Option<Supplement>>

impl SettableField<4> for EquationElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Option<EcoString>

impl SettableProperty<10> for EquationElem

const FIELD: SettablePropertyData<Self, 10u8>

type Type = Option<bool>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<11> for EquationElem

const FIELD: SettablePropertyData<Self, 11u8>

type Type = Option<MathClass>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<12> for EquationElem

const FIELD: SettablePropertyData<Self, 12u8>

type Type = (i16, i16)

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<6> for EquationElem

const FIELD: SettablePropertyData<Self, 6u8>

type Type = MathSize

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<7> for EquationElem

const FIELD: SettablePropertyData<Self, 7u8>

type Type = Option<MathVariant>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<8> for EquationElem

const FIELD: SettablePropertyData<Self, 8u8>

type Type = bool

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<9> for EquationElem

const FIELD: SettablePropertyData<Self, 9u8>

type Type = bool

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SynthesizedField<13> for EquationElem

const FIELD: SynthesizedFieldData<Self, 13u8>

type Type = Locale

impl RefableProperty<0> for EquationElem

impl RefableProperty<1> for EquationElem

impl RefableProperty<10> for EquationElem

impl RefableProperty<11> for EquationElem

impl RefableProperty<12> for EquationElem

impl RefableProperty<2> for EquationElem

impl RefableProperty<3> for EquationElem

impl RefableProperty<4> for EquationElem

impl RefableProperty<6> for EquationElem

impl RefableProperty<7> for EquationElem

impl RefableProperty<8> for EquationElem

impl RefableProperty<9> for EquationElem