Struct AlignElem

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

Aligns content horizontally and vertically.

Example

Let’s start with centering our content horizontally:

#set page(height: 120pt)
#set align(center)

Centered text, a sight to see \
In perfect balance, visually \
Not left nor right, it stands alone \
A work of art, a visual throne

To center something vertically, use horizon alignment:

#set page(height: 120pt)
#set align(horizon)

Vertically centered, \
the stage had entered, \
a new paragraph.

Combining alignments

You can combine two alignments with the + operator. Let’s also only apply this to one piece of content by using the function form instead of a set rule:

#set page(height: 120pt)
Though left in the beginning ...

#align(right + bottom)[
  ... they were right in the end, \
  and with addition had gotten, \
  the paragraph to the bottom!
]

Nested alignment

You can use varying alignments for layout containers and the elements within them. This way, you can create intricate layouts:

#align(center, block[
  #set align(left)
  Though centered together \
  alone \
  we \
  are \
  left.
])

Alignment within the same line

The align function performs block-level alignment and thus always interrupts the current paragraph. To have different alignment for parts of the same line, you should use fractional spacing instead:

Start #h(1fr) End

Fields

body: Content

Implementations

impl AlignElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_alignment(self, alignment: Alignment) -> Self

Builder-style setter for the alignment field.

pub fn push_alignment(&mut self, alignment: Alignment)

Setter for the alignment field.

pub fn alignment(&self, styles: StyleChain<'_>) -> Alignment

The [alignment] along both axes.

#set page(height: 6cm)
#set text(lang: "ar")

مثال
#align(
  end + horizon,
  rect(inset: 12pt)[ركن]
)

pub fn alignment_in(styles: StyleChain<'_>) -> Alignment

Access the alignment field in the given style chain.

pub fn set_alignment(alignment: Alignment) -> Property

Create a style property for the alignment field.

Trait Implementations

impl Capable for AlignElem

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

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

impl Clone for AlignElem

fn clone(&self) -> AlignElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for AlignElem

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

Construct an element from the arguments.

impl Debug for AlignElem

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

Formats the value using the given formatter.

impl Fields for AlignElem

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 AlignElem

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 AlignElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for AlignElem

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 AlignElem

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 AlignElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for AlignElem

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

Parse relevant arguments into style properties for this element.