mirror of
https://github.com/typst/typst
synced 2025-07-28 06:47:53 +08:00
51 lines
1.3 KiB
Rust
51 lines
1.3 KiB
Rust
use crate::foundations::elem;
|
|
use crate::layout::{Abs, Angle, Axes, Length, Rel};
|
|
use crate::visualize::Stroke;
|
|
|
|
/// A line from one point to another.
|
|
///
|
|
/// # Example
|
|
/// ```example
|
|
/// #set page(height: 100pt)
|
|
///
|
|
/// #line(length: 100%)
|
|
/// #line(end: (50%, 50%))
|
|
/// #line(
|
|
/// length: 4cm,
|
|
/// stroke: 2pt + maroon,
|
|
/// )
|
|
/// ```
|
|
#[elem]
|
|
pub struct LineElem {
|
|
/// The start point of the line.
|
|
///
|
|
/// Must be an array of exactly two relative lengths.
|
|
pub start: Axes<Rel<Length>>,
|
|
|
|
/// The point where the line ends.
|
|
pub end: Option<Axes<Rel<Length>>>,
|
|
|
|
/// The line's length. This is only respected if `end` is `{none}`.
|
|
#[default(Abs::pt(30.0).into())]
|
|
pub length: Rel<Length>,
|
|
|
|
/// The angle at which the line points away from the origin. This is only
|
|
/// respected if `end` is `{none}`.
|
|
pub angle: Angle,
|
|
|
|
/// How to [stroke] the line.
|
|
///
|
|
/// ```example
|
|
/// #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))),
|
|
/// )
|
|
/// ```
|
|
#[fold]
|
|
pub stroke: Stroke,
|
|
}
|