Struct GridVLine

pub struct GridVLine { /* private fields */ }

A vertical line in the grid.

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

Implementations

impl GridVLine

pub fn new() -> GridVLine

Create a new instance of the element.

pub fn with_x(self, x: Smart<usize>) -> GridVLine

Builder-style setter for the x field.

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

Builder-style setter for the start field.

pub fn with_end(self, end: Option<NonZero<usize>>) -> GridVLine

Builder-style setter for the end field.

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

Builder-style setter for the stroke field.

pub fn with_position(self, position: OuterHAlignment) -> GridVLine

Builder-style setter for the position field.

pub fn push_x(&mut self, x: Smart<usize>)

Setter for the x field.

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

Setter for the start field.

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

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: OuterHAlignment)

Setter for the position field.

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

The column before which the horizontal line is placed (zero-indexed). If the position field is set to {end}, the line is placed after the column with the given index instead (see that field’s docs for details).

Specifying {auto} causes the line to be placed at the column after the last automatically positioned cell (that is, cell without coordinate overrides) before the line among the grid’s children. If there is no such cell before the line, it is placed before the grid’s first column (column 0). Note that specifying for this option exactly the total amount of columns in the grid causes this vertical line to override the end border of the grid (right in LTR, left in RTL), while a value of 0 overrides the start border (left in LTR, right in RTL).

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

The row at which the vertical line starts (zero-indexed, inclusive).

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

The row on top of which the vertical line ends (zero-indexed, exclusive). Therefore, the vertical line will be drawn up to and across row end - 1.

A value equal to {none} or to the amount of rows causes it to extend all the way towards the bottom of the grid.

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 vlines or per-cell stroke below it.

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

The position at which the line is placed, given its column (x) - either {start} to draw before it or {end} to draw after it.

The values {left} and {right} are also accepted, but discouraged as they cause your grid to be inconsistent between left-to-right and right-to-left documents.

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

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

Access the x 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<NonZero<usize>>

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<'_>) -> OuterHAlignment

Access the position field in the given style chain.

pub fn set_x(x: Smart<usize>) -> Property

Create a style property for the x field.

pub fn set_start(start: usize) -> Property

Create a style property for the start field.

pub fn set_end(end: Option<NonZero<usize>>) -> 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: OuterHAlignment) -> Property

Create a style property for the position field.

Trait Implementations

impl Capable for GridVLine

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

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

impl Clone for GridVLine

fn clone(&self) -> GridVLine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for GridVLine

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

Construct an element from the arguments.

impl Debug for GridVLine

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

Formats the value using the given formatter.

impl Fields for GridVLine

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 GridVLine

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 GridVLine

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for GridVLine

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 GridVLine

fn eq(&self, other: &GridVLine) -> 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 GridVLine

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for GridVLine

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

Parse relevant arguments into style properties for this element.