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

ShapeProps.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

ShapeProps.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

ShapeProps.bottomRight

cache?

optional cache?: SignalValue<boolean>

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

Inherited from

ShapeProps.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

ShapeProps.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

ShapeProps.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

ShapeProps.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

ShapeProps.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

ShapeProps.cachePaddingTop

children?

optional children?: SignalValue<ComponentChildren>

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

Inherited from

ShapeProps.children

clip?

optional clip?: SignalValue<boolean>

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

Inherited from

ShapeProps.clip

closed?

optional closed?: SignalValue<boolean>

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

Whether the curve should be closed.

Remarks

Closed curves have their start and end points connected.

columnGap?

optional columnGap?: SignalValue<Length>

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

Inherited from

ShapeProps.columnGap

composite?

optional composite?: SignalValue<boolean>

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

Inherited from

ShapeProps.composite

compositeOperation?

optional compositeOperation?: SignalValue<GlobalCompositeOperation>

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

Inherited from

ShapeProps.compositeOperation

direction?

optional direction?: SignalValue<FlexDirection>

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

Inherited from

ShapeProps.direction

end?

optional end?: SignalValue<number>

Defined in: 2d/src/lib/components/Curve.ts:38

A percentage from the start after which the curve should be clipped.

Remarks

The portion of the curve that comes after the given percentage will be made invisible.

This property is usefully for animating the curve appearing on the screen. The value of 0 means the very start of the curve (accounting for the startOffset) while 1 means the very end (accounting for the endOffset).

endArrow?

optional endArrow?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Curve.ts:46

Whether to display an arrow at the end of the visible curve.

Remarks

Use arrowSize to control the size of the arrow.

endOffset?

optional endOffset?: SignalValue<number>

Defined in: 2d/src/lib/components/Curve.ts:42

The offset in pixels from the end of the curve.

Remarks

This property lets you specify where along the defined curve the actual visible portion ends. For example, setting it to 20 will make the last 20 pixels of the curve invisible.

This property is useful for trimming the curve using a fixed distance. If you want to animate the curve appearing on the screen, use end instead.

fill?

optional fill?: SignalValue<PossibleCanvasStyle>

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

Inherited from

ShapeProps.fill

filters?

optional filters?: SignalValue<Filter[]>

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

Inherited from

ShapeProps.filters

fontFamily?

optional fontFamily?: SignalValue<string>

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

Inherited from

ShapeProps.fontFamily

fontSize?

optional fontSize?: SignalValue<number>

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

Inherited from

ShapeProps.fontSize

fontStyle?

optional fontStyle?: SignalValue<string>

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

Inherited from

ShapeProps.fontStyle

fontWeight?

optional fontWeight?: SignalValue<number>

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

Inherited from

ShapeProps.fontWeight

gap?

optional gap?: SignalValue<Length>

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

Inherited from

ShapeProps.gap

grow?

optional grow?: SignalValue<number>

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

Inherited from

ShapeProps.grow

height?

optional height?: SignalValue<Length>

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

Inherited from

ShapeProps.height

justifyContent?

optional justifyContent?: SignalValue<FlexContent>

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

Inherited from

ShapeProps.justifyContent

key?

optional key?: string

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

Inherited from

ShapeProps.key

layout?

optional layout?: LayoutMode

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

Inherited from

ShapeProps.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

ShapeProps.left

letterSpacing?

optional letterSpacing?: SignalValue<number>

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

Inherited from

ShapeProps.letterSpacing

lineCap?

optional lineCap?: SignalValue<CanvasLineCap>

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

Inherited from

ShapeProps.lineCap

lineDash?

optional lineDash?: SignalValue<number[]>

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

Inherited from

ShapeProps.lineDash

lineDashOffset?

optional lineDashOffset?: SignalValue<number>

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

Inherited from

ShapeProps.lineDashOffset

lineHeight?

optional lineHeight?: SignalValue<Length>

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

Inherited from

ShapeProps.lineHeight

lineJoin?

optional lineJoin?: SignalValue<CanvasLineJoin>

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

Inherited from

ShapeProps.lineJoin

lineWidth?

optional lineWidth?: SignalValue<number>

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

Inherited from

ShapeProps.lineWidth

margin?

optional margin?: SignalValue<PossibleSpacing>

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

Inherited from

ShapeProps.margin

marginBottom?

optional marginBottom?: SignalValue<number>

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

Inherited from

ShapeProps.marginBottom

marginLeft?

optional marginLeft?: SignalValue<number>

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

Inherited from

ShapeProps.marginLeft

marginRight?

optional marginRight?: SignalValue<number>

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

Inherited from

ShapeProps.marginRight

marginTop?

optional marginTop?: SignalValue<number>

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

Inherited from

ShapeProps.marginTop

maxHeight?

optional maxHeight?: SignalValue<LengthLimit>

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

Inherited from

ShapeProps.maxHeight

maxWidth?

optional maxWidth?: SignalValue<LengthLimit>

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

Inherited from

ShapeProps.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

ShapeProps.middle

minHeight?

optional minHeight?: SignalValue<LengthLimit>

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

