Skip to main content

FrameNode

Struct FrameNode 

Source
pub struct FrameNode {
Show 29 fields pub id: String, pub name: Option<String>, pub role: Option<String>, pub x: Option<PropertyValue>, pub y: Option<PropertyValue>, pub w: Option<PropertyValue>, pub h: Option<PropertyValue>, pub layout: Option<String>, pub columns: Option<u32>, pub rows: Option<u32>, pub opacity: Option<f64>, pub visible: Option<bool>, pub locked: Option<bool>, pub rotate: Option<Dimension>, pub blend_mode: Option<String>, pub shadow: Option<PropertyValue>, pub filter: Option<PropertyValue>, pub mask: Option<PropertyValue>, pub blur: Option<Dimension>, pub style: Option<String>, pub children: Vec<Node>, pub anchor: Option<String>, pub anchor_zone: Option<String>, pub anchor_sibling: Option<String>, pub anchor_edge: Option<String>, pub anchor_gap: Option<Dimension>, pub anchor_parent: Option<bool>, pub source_span: Option<Span>, pub unknown_props: BTreeMap<String, UnknownProperty>,
}
Expand description

A frame node — a container that CLIPS its children to its rectangular bounds and renders them in source order (first child = bottom of z-order).

Unlike group, a frame has required geometry (x, y, w, h): these four dimensions define the clip rectangle. Children are rendered at their absolute page coordinates — frame does NOT translate children (dx/dy are unchanged). The frame only clips; it has no fill of its own in v0.

Opacity cascades (multiplies) into all descendant node alphas, exactly as in GroupNode.

Fields§

§id: String§name: Option<String>§role: Option<String>§x: Option<PropertyValue>

Required: clip-rectangle left edge in page coordinates.

§y: Option<PropertyValue>

Required: clip-rectangle top edge in page coordinates.

§w: Option<PropertyValue>

Required: clip-rectangle width.

§h: Option<PropertyValue>

Required: clip-rectangle height.

§layout: Option<String>

Layout algorithm hint (“absolute”/“flow”/“grid”). "flow" activates a vertical-stack flow layout (uniform padding inset + gap between children, resolved from the frame’s style); "grid" tiles children row-major into a columns × rows grid inside the padded content box with uniform gap gutters; any other value (including None and "absolute") keeps the clip-only absolute-positioning model.

§columns: Option<u32>

Grid column count for layout="grid" (ignored otherwise). When the frame uses grid layout, children tile row-major into columns columns; absent → treated as 1 column. KDL: columns=2.

§rows: Option<u32>

Grid row count for layout="grid" (ignored otherwise). Absent → derived as ceil(child_count / columns) so the grid grows to fit its children. KDL: rows=3.

§opacity: Option<f64>

Opacity that cascades (multiplies) into all descendant node alphas.

§visible: Option<bool>

When Some(false) the entire subtree (including the clip) is excluded from the render.

§locked: Option<bool>§rotate: Option<Dimension>

Rotation in degrees, applied at render about the node’s center (the subtree rotates with it; see the compile-site notes for clip limitations).

§blend_mode: Option<String>

Compositing blend mode: "normal" (default) or one of the 11 separable blends. None/"normal" render source-over (byte-identical).

§shadow: Option<PropertyValue>

Drop shadow / outer glow, as a (token) ref to a shadow token.

§filter: Option<PropertyValue>

Color/image filter stack, as a (token) ref to a filter token.

§mask: Option<PropertyValue>

Soft reveal mask, as a (token) ref to a mask token.

§blur: Option<Dimension>

Gaussian blur radius applied to the node’s own rendered ink (sigma in the declared unit, resolved to pixels at compile time). None / 0 → no blur (byte-identical to having no attribute).

§style: Option<String>§children: Vec<Node>

Child nodes in source order.

§anchor: Option<String>

Page-relative placement anchor (one of the nine named positions, e.g. "bottom-right"). When present and recognized, the compile step derives the node’s x and/or y from the page and node dimensions. An explicitly- authored x or y always wins.

§anchor_zone: Option<String>

Optional safe-zone reference for the anchor. See RectNode::anchor_zone.

§anchor_sibling: Option<String>

Optional sibling node id for sibling-relative anchor positioning. See RectNode::anchor_sibling.

§anchor_edge: Option<String>

Adjacent-placement edge relative to anchor-sibling: above/below/before/after. See RectNode::anchor_edge.

§anchor_gap: Option<Dimension>

Gap (px) between this node and its anchor-sibling edge when anchor-edge is set. See RectNode::anchor_gap.

§anchor_parent: Option<bool>

Parent-relative anchor toggle. See RectNode::anchor_parent.

§source_span: Option<Span>

Source declaration span, when available.

§unknown_props: BTreeMap<String, UnknownProperty>

Unknown properties preserved for forward-compat.

Trait Implementations§

Source§

impl Clone for FrameNode

Source§

fn clone(&self) -> FrameNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FrameNode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FrameNode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for FrameNode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.