{"route":"/en-US-v0.13.1/reference/model/table/","title":"Table","description":"Documentation for the `table` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-columns","name":"columns","children":[]},{"id":"parameters-rows","name":"rows","children":[]},{"id":"parameters-gutter","name":"gutter","children":[]},{"id":"parameters-column-gutter","name":"column-gutter","children":[]},{"id":"parameters-row-gutter","name":"row-gutter","children":[]},{"id":"parameters-fill","name":"fill","children":[]},{"id":"parameters-align","name":"align","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-inset","name":"inset","children":[]},{"id":"parameters-children","name":"children","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-cell","name":"Table Cell","children":[{"id":"definitions-cell-body","name":"body","children":[]},{"id":"definitions-cell-x","name":"x","children":[]},{"id":"definitions-cell-y","name":"y","children":[]},{"id":"definitions-cell-colspan","name":"colspan","children":[]},{"id":"definitions-cell-rowspan","name":"rowspan","children":[]},{"id":"definitions-cell-fill","name":"fill","children":[]},{"id":"definitions-cell-align","name":"align","children":[]},{"id":"definitions-cell-inset","name":"inset","children":[]},{"id":"definitions-cell-stroke","name":"stroke","children":[]},{"id":"definitions-cell-breakable","name":"breakable","children":[]}]},{"id":"definitions-hline","name":"Table Horizontal Line","children":[{"id":"definitions-hline-y","name":"y","children":[]},{"id":"definitions-hline-start","name":"start","children":[]},{"id":"definitions-hline-end","name":"end","children":[]},{"id":"definitions-hline-stroke","name":"stroke","children":[]},{"id":"definitions-hline-position","name":"position","children":[]}]},{"id":"definitions-vline","name":"Table Vertical Line","children":[{"id":"definitions-vline-x","name":"x","children":[]},{"id":"definitions-vline-start","name":"start","children":[]},{"id":"definitions-vline-end","name":"end","children":[]},{"id":"definitions-vline-stroke","name":"stroke","children":[]},{"id":"definitions-vline-position","name":"position","children":[]}]},{"id":"definitions-header","name":"Table Header","children":[{"id":"definitions-header-repeat","name":"repeat","children":[]},{"id":"definitions-header-children","name":"children","children":[]}]},{"id":"definitions-footer","name":"Table Footer","children":[{"id":"definitions-footer-repeat","name":"repeat","children":[]},{"id":"definitions-footer-children","name":"children","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"table","title":"Table","keywords":[],"oneliner":"A table of items.","element":true,"contextual":false,"deprecation":null,"details":"

A table of items.

\n

Tables are used to arrange content in cells. Cells can contain arbitrary\ncontent, including multiple paragraphs and are specified in row-major order.\nFor a hands-on explanation of all the ways you can use and customize tables\nin Typst, check out the table guide.

\n

Because tables are just grids with different defaults for some cell\nproperties (notably stroke and inset), refer to the grid\ndocumentation for more information on how to size the table tracks\nand specify the cell appearance properties.

\n

If you are unsure whether you should be using a table or a grid, consider\nwhether the content you are arranging semantically belongs together as a set\nof related data points or similar or whether you are just want to enhance\nyour presentation by arranging unrelated content in a grid. In the former\ncase, a table is the right choice, while in the latter case, a grid is more\nappropriate. Furthermore, Typst will annotate its output in the future such\nthat screenreaders will announce content in table as tabular while a\ngrid's content will be announced no different than multiple content blocks\nin the document flow.

\n

Note that, to override a particular cell's properties or apply show rules on\ntable cells, you can use the table.cell element. See its\ndocumentation for more information.

\n

Although the table and the grid share most properties, set and show\nrules on one of them do not affect the other.

\n

To give a table a caption and make it referenceable, put it into a\nfigure.

\n

Example

\n

The example below demonstrates some of the most common table options.

\n
#table(\n  columns: (1fr, auto, auto),\n  inset: 10pt,\n  align: horizon,\n  table.header(\n    [], [*Volume*], [*Parameters*],\n  ),\n  image("cylinder.svg"),\n  $ pi h (D^2 - d^2) / 4 $,\n  [\n    $h$: height \\\n    $D$: outer radius \\\n    $d$: inner radius\n  ],\n  image("tetrahedron.svg"),\n  $ sqrt(2) / 12 a^3 $,\n  [$a$: edge length]\n)\n
\"Preview\"
\n

Much like with grids, you can use table.cell to customize\nthe appearance and the position of each cell.

\n
#set table(\n  stroke: none,\n  gutter: 0.2em,\n  fill: (x, y) =>\n    if x == 0 or y == 0 { gray },\n  inset: (right: 1.5em),\n)\n\n#show table.cell: it => {\n  if it.x == 0 or it.y == 0 {\n    set text(white)\n    strong(it)\n  } else if it.body == [] {\n    // Replace empty cells with 'N/A'\n    pad(..it.inset)[_N/A_]\n  } else {\n    it\n  }\n}\n\n#let a = table.cell(\n  fill: green.lighten(60%),\n)[A]\n#let b = table.cell(\n  fill: aqua.lighten(60%),\n)[B]\n\n#table(\n  columns: 4,\n  [], [Exam 1], [Exam 2], [Exam 3],\n\n  [John], [], a, [],\n  [Mary], [], a, a,\n  [Robert], b, a, b,\n)\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"columns","details":"

The column sizes. See the grid documentation for more\ninformation on track sizing.

","example":null,"types":["auto","int","relative","fraction","array"],"strings":[],"default":"()","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"rows","details":"

The row sizes. See the grid documentation for more information\non track sizing.

","example":null,"types":["auto","int","relative","fraction","array"],"strings":[],"default":"()","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"gutter","details":"

The gaps between rows and columns. This is a shorthand for setting\ncolumn-gutter and row-gutter to the same value. See the grid\ndocumentation for more information on gutters.

","example":null,"types":["auto","int","relative","fraction","array"],"strings":[],"default":"()","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"column-gutter","details":"

The gaps between columns. Takes precedence over gutter. See the\ngrid documentation for more information on gutters.

","example":null,"types":["auto","int","relative","fraction","array"],"strings":[],"default":"()","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"row-gutter","details":"

The gaps between rows. Takes precedence over gutter. See the\ngrid documentation for more information on gutters.

","example":null,"types":["auto","int","relative","fraction","array"],"strings":[],"default":"()","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill","details":"

How to fill the cells.

\n

This can be a color or a function that returns a color. The function\nreceives the cells' column and row indices, starting from zero. This can\nbe used to implement striped tables.

","example":"
#table(\n  fill: (x, _) =>\n    if calc.odd(x) { luma(240) }\n    else { white },\n  align: (x, y) =>\n    if y == 0 { center }\n    else if x == 0 { left }\n    else { right },\n  columns: 4,\n  [], [*Q1*], [*Q2*], [*Q3*],\n  [Revenue:], [1000 €], [2000 €], [3000 €],\n  [Expenses:], [500 €], [1000 €], [1500 €],\n  [Profit:], [500 €], [1000 €], [1500 €],\n)\n
\"Preview\"
","types":["none","color","gradient","array","tiling","function"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"align","details":"

How to align the cells' content.

\n

This can either be a single alignment, an array of alignments\n(corresponding to each column) or a function that returns an alignment.\nThe function receives the cells' column and row indices, starting from\nzero. If set to auto, the outer alignment is used.

","example":"
#table(\n  columns: 3,\n  align: (left, center, right),\n  [Hello], [Hello], [Hello],\n  [A], [B], [C],\n)\n
\"Preview\"
","types":["auto","array","alignment","function"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

How to stroke the cells.

\n

Strokes can be disabled by setting this to none.

\n

If it is necessary to place lines which can cross spacing between cells\nproduced by the gutter option, or to override the stroke between\nmultiple specific cells, consider specifying one or more of\ntable.hline and table.vline\nalongside your table cells.

\n

See the grid documentation for more information on\nstrokes.

","example":null,"types":["none","length","color","gradient","array","stroke","tiling","dictionary","function"],"strings":[],"default":"1pt + black","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"inset","details":"

How much to pad the cells' content.

","example":"
#table(\n  inset: 10pt,\n  [Hello],\n  [World],\n)\n\n#table(\n  columns: 2,\n  inset: (\n    x: 20pt,\n    y: 10pt,\n  ),\n  [Hello],\n  [World],\n)\n
\"Preview\"
","types":["relative","array","dictionary","function"],"strings":[],"default":"0% + 5pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":"

The contents of the table cells, plus any extra table lines specified\nwith the table.hline and\ntable.vline elements.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[{"path":["table"],"name":"cell","title":"Table Cell","keywords":[],"oneliner":"A cell in the table. Use this to position a cell manually or to apply","element":true,"contextual":false,"deprecation":null,"details":"

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

\n

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

","example":"
#show table.cell.where(y: 0): strong\n#set table(\n  stroke: (x, y) => if y == 0 {\n    (bottom: 0.7pt + black)\n  },\n  align: (x, y) => (\n    if x > 0 { center }\n    else { left }\n  )\n)\n\n#table(\n  columns: 3,\n  table.header(\n    [Substance],\n    [Subcritical °C],\n    [Supercritical °C],\n  ),\n  [Hydrochloric Acid],\n  [12.0], [92.1],\n  [Sodium Myreth Sulfate],\n  [16.6], [104],\n  [Potassium Hydroxide],\n  table.cell(colspan: 2)[24.7],\n)\n
\"Preview\"
\n

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

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

You may also apply a show rule on table.cell to style all cells at once.\nCombined with selectors, this allows you to apply styles based on a cell's\nposition:

\n
#show table.cell.where(x: 0): strong\n\n#table(\n  columns: 3,\n  gutter: 3pt,\n  [Name], [Age], [Strength],\n  [Hannes], [36], [Grace],\n  [Irma], [50], [Resourcefulness],\n  [Vikram], [49], [Perseverance],\n)\n
\"Preview\"
","self":false,"params":[{"name":"body","details":"

The cell's body.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"x","details":"

The cell's column (zero-indexed).\nFunctions identically to the x field in grid.cell.

","example":null,"types":["auto","int"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"y","details":"

The cell's row (zero-indexed).\nFunctions identically to the y field in grid.cell.

","example":null,"types":["auto","int"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"colspan","details":"

The amount of columns spanned by this cell.

","example":null,"types":["int"],"strings":[],"default":"1","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"rowspan","details":"

The amount of rows spanned by this cell.

","example":null,"types":["int"],"strings":[],"default":"1","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill","details":"

The cell's fill override.

","example":null,"types":["none","auto","color","gradient","tiling"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"align","details":"

The cell's alignment override.

","example":null,"types":["auto","alignment"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"inset","details":"

The cell's inset override.

","example":null,"types":["auto","relative","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

The cell's stroke override.

","example":null,"types":["none","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"breakable","details":"

Whether rows spanned by this cell can be placed in different pages.\nWhen equal to auto, a cell spanning only fixed-size rows is\nunbreakable, while a cell spanning at least one auto-sized row is\nbreakable.

","example":null,"types":["auto","bool"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]},{"path":["table"],"name":"hline","title":"Table Horizontal Line","keywords":[],"oneliner":"A horizontal line in the table.","element":true,"contextual":false,"deprecation":null,"details":"

A horizontal line in the table.

\n

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

\n

Use this function instead of the table's stroke field if you want to\nmanually place a horizontal line at a specific position in a single table.\nConsider using table's stroke field or table.cell's\nstroke field instead if the line you want to place is\npart of all your tables' designs.

","example":"
#set table.hline(stroke: .6pt)\n\n#table(\n  stroke: none,\n  columns: (auto, 1fr),\n  [09:00], [Badge pick up],\n  [09:45], [Opening Keynote],\n  [10:30], [Talk: Typst's Future],\n  [11:15], [Session: Good PRs],\n  table.hline(start: 1),\n  [Noon], [_Lunch break_],\n  table.hline(start: 1),\n  [14:00], [Talk: Tracked Layout],\n  [15:00], [Talk: Automations],\n  [16:00], [Workshop: Tables],\n  table.hline(),\n  [19:00], [Day 1 Attendee Mixer],\n)\n
\"Preview\"
","self":false,"params":[{"name":"y","details":"

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

","example":null,"types":["auto","int"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"start","details":"

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

","example":null,"types":["int"],"strings":[],"default":"0","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"end","details":"

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

","example":null,"types":["none","int"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

The line's stroke.

\n

Specifying none removes any lines previously placed across this\nline's range, including hlines or per-cell stroke below it.

","example":null,"types":["none","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"1pt + black","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"position","details":"

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

\n

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

","example":null,"types":["alignment"],"strings":[],"default":"top","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]},{"path":["table"],"name":"vline","title":"Table Vertical Line","keywords":[],"oneliner":"A vertical line in the table. See the docs for [`grid.vline`]($grid.vline)","element":true,"contextual":false,"deprecation":null,"details":"

A vertical line in the table. See the docs for grid.vline\nfor more information regarding how to use this element's fields.

\n

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

\n

Similar to table.hline, use this function if you want to\nmanually place a vertical line at a specific position in a single table and\nuse the table's stroke field or table.cell's\nstroke field instead if the line you want to place is\npart of all your tables' designs.

","example":null,"self":false,"params":[{"name":"x","details":"

The column before which the horizontal line is placed (zero-indexed).\nFunctions identically to the x field in grid.vline.

","example":null,"types":["auto","int"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"start","details":"

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

","example":null,"types":["int"],"strings":[],"default":"0","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"end","details":"

The row on top of which the vertical line ends (zero-indexed,\nexclusive).

","example":null,"types":["none","int"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

The line's stroke.

\n

Specifying none removes any lines previously placed across this\nline's range, including vlines or per-cell stroke below it.

","example":null,"types":["none","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"1pt + black","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"position","details":"

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

\n

The values left and right are also accepted, but discouraged as\nthey cause your table to be inconsistent between left-to-right and\nright-to-left documents.

\n

This setting is only relevant when column gutter is enabled (and\nshouldn't be used otherwise - prefer just increasing the x field by\none instead), since then the position after a column becomes different\nfrom the position before the next column due to the spacing between\nboth.

","example":null,"types":["alignment"],"strings":[],"default":"start","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]},{"path":["table"],"name":"header","title":"Table Header","keywords":[],"oneliner":"A repeatable table header.","element":true,"contextual":false,"deprecation":null,"details":"

A repeatable table header.

\n

You should wrap your tables' heading rows in this function even if you do not\nplan to wrap your table across pages because Typst will use this function to\nattach accessibility metadata to tables in the future and ensure universal\naccess to your document.

\n

You can use the repeat parameter to control whether your table's header\nwill be repeated across pages.

","example":"
#set page(height: 11.5em)\n#set table(\n  fill: (x, y) =>\n    if x == 0 or y == 0 {\n      gray.lighten(40%)\n    },\n  align: right,\n)\n\n#show table.cell.where(x: 0): strong\n#show table.cell.where(y: 0): strong\n\n#table(\n  columns: 4,\n  table.header(\n    [], [Blue chip],\n    [Fresh IPO], [Penny st'k],\n  ),\n  table.cell(\n    rowspan: 6,\n    align: horizon,\n    rotate(-90deg, reflow: true)[\n      *USD / day*\n    ],\n  ),\n  [0.20], [104], [5],\n  [3.17], [108], [4],\n  [1.59], [84],  [1],\n  [0.26], [98],  [15],\n  [0.01], [195], [4],\n  [7.34], [57],  [2],\n)\n
\"Preview\"
","self":false,"params":[{"name":"repeat","details":"

Whether this header should be repeated across pages.

","example":null,"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":"

The cells and lines within the header.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[]},{"path":["table"],"name":"footer","title":"Table Footer","keywords":[],"oneliner":"A repeatable table footer.","element":true,"contextual":false,"deprecation":null,"details":"

A repeatable table footer.

\n

Just like the table.header element, the footer can repeat\nitself on every page of the table. This is useful for improving legibility\nby adding the column labels in both the header and footer of a large table,\ntotals, or other information that should be visible on every page.

\n

No other table cells may be placed after the footer.

","example":null,"self":false,"params":[{"name":"repeat","details":"

Whether this footer should be repeated across pages.

","example":null,"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":"

The cells and lines within the footer.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[]}]}}}