This shortcut property will set the node’s position so that the bottom edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.bottom

bottomLeft?

optional bottomLeft?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:183

The position of the bottom left corner of this node.

Remarks

This shortcut property will set the node’s position so that the bottom left corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.bottomLeft

bottomRight?

optional bottomRight?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:192

The position of the bottom right corner of this node.

Remarks

This shortcut property will set the node’s position so that the bottom right corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.bottomRight

cache?

optional cache?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Node.ts:99

Inherited from

LayoutProps.cache

cachePadding?

optional cachePadding?: SignalValue<PossibleSpacing>

Defined in: 2d/src/lib/components/Node.ts:119

Controls the padding of the cached canvas used by this node.

Remarks

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from

LayoutProps.cachePadding

cachePaddingBottom?

optional cachePaddingBottom?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:107

Controls the padding of the cached canvas used by this node.

Remarks

Inherited from

LayoutProps.cachePaddingBottom

cachePaddingLeft?

optional cachePaddingLeft?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:111

Controls the padding of the cached canvas used by this node.

Remarks

Inherited from

LayoutProps.cachePaddingLeft

cachePaddingRight?

optional cachePaddingRight?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:115

Controls the padding of the cached canvas used by this node.

Remarks

Inherited from

LayoutProps.cachePaddingRight

cachePaddingTop?

optional cachePaddingTop?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:103

Controls the padding of the cached canvas used by this node.

Remarks

Inherited from

LayoutProps.cachePaddingTop

children?

optional children?: SignalValue<ComponentChildren>

Defined in: 2d/src/lib/components/Node.ts:71

Inherited from

LayoutProps.children

clip?

optional clip?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Layout.ts:193

Inherited from

LayoutProps.clip

columnGap?

optional columnGap?: SignalValue<Length>

Defined in: 2d/src/lib/components/Layout.ts:93

Inherited from

LayoutProps.columnGap

composite?

optional composite?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Node.ts:121

Inherited from

LayoutProps.composite

compositeOperation?

optional compositeOperation?: SignalValue<GlobalCompositeOperation>

Defined in: 2d/src/lib/components/Node.ts:122

Inherited from

LayoutProps.compositeOperation

direction?

optional direction?: SignalValue<FlexDirection>

Defined in: 2d/src/lib/components/Layout.ts:82

Inherited from

LayoutProps.direction

fill?

optional fill?: SignalValue<PossibleCanvasStyle>

Defined in: 2d/src/lib/components/Shape.ts:18

filters?

optional filters?: SignalValue<Filter[]>

Defined in: 2d/src/lib/components/Node.ts:91

Inherited from

LayoutProps.filters

fontFamily?

optional fontFamily?: SignalValue<string>

Defined in: 2d/src/lib/components/Layout.ts:96

Inherited from

LayoutProps.fontFamily

fontSize?

optional fontSize?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:97

Inherited from

LayoutProps.fontSize

fontStyle?

optional fontStyle?: SignalValue<string>

Defined in: 2d/src/lib/components/Layout.ts:98

Inherited from

LayoutProps.fontStyle

fontWeight?

optional fontWeight?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:99

Inherited from

LayoutProps.fontWeight

gap?

optional gap?: SignalValue<Length>

Defined in: 2d/src/lib/components/Layout.ts:94

Inherited from

LayoutProps.gap

grow?

optional grow?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:84

Inherited from

LayoutProps.grow

height?

optional height?: SignalValue<Length>

Defined in: 2d/src/lib/components/Layout.ts:63

Inherited from

LayoutProps.height

justifyContent?

optional justifyContent?: SignalValue<FlexContent>

Defined in: 2d/src/lib/components/Layout.ts:88

Inherited from

LayoutProps.justifyContent

key?

optional key?: string

Defined in: 2d/src/lib/components/Node.ts:76

Inherited from

LayoutProps.key

layout?

optional layout?: LayoutMode

Defined in: 2d/src/lib/components/Layout.ts:59

Inherited from

LayoutProps.layout

left?

optional left?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:147

The position of the left edge of this node.

Remarks

This shortcut property will set the node’s position so that the left edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.left

letterSpacing?

optional letterSpacing?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:101

Inherited from

LayoutProps.letterSpacing

lineCap?

optional lineCap?: SignalValue<CanvasLineCap>

Defined in: 2d/src/lib/components/Shape.ts:23

lineDash?

optional lineDash?: SignalValue<number[]>

Defined in: 2d/src/lib/components/Shape.ts:24

lineDashOffset?

optional lineDashOffset?: SignalValue<number>

Defined in: 2d/src/lib/components/Shape.ts:25

lineHeight?

optional lineHeight?: SignalValue<Length>

Defined in: 2d/src/lib/components/Layout.ts:100

Inherited from

LayoutProps.lineHeight

lineJoin?

optional lineJoin?: SignalValue<CanvasLineJoin>

Defined in: 2d/src/lib/components/Shape.ts:22

lineWidth?

optional lineWidth?: SignalValue<number>

Defined in: 2d/src/lib/components/Shape.ts:21

margin?

optional margin?: SignalValue<PossibleSpacing>

Defined in: 2d/src/lib/components/Layout.ts:74

Inherited from

LayoutProps.margin

marginBottom?

optional marginBottom?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:71

Inherited from

LayoutProps.marginBottom

marginLeft?

optional marginLeft?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:72

Inherited from

LayoutProps.marginLeft

marginRight?

optional marginRight?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:73

Inherited from

LayoutProps.marginRight

marginTop?

optional marginTop?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:70

Inherited from

LayoutProps.marginTop

maxHeight?

optional maxHeight?: SignalValue<LengthLimit>

Defined in: 2d/src/lib/components/Layout.ts:65

