Skip to main content

KnotProps

interface KnotProps extends NodeProps

Properties​

auto​

auto?: SignalValuePossibleKnotAuto

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

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

cache​

cache?: SignalValueboolean
Inherited from NodeProps.cache

cachePadding​

cachePadding?: SignalValuePossibleSpacing

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

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

Inherited from NodeProps.cachePadding

cachePaddingBottom​

cachePaddingBottom?: SignalValuenumber

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

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

Inherited from NodeProps.cachePaddingBottom

cachePaddingLeft​

cachePaddingLeft?: SignalValuenumber

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

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

Inherited from NodeProps.cachePaddingLeft

cachePaddingRight​

cachePaddingRight?: SignalValuenumber

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

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

Inherited from NodeProps.cachePaddingRight

cachePaddingTop​

cachePaddingTop?: SignalValuenumber

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

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

Inherited from NodeProps.cachePaddingTop

children​

children?: SignalValueComponentChildren
Inherited from NodeProps.children

composite​

composite?: SignalValueboolean
Inherited from NodeProps.composite

compositeOperation​

compositeOperation?: SignalValueGlobalCompositeOperation
Inherited from NodeProps.compositeOperation

endHandle​

endHandle?: SignalValuePossibleVector2number

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

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

If neither an end handle nor a start handle is provided, the positions of the handles gets calculated automatically to create smooth curve through the 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 the auto-calculated position by using the auto property.

endHandleAuto​

endHandleAuto?: SignalValuenumber

filters​

filters?: SignalValueFilter[]
Inherited from NodeProps.filters

key​

key?: string
Inherited from NodeProps.key

opacity​

opacity?: SignalValuenumber
Inherited from NodeProps.opacity

position​

position?: SignalValuePossibleVector2number
Inherited from NodeProps.position

ref​

ref?: ReferenceReceiverany
Inherited from NodeProps.ref

rotation​

rotation?: SignalValuenumber
Inherited from NodeProps.rotation

scale​

scale?: SignalValuePossibleVector2number
Inherited from NodeProps.scale

scaleX​

scaleX?: SignalValuenumber
Inherited from NodeProps.scaleX

scaleY​

scaleY?: SignalValuenumber
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?: SignalValuenumber
Inherited from NodeProps.shadowBlur

shadowColor​

shadowColor?: SignalValuePossibleColor
Inherited from NodeProps.shadowColor

shadowOffset​

shadowOffset?: SignalValuePossibleVector2number
Inherited from NodeProps.shadowOffset

shadowOffsetX​

shadowOffsetX?: SignalValuenumber
Inherited from NodeProps.shadowOffsetX

shadowOffsetY​

shadowOffsetY?: SignalValuenumber
Inherited from NodeProps.shadowOffsetY

skew​

skew?: SignalValuePossibleVector2number
Inherited from NodeProps.skew

skewX​

skewX?: SignalValuenumber
Inherited from NodeProps.skewX

skewY​

skewY?: SignalValuenumber
Inherited from NodeProps.skewY

spawner​

spawner?: SignalValueComponentChildren

Deprecated

Use children instead.

Inherited from NodeProps.spawner

startHandle​

startHandle?: SignalValuePossibleVector2number

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

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

If neither an end handle nor a start handle is provided, the positions of the handles gets calculated automatically to create smooth curve through the 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 the auto-calculated position by using the auto property.

startHandleAuto​

startHandleAuto?: SignalValuenumber

x​

x?: SignalValuenumber
Inherited from NodeProps.x

y​

y?: SignalValuenumber
Inherited from NodeProps.y

zIndex​

zIndex?: SignalValuenumber
Inherited from NodeProps.zIndex