Struct GridCell

pub struct GridCell {
    pub body: Content,
    /* private fields */
}

A cell in the grid. You can use this function in the argument list of a grid to override grid style properties for an individual cell or manually positioning it within the grid. You can also use this function in show rules to apply certain styles to multiple cells at once.

For example, you can override the position and stroke for a single cell:

>>> #set page(width: auto)
>>> #set text(15pt, font: "Noto Sans Symbols 2", bottom-edge: -.2em)
<<< #set text(15pt, font: "Noto Sans Symbols 2")
#show regex("[♚-♟︎]"): set text(fill: rgb("21212A"))
#show regex("[♔-♙]"): set text(fill: rgb("111015"))

#grid(
  fill: (x, y) => rgb(
    if calc.odd(x + y) { "7F8396" }
    else { "EFF0F3" }
  ),
  columns: (1em,) * 8,
  rows: 1em,
  align: center + horizon,

  [♖], [♘], [♗], [♕], [♔], [♗], [♘], [♖],
  [♙], [♙], [♙], [♙], [],  [♙], [♙], [♙],
  grid.cell(
    x: 4, y: 3,
    stroke: blue.transparentize(60%)
  )[♙],

  ..(grid.cell(y: 6)[♟],) * 8,
  ..([♜], [♞], [♝], [♛], [♚], [♝], [♞], [♜])
    .map(grid.cell.with(y: 7)),
)

You may also apply a show rule on grid.cell to style all cells at once, which allows you, for example, to apply styles based on a cell’s position. Refer to the examples of the table.cell element to learn more about this.

Fields

body: Content

Implementations

impl GridCell

pub fn new(body: Content) -> Self

Create a new instance of the element.

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

Builder-style setter for the x field.

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

Builder-style setter for the y field.

pub fn with_colspan(self, colspan: NonZeroUsize) -> Self

Builder-style setter for the colspan field.

pub fn with_rowspan(self, rowspan: NonZeroUsize) -> Self

Builder-style setter for the rowspan field.

pub fn with_fill(self, fill: Smart<Option<Paint>>) -> Self

Builder-style setter for the fill field.

pub fn with_align(self, align: Smart<Alignment>) -> Self

Builder-style setter for the align field.

pub fn with_inset(self, inset: Smart<Sides<Option<Rel<Length>>>>) -> Self

Builder-style setter for the inset field.

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

Builder-style setter for the stroke field.

pub fn with_breakable(self, breakable: Smart<bool>) -> Self

Builder-style setter for the breakable field.

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

Setter for the x field.

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

Setter for the y field.

pub fn push_colspan(&mut self, colspan: NonZeroUsize)

Setter for the colspan field.

pub fn push_rowspan(&mut self, rowspan: NonZeroUsize)

Setter for the rowspan field.

pub fn push_fill(&mut self, fill: Smart<Option<Paint>>)

Setter for the fill field.

pub fn push_align(&mut self, align: Smart<Alignment>)

Setter for the align field.

pub fn push_inset(&mut self, inset: Smart<Sides<Option<Rel<Length>>>>)

Setter for the inset field.

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

Setter for the stroke field.

pub fn push_breakable(&mut self, breakable: Smart<bool>)

Setter for the breakable field.

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

The cell’s column (zero-indexed). This field may be used in show rules to style a cell depending on its column.

You may override this field to pick in which column the cell must be placed. If no row (y) is chosen, the cell will be placed in the first row (starting at row 0) with that column available (or a new row if none). If both x and y are chosen, however, the cell will be placed in that exact position. An error is raised if that position is not available (thus, it is usually wise to specify cells with a custom position before cells with automatic positions).

#let circ(c) = circle(
    fill: c, width: 5mm
)

#grid(
  columns: 4,
  rows: 7mm,
  stroke: .5pt + blue,
  align: center + horizon,
  inset: 1mm,

  grid.cell(x: 2, y: 2, circ(aqua)),
  circ(yellow),
  grid.cell(x: 3, circ(green)),
  circ(black),
)

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

The cell’s row (zero-indexed). This field may be used in show rules to style a cell depending on its row.

You may override this field to pick in which row the cell must be placed. If no column (x) is chosen, the cell will be placed in the first column (starting at column 0) available in the chosen row. If all columns in the chosen row are already occupied, an error is raised.

#let tri(c) = polygon.regular(
  fill: c,
  size: 5mm,
  vertices: 3,
)

#grid(
  columns: 2,
  stroke: blue,
  inset: 1mm,

  tri(black),
  grid.cell(y: 1, tri(teal)),
  grid.cell(y: 1, tri(red)),
  grid.cell(y: 2, tri(orange))
)

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

The amount of columns spanned by this cell.

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

The amount of rows spanned by this cell.

pub fn fill(&self, styles: StyleChain<'_>) -> Smart<Option<Paint>>

The cell’s fill override.

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

The cell’s alignment override.

pub fn inset(&self, styles: StyleChain<'_>) -> Smart<Sides<Option<Rel<Length>>>>

The cell’s inset override.

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

The cell’s stroke override.

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

Whether rows spanned by this cell can be placed in different pages. When equal to {auto}, a cell spanning only fixed-size rows is unbreakable, while a cell spanning at least one {auto}-sized row is breakable.

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

Access the x field in the given style chain.

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

Access the y field in the given style chain.

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

Access the colspan field in the given style chain.

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

Access the rowspan field in the given style chain.

pub fn fill_in(styles: StyleChain<'_>) -> Smart<Option<Paint>>

Access the fill field in the given style chain.

pub fn align_in(styles: StyleChain<'_>) -> Smart<Alignment>

Access the align field in the given style chain.

pub fn inset_in(styles: StyleChain<'_>) -> Smart<Sides<Option<Rel<Length>>>>

Access the inset field in the given style chain.

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

Access the stroke field in the given style chain.

pub fn breakable_in(styles: StyleChain<'_>) -> Smart<bool>

Access the breakable 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_y(y: Smart<usize>) -> Property

Create a style property for the y field.

pub fn set_colspan(colspan: NonZeroUsize) -> Property

Create a style property for the colspan field.

pub fn set_rowspan(rowspan: NonZeroUsize) -> Property

Create a style property for the rowspan field.

pub fn set_fill(fill: Smart<Option<Paint>>) -> Property

Create a style property for the fill field.

pub fn set_align(align: Smart<Alignment>) -> Property

Create a style property for the align field.

pub fn set_inset(inset: Smart<Sides<Option<Rel<Length>>>>) -> Property

Create a style property for the inset field.

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

Create a style property for the stroke field.

pub fn set_breakable(breakable: Smart<bool>) -> Property

Create a style property for the breakable field.

Trait Implementations

impl Capable for GridCell

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

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

impl Clone for GridCell

fn clone(&self) -> GridCell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for GridCell

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

Construct an element from the arguments.

impl Debug for GridCell

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

Formats the value using the given formatter.

impl Fields for GridCell

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 From<Content> for GridCell

fn from(value: Content) -> Self

Converts to this type from the input type.

impl FromValue for GridCell

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for GridCell

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 GridCell

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for GridCell

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 GridCell

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 Reflect for GridCell

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for GridCell

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for GridCell

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

Parse relevant arguments into style properties for this element.