{"route":"/en-US-v0.14.1/reference/pdf/header-cell/","title":"Header Cell","description":"Documentation for the `header-cell` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-level","name":"level","children":[]},{"id":"parameters-scope","name":"scope","children":[]},{"id":"parameters-cell","name":"cell","children":[]}]}],"body":{"kind":"func","content":{"path":["pdf"],"name":"header-cell","title":"Header Cell","keywords":[],"oneliner":"Explicitly defines a cell as a header cell.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"Explicitly defines a cell as a header cell.
\nHeader cells help users of Assistive Technology (AT) understand and navigate\ncomplex tables. When your table is correctly marked up with header cells, AT\ncan announce the relevant header information on-demand when entering a cell.
\nBy default, Typst will automatically mark all cells within table.header\nas header cells. They will apply to the columns below them. You can use that\nfunction's level parameter to make header cells\nlabelled by other header cells.
\nThe pdf.header-cell function allows you to indicate that a cell is a\nheader cell in the following additional situations:
\n\n- You have a header column in which each cell applies to its row. In\nthat case, you pass
"row" as an argument to the scope\nparameter to indicate that the header cell\napplies to the row. \n- You have a cell in
table.header, for example at the very start, that\nlabels both its row and column. In that case, you pass "both" as an\nargument to the scope parameter. \n- You have a header cell in a row not containing other header cells. In that\ncase, you can use this function to mark it as a header cell.
\n
\nThe API of this feature is temporary. Hence, calling this function requires\nenabling the a11y-extras feature flag at the moment. In a future Typst\nrelease, this functionality may move out of the pdf module so that tables\nin other export targets can contain the same information.
\n#show table.cell.where(x: 0): set text(weight: "medium")\n#show table.cell.where(y: 0): set text(weight: "bold")\n\n#table(\n columns: 3,\n align: (start, end, end),\n\n table.header(\n \n \n pdf.header-cell(scope: "both")[Nutrient],\n [Per 100g],\n [Per Serving],\n ),\n\n \n pdf.header-cell(scope: "row")[Calories],\n [250 kcal], [375 kcal],\n pdf.header-cell(scope: "row")[Protein],\n [8g], [12g],\n pdf.header-cell(scope: "row")[Fat],\n [12g], [18g],\n pdf.header-cell(scope: "row")[Carbs],\n [30g], [45g],\n)\n
The nesting level of this header cell.
"}],"types":["int"],"strings":[],"default":"1","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"scope","details":[{"kind":"html","content":"What track of the table this header cell applies to.
"}],"types":["str"],"strings":[{"string":"both","details":"The header cell refers to both the row and the column.
"},{"string":"column","details":"The header cell refers to the column.
"},{"string":"row","details":"The header cell refers to the row.
"}],"default":""column"","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"cell","details":[{"kind":"html","content":"The table cell.
\nThis can be content or a call to table.cell.
"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}}} ![\"Preview\"](\"/en-US-v0.14.1/assets/41f9acbb3490553d6e9d371bd5ea718f.png\")