Inherited from

ShapeProps.minHeight

minWidth?

optional minWidth?: SignalValue<LengthLimit>

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

Inherited from

ShapeProps.minWidth

offset?

optional offset?: SignalValue<PossibleVector2>

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

Inherited from

ShapeProps.offset

offsetX?

optional offsetX?: SignalValue<number>

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

Inherited from

ShapeProps.offsetX

offsetY?

optional offsetY?: SignalValue<number>

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

Inherited from

ShapeProps.offsetY

opacity?

optional opacity?: SignalValue<number>

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

Inherited from

ShapeProps.opacity

padding?

optional padding?: SignalValue<PossibleSpacing>

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

Inherited from

ShapeProps.padding

paddingBottom?

optional paddingBottom?: SignalValue<number>

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

Inherited from

ShapeProps.paddingBottom

paddingLeft?

optional paddingLeft?: SignalValue<number>

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

Inherited from

ShapeProps.paddingLeft

paddingRight?

optional paddingRight?: SignalValue<number>

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

Inherited from

ShapeProps.paddingRight

paddingTop?

optional paddingTop?: SignalValue<number>

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

Inherited from

ShapeProps.paddingTop

position?

optional position?: SignalValue<PossibleVector2>

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

Inherited from

ShapeProps.position

ratio?

optional ratio?: SignalValue<number>

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

Inherited from

ShapeProps.ratio

ref?

optional ref?: ReferenceReceiver<any>

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

Inherited from

ShapeProps.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

ShapeProps.right

rotation?

optional rotation?: SignalValue<number>

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

Inherited from

ShapeProps.rotation

rowGap?

optional rowGap?: SignalValue<Length>

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

Inherited from

ShapeProps.rowGap

scale?

optional scale?: SignalValue<PossibleVector2>

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

Inherited from

ShapeProps.scale

scaleX?

optional scaleX?: SignalValue<number>

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

Inherited from

ShapeProps.scaleX

scaleY?

optional scaleY?: SignalValue<number>

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

Inherited from

ShapeProps.scaleY

shaders?

optional shaders?: PossibleShaderConfig

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

Experimental

Inherited from

ShapeProps.shaders

shadowBlur?

optional shadowBlur?: SignalValue<number>

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

Inherited from

ShapeProps.shadowBlur

shadowColor?

optional shadowColor?: SignalValue<PossibleColor>

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

Inherited from

ShapeProps.shadowColor

shadowOffset?

optional shadowOffset?: SignalValue<PossibleVector2>

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

Inherited from

ShapeProps.shadowOffset

shadowOffsetX?

optional shadowOffsetX?: SignalValue<number>

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

Inherited from

ShapeProps.shadowOffsetX

shadowOffsetY?

optional shadowOffsetY?: SignalValue<number>

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

Inherited from

ShapeProps.shadowOffsetY

shrink?

optional shrink?: SignalValue<number>

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

Inherited from

ShapeProps.shrink

size?

optional size?: SignalValue<PossibleVector2<Length>>

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

Inherited from

ShapeProps.size

skew?

optional skew?: SignalValue<PossibleVector2>

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

Inherited from

ShapeProps.skew

skewX?

optional skewX?: SignalValue<number>

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

Inherited from

ShapeProps.skewX

skewY?

optional skewY?: SignalValue<number>

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

Inherited from

ShapeProps.skewY

spawner?

optional spawner?: SignalValue<ComponentChildren>

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

Deprecated

Use children instead.

Inherited from

ShapeProps.spawner

start?

optional start?: SignalValue<number>

Defined in: 2d/src/lib/components/Curve.ts:26

A percentage from the start before which the curve should be clipped.

Remarks

The portion of the curve that comes before the given percentage will be made invisible.

startArrow?

optional startArrow?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Curve.ts:34

Whether to display an arrow at the start of the visible curve.

Remarks

Use arrowSize to control the size of the arrow.

startOffset?

optional startOffset?: SignalValue<number>

Defined in: 2d/src/lib/components/Curve.ts:30

The offset in pixels from the start of the curve.

Remarks

This property lets you specify where along the defined curve the actual visible portion starts. For example, setting it to 20 will make the first 20 pixels of the curve invisible.

This property is useful for trimming the curve using a fixed distance. If you want to animate the curve appearing on the screen, use start instead.

stroke?

optional stroke?: SignalValue<PossibleCanvasStyle>

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

Inherited from

ShapeProps.stroke

strokeFirst?

optional strokeFirst?: SignalValue<boolean>

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

Inherited from

ShapeProps.strokeFirst

tagName?

optional tagName?: keyof HTMLElementTagNameMap

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

Inherited from

ShapeProps.tagName

textAlign?

optional textAlign?: SignalValue<CanvasTextAlign>

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

Inherited from

ShapeProps.textAlign

textDirection?

optional textDirection?: SignalValue<CanvasDirection>

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

Inherited from

ShapeProps.textDirection

textWrap?

optional textWrap?: SignalValue<TextWrap>

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

Inherited from

ShapeProps.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

ShapeProps.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

ShapeProps.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.