Skip to main content

CurveProps

                            
                              
                                interface 
                                CurveProps
                                extends 
                                
                                  
                                    
                                      ShapeProps

Extended by

  • CircleProps
  • CubicBezierProps
  • LineProps
  • PathProps
  • QuadBezierProps
  • RayProps
  • RectProps
  • SplineProps

Properties ​

alignContent ​ 

                            
                              
                                alignContent
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexContent
Inherited from ShapeProps.alignContent

alignItems ​ 

                            
                              
                                alignItems
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexItems
Inherited from ShapeProps.alignItems

alignSelf ​ 

                            
                              
                                alignSelf
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexItems
Inherited from ShapeProps.alignSelf

antialiased ​ 

                            
                              
                                antialiased
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from ShapeProps.antialiased

arrowSize ​ 

                            
                              
                                arrowSize
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

Controls the size of the end and start arrows.

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

basis ​ 

                            
                              
                                basis
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexBasis
Inherited from ShapeProps.basis

bottom ​ 

                            
                              
                                bottom
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the bottom edge of this node.

This shortcut property will set the node's position so that the bottom edgeends up in the given place.If present, overrides the position property.

Inherited from ShapeProps.bottom

bottomLeft ​ 

                            
                              
                                bottomLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the bottom left corner of this node.

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

Inherited from ShapeProps.bottomLeft

bottomRight ​ 

                            
                              
                                bottomRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the bottom right corner of this node.

This shortcut property will set the node's position so that the bottomright corner ends up in the given place.If present, overrides the position property.

Inherited from ShapeProps.bottomRight

cache ​ 

                            
                              
                                cache
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from ShapeProps.cache

cachePadding ​ 

                            
                              
                                cachePadding
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleSpacing

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

By default, the size of the cache is determined based on the bounding boxof the node and its children. That includes effects such as stroke orshadow. 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 ​ 

                            
                              
                                cachePaddingBottom
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

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

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

Inherited from ShapeProps.cachePaddingBottom

cachePaddingLeft ​ 

                            
                              
                                cachePaddingLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

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

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

Inherited from ShapeProps.cachePaddingLeft

cachePaddingRight ​ 

                            
                              
                                cachePaddingRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

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

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

Inherited from ShapeProps.cachePaddingRight

cachePaddingTop ​ 

                            
                              
                                cachePaddingTop
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

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

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

Inherited from ShapeProps.cachePaddingTop

children ​ 

                            
                              
                                children
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      ComponentChildren
Inherited from ShapeProps.children

clip ​ 

                            
                              
                                clip
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from ShapeProps.clip

closed ​ 

                            
                              
                                closed
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean

Whether the curve should be closed.

Closed curves have their start and end points connected.

columnGap ​ 

                            
                              
                                columnGap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from ShapeProps.columnGap

composite ​ 

                            
                              
                                composite
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from ShapeProps.composite

compositeOperation ​ 

                            
                              
                                compositeOperation
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      GlobalCompositeOperation
Inherited from ShapeProps.compositeOperation

direction ​ 

                            
                              
                                direction
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexDirection
Inherited from ShapeProps.direction

end ​ 

                            
                              
                                end
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

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

The portion of the curve that comes after the given percentage will bemade 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 ​ 

                            
                              
                                endArrow
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean

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

Use arrowSize to control the size of the arrow.

endOffset ​ 

                            
                              
                                endOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

The offset in pixels from the end of the curve.

This property lets you specify where along the defined curve the actualvisible portion ends. For example, setting it to 20 will make the last20 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 ​ 

                            
                              
                                fill
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleCanvasStyle
Inherited from ShapeProps.fill

filters ​ 

                            
                              
                                filters
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Filter
                                      []
Inherited from ShapeProps.filters

fontFamily ​ 

                            
                              
                                fontFamily
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      string
Inherited from ShapeProps.fontFamily

fontSize ​ 

                            
                              
                                fontSize
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.fontSize

fontStyle ​ 

                            
                              
                                fontStyle
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      string
Inherited from ShapeProps.fontStyle

fontWeight ​ 

                            
                              
                                fontWeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.fontWeight

gap ​ 

                            
                              
                                gap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from ShapeProps.gap

grow ​ 

                            
                              
                                grow
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.grow

height ​ 

                            
                              
                                height
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from ShapeProps.height

justifyContent ​ 

                            
                              
                                justifyContent
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexContent
Inherited from ShapeProps.justifyContent

key ​ 

                            
                              
                                key
                                ?: 
                                string
Inherited from ShapeProps.key

layout ​ 

                            
                              
                                layout
                                ?: 
                                LayoutMode
Inherited from ShapeProps.layout

left ​ 

                            
                              
                                left
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the left edge of this node.

This shortcut property will set the node's position so that the left edgeends up in the given place.If present, overrides the position property.

Inherited from ShapeProps.left

letterSpacing ​ 

                            
                              
                                letterSpacing
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.letterSpacing

lineCap ​ 

                            
                              
                                lineCap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasLineCap
Inherited from ShapeProps.lineCap

lineDash ​ 

                            
                              
                                lineDash
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
                                      []
Inherited from ShapeProps.lineDash

lineDashOffset ​ 

                            
                              
                                lineDashOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.lineDashOffset

lineHeight ​ 

                            
                              
                                lineHeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from ShapeProps.lineHeight

lineJoin ​ 

                            
                              
                                lineJoin
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasLineJoin
Inherited from ShapeProps.lineJoin

