Skip to main content

canvas

canvas(
length: length,x: numbervector,y: numbervector,z: numbervector,baseline: nonenumbercoordinate,debug: bool,background: nonecolor,stroke: nonestroke,padding: nonenumberarraydictionary,body: nonearrayelement,
) -> content

Sets up a canvas for drawing on.

length:

length
Default: 1cm​

Used to specify what 1 coordinate unit is. Note that ratios are no longer supported! You can wrap the canvas into a layout(ly => canvas(length: ly.width * <ratio>, ...)).

baseline:

none or number or coordinate
Default: none​

Specifies the coordinate to use as the baseline. Setting this the canvas behaves like a box element instead of a block.

body:

none or array or element
​

A code block in which functions from the draw module have been called.

background:

none or color
Default: none​

A color to be used for the background of the canvas.

stroke:

none or stroke
Default: none​

Stroke style to apply to the canvas top-level element (box or block)

padding:

none or number or array or dictionary
Default: none​

How much padding to add to the canvas. none applies no padding. A number applies padding to all sides equally. A dictionary applies padding following Typst's pad function: https://typst.app/docs/reference/layout/pad/. An array follows CSS like padding: (y, x), (top, x, bottom) or (top, right, bottom, left).

x:

number or vector
Default: 1.0​

Sets up the x vector of the coordinate system to (x, 0, 0) or to the given vector.

y:

number or vector
Default: 1.0​

Sets up the y vector of the coordinate system to (0, y, 0) or to the given vector.

z:

number or vector
Default: 1.0​

Sets up the z vector of the coordinate system to (0, 0, z) or to the given vector.

debug:

bool
Default: false​

Shows the bounding boxes of each element when true.