Skip to main content

ShapeProps

interface ShapeProps extends LayoutProps

Extended by

  • CodeProps
  • CurveProps
  • GridProps
  • SVGProps
  • TxtProps

Properties​

alignContent​

Inherited from LayoutProps.alignContent

alignItems​

Inherited from LayoutProps.alignItems

alignSelf​

Inherited from LayoutProps.alignSelf

anchor​

Inherited from LayoutProps.anchor

anchorX​

Inherited from LayoutProps.anchorX

anchorY​

Inherited from LayoutProps.anchorY

antialiased​


basis​

basis?: SignalValueFlexBasis
Inherited from LayoutProps.basis

bottom​

The position of the bottom edge of this node.

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​

The position of the bottom left corner of this node.

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​

The position of the bottom right corner of this node.

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

bowing​

Controls the curve deviation from a straight line.

A value of 0 will cause lines to be perfectly straight. Higher values introduce more curvature.


cache​

Inherited from LayoutProps.cache

cachePadding​

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

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​

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

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

cachePaddingLeft​

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

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

cachePaddingRight​

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

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

cachePaddingTop​

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

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

children​

children?: SignalValueComponentChildren
Inherited from LayoutProps.children

clip​

clip?: SignalValueboolean
Inherited from LayoutProps.clip

columnGap​

Inherited from LayoutProps.columnGap

composite​

Inherited from LayoutProps.composite

compositeOperation​

compositeOperation?: SignalValueGlobalCompositeOperation
Inherited from LayoutProps.compositeOperation

direction​

direction?: SignalValueFlexDirection
Inherited from LayoutProps.direction

fill​

fill?: SignalValuePossibleCanvasStyle

fillShaders​

fillShaders?: PossibleShaderConfig

filters​

Inherited from LayoutProps.filters

fontFamily​

Inherited from LayoutProps.fontFamily

fontSize​

Inherited from LayoutProps.fontSize

fontStyle​

Inherited from LayoutProps.fontStyle

fontWeight​

Inherited from LayoutProps.fontWeight

gap​

Inherited from LayoutProps.gap

grow​

Inherited from LayoutProps.grow

height​

Inherited from LayoutProps.height

justifyContent​

Inherited from LayoutProps.justifyContent

key​

key?: string
Inherited from LayoutProps.key

layout​

layout?: LayoutMode
Inherited from LayoutProps.layout

layoutChildren​

layoutChildren?: LayoutMode

Whether this node lays out its own children with flex. When null (the default), falls back to layout.

Inherited from LayoutProps.layoutChildren

layoutSelf​

layoutSelf?: LayoutMode

Whether this node participates in its parent's flex layout. When null (the default), falls back to layout.

Inherited from LayoutProps.layoutSelf

left​

The position of the left edge of this node.

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​

Inherited from LayoutProps.letterSpacing

lineCap​

lineCap?: SignalValueCanvasLineCap

lineDash​


lineDashOffset​


lineHeight​

Inherited from LayoutProps.lineHeight

lineJoin​

lineJoin?: SignalValueCanvasLineJoin

lineWidth​


margin​

Inherited from LayoutProps.margin

marginBottom​

Inherited from LayoutProps.marginBottom

marginLeft​

Inherited from LayoutProps.marginLeft

marginRight​

Inherited from LayoutProps.marginRight

marginTop​

Inherited from LayoutProps.marginTop

maxHeight​

maxHeight?: SignalValueLengthLimit
Inherited from LayoutProps.maxHeight

maxWidth​

maxWidth?: SignalValueLengthLimit
Inherited from LayoutProps.maxWidth

middle​

The position of the center of this node.

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 anchor is not set, this will be the same as the NodeProps.position.

Inherited from LayoutProps.middle

minHeight​

minHeight?: SignalValueLengthLimit
Inherited from LayoutProps.minHeight

minWidth​

minWidth?: SignalValueLengthLimit
Inherited from LayoutProps.minWidth

