Struct TableHLine

pub struct TableHLine { /* private fields */ }

A horizontal line in the table.

Overrides any per-cell stroke, including stroke specified through the table’s stroke field. Can cross spacing between cells created through the table’s column-gutter option.

Use this function instead of the table’s stroke field if you want to manually place a horizontal line at a specific position in a single table. Consider using table’s stroke field or table.cell’s stroke field instead if the line you want to place is part of all your tables’ designs.

#set table.hline(stroke: .6pt)

#table(
  stroke: none,
  columns: (auto, 1fr),
  [09:00], [Badge pick up],
  [09:45], [Opening Keynote],
  [10:30], [Talk: Typst's Future],
  [11:15], [Session: Good PRs],
  table.hline(start: 1),
  [Noon], [_Lunch break_],
  table.hline(start: 1),
  [14:00], [Talk: Tracked Layout],
  [15:00], [Talk: Automations],
  [16:00], [Workshop: Tables],
  table.hline(),
  [19:00], [Day 1 Attendee Mixer],
)

Implementations

impl TableHLine

pub fn new() -> Self

Create a new instance of the element.

pub fn with_y(self, y: Smart<usize>) -> Self

Builder-style setter for the y field.

pub fn with_start(self, start: usize) -> Self

Builder-style setter for the start field.

pub fn with_end(self, end: Option<NonZeroUsize>) -> Self

Builder-style setter for the end field.

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

Builder-style setter for the stroke field.

pub fn with_position(self, position: OuterVAlignment) -> Self

Builder-style setter for the position field.

pub fn push_y(&mut self, y: Smart<usize>)

Setter for the y field.

pub fn push_start(&mut self, start: usize)

Setter for the start field.

pub fn push_end(&mut self, end: Option<NonZeroUsize>)

Setter for the end field.

pub fn push_stroke(&mut self, stroke: Option<Arc<Stroke>>)

Setter for the stroke field.

pub fn push_position(&mut self, position: OuterVAlignment)

Setter for the position field.

pub fn y(&self, styles: StyleChain<'_>) -> Smart<usize>

The row above which the horizontal line is placed (zero-indexed). Functions identically to the y field in grid.hline.

pub fn start(&self, styles: StyleChain<'_>) -> usize

The column at which the horizontal line starts (zero-indexed, inclusive).

pub fn end(&self, styles: StyleChain<'_>) -> Option<NonZeroUsize>

The column before which the horizontal line ends (zero-indexed, exclusive).

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

The line’s stroke.

Specifying {none} removes any lines previously placed across this line’s range, including hlines or per-cell stroke below it.

pub fn position(&self, styles: StyleChain<'_>) -> OuterVAlignment

The position at which the line is placed, given its row (y) - either {top} to draw above it or {bottom} to draw below it.

This setting is only relevant when row gutter is enabled (and shouldn’t be used otherwise - prefer just increasing the y field by one instead), since then the position below a row becomes different from the position above the next row due to the spacing between both.

pub fn y_in(styles: StyleChain<'_>) -> Smart<usize>

Access the y field in the given style chain.

pub fn start_in(styles: StyleChain<'_>) -> usize

Access the start field in the given style chain.

pub fn end_in(styles: StyleChain<'_>) -> Option<NonZeroUsize>

Access the end field in the given style chain.

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

Access the stroke field in the given style chain.

pub fn position_in(styles: StyleChain<'_>) -> OuterVAlignment

Access the position field in the given style chain.

pub fn set_y(y: Smart<usize>) -> Property

Create a style property for the y field.

pub fn set_start(start: usize) -> Property

Create a style property for the start field.

pub fn set_end(end: Option<NonZeroUsize>) -> Property

Create a style property for the end field.

pub fn set_stroke(stroke: Option<Arc<Stroke>>) -> Property

Create a style property for the stroke field.

pub fn set_position(position: OuterVAlignment) -> Property

Create a style property for the position field.

Trait Implementations

impl Capable for TableHLine

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

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

impl Clone for TableHLine

fn clone(&self) -> TableHLine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for TableHLine

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

Construct an element from the arguments.

impl Debug for TableHLine

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

Formats the value using the given formatter.

impl Fields for TableHLine

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 TableHLine

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 TableHLine

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for TableHLine

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 TableHLine

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 TableHLine

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for TableHLine

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

Parse relevant arguments into style properties for this element.