Computed layout result containing position, size, and spacing values for a node.
This class wraps the native [taffy::Layout] and provides read-only access
to all computed layout values. All dimensions are in pixels.
In-flow positions are relative to the parent's border box. Absolute positions
are relative to the nearest non-static ancestor's border box. Fixed positions
and absolute positions without a positioned ancestor are reported relative to
the root's border box, although their layout area is the initial containing block
defined by the available space. Root positions use canvas coordinates, including
margins and applicable insets. Add the corresponding ancestor's canvas position
when rendering; do not always add the direct parent's position.
const tree = new TaffyTree();
const rootId = tree.newLeaf(new Style());
const node = rootId;
tree.computeLayout(rootId, { width: 800, height: 600 });
const layout = tree.getLayout(node);
console.log("Position:", layout.x, layout.y);
console.log("Size:", layout.width, layout.height);
console.log("Content:", layout.contentWidth, layout.contentHeight);
console.log(
"Padding:",
layout.paddingTop,
layout.paddingRight,
layout.paddingBottom,
layout.paddingLeft,
);
console.log(
"Border:",
layout.borderTop,
layout.borderRight,
layout.borderBottom,
layout.borderLeft,
);
console.log(
"Margin:",
layout.marginTop,
layout.marginRight,
layout.marginBottom,
layout.marginLeft,
);
console.log("Scrollbar:", layout.scrollbarWidth, layout.scrollbarHeight);
console.log("Order:", layout.order);
| Property |
Modifier |
Type |
Description |
border
|
readonly |
any |
Gets the border as a Rect with left, right, top, bottom border widths Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const border = layout.border; console.log(Border: ${border.left} ${border.right} ${border.top} ${border.bottom}); tree.free();
|
borderBottom
|
readonly |
number |
Gets the bottom border width |
borderLeft
|
readonly |
number |
Gets the left border width |
borderRight
|
readonly |
number |
Gets the right border width |
borderTop
|
readonly |
number |
Gets the top border width |
contentHeight
|
readonly |
number |
Gets the vertical content extent from the scroll origin Measures the reachable bottom edge from the padding-box top edge. Content above the scroll origin does not increase this extent, which may exceed height. |
contentSize
|
readonly |
any |
Gets the reachable content extents as { width, height } Extents are measured from the padding-box scroll origin: top-left for LTR and top-right for RTL. They may exceed the node's width and height. Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const contentSize = layout.contentSize; console.log(Content: ${contentSize.width} x ${contentSize.height}); tree.free();
|
contentWidth
|
readonly |
number |
Gets the horizontal content extent from the scroll origin Measures the reachable end of the content from the padding-box scroll origin: the left edge for LTR and the right edge for RTL. Content before that origin does not increase this extent, which may exceed width. |
height
|
readonly |
number |
Gets the computed height of the node This is the final height after layout computation, including any constraints from min/max size or flex properties. |
margin
|
readonly |
any |
Gets the margin as a Rect with left, right, top, bottom margins Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const margin = layout.margin; console.log(Margin: ${margin.left} ${margin.right} ${margin.top} ${margin.bottom}); tree.free();
|
marginBottom
|
readonly |
number |
Gets the bottom margin |
marginLeft
|
readonly |
number |
Gets the left margin |
marginRight
|
readonly |
number |
Gets the right margin |
marginTop
|
readonly |
number |
Gets the top margin |
order
|
readonly |
number |
Gets the rendering order of the node This value determines the z-order for overlapping elements. Lower values are rendered first (behind higher values). |
padding
|
readonly |
any |
Gets the padding as a Rect with left, right, top, bottom padding Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const padding = layout.padding; console.log(Padding: ${padding.left} ${padding.right} ${padding.top} ${padding.bottom}); tree.free();
|
paddingBottom
|
readonly |
number |
Gets the bottom padding |
paddingLeft
|
readonly |
number |
Gets the left padding |
paddingRight
|
readonly |
number |
Gets the right padding |
paddingTop
|
readonly |
number |
Gets the top padding |
position
|
readonly |
any |
Gets the position as a Point with x and y coordinates Uses the same coordinate system as the x and y getters. For out-of-flow nodes, the reference box may be an ancestor other than the direct parent. Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const pos = layout.position; console.log(Position: (${pos.x}, ${pos.y})); tree.free();
|
scrollbarHeight
|
readonly |
number |
Gets the height of the horizontal scrollbar When overflow is set to scroll, this indicates the space reserved for the horizontal scrollbar. |
scrollbarSize
|
readonly |
any |
Gets the scrollbar size as a Size with scrollbarWidth and scrollbarHeight When overflow is set to scroll, this indicates the space reserved for scrollbars. Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const scrollbarSize = layout.scrollbarSize; console.log(Scrollbar: ${scrollbarSize.width} x ${scrollbarSize.height}); tree.free();
|
scrollbarWidth
|
readonly |
number |
Gets the width of the vertical scrollbar When overflow is set to scroll, this indicates the space reserved for the vertical scrollbar. |
size
|
readonly |
any |
Gets the size as a Size with width and height Example import { TaffyTree, Style } from "taffy-layout"; const tree = new TaffyTree(); const root = tree.newLeaf(new Style()); tree.computeLayout(root, { width: 100, height: 100 }); const layout = tree.getLayout(root); const size = layout.size; console.log(Size: ${size.width} x ${size.height}); tree.free();
|
width
|
readonly |
number |
Gets the computed width of the node This is the final width after layout computation, including any constraints from min/max size or flex properties. |
x
|
readonly |
number |
Gets the X coordinate of the node's top-left corner Relative to the parent's border box for in-flow nodes, or the nearest non-static ancestor's border box for absolute nodes. Fixed nodes and absolute nodes without a positioned ancestor report coordinates relative to the root's border box. The root itself uses canvas coordinates, accounting for direction, margins and applicable insets. |
y
|
readonly |
number |
Gets the Y coordinate of the node's top-left corner Uses the same reference box as x: the parent for in-flow nodes, the nearest non-static ancestor for absolute nodes, or the root for fixed nodes and absolute nodes without a positioned ancestor. The root itself uses canvas coordinates, accounting for margins and applicable insets. |
void
void
Reads multiple layout properties in a single WASM call.
Supports both object properties and individual flat properties.
undefined
A single value for one key, values in key order for multiple keys,
or undefined when no keys are supplied
Error if any property key is unknown.
Remarks
- Single property: returns exact value type
- Multiple literal keys: returns a typed tuple for destructuring
- A dynamic array of keys: returns an array of the corresponding value types
import { TaffyTree, Style } from "taffy-layout";
const tree = new TaffyTree();
const root = tree.newLeaf(new Style());
tree.computeLayout(root, { width: 100, height: 100 });
const layout = tree.getLayout(root);
// Single property - returns exact type
const width = layout.get("width"); // number
// Two properties - returns tuple for destructuring
const [pos, size] = layout.get("position", "size");
// pos: Point<number>, size: Size<number>
// Three properties - returns tuple for destructuring
const [x, y, w] = layout.get("x", "y", "width");
// Four literal keys also return a typed tuple
const values = layout.get("x", "y", "width", "height");
// values type is: [number, number, number, number]
tree.free();
get<K>(...keys): LayoutPropertyValues[K];
| Parameter |
Type |
...keys |
[K] |
LayoutPropertyValues[K]
get<K1, K2>(...keys): [LayoutPropertyValues[K1], LayoutPropertyValues[K2]];
| Parameter |
Type |
...keys |
[K1, K2] |
[LayoutPropertyValues[K1], LayoutPropertyValues[K2]]
get<K1, K2, K3>(...keys): [LayoutPropertyValues[K1], LayoutPropertyValues[K2], LayoutPropertyValues[K3]];
| Parameter |
Type |
...keys |
[K1, K2, K3] |
[LayoutPropertyValues[K1], LayoutPropertyValues[K2], LayoutPropertyValues[K3]]
get<Keys>(...keys): LayoutPropertyArrayValues<Keys>;
| Parameter |
Type |
...keys |
Keys |
LayoutPropertyArrayValues<Keys>