Struct TableCell

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

A cell in the table. Use this to position a cell manually or to apply styling. To do the latter, you can either use the function to override the properties for a particular cell, or use it in show rules to apply certain styles to multiple cells at once.

Perhaps the most important use case of {table.cell} is to make a cell span multiple columns and/or rows with the colspan and rowspan fields.

>>> #set page(width: auto)
#show table.cell.where(y: 0): strong
#set table(
  stroke: (x, y) => if y == 0 {
    (bottom: 0.7pt + black)
  },
  align: (x, y) => (
    if x > 0 { center }
    else { left }
  )
)

#table(
  columns: 3,
  table.header(
    [Substance],
    [Subcritical °C],
    [Supercritical °C],
  ),
  [Hydrochloric Acid],
  [12.0], [92.1],
  [Sodium Myreth Sulfate],
  [16.6], [104],
  [Potassium Hydroxide],
  table.cell(colspan: 2)[24.7],
)

For example, you can override the fill, alignment or inset for a single cell:

>>> #set page(width: auto)
// You can also import those.
#import table: cell, header

#table(
  columns: 2,
  align: center,
  header(
    [*Trip progress*],
    [*Itinerary*],
  ),
  cell(
    align: right,
    fill: fuchsia.lighten(80%),
    [🚗],
  ),
  [Get in, folks!],
  [🚗], [Eat curbside hotdog],
  cell(align: left)[🌴🚗],
  cell(
    inset: 0.06em,
    text(1.62em)[🛖🌅🌊],
  ),
)

You may also apply a show rule on table.cell to style all cells at once. Combined with selectors, this allows you to apply styles based on a cell’s position:

#show table.cell.where(x: 0): strong

#table(
  columns: 3,
  gutter: 3pt,
  [Name], [Age], [Strength],
  [Hannes], [36], [Grace],
  [Irma], [50], [Resourcefulness],
  [Vikram], [49], [Perseverance],
)

Fields

body: Content

Implementations

impl TableCell

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). Functions identically to the x field in grid.cell.

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

The cell’s row (zero-indexed). Functions identically to the y field in grid.cell.

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 TableCell

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

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

impl Clone for TableCell

fn clone(&self) -> TableCell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for TableCell

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

Construct an element from the arguments.

impl Debug for TableCell

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

Formats the value using the given formatter.

impl Fields for TableCell

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 TableCell

fn from(value: Content) -> Self

Converts to this type from the input type.

impl FromValue for TableCell

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

Try to cast the value into an instance of Self.

impl Hash for TableCell

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 TableCell

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for TableCell

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 TableCell

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 TableCell

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 TableCell

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for TableCell

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

Parse relevant arguments into style properties for this element.