{"route":"/en-US-v0.13.1/reference/layout/length/","title":"Length","description":"Documentation for the Length type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"fields","name":"Fields","children":[]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-pt","name":"Points","children":[]},{"id":"definitions-mm","name":"Millimeters","children":[]},{"id":"definitions-cm","name":"Centimeters","children":[]},{"id":"definitions-inches","name":"Inches","children":[]},{"id":"definitions-to-absolute","name":"To Absolute","children":[]}]}],"body":{"kind":"type","content":{"name":"length","title":"Length","keywords":[],"oneliner":"A size or distance, possibly expressed with contextual units.","details":"

A size or distance, possibly expressed with contextual units.

\n

Typst supports the following length units:

\n\n

You can multiply lengths with and divide them by integers and floats.

\n

Example

\n
#rect(width: 20pt)\n#rect(width: 2em)\n#rect(width: 1in)\n\n#(3em + 5pt).em \\\n#(20pt).em \\\n#(40em + 2pt).abs \\\n#(5em).abs\n
\"Preview\"
\n

Fields

\n","constructor":null,"scope":[{"path":["length"],"name":"pt","title":"Points","keywords":[],"oneliner":"Converts this length to points.","element":false,"contextual":false,"deprecation":null,"details":"

Converts this length to points.

\n

Fails with an error if this length has non-zero em units (such as\n5em + 2pt instead of just 2pt). Use the abs field (such as in\n(5em + 2pt).abs.pt()) to ignore the em component of the length (thus\nconverting only its absolute component).

","example":null,"self":true,"params":[],"returns":["float"],"scope":[]},{"path":["length"],"name":"mm","title":"Millimeters","keywords":[],"oneliner":"Converts this length to millimeters.","element":false,"contextual":false,"deprecation":null,"details":"

Converts this length to millimeters.

\n

Fails with an error if this length has non-zero em units. See the\npt method for more details.

","example":null,"self":true,"params":[],"returns":["float"],"scope":[]},{"path":["length"],"name":"cm","title":"Centimeters","keywords":[],"oneliner":"Converts this length to centimeters.","element":false,"contextual":false,"deprecation":null,"details":"

Converts this length to centimeters.

\n

Fails with an error if this length has non-zero em units. See the\npt method for more details.

","example":null,"self":true,"params":[],"returns":["float"],"scope":[]},{"path":["length"],"name":"inches","title":"Inches","keywords":[],"oneliner":"Converts this length to inches.","element":false,"contextual":false,"deprecation":null,"details":"

Converts this length to inches.

\n

Fails with an error if this length has non-zero em units. See the\npt method for more details.

","example":null,"self":true,"params":[],"returns":["float"],"scope":[]},{"path":["length"],"name":"to-absolute","title":"To Absolute","keywords":[],"oneliner":"Resolve this length to an absolute length.","element":false,"contextual":false,"deprecation":null,"details":"

Resolve this length to an absolute length.

","example":"
#set text(size: 12pt)\n#context [\n  #(6pt).to-absolute() \\\n  #(6pt + 10em).to-absolute() \\\n  #(10em).to-absolute()\n]\n\n#set text(size: 6pt)\n#context [\n  #(6pt).to-absolute() \\\n  #(6pt + 10em).to-absolute() \\\n  #(10em).to-absolute()\n]\n
\"Preview\"
","self":true,"params":[],"returns":["length"],"scope":[]}]}}}