Struct LineElem

pub struct LineElem { /* private fields */ }

A line from one point to another.

Example

#set page(height: 100pt)

#line(length: 100%)
#line(end: (50%, 50%))
#line(
  length: 4cm,
  stroke: 2pt + maroon,
)

Implementations

impl LineElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_start(self, start: Axes<Rel<Length>>) -> Self

Builder-style setter for the start field.

pub fn with_end(self, end: Option<Axes<Rel<Length>>>) -> Self

Builder-style setter for the end field.

pub fn with_length(self, length: Rel<Length>) -> Self

Builder-style setter for the length field.

pub fn with_angle(self, angle: Angle) -> Self

Builder-style setter for the angle field.

pub fn with_stroke(self, stroke: Stroke) -> Self

Builder-style setter for the stroke field.

pub fn push_start(&mut self, start: Axes<Rel<Length>>)

Setter for the start field.

pub fn push_end(&mut self, end: Option<Axes<Rel<Length>>>)

Setter for the end field.

pub fn push_length(&mut self, length: Rel<Length>)

Setter for the length field.

pub fn push_angle(&mut self, angle: Angle)

Setter for the angle field.

pub fn push_stroke(&mut self, stroke: Stroke)

Setter for the stroke field.

pub fn start( &self, styles: StyleChain<'_>, ) -> <Axes<Rel<Length>> as Resolve>::Output

The start point of the line.

Must be an array of exactly two relative lengths.

pub fn end( &self, styles: StyleChain<'_>, ) -> <Option<Axes<Rel<Length>>> as Resolve>::Output

The point where the line ends.

pub fn length(&self, styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

The line’s length. This is only respected if end is {none}.

pub fn angle(&self, styles: StyleChain<'_>) -> Angle

The angle at which the line points away from the origin. This is only respected if end is {none}.

pub fn stroke(&self, styles: StyleChain<'_>) -> <Stroke as Resolve>::Output

How to [stroke] the line.

#set line(length: 100%)
#stack(
  spacing: 1em,
  line(stroke: 2pt + red),
  line(stroke: (paint: blue, thickness: 4pt, cap: "round")),
  line(stroke: (paint: blue, thickness: 1pt, dash: "dashed")),
  line(stroke: (paint: blue, thickness: 1pt, dash: ("dot", 2pt, 4pt, 2pt))),
)

pub fn start_in( styles: StyleChain<'_>, ) -> <Axes<Rel<Length>> as Resolve>::Output

Access the start field in the given style chain.

pub fn end_in( styles: StyleChain<'_>, ) -> <Option<Axes<Rel<Length>>> as Resolve>::Output

Access the end field in the given style chain.

pub fn length_in(styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

Access the length field in the given style chain.

pub fn angle_in(styles: StyleChain<'_>) -> Angle

Access the angle field in the given style chain.

pub fn stroke_in(styles: StyleChain<'_>) -> <Stroke as Resolve>::Output

Access the stroke field in the given style chain.

pub fn set_start(start: Axes<Rel<Length>>) -> Property

Create a style property for the start field.

pub fn set_end(end: Option<Axes<Rel<Length>>>) -> Property

Create a style property for the end field.

pub fn set_length(length: Rel<Length>) -> Property

Create a style property for the length field.

pub fn set_angle(angle: Angle) -> Property

Create a style property for the angle field.

pub fn set_stroke(stroke: Stroke) -> Property

Create a style property for the stroke field.

Trait Implementations

impl Capable for LineElem

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

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

impl Clone for LineElem

fn clone(&self) -> LineElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for LineElem

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

Construct an element from the arguments.

impl Debug for LineElem

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

Formats the value using the given formatter.

impl Fields for LineElem

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 LineElem

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 LineElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for LineElem

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 LineElem

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 LineElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for LineElem

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

Parse relevant arguments into style properties for this element.