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.

impl ParLine

pub const numbering: Field<Self, 0u8>

pub const number_align: Field<Self, 1u8>

pub const number_margin: Field<Self, 2u8>

pub const number_clearance: Field<Self, 3u8>

pub const numbering_scope: Field<Self, 4u8>

Trait Implementations

impl Clone for ParLine

fn clone(&self) -> ParLine

Returns a duplicate 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 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 NativeElement for ParLine

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl Set for ParLine

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

Parse relevant arguments into style properties for this element.

impl SettableProperty<0> for ParLine

const FIELD: SettablePropertyData<Self, 0u8>

type Type = Option<Numbering>

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<1> for ParLine

const FIELD: SettablePropertyData<Self, 1u8>

type Type = Smart<HAlignment>

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<2> for ParLine

const FIELD: SettablePropertyData<Self, 2u8>

type Type = OuterHAlignment

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<3> for ParLine

const FIELD: SettablePropertyData<Self, 3u8>

type Type = Smart<Length>

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<4> for ParLine

const FIELD: SettablePropertyData<Self, 4u8>

type Type = LineNumberingScope

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 RefableProperty<0> for ParLine

impl RefableProperty<1> for ParLine

impl RefableProperty<2> for ParLine

impl RefableProperty<3> for ParLine

impl RefableProperty<4> for ParLine