Skip to main content

RectProps

interface RectProps extends CurveProps

Extended by

  • ImgProps
  • VideoProps
  • View2DProps

Properties​

alignContent​

Inherited from CurveProps.alignContent

alignItems​

Inherited from CurveProps.alignItems

alignSelf​

Inherited from CurveProps.alignSelf

anchor​

Inherited from CurveProps.anchor

anchorX​

Inherited from CurveProps.anchorX

anchorY​

Inherited from CurveProps.anchorY

antialiased​

Inherited from CurveProps.antialiased

arrowSize​

Controls the size of the end and start arrows.

To make the arrows visible make sure to enable startArrow and/or endArrow.

Inherited from CurveProps.arrowSize

basis​

basis?: SignalValueFlexBasis
Inherited from CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.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.

Inherited from CurveProps.bowing

cache​

Inherited from CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.cachePaddingTop

children​

children?: SignalValueComponentChildren
Inherited from CurveProps.children

clip​

clip?: SignalValueboolean
Inherited from CurveProps.clip

closed​

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from CurveProps.closed

columnGap​

Inherited from CurveProps.columnGap

composite​

Inherited from CurveProps.composite

compositeOperation​

compositeOperation?: SignalValueGlobalCompositeOperation
Inherited from CurveProps.compositeOperation

cornerSharpness​

Controls the sharpness of smoothCorners.

This property only affects the way rounded corners are drawn. To control the corner radius use the radius property.

Requires smoothCorners to be enabled to have any effect. By default, corner sharpness is set to 0.6 which represents a smooth, circle-like rounding. At 0 the edges are squared off.


direction​

direction?: SignalValueFlexDirection
Inherited from CurveProps.direction

end​

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

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

Inherited from CurveProps.end

endArrow​

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

Use arrowSize to control the size of the arrow.

Inherited from CurveProps.endArrow

endOffset​

The offset in pixels from the end of the curve.

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.

Inherited from CurveProps.endOffset

fill​

fill?: SignalValuePossibleCanvasStyle
Inherited from CurveProps.fill

fillShaders​

fillShaders?: PossibleShaderConfig
Inherited from CurveProps.fillShaders

filters​

Inherited from CurveProps.filters

fontFamily​

Inherited from CurveProps.fontFamily

fontSize​

Inherited from CurveProps.fontSize

fontStyle​

Inherited from CurveProps.fontStyle

fontWeight​

Inherited from CurveProps.fontWeight

gap​

Inherited from CurveProps.gap

grow​

Inherited from CurveProps.grow

height​

Inherited from CurveProps.height

justifyContent​

Inherited from CurveProps.justifyContent

key​

key?: string
Inherited from CurveProps.key

layout​

layout?: LayoutMode
Inherited from CurveProps.layout

layoutChildren​

layoutChildren?: LayoutMode

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

Inherited from CurveProps.layoutChildren

layoutSelf​

layoutSelf?: LayoutMode

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

Inherited from CurveProps.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 CurveProps.left

letterSpacing​

Inherited from CurveProps.letterSpacing

lineCap​

lineCap?: SignalValueCanvasLineCap
Inherited from CurveProps.lineCap

lineDash​

Inherited from CurveProps.lineDash

lineDashOffset​

Inherited from CurveProps.lineDashOffset

lineHeight​

Inherited from CurveProps.lineHeight

lineJoin​

lineJoin?: SignalValueCanvasLineJoin
Inherited from CurveProps.lineJoin

lineWidth​

Inherited from CurveProps.lineWidth

margin​

Inherited from CurveProps.margin

marginBottom​

Inherited from CurveProps.marginBottom

marginLeft​

Inherited from CurveProps.marginLeft

marginRight​

Inherited from CurveProps.marginRight

marginTop​

Inherited from CurveProps.marginTop

maxHeight​

maxHeight?: SignalValueLengthLimit
Inherited from CurveProps.maxHeight

maxWidth​

maxWidth?: SignalValueLengthLimit
Inherited from CurveProps.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 CurveProps.middle

minHeight​

minHeight?: SignalValueLengthLimit
Inherited from CurveProps.minHeight

minWidth​

minWidth?: SignalValueLengthLimit
Inherited from CurveProps.minWidth

opacity​

Inherited from CurveProps.opacity

padding​

Inherited from CurveProps.padding

paddingBottom​

Inherited from CurveProps.paddingBottom

paddingLeft​

