Struct SubElem

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

Renders text in subscript.

The text is rendered smaller and its baseline is lowered.

Example

Revenue#sub[yearly]

Fields

body: Content

Implementations

impl SubElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_typographic(self, typographic: bool) -> Self

Builder-style setter for the typographic field.

pub fn with_baseline(self, baseline: Length) -> Self

Builder-style setter for the baseline field.

pub fn with_size(self, size: TextSize) -> Self

Builder-style setter for the size field.

pub fn push_typographic(&mut self, typographic: bool)

Setter for the typographic field.

pub fn push_baseline(&mut self, baseline: Length)

Setter for the baseline field.

pub fn push_size(&mut self, size: TextSize)

Setter for the size field.

pub fn typographic(&self, styles: StyleChain<'_>) -> bool

Whether to prefer the dedicated subscript characters of the font.

If this is enabled, Typst first tries to transform the text to subscript codepoints. If that fails, it falls back to rendering lowered and shrunk normal letters.

N#sub(typographic: true)[1]
N#sub(typographic: false)[1]

pub fn baseline(&self, styles: StyleChain<'_>) -> Length

The baseline shift for synthetic subscripts. Does not apply if typographic is true and the font has subscript codepoints for the given body.

pub fn size(&self, styles: StyleChain<'_>) -> TextSize

The font size for synthetic subscripts. Does not apply if typographic is true and the font has subscript codepoints for the given body.

pub fn typographic_in(styles: StyleChain<'_>) -> bool

Access the typographic field in the given style chain.

pub fn baseline_in(styles: StyleChain<'_>) -> Length

Access the baseline field in the given style chain.

pub fn size_in(styles: StyleChain<'_>) -> TextSize

Access the size field in the given style chain.

pub fn set_typographic(typographic: bool) -> Property

Create a style property for the typographic field.

pub fn set_baseline(baseline: Length) -> Property

Create a style property for the baseline field.

pub fn set_size(size: TextSize) -> Property

Create a style property for the size field.

Trait Implementations

impl Capable for SubElem

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

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

impl Clone for SubElem

fn clone(&self) -> SubElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for SubElem

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

Construct an element from the arguments.

impl Debug for SubElem

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

Formats the value using the given formatter.

impl Fields for SubElem

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 Hash for SubElem

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 SubElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for SubElem

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 SubElem

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 Repr for SubElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for SubElem

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

Parse relevant arguments into style properties for this element.