Struct ParLine

pub struct ParLine {}

A paragraph line.

This element is exclusively used for line number configuration through set rules and cannot be placed.

The numbering option is used to enable line numbers by specifying a numbering format.

>>> #set page(margin: (left: 3em))
#set par.line(numbering: "1")

Roses are red. \
Violets are blue. \
Typst is there for you.

The numbering option takes either a predefined numbering pattern or a function returning styled content. You can disable line numbers for text inside certain elements by setting the numbering to {none} using show-set rules.

>>> #set page(margin: (left: 3em))
// Styled red line numbers.
#set par.line(
  numbering: n => text(red)[#n]
)

// Disable numbers inside figures.
#show figure: set par.line(
  numbering: none
)

Roses are red. \
Violets are blue.

#figure(
  caption: [Without line numbers.]
)[
  Lorem ipsum \
  dolor sit amet
]

The text above is a sample \
originating from distant times.

This element exposes further options which may be used to control other aspects of line numbering, such as its alignment or margin. In addition, you can control whether the numbering is reset on each page through the numbering-scope option.

Implementations

impl ParLine

pub fn new() -> Self

Create a new instance of the element.

pub fn numbering_in(styles: StyleChain<'_>) -> Option<Numbering>

Access the numbering field in the given style chain.

pub fn number_align_in(styles: StyleChain<'_>) -> Smart<HAlignment>

Access the number-align field in the given style chain.

pub fn number_margin_in(styles: StyleChain<'_>) -> OuterHAlignment

Access the number-margin field in the given style chain.

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

Access the number-clearance field in the given style chain.

pub fn numbering_scope_in(styles: StyleChain<'_>) -> LineNumberingScope

Access the numbering-scope field in the given style chain.

pub fn set_numbering(numbering: Option<Numbering>) -> Property

Create a style property for the numbering field.

pub fn set_number_align(number_align: Smart<HAlignment>) -> Property

Create a style property for the number-align field.

pub fn set_number_margin(number_margin: OuterHAlignment) -> Property

Create a style property for the number-margin field.

pub fn set_number_clearance(number_clearance: Smart<Length>) -> Property

Create a style property for the number-clearance field.

pub fn set_numbering_scope(numbering_scope: LineNumberingScope) -> Property

Create a style property for the numbering-scope field.

Trait Implementations

impl Capable for ParLine

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

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

impl Clone for ParLine

fn clone(&self) -> ParLine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for ParLine

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

Construct an element from the arguments.

impl Debug for ParLine

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

Formats the value using the given formatter.

impl Fields for ParLine

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 ParLine

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 ParLine

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for ParLine

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 ParLine

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 ParLine

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for ParLine

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

Parse relevant arguments into style properties for this element.