Skip to content

alias ReadOnlyDimensionParameter

(alias) ReadOnlyDimensionParameter = ("pagedepth"|"pagefilllstretch"|"pagefillstretch"|"pagefilstretch"|"pagegoal"|"pageshrink"|"pagestretch"|"pagetotal")
    | "pagedepth" -- Depth of the current page.
    | "pagefilllstretch" -- Accumulated third-order stretch of the current page.
    | "pagefillstretch" -- Accumulated second-order stretch of the current page.
    | "pagefilstretch" -- Accumulated first-order stretch of the current page.
    | "pagegoal" -- Goal height of the page box. This starts at `\vsize`, and is diminished by heights of insertion items.
    | "pageshrink" -- Accumulated shrink of the current page.
    | "pagestretch" -- Accumulated zeroth-order stretch of the current page.
    | "pagetotal" -- Accumulated natural height of the current page.

The dimension parameters accept Lua numbers (signifying scaled points) or strings (with included dimension). The result is always a number in scaled points. These are read-only:

Reference: