Struct MatElem

pub struct MatElem {
    pub rows: Vec<Vec<Content>>,
    /* private fields */
}

A matrix.

The elements of a row should be separated by commas, while the rows themselves should be separated by semicolons. The semicolon syntax merges preceding arguments separated by commas into an array. You can also use this special syntax of math function calls to define custom functions that take 2D data.

Content in cells can be aligned with the align parameter, or content in cells that are in the same row can be aligned with the & symbol.

Example

$ mat(
  1, 2, ..., 10;
  2, 2, ..., 10;
  dots.v, dots.v, dots.down, dots.v;
  10, 10, ..., 10;
) $

Fields

rows: Vec<Vec<Content>>

Implementations

impl MatElem

pub fn new(rows: Vec<Vec<Content>>) -> Self

Create a new instance of the element.

pub fn with_delim(self, delim: DelimiterPair) -> Self

Builder-style setter for the delim field.

pub fn with_align(self, align: HAlignment) -> Self

Builder-style setter for the align field.

pub fn with_augment(self, augment: Option<Augment>) -> Self

Builder-style setter for the augment field.

pub fn with_row_gap(self, row_gap: Rel<Length>) -> Self

Builder-style setter for the row-gap field.

pub fn with_column_gap(self, column_gap: Rel<Length>) -> Self

Builder-style setter for the column-gap field.

pub fn push_delim(&mut self, delim: DelimiterPair)

Setter for the delim field.

pub fn push_align(&mut self, align: HAlignment)

Setter for the align field.

pub fn push_augment(&mut self, augment: Option<Augment>)

Setter for the augment field.

pub fn push_row_gap(&mut self, row_gap: Rel<Length>)

Setter for the row-gap field.

pub fn push_column_gap(&mut self, column_gap: Rel<Length>)

Setter for the column-gap field.

pub fn delim(&self, styles: StyleChain<'_>) -> DelimiterPair

The delimiter to use.

Can be a single character specifying the left delimiter, in which case the right delimiter is inferred. Otherwise, can be an array containing a left and a right delimiter.

#set math.mat(delim: "[")
$ mat(1, 2; 3, 4) $

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

The horizontal alignment that each cell should have.

#set math.mat(align: right)
$ mat(-1, 1, 1; 1, -1, 1; 1, 1, -1) $

pub fn augment( &self, styles: StyleChain<'_>, ) -> <Option<Augment> as Resolve>::Output

Draws augmentation lines in a matrix.

• {none}: No lines are drawn.
• A single number: A vertical augmentation line is drawn after the specified column number. Negative numbers start from the end.
• A dictionary: With a dictionary, multiple augmentation lines can be drawn both horizontally and vertically. Additionally, the style of the lines can be set. The dictionary can contain the following keys:
  • hline: The offsets at which horizontal lines should be drawn. For example, an offset of 2 would result in a horizontal line being drawn after the second row of the matrix. Accepts either an integer for a single line, or an array of integers for multiple lines. Like for a single number, negative numbers start from the end.
  • vline: The offsets at which vertical lines should be drawn. For example, an offset of 2 would result in a vertical line being drawn after the second column of the matrix. Accepts either an integer for a single line, or an array of integers for multiple lines. Like for a single number, negative numbers start from the end.
  • stroke: How to stroke the line. If set to {auto}, takes on a thickness of 0.05em and square line caps.

$ mat(1, 0, 1; 0, 1, 2; augment: #2) $
// Equivalent to:
$ mat(1, 0, 1; 0, 1, 2; augment: #(-1)) $

$ mat(0, 0, 0; 1, 1, 1; augment: #(hline: 1, stroke: 2pt + green)) $

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

The gap between rows.

#set math.mat(row-gap: 1em)
$ mat(1, 2; 3, 4) $

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

The gap between columns.

#set math.mat(column-gap: 1em)
$ mat(1, 2; 3, 4) $

pub fn delim_in(styles: StyleChain<'_>) -> DelimiterPair

Access the delim field in the given style chain.

pub fn align_in(styles: StyleChain<'_>) -> <HAlignment as Resolve>::Output

Access the align field in the given style chain.

pub fn augment_in( styles: StyleChain<'_>, ) -> <Option<Augment> as Resolve>::Output

Access the augment field in the given style chain.

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

Access the row-gap field in the given style chain.

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

Access the column-gap field in the given style chain.

pub fn set_delim(delim: DelimiterPair) -> Property

Create a style property for the delim field.

pub fn set_align(align: HAlignment) -> Property

Create a style property for the align field.

pub fn set_augment(augment: Option<Augment>) -> Property

Create a style property for the augment field.

pub fn set_row_gap(row_gap: Rel<Length>) -> Property

Create a style property for the row-gap field.

pub fn set_column_gap(column_gap: Rel<Length>) -> Property

Create a style property for the column-gap field.

Trait Implementations

impl Capable for MatElem

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

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

impl Clone for MatElem

fn clone(&self) -> MatElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for MatElem

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

Construct an element from the arguments.

impl Debug for MatElem

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

Formats the value using the given formatter.

impl Fields for MatElem

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 MatElem

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 MatElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for MatElem

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 MatElem

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 MatElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for MatElem

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

Parse relevant arguments into style properties for this element.