Struct PageElem 

pub struct PageElem {}

Layouts its child onto one or multiple pages.

Although this function is primarily used in set rules to affect page properties, it can also be used to explicitly render its argument onto a set of pages of its own.

Pages can be set to use {auto} as their width or height. In this case, the pages will grow to fit their content on the respective axis.

The Guide for Page Setup explains how to use this and related functions to set up a document with many examples.

Example

>>> #set page(margin: auto)
#set page("us-letter")

There you go, US friends!

Accessibility

The contents of the page’s header, footer, foreground, and background are invisible to Assistive Technology (AT) like screen readers. Only the body of the page is read by AT. Do not include vital information not included elsewhere in the document in these areas.

Implementations

impl PageElem

pub fn new() -> Self

Create a new instance of the element.

impl PageElem

pub const width: Field<Self, 1u8>

pub const height: Field<Self, 2u8>

pub const flipped: Field<Self, 3u8>

pub const margin: Field<Self, 4u8>

pub const binding: Field<Self, 5u8>

pub const columns: Field<Self, 6u8>

pub const fill: Field<Self, 7u8>

pub const numbering: Field<Self, 8u8>

pub const supplement: Field<Self, 9u8>

pub const number_align: Field<Self, 10u8>

pub const header: Field<Self, 11u8>

pub const header_ascent: Field<Self, 12u8>

pub const footer: Field<Self, 13u8>

pub const footer_descent: Field<Self, 14u8>

pub const background: Field<Self, 15u8>

pub const foreground: Field<Self, 16u8>

Trait Implementations

impl Clone for PageElem

fn clone(&self) -> PageElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for PageElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for PageElem

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

Formats the value using the given formatter.

impl ExternalField<0> for PageElem

const FIELD: ExternalFieldData<Self, 0u8>

type Type = Paper

impl ExternalField<17> for PageElem

const FIELD: ExternalFieldData<Self, 17u8>

type Type = Content

impl Hash for PageElem

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 LocalName for PageElem

const KEY: &'static str = "page"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl NativeElement for PageElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl Set for PageElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableProperty<1> for PageElem

const FIELD: SettablePropertyData<Self, 1u8>

type Type = Smart<Length>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<10> for PageElem

const FIELD: SettablePropertyData<Self, 10u8>

type Type = SpecificAlignment<HAlignment, OuterVAlignment>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<11> for PageElem

const FIELD: SettablePropertyData<Self, 11u8>

type Type = Smart<Option<Content>>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<12> for PageElem

const FIELD: SettablePropertyData<Self, 12u8>

type Type = Rel

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<13> for PageElem

const FIELD: SettablePropertyData<Self, 13u8>

type Type = Smart<Option<Content>>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<14> for PageElem

const FIELD: SettablePropertyData<Self, 14u8>

type Type = Rel

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<15> for PageElem

const FIELD: SettablePropertyData<Self, 15u8>

type Type = Option<Content>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<16> for PageElem

const FIELD: SettablePropertyData<Self, 16u8>

type Type = Option<Content>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<2> for PageElem

const FIELD: SettablePropertyData<Self, 2u8>

type Type = Smart<Length>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<3> for PageElem

const FIELD: SettablePropertyData<Self, 3u8>

type Type = bool

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<4> for PageElem

const FIELD: SettablePropertyData<Self, 4u8>

type Type = Margin

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<5> for PageElem

const FIELD: SettablePropertyData<Self, 5u8>

type Type = Smart<Binding>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<6> for PageElem

const FIELD: SettablePropertyData<Self, 6u8>

type Type = NonZero<usize>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<7> for PageElem

const FIELD: SettablePropertyData<Self, 7u8>

type Type = Smart<Option<Paint>>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<8> for PageElem

const FIELD: SettablePropertyData<Self, 8u8>

type Type = Option<Numbering>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<9> for PageElem

const FIELD: SettablePropertyData<Self, 9u8>

type Type = Smart<Option<Content>>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl RefableProperty<1> for PageElem

impl RefableProperty<10> for PageElem

impl RefableProperty<11> for PageElem

impl RefableProperty<12> for PageElem

impl RefableProperty<13> for PageElem

impl RefableProperty<14> for PageElem

impl RefableProperty<15> for PageElem

impl RefableProperty<16> for PageElem

impl RefableProperty<2> for PageElem

impl RefableProperty<3> for PageElem

impl RefableProperty<5> for PageElem

impl RefableProperty<6> for PageElem

impl RefableProperty<7> for PageElem

impl RefableProperty<8> for PageElem

impl RefableProperty<9> for PageElem