{"route":"/en-US-v0.14.1/reference/introspection/location/","title":"Location","description":"Documentation for the Location type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"locatable","name":"Locatable","children":[]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-page","name":"Page","children":[]},{"id":"definitions-position","name":"Position","children":[]},{"id":"definitions-page-numbering","name":"Page Numbering","children":[]}]}],"body":{"kind":"type","content":{"name":"location","title":"Location","keywords":[],"oneliner":"Identifies an element in the document.","details":"

Identifies an element in the document.

\n

A location uniquely identifies an element in the document and lets you\naccess its absolute position on the pages. You can retrieve the current\nlocation with the here function and the location of a queried or shown\nelement with the location() method on content.

\n

Locatable elements

\n

Elements that are automatically assigned a location are called locatable.\nFor efficiency reasons, not all elements are locatable.

\n\n

To find out whether a specific element is locatable, you can try to\nquery for it.

\n

Note that you can still observe elements that are not locatable in queries\nthrough other means, for instance, when they have a label attached to them.

","constructor":null,"scope":[{"path":["location"],"name":"page","title":"Page","keywords":[],"oneliner":"Returns the page number for this location.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the page number for this location.

\n

Note that this does not return the value of the page counter\nat this location, but the true page number (starting from one).

\n

If you want to know the value of the page counter, use\ncounter(page).at(loc) instead.

\n

Can be used with here to retrieve the physical page position\nof the current context:

"},{"kind":"example","content":{"body":"
#context [\n  I am located on\n  page #here().page()\n]\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["int"],"scope":[]},{"path":["location"],"name":"position","title":"Position","keywords":[],"oneliner":"Returns a dictionary with the page number and the x, y position for this location.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns a dictionary with the page number and the x, y position for this\nlocation. The page number starts at one and the coordinates are measured\nfrom the top-left of the page.

\n

If you only need the page number, use page() instead as it allows\nTypst to skip unnecessary work.

"}],"self":true,"params":[],"returns":["dictionary"],"scope":[]},{"path":["location"],"name":"page-numbering","title":"Page Numbering","keywords":[],"oneliner":"Returns the page numbering pattern of the page at this location.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the page numbering pattern of the page at this location. This\ncan be used when displaying the page counter in order to obtain the\nlocal numbering. This is useful if you are building custom indices or\noutlines.

\n

If the page numbering is set to none at that location, this function\nreturns none.

"}],"self":true,"params":[],"returns":["none","str","function"],"scope":[]}]}}}