Enum Alignment

pub enum Alignment {
    H(HAlignment),
    V(VAlignment),
    Both(HAlignment, VAlignment),
}

Where to [align] something along an axis.

Possible values are:

• start: Aligns at the start of the text direction.
• end: Aligns at the end of the text direction.
• left: Align at the left.
• center: Aligns in the middle, horizontally.
• right: Aligns at the right.
• top: Aligns at the top.
• horizon: Aligns in the middle, vertically.
• bottom: Align at the bottom.

These values are available globally and also in the alignment type’s scope, so you can write either of the following two:

#align(center)[Hi]
#align(alignment.center)[Hi]

2D alignments

To align along both axes at the same time, add the two alignments using the + operator. For example, top + right aligns the content to the top right corner.

#set page(height: 3cm)
#align(center + bottom)[Hi]

Fields

The x and y fields hold the alignment’s horizontal and vertical components, respectively (as yet another alignment). They may be {none}.

#(top + right).x \
#left.x \
#left.y (none)

Variants

H(HAlignment)

V(VAlignment)

Both(HAlignment, VAlignment)

Implementations

impl Alignment

pub const fn x(self) -> Option<HAlignment>

The horizontal component.

pub const fn y(self) -> Option<VAlignment>

The vertical component.

pub fn fix(self, text_dir: Dir) -> Axes<FixedAlignment>

Normalize the alignment to a LTR-TTB space.

impl Alignment

pub const START: Self

pub const LEFT: Self

pub const CENTER: Self

pub const RIGHT: Self

pub const END: Self

pub const TOP: Self

pub const HORIZON: Self

pub const BOTTOM: Self

pub const fn axis(self) -> Option<Axis>

The axis this alignment belongs to.

• {"horizontal"} for start, left, center, right, and end
• {"vertical"} for top, horizon, and bottom
• {none} for 2-dimensional alignments

#left.axis() \
#bottom.axis()

pub const fn inv(self) -> Alignment

The inverse alignment.

#top.inv() \
#left.inv() \
#center.inv() \
#(left + bottom).inv()

Trait Implementations

impl Add for Alignment

type Output = Result<Alignment, EcoString>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for Alignment

fn clone(&self) -> Alignment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Alignment

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

Formats the value using the given formatter.

impl Default for Alignment

fn default() -> Self

Returns the “default value” for a type.

impl Fold for Alignment

fn fold(self, outer: Self) -> Self

Fold this inner value with an outer folded value.

impl From<HAlignment> for Alignment

fn from(align: HAlignment) -> Self

Converts to this type from the input type.

impl From<Side> for Alignment

fn from(side: Side) -> Self

Converts to this type from the input type.

impl<H, V> From<SpecificAlignment<H, V>> for Alignment

where HAlignment: From<H>, VAlignment: From<V>,

fn from(value: SpecificAlignment<H, V>) -> Self

Converts to this type from the input type.

impl From<VAlignment> for Alignment

fn from(align: VAlignment) -> Self

Converts to this type from the input type.

impl FromValue for Alignment

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Alignment

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 Alignment

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Alignment

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

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Alignment

const NAME: &'static str = "alignment"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for Alignment

fn eq(&self, other: &Alignment) -> 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 Reflect for Alignment

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Alignment

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Resolve for Alignment

type Output = Axes<FixedAlignment>

The type of the resolved output.

fn resolve(self, styles: StyleChain<'_>) -> Self::Output

Resolve the value using the style chain.

impl TryFrom<Alignment> for HAlignment

type Error = EcoString

The type returned in the event of a conversion error.

fn try_from(value: Alignment) -> StrResult<Self>

Performs the conversion.

impl TryFrom<Alignment> for OuterHAlignment

type Error = EcoString

The type returned in the event of a conversion error.

fn try_from(value: Alignment) -> StrResult<Self>

Performs the conversion.

impl TryFrom<Alignment> for OuterVAlignment

type Error = EcoString

The type returned in the event of a conversion error.

fn try_from(value: Alignment) -> StrResult<Self>

Performs the conversion.

impl TryFrom<Alignment> for VAlignment

type Error = EcoString

The type returned in the event of a conversion error.

fn try_from(value: Alignment) -> StrResult<Self>

Performs the conversion.

impl Copy for Alignment

impl Eq for Alignment

impl StructuralPartialEq for Alignment