Struct Location

pub struct Location(/* private fields */);

Identifies an element in the document.

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

Locatable elements { #locatable }

Currently, only a subset of element functions is locatable. Aside from headings and figures, this includes equations, references, quotes and all elements with an explicit label. As a result, you can query for e.g. [strong] elements, but you will find only those that have an explicit label attached to them. This limitation will be resolved in the future.

Implementations

impl Location

pub fn new(hash: u128) -> Self

Create a new location from a unique hash.

pub fn hash(self) -> u128

Extract the raw hash.

pub fn variant(self, n: usize) -> Self

Produces a well-known variant of this location.

This is a synthetic location created from another one and is used, for example, in bibliography management to create individual linkable locations for reference entries from the bibliography’s location.

impl Location

pub fn page(self, engine: &mut Engine<'_>) -> NonZeroUsize

Returns the page number for this location.

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

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

Can be used with [here] to retrieve the physical page position of the current context:

#context [
  I am located on
  page #here().page()
]

pub fn position(self, engine: &mut Engine<'_>) -> Position

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

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

pub fn page_numbering(self, engine: &mut Engine<'_>) -> Option<Numbering>

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

If the page numbering is set to {none} at that location, this function returns {none}.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Location

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Location> for LocatableSelector

fn from(loc: Location) -> Self

Converts to this type from the input type.

impl From<Location> for Selector

fn from(value: Location) -> Self

Converts to this type from the input type.

impl FromValue for Location

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Location

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Location

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Location

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Location

const NAME: &'static str = "location"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for Location

fn eq(&self, other: &Location) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Location

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Location

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Copy for Location

impl Eq for Location

impl StructuralPartialEq for Location