lineWidth ​ 

                            
                              
                                lineWidth
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.lineWidth

margin ​ 

                            
                              
                                margin
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleSpacing
Inherited from ShapeProps.margin

marginBottom ​ 

                            
                              
                                marginBottom
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.marginBottom

marginLeft ​ 

                            
                              
                                marginLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.marginLeft

marginRight ​ 

                            
                              
                                marginRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.marginRight

marginTop ​ 

                            
                              
                                marginTop
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.marginTop

maxHeight ​ 

                            
                              
                                maxHeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from ShapeProps.maxHeight

maxWidth ​ 

                            
                              
                                maxWidth
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from ShapeProps.maxWidth

middle ​ 

                            
                              
                                middle
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the center of this node.

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

Inherited from ShapeProps.middle

minHeight ​ 

                            
                              
                                minHeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from ShapeProps.minHeight

minWidth ​ 

                            
                              
                                minWidth
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from ShapeProps.minWidth

offset ​ 

                            
                              
                                offset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from ShapeProps.offset

offsetX ​ 

                            
                              
                                offsetX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.offsetX

offsetY ​ 

                            
                              
                                offsetY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.offsetY

opacity ​ 

                            
                              
                                opacity
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.opacity

padding ​ 

                            
                              
                                padding
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleSpacing
Inherited from ShapeProps.padding

paddingBottom ​ 

                            
                              
                                paddingBottom
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.paddingBottom

paddingLeft ​ 

                            
                              
                                paddingLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.paddingLeft

paddingRight ​ 

                            
                              
                                paddingRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.paddingRight

paddingTop ​ 

                            
                              
                                paddingTop
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.paddingTop

position ​ 

                            
                              
                                position
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from ShapeProps.position

ratio ​ 

                            
                              
                                ratio
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.ratio

ref ​ 

                            
                              
                                ref
                                ?: 
                                ReferenceReceiver
                                
                                  
                                    
                                      any
Inherited from ShapeProps.ref 
                            
                              
                                right
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the right edge of this node.

This shortcut property will set the node's position so that the right edgeends up in the given place.If present, overrides the position property.

Inherited from ShapeProps.right

rotation ​ 

                            
                              
                                rotation
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.rotation

rowGap ​ 

                            
                              
                                rowGap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from ShapeProps.rowGap

scale ​ 

                            
                              
                                scale
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from ShapeProps.scale

scaleX ​ 

                            
                              
                                scaleX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.scaleX

scaleY ​ 

                            
                              
                                scaleY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.scaleY

shaders ​ 

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

shadowBlur ​ 

                            
                              
                                shadowBlur
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.shadowBlur

shadowColor ​ 

                            
                              
                                shadowColor
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleColor
Inherited from ShapeProps.shadowColor

shadowOffset ​ 

                            
                              
                                shadowOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from ShapeProps.shadowOffset

shadowOffsetX ​ 

                            
                              
                                shadowOffsetX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.shadowOffsetX

shadowOffsetY ​ 

                            
                              
                                shadowOffsetY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.shadowOffsetY

shrink ​ 

                            
                              
                                shrink
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.shrink

size ​ 

                            
                              
                                size
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            Length
Inherited from ShapeProps.size

skew ​ 

                            
                              
                                skew
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from ShapeProps.skew

skewX ​ 

                            
                              
                                skewX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.skewX

skewY ​ 

                            
                              
                                skewY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.skewY

spawner ​ 

                            
                              
                                spawner
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      ComponentChildren

Deprecated

Use children instead.

Inherited from ShapeProps.spawner

start ​ 

                            
                              
                                start
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

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

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

startArrow ​ 

                            
                              
                                startArrow
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean

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

Use arrowSize to control the size of the arrow.

startOffset ​ 

                            
                              
                                startOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

The offset in pixels from the start of the curve.

This property lets you specify where along the defined curve the actualvisible portion starts. For example, setting it to 20 will make the first20 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 ​ 

                            
                              
                                stroke
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleCanvasStyle
Inherited from ShapeProps.stroke

strokeFirst ​ 

                            
                              
                                strokeFirst
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from ShapeProps.strokeFirst

tagName ​ 

                            
                              
                                tagName
                                ?: 
                                keyof 
                                HTMLElementTagNameMap
Inherited from ShapeProps.tagName

textAlign ​ 

                            
                              
                                textAlign
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasTextAlign
Inherited from ShapeProps.textAlign

textDirection ​ 

                            
                              
                                textDirection
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasDirection
Inherited from ShapeProps.textDirection

textWrap ​ 

                            
                              
                                textWrap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      TextWrap
Inherited from ShapeProps.textWrap

top ​ 

                            
                              
                                top
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the top edge of this node.

This shortcut property will set the node's position so that the top edgeends up in the given place.If present, overrides the position property.

Inherited from ShapeProps.top

topLeft ​ 

                            
                              
                                topLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the top left corner of this node.

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

Inherited from ShapeProps.topLeft

topRight ​ 

                            
                              
                                topRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the top right corner of this node.

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

Inherited from ShapeProps.topRight

width ​ 

                            
                              
                                width
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from ShapeProps.width

wrap ​ 

                            
                              
                                wrap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexWrap
Inherited from ShapeProps.wrap

x ​ 

                            
                              
                                x
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.x

y ​ 

                            
                              
                                y
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.y

zIndex ​ 

                            
                              
                                zIndex
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from ShapeProps.zIndex