Inherited from CurveProps.paddingLeft

paddingRight​

Inherited from CurveProps.paddingRight

paddingTop​

Inherited from CurveProps.paddingTop

position​

Inherited from CurveProps.position

radius​

Rounds the corners of this rectangle.

The value represents the radius of the quarter circle that is used to round the corners. If the value is a number, the same radius is used for all corners. Passing an array of two to four numbers will set individual radii for each corner. Individual radii correspond to different corners depending on the number of values passed:

// top-left-and-bottom-right | top-right-and-bottom-left
[10, 30]
// top-left | top-right-and-bottom-left | bottom-right
[10, 20, 30]
// top-left | top-right | bottom-right | bottom-left
[10, 20, 30, 40]

ratio​

Inherited from CurveProps.ratio

ref​

Inherited from CurveProps.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 CurveProps.right

rotation​

Inherited from CurveProps.rotation

rough​

Enable rough.js rendering.

Inherited from CurveProps.rough

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.

Inherited from CurveProps.roughDisableMultiStroke

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.

Inherited from CurveProps.roughDisableMultiStrokeFill

roughFillStyle​

roughFillStyle?: SignalValueRoughFillStyle

Fill style for the shape.

Inherited from CurveProps.roughFillStyle

roughFillWeight​

Thickness of the lines used for filling.

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

Inherited from CurveProps.roughFillWeight

roughHachureAngle​

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Inherited from CurveProps.roughHachureAngle

roughHachureGap​

Gap between hachure lines in pixels.

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

Inherited from CurveProps.roughHachureGap

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.

Inherited from CurveProps.roughness

roughSeed​

Seed for the random number generator.

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

Inherited from CurveProps.roughSeed

rowGap​

Inherited from CurveProps.rowGap

scale​

Inherited from CurveProps.scale

scaleX​

Inherited from CurveProps.scaleX

scaleY​

Inherited from CurveProps.scaleY

shaders​

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

shadowBlur​

Inherited from CurveProps.shadowBlur

shadowColor​

Inherited from CurveProps.shadowColor

shadowOffset​

Inherited from CurveProps.shadowOffset

shadowOffsetX​

Inherited from CurveProps.shadowOffsetX

shadowOffsetY​

Inherited from CurveProps.shadowOffsetY

shrink​

Inherited from CurveProps.shrink

size​

Inherited from CurveProps.size

skew​

Inherited from CurveProps.skew

skewX​

Inherited from CurveProps.skewX

skewY​

Inherited from CurveProps.skewY

smoothCorners​

Enables corner smoothing.

This property only affects the way rounded corners are drawn. To control the corner radius use the radius property.

When enabled, rounded corners are drawn continuously using Bézier curves rather than quarter circles. The sharpness of the curve can be controlled with cornerSharpness.

You can read more about corner smoothing in this article by Nick Lawrence.


spawner​

spawner?: SignalValueComponentChildren

Deprecated

Use children instead.

Inherited from CurveProps.spawner

start​

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

The portion of the curve that comes before 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).

Inherited from CurveProps.start

startArrow​

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

Use arrowSize to control the size of the arrow.

Inherited from CurveProps.startArrow

startOffset​

The offset in pixels from the start of the curve.

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.

Inherited from CurveProps.startOffset

stroke​

stroke?: SignalValuePossibleCanvasStyle
Inherited from CurveProps.stroke

strokeFirst​

Inherited from CurveProps.strokeFirst

strokeShaders​

strokeShaders?: PossibleShaderConfig
Inherited from CurveProps.strokeShaders

textAlign​

Inherited from CurveProps.textAlign

textDirection​

textDirection?: SignalValueCanvasDirection
Inherited from CurveProps.textDirection

textWrap​

Inherited from CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.topRight

translate​

Inherited from CurveProps.translate

translateX​

Inherited from CurveProps.translateX

translateY​

Inherited from CurveProps.translateY

verticalAlign​

verticalAlign?: SignalValueVerticalAlign
Inherited from CurveProps.verticalAlign

width​

Inherited from CurveProps.width

wordBreak​

Inherited from CurveProps.wordBreak

wrap​

wrap?: SignalValueFlexWrap
Inherited from CurveProps.wrap

x​

x?: SignalValuenumber
Inherited from CurveProps.x

y​

y?: SignalValuenumber
Inherited from CurveProps.y

zIndex​

Inherited from CurveProps.zIndex