Skip to main content

PathProps

                            
                              
                                interface 
                                PathProps
                                extends 
                                
                                  
                                    
                                      CurveProps

Properties ​

alignContent ​ 

                            
                              
                                alignContent
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexContent
Inherited from CurveProps.alignContent

alignItems ​ 

                            
                              
                                alignItems
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexItems
Inherited from CurveProps.alignItems

alignSelf ​ 

                            
                              
                                alignSelf
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexItems
Inherited from CurveProps.alignSelf

antialiased ​ 

                            
                              
                                antialiased
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from CurveProps.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 .

Inherited from CurveProps.arrowSize

basis ​ 

                            
                              
                                basis
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexBasis
Inherited from CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.bottomRight

cache ​ 

                            
                              
                                cache
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.cachePaddingTop

children ​ 

                            
                              
                                children
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      ComponentChildren
Inherited from CurveProps.children

clip ​ 

                            
                              
                                clip
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from CurveProps.clip

closed ​ 

                            
                              
                                closed
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from CurveProps.closed

columnGap ​ 

                            
                              
                                columnGap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from CurveProps.columnGap

composite ​ 

                            
                              
                                composite
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from CurveProps.composite

compositeOperation ​ 

                            
                              
                                compositeOperation
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      GlobalCompositeOperation
Inherited from CurveProps.compositeOperation

data ​ 

                            
                              
                                data
                                : 
                                SignalValue
                                
                                  
                                    
                                      string

direction ​ 

                            
                              
                                direction
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexDirection
Inherited from CurveProps.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 ).

Inherited from CurveProps.end

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.

Inherited from CurveProps.endArrow

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.

Inherited from CurveProps.endOffset

fill ​ 

                            
                              
                                fill
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleCanvasStyle
Inherited from CurveProps.fill

filters ​ 

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

fontFamily ​ 

                            
                              
                                fontFamily
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      string
Inherited from CurveProps.fontFamily

fontSize ​ 

                            
                              
                                fontSize
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.fontSize

fontStyle ​ 

                            
                              
                                fontStyle
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      string
Inherited from CurveProps.fontStyle

fontWeight ​ 

                            
                              
                                fontWeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.fontWeight

gap ​ 

                            
                              
                                gap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from CurveProps.gap

grow ​ 

                            
                              
                                grow
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.grow

height ​ 

                            
                              
                                height
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from CurveProps.height

justifyContent ​ 

                            
                              
                                justifyContent
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexContent
Inherited from CurveProps.justifyContent

key ​ 

                            
                              
                                key
                                ?: 
                                string
Inherited from CurveProps.key

layout ​ 

                            
                              
                                layout
                                ?: 
                                LayoutMode
Inherited from CurveProps.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 CurveProps.left

letterSpacing ​ 

                            
                              
                                letterSpacing
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.letterSpacing

lineCap ​ 

                            
                              
                                lineCap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasLineCap
Inherited from CurveProps.lineCap

lineDash ​ 

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

lineDashOffset ​ 

                            
                              
                                lineDashOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.lineDashOffset

lineHeight ​ 

                            
                              
                                lineHeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from CurveProps.lineHeight

lineJoin ​ 

                            
                              
                                lineJoin
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasLineJoin
Inherited from CurveProps.lineJoin

lineWidth ​ 

                            
                              
                                lineWidth
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.lineWidth

margin ​ 

                            
                              
                                margin
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleSpacing
Inherited from CurveProps.margin

marginBottom ​ 

                            
                              
                                marginBottom
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.marginBottom

marginLeft ​ 

                            
                              
                                marginLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.marginLeft

marginRight ​ 

                            
                              
                                marginRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.marginRight

marginTop ​ 

                            
                              
                                marginTop
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.marginTop

maxHeight ​ 

                            
                              
                                maxHeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from CurveProps.maxHeight

maxWidth ​ 

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

minHeight ​ 

                            
                              
                                minHeight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from CurveProps.minHeight

minWidth ​ 

                            
                              
                                minWidth
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      LengthLimit
Inherited from CurveProps.minWidth

offset ​ 

                            
                              
                                offset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from CurveProps.offset

offsetX ​ 

                            
                              
                                offsetX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.offsetX

offsetY ​ 

                            
                              
                                offsetY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.offsetY

opacity ​ 

                            
                              
                                opacity
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.opacity

padding ​ 

                            
                              
                                padding
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleSpacing
Inherited from CurveProps.padding

paddingBottom ​ 

                            
                              
                                paddingBottom
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.paddingBottom

paddingLeft ​ 

                            
                              
                                paddingLeft
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.paddingLeft

paddingRight ​ 

                            
                              
                                paddingRight
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.paddingRight

paddingTop ​ 

                            
                              
                                paddingTop
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.paddingTop

position ​ 

                            
                              
                                position
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from CurveProps.position

ratio ​ 

                            
                              
                                ratio
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.ratio

ref ​ 

                            
                              
                                ref
                                ?: 
                                ReferenceReceiver
                                
                                  
                                    
                                      any
Inherited from CurveProps.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 CurveProps.right

rotation ​ 

                            
                              
                                rotation
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.rotation

rowGap ​ 

                            
                              
                                rowGap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from CurveProps.rowGap

scale ​ 

                            
                              
                                scale
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from CurveProps.scale

scaleX ​ 

                            
                              
                                scaleX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.scaleX

scaleY ​ 

                            
                              
                                scaleY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
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 ​ 

                            
                              
                                shadowBlur
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.shadowBlur

shadowColor ​ 

                            
                              
                                shadowColor
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleColor
Inherited from CurveProps.shadowColor

shadowOffset ​ 

                            
                              
                                shadowOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from CurveProps.shadowOffset

shadowOffsetX ​ 

                            
                              
                                shadowOffsetX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.shadowOffsetX

shadowOffsetY ​ 

                            
                              
                                shadowOffsetY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.shadowOffsetY

shrink ​ 

                            
                              
                                shrink
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.shrink

size ​ 

                            
                              
                                size
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            Length
Inherited from CurveProps.size

skew ​ 

                            
                              
                                skew
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from CurveProps.skew

skewX ​ 

                            
                              
                                skewX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.skewX

skewY ​ 

                            
                              
                                skewY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.skewY

spawner ​ 

                            
                              
                                spawner
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      ComponentChildren

Deprecated

Use children instead.

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

Inherited from CurveProps.start

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.

Inherited from CurveProps.startArrow

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.

Inherited from CurveProps.startOffset

stroke ​ 

                            
                              
                                stroke
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleCanvasStyle
Inherited from CurveProps.stroke

strokeFirst ​ 

                            
                              
                                strokeFirst
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from CurveProps.strokeFirst

tagName ​ 

                            
                              
                                tagName
                                ?: 
                                keyof 
                                HTMLElementTagNameMap
Inherited from CurveProps.tagName

textAlign ​ 

                            
                              
                                textAlign
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasTextAlign
Inherited from CurveProps.textAlign

textDirection ​ 

                            
                              
                                textDirection
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      CanvasDirection
Inherited from CurveProps.textDirection

textWrap ​ 

                            
                              
                                textWrap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      TextWrap
Inherited from CurveProps.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 CurveProps.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 CurveProps.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 CurveProps.topRight

width ​ 

                            
                              
                                width
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      Length
Inherited from CurveProps.width

wrap ​ 

                            
                              
                                wrap
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      FlexWrap
Inherited from CurveProps.wrap

x ​ 

                            
                              
                                x
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.x

y ​ 

                            
                              
                                y
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.y

zIndex ​ 

                            
                              
                                zIndex
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from CurveProps.zIndex