Inherited from

LayoutProps.maxHeight

maxWidth?

optional maxWidth?: SignalValue<LengthLimit>

Defined in: 2d/src/lib/components/Layout.ts:64

Inherited from

LayoutProps.maxWidth

middle?

optional middle?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:120

The position of the center of this node.

Remarks

This shortcut property will set the node’s position so that the center ends up in the given place. If present, overrides the NodeProps.position property. When offset is not set, this will be the same as the NodeProps.position.

Inherited from

LayoutProps.middle

minHeight?

optional minHeight?: SignalValue<LengthLimit>

Defined in: 2d/src/lib/components/Layout.ts:67

Inherited from

LayoutProps.minHeight

minWidth?

optional minWidth?: SignalValue<LengthLimit>

Defined in: 2d/src/lib/components/Layout.ts:66

Inherited from

LayoutProps.minWidth

offset?

optional offset?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:109

Inherited from

LayoutProps.offset

offsetX?

optional offsetX?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:107

Inherited from

LayoutProps.offsetX

offsetY?

optional offsetY?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:108

Inherited from

LayoutProps.offsetY

opacity?

optional opacity?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:90

Inherited from

LayoutProps.opacity

padding?

optional padding?: SignalValue<PossibleSpacing>

Defined in: 2d/src/lib/components/Layout.ts:80

Inherited from

LayoutProps.padding

paddingBottom?

optional paddingBottom?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:77

Inherited from

LayoutProps.paddingBottom

paddingLeft?

optional paddingLeft?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:78

Inherited from

LayoutProps.paddingLeft

paddingRight?

optional paddingRight?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:79

Inherited from

LayoutProps.paddingRight

paddingTop?

optional paddingTop?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:76

Inherited from

LayoutProps.paddingTop

position?

optional position?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:80

Inherited from

LayoutProps.position

ratio?

optional ratio?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:68

Inherited from

LayoutProps.ratio

ref?

optional ref?: ReferenceReceiver<any>

Defined in: 2d/src/lib/components/Node.ts:70

Inherited from

LayoutProps.ref

right?

optional right?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:156

The position of the right edge of this node.

Remarks

This shortcut property will set the node’s position so that the right edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.right

rotation?

optional rotation?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:81

Inherited from

LayoutProps.rotation

rowGap?

optional rowGap?: SignalValue<Length>

Defined in: 2d/src/lib/components/Layout.ts:92

Inherited from

LayoutProps.rowGap

scale?

optional scale?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:84

Inherited from

LayoutProps.scale

scaleX?

optional scaleX?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:82

Inherited from

LayoutProps.scaleX

scaleY?

optional scaleY?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:83

Inherited from

LayoutProps.scaleY

shaders?

optional shaders?: PossibleShaderConfig

Defined in: 2d/src/lib/components/Node.ts:126

Experimental

Inherited from

LayoutProps.shaders

shadowBlur?

optional shadowBlur?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:94

Inherited from

LayoutProps.shadowBlur

shadowColor?

optional shadowColor?: SignalValue<PossibleColor>

Defined in: 2d/src/lib/components/Node.ts:93

Inherited from

LayoutProps.shadowColor

shadowOffset?

optional shadowOffset?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:97

Inherited from

LayoutProps.shadowOffset

shadowOffsetX?

optional shadowOffsetX?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:95

Inherited from

LayoutProps.shadowOffsetX

shadowOffsetY?

optional shadowOffsetY?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:96

Inherited from

LayoutProps.shadowOffsetY

shrink?

optional shrink?: SignalValue<number>

Defined in: 2d/src/lib/components/Layout.ts:85

Inherited from

LayoutProps.shrink

size?

optional size?: SignalValue<PossibleVector2<Length>>

Defined in: 2d/src/lib/components/Layout.ts:106

Inherited from

LayoutProps.size

skew?

optional skew?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:87

Inherited from

LayoutProps.skew

skewX?

optional skewX?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:85

Inherited from

LayoutProps.skewX

skewY?

optional skewY?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:86

Inherited from

LayoutProps.skewY

spawner?

optional spawner?: SignalValue<ComponentChildren>

Defined in: 2d/src/lib/components/Node.ts:75

Deprecated

Use children instead.

Inherited from

LayoutProps.spawner

stroke?

optional stroke?: SignalValue<PossibleCanvasStyle>

Defined in: 2d/src/lib/components/Shape.ts:19

strokeFirst?

optional strokeFirst?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Shape.ts:20

tagName?

optional tagName?: keyof HTMLElementTagNameMap

Defined in: 2d/src/lib/components/Layout.ts:60

Inherited from

LayoutProps.tagName

textAlign?

optional textAlign?: SignalValue<CanvasTextAlign>

Defined in: 2d/src/lib/components/Layout.ts:104

Inherited from

LayoutProps.textAlign

textDirection?

optional textDirection?: SignalValue<CanvasDirection>

Defined in: 2d/src/lib/components/Layout.ts:103

Inherited from

LayoutProps.textDirection

textWrap?

optional textWrap?: SignalValue<TextWrap>

Defined in: 2d/src/lib/components/Layout.ts:102

Inherited from

LayoutProps.textWrap

top?

optional top?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:129

The position of the top edge of this node.

Remarks

This shortcut property will set the node’s position so that the top edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.top

topLeft?

optional topLeft?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:165

The position of the top left corner of this node.

Remarks

This shortcut property will set the node’s position so that the top left corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from

LayoutProps.topLeft

topRight?

optional topRight?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Layout.ts:174

The position of the top right corner of this node.

Remarks

This shortcut property will set the node’s position so that the top right corner ends up in the given place. If present, overrides the NodeProps.position property.