Struct ColumnsElem

pub struct ColumnsElem {
    pub body: Content,
    /* private fields */
}

Separates a region into multiple equally sized columns.

The column function lets you separate the interior of any container into multiple columns. It will currently not balance the height of the columns. Instead, the columns will take up the height of their container or the remaining height on the page. Support for balanced columns is planned for the future.

Page-level columns { #page-level }

If you need to insert columns across your whole document, use the {page} function’s columns parameter instead. This will create the columns directly at the page-level rather than wrapping all of your content in a layout container. As a result, things like pagebreaks, footnotes, and line numbers will continue to work as expected. For more information, also read the relevant part of the page setup guide.

Breaking out of columns { #breaking-out }

To temporarily break out of columns (e.g. for a paper’s title), use parent-scoped floating placement:

#set page(columns: 2, height: 150pt)

#place(
  top + center,
  scope: "parent",
  float: true,
  text(1.4em, weight: "bold")[
    My document
  ],
)

#lorem(40)

Fields

body: Content

Implementations

impl ColumnsElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_count(self, count: NonZeroUsize) -> Self

Builder-style setter for the count field.

pub fn with_gutter(self, gutter: Rel<Length>) -> Self

Builder-style setter for the gutter field.

pub fn push_count(&mut self, count: NonZeroUsize)

Setter for the count field.

pub fn push_gutter(&mut self, gutter: Rel<Length>)

Setter for the gutter field.

pub fn count(&self, styles: StyleChain<'_>) -> NonZeroUsize

The number of columns.

pub fn gutter(&self, styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

The size of the gutter space between each column.

pub fn count_in(styles: StyleChain<'_>) -> NonZeroUsize

Access the count field in the given style chain.

pub fn gutter_in(styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

Access the gutter field in the given style chain.

pub fn set_count(count: NonZeroUsize) -> Property

Create a style property for the count field.

pub fn set_gutter(gutter: Rel<Length>) -> Property

Create a style property for the gutter field.

Trait Implementations

impl Capable for ColumnsElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for ColumnsElem

fn clone(&self) -> ColumnsElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for ColumnsElem

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

Construct an element from the arguments.

impl Debug for ColumnsElem

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

Formats the value using the given formatter.

impl Fields for ColumnsElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl Hash for ColumnsElem

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 ColumnsElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for ColumnsElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for ColumnsElem

fn eq(&self, other: &Self) -> 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 Repr for ColumnsElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for ColumnsElem

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

Parse relevant arguments into style properties for this element.