opacity​

Inherited from LayoutProps.opacity

padding​

Inherited from LayoutProps.padding

paddingBottom​

Inherited from LayoutProps.paddingBottom

paddingLeft​

Inherited from LayoutProps.paddingLeft

paddingRight​

Inherited from LayoutProps.paddingRight

paddingTop​

Inherited from LayoutProps.paddingTop

position​

Inherited from LayoutProps.position

ratio​

Inherited from LayoutProps.ratio

ref​

Inherited from LayoutProps.ref

The position of the right edge of this node.

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​

Inherited from LayoutProps.rotation

rough​

Enable rough.js rendering.


roughDisableMultiStroke​

Whether to disable multi-stroke rendering.

By default, Rough.js renders strokes with multiple lines for a more sketchy appearance. Set to true to use a single stroke.


roughDisableMultiStrokeFill​

Whether to disable multi-stroke fill.

By default, Rough.js renders fills with multiple passes. Set to true to use a single fill pass.


roughFillStyle​

roughFillStyle?: SignalValueRoughFillStyle

Fill style for the shape.


roughFillWeight​

Thickness of the lines used for filling.

Only applicable for hachure, cross-hatch, and similar fill styles.


roughHachureAngle​

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.


roughHachureGap​

Gap between hachure lines in pixels.

Only applicable for hachure, cross-hatch, and similar fill styles.


roughness​

Numerical value indicating how rough the drawing is.

A value of 0 will produce a smooth shape, while higher values introduce more irregularity. Typical range is 0-10.


roughSeed​

Seed for the random number generator.

Using the same seed produces consistent results, which is useful for reproducible animations.


rowGap​

Inherited from LayoutProps.rowGap

scale​

Inherited from LayoutProps.scale

scaleX​

Inherited from LayoutProps.scaleX

scaleY​

Inherited from LayoutProps.scaleY

shaders​

shaders?: PossibleShaderConfig
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from LayoutProps.shaders

shadowBlur​

Inherited from LayoutProps.shadowBlur

shadowColor​

Inherited from LayoutProps.shadowColor

shadowOffset​

Inherited from LayoutProps.shadowOffset

shadowOffsetX​

Inherited from LayoutProps.shadowOffsetX

shadowOffsetY​

Inherited from LayoutProps.shadowOffsetY

shrink​

Inherited from LayoutProps.shrink

size​

Inherited from LayoutProps.size

skew​

Inherited from LayoutProps.skew

skewX​

Inherited from LayoutProps.skewX

skewY​

Inherited from LayoutProps.skewY

spawner​

spawner?: SignalValueComponentChildren

Deprecated

Use children instead.

Inherited from LayoutProps.spawner

stroke​

stroke?: SignalValuePossibleCanvasStyle

strokeFirst​


strokeShaders​

strokeShaders?: PossibleShaderConfig

textAlign​

Inherited from LayoutProps.textAlign

textDirection​

textDirection?: SignalValueCanvasDirection
Inherited from LayoutProps.textDirection

textWrap​

Inherited from LayoutProps.textWrap

top​

The position of the top edge of this node.

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​

The position of the top left corner of this node.

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​

The position of the top right corner of this node.

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.

Inherited from LayoutProps.topRight

translate​

Inherited from LayoutProps.translate

translateX​

Inherited from LayoutProps.translateX

translateY​

Inherited from LayoutProps.translateY

verticalAlign​

verticalAlign?: SignalValueVerticalAlign
Inherited from LayoutProps.verticalAlign

width​

Inherited from LayoutProps.width

wordBreak​

Inherited from LayoutProps.wordBreak

wrap​

wrap?: SignalValueFlexWrap
Inherited from LayoutProps.wrap

x​

x?: SignalValuenumber
Inherited from LayoutProps.x

y​

y?: SignalValuenumber
Inherited from LayoutProps.y

zIndex​

Inherited from LayoutProps.zIndex