Skip to main content

KnotProps

                            
                              
                                interface 
                                KnotProps
                                extends 
                                
                                  
                                    
                                      NodeProps

Properties ​

auto ​ 

                            
                              
                                auto
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleKnotAuto

How much to blend between the user-provided handles and the auto-calculatedhandles.

This property has no effect if no explicit handles are provided for theknot.

cache ​ 

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

children ​ 

                            
                              
                                children
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      ComponentChildren
Inherited from NodeProps.children

composite ​ 

                            
                              
                                composite
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from NodeProps.composite

compositeOperation ​ 

                            
                              
                                compositeOperation
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      GlobalCompositeOperation
Inherited from NodeProps.compositeOperation

endHandle ​ 

                            
                              
                                endHandle
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the knot's end handle. The position is provided relativeto the knot's position.

By default, the position of the end handle will be the mirrored positionof the startHandle .

If neither an end handle nor a start handle is provided, the positions ofthe handles gets calculated automatically to create smooth curve throughthe knot. The smoothness of the resulting curve can be controlled via the smoothness property.

It is also possible to blend between a user-defined position and theauto-calculated position by using the auto property.

endHandleAuto ​ 

                            
                              
                                endHandleAuto
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

filters ​ 

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

key ​ 

                            
                              
                                key
                                ?: 
                                string
Inherited from NodeProps.key

opacity ​ 

                            
                              
                                opacity
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.opacity

position ​ 

                            
                              
                                position
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from NodeProps.position

ref ​ 

                            
                              
                                ref
                                ?: 
                                ReferenceReceiver
                                
                                  
                                    
                                      any
Inherited from NodeProps.ref

rotation ​ 

                            
                              
                                rotation
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.rotation

scale ​ 

                            
                              
                                scale
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from NodeProps.scale

scaleX ​ 

                            
                              
                                scaleX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.scaleX

scaleY ​ 

                            
                              
                                scaleY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.scaleY

shaders ​ 

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

shadowBlur ​ 

                            
                              
                                shadowBlur
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.shadowBlur

shadowColor ​ 

                            
                              
                                shadowColor
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleColor
Inherited from NodeProps.shadowColor

shadowOffset ​ 

                            
                              
                                shadowOffset
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from NodeProps.shadowOffset

shadowOffsetX ​ 

                            
                              
                                shadowOffsetX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.shadowOffsetX

shadowOffsetY ​ 

                            
                              
                                shadowOffsetY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.shadowOffsetY

skew ​ 

                            
                              
                                skew
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number
Inherited from NodeProps.skew

skewX ​ 

                            
                              
                                skewX
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.skewX

skewY ​ 

                            
                              
                                skewY
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.skewY

spawner ​ 

                            
                              
                                spawner
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      ComponentChildren

Deprecated

Use children instead.

Inherited from NodeProps.spawner

startHandle ​ 

                            
                              
                                startHandle
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      PossibleVector2
                                      
                                        
                                          
                                            number

The position of the knot's start handle. The position is provided relativeto the knot's position.

By default, the position of the start handle will be the mirrored positionof the endHandle .

If neither an end handle nor a start handle is provided, the positions ofthe handles gets calculated automatically to create smooth curve throughthe knot. The smoothness of the resulting curve can be controlled via the smoothness property.

It is also possible to blend between a user-defined position and theauto-calculated position by using the auto property.

startHandleAuto ​ 

                            
                              
                                startHandleAuto
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number

x ​ 

                            
                              
                                x
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.x

y ​ 

                            
                              
                                y
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.y

zIndex ​ 

                            
                              
                                zIndex
                                ?: 
                                SignalValue
                                
                                  
                                    
                                      number
Inherited from NodeProps.zIndex