Skip to main content

Path

class Path extends Curve

Constructors

constructor

public override new Pathprops: PathProps: Path

Parameters

Overwrites Curve.constructor

Properties

absolutePosition

A helper signal for operating on the position in world space.

Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.

If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.

Unlike position, this signal is not compound - it doesn't contain separate signals for the x and y components.

Inherited from Curve.absolutePosition

absoluteRotation

readonly public absoluteRotation: SimpleSignalnumberPath

A helper signal for operating on the rotation in world space.

Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.

If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.

Inherited from Curve.absoluteRotation

absoluteScale

A helper signal for operating on the scale in world space.

Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.

If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.

Unlike scale, this signal is not compound - it doesn't contain separate signals for the x and y components.

Inherited from Curve.absoluteScale

alignContent

Inherited from Curve.alignContent

alignItems

Inherited from Curve.alignItems

alignSelf

Inherited from Curve.alignSelf

antialiased

readonly public antialiased: SimpleSignalbooleanPath
Inherited from Curve.antialiased

arrowSize

readonly public arrowSize: SimpleSignalnumberPath

Controls the size of the end and start arrows.

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

Inherited from Curve.arrowSize

basis

Inherited from Curve.basis

bottom

The position of the bottom edge of this node.

When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.

When retrieved, it will return the position of the bottom edge in the parent space.

Inherited from Curve.bottom

bottomLeft

The position of the bottom left corner of this node.

When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.

When retrieved, it will return the position of the bottom left corner in the parent space.

Inherited from Curve.bottomLeft

bottomRight

The position of the bottom right corner of this node.

When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.

When retrieved, it will return the position of the bottom right corner in the parent space.

Inherited from Curve.bottomRight

cache

readonly public cache: SimpleSignalbooleanPath
Inherited from Curve.cache

children

readonly public children: SimpleSignalNode[]Path
Inherited from Curve.children

clip

readonly public clip: SimpleSignalbooleanPath
Inherited from Curve.clip

closed

readonly public closed: SimpleSignalbooleanPath

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from Curve.closed

composite

readonly public composite: SimpleSignalbooleanPath
Inherited from Curve.composite

compositeOperation

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationPath
Inherited from Curve.compositeOperation

creationStack

readonly public creationStack?: string
Inherited from Curve.creationStack

data

readonly public data: SimpleSignalstringPath

direction

Inherited from Curve.direction

element

Inherited from Curve.element

end

readonly public end: SimpleSignalnumberPath

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

The portion of the curve that comes after the given percentage will be made invisible.

This property is usefully for animating the curve appearing on the screen. The value of 0 means the very start of the curve (accounting for the startOffset) while 1 means the very end (accounting for the endOffset).

Inherited from Curve.end

endArrow

readonly public endArrow: SimpleSignalbooleanPath

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

Use arrowSize to control the size of the arrow.

Inherited from Curve.endArrow

endOffset

readonly public endOffset: SimpleSignalnumberPath

The offset in pixels from the end of the curve.

This property lets you specify where along the defined curve the actual visible portion ends. For example, setting it to 20 will make the last 20 pixels of the curve invisible.

This property is useful for trimming the curve using a fixed distance. If you want to animate the curve appearing on the screen, use end instead.

Inherited from Curve.endOffset

fill

readonly public fill: CanvasStyleSignalPath
Inherited from Curve.fill

filters

readonly public filters: FiltersSignalPath
Inherited from Curve.filters

fontFamily

readonly public fontFamily: SimpleSignalstringPath
Inherited from Curve.fontFamily

fontSize

readonly public fontSize: SimpleSignalnumberPath
Inherited from Curve.fontSize

fontStyle

readonly public fontStyle: SimpleSignalstringPath
Inherited from Curve.fontStyle

fontWeight

readonly public fontWeight: SimpleSignalnumberPath
Inherited from Curve.fontWeight

gap

readonly public gap: Vector2LengthSignalPath
Inherited from Curve.gap

grow

readonly public grow: SimpleSignalnumberPath
Inherited from Curve.grow

isClass

public isClass: boolean
Inherited from Curve.isClass

justifyContent

Inherited from Curve.justifyContent

key

readonly public key: string
Inherited from Curve.key

layout

Inherited from Curve.layout

left

readonly public left: SimpleVector2SignalPath

The position of the left edge of this node.

When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.

When retrieved, it will return the position of the left edge in the parent space.

Inherited from Curve.left

letterSpacing

readonly public letterSpacing: SimpleSignalnumberPath
Inherited from Curve.letterSpacing

lineCap

readonly public lineCap: SimpleSignalCanvasLineCapPath
Inherited from Curve.lineCap

lineDash

readonly public lineDash: SimpleSignalnumber[]Path
Inherited from Curve.lineDash

lineDashOffset

readonly public lineDashOffset: SimpleSignalnumberPath
Inherited from Curve.lineDashOffset

lineHeight

Inherited from Curve.lineHeight

lineJoin

readonly public lineJoin: SimpleSignalCanvasLineJoinPath
Inherited from Curve.lineJoin

lineWidth

readonly public lineWidth: SimpleSignalnumberPath
Inherited from Curve.lineWidth

margin

readonly public margin: SpacingSignalPath
Inherited from Curve.margin

maxHeight

Inherited from Curve.maxHeight

maxWidth

Inherited from Curve.maxWidth

middle

The position of the center of this node.

When set, this shortcut property will modify the node's position so that the center ends up in the given place.

If the offset has not been changed, this will be the same as the position.

When retrieved, it will return the position of the center in the parent space.

Inherited from Curve.middle

minHeight

Inherited from Curve.minHeight

minWidth

Inherited from Curve.minWidth

offset

readonly public offset: Vector2SignalPath

Represents the offset of this node's origin.

By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.

The value is relative to the size of this node. A value of 1 means as far to the right/bottom as possible. Here are a few examples of offsets:

  • [-1, -1] - top left corner
  • [1, -1] - top right corner
  • [0, 1] - bottom edge
  • [-1, 1] - bottom left corner
Inherited from Curve.offset

opacity

readonly public opacity: SimpleSignalnumberPath
Inherited from Curve.opacity

padding

readonly public padding: SpacingSignalPath
Inherited from Curve.padding

parent

readonly public parent: SimpleSignalnullNodevoid = ...
Inherited from Curve.parent

position

readonly public position: Vector2SignalPath

Represents the position of this node in local space of its parent.

Examples

Inherited from Curve.position

properties

readonly public properties: RecordstringPropertyMetadataany = ...
Inherited from Curve.properties

ratio

readonly public ratio: SimpleSignalnullnumberPath
Inherited from Curve.ratio

The position of the right edge of this node.

When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.

When retrieved, it will return the position of the right edge in the parent space.

Inherited from Curve.right

rotation

readonly public rotation: SimpleSignalnumberPath

Represents the rotation (in degrees) of this node relative to its parent.

Inherited from Curve.rotation

scale

readonly public scale: Vector2SignalPath

Represents the scale of this node in local space of its parent.

Examples

Inherited from Curve.scale

shadowBlur

readonly public shadowBlur: SimpleSignalnumberPath
Inherited from Curve.shadowBlur

shadowColor

readonly public shadowColor: ColorSignalPath
Inherited from Curve.shadowColor

shadowOffset

Inherited from Curve.shadowOffset

shrink

readonly public shrink: SimpleSignalnumberPath
Inherited from Curve.shrink

size

readonly public size: Vector2LengthSignalPath

Represents the size of this node.

A size is a two-dimensional vector, where x represents the width, and y represents the height.

The value of both x and y is of type Length which is either:

  • number - the desired length in pixels
  • ${number}% - a string with the desired length in percents, for example '50%'
  • null - an automatic length

When retrieving the size, all units are converted to pixels, using the current state of the layout. For example, retrieving the width set to '50%', while the parent has a width of 200px will result in the number 100 being returned.

When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.

Examples

Inherited from Curve.size

skew

readonly public skew: Vector2SignalPath

Represents the skew of this node in local space of its parent.

Examples

Inherited from Curve.skew

start

readonly public start: SimpleSignalnumberPath

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

The portion of the curve that comes before the given percentage will be made invisible.

This property is usefully for animating the curve appearing on the screen. The value of 0 means the very start of the curve (accounting for the startOffset) while 1 means the very end (accounting for the endOffset).

Inherited from Curve.start

startArrow

readonly public startArrow: SimpleSignalbooleanPath

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

Use arrowSize to control the size of the arrow.

Inherited from Curve.startArrow

startOffset

readonly public startOffset: SimpleSignalnumberPath

The offset in pixels from the start of the curve.

This property lets you specify where along the defined curve the actual visible portion starts. For example, setting it to 20 will make the first 20 pixels of the curve invisible.

This property is useful for trimming the curve using a fixed distance. If you want to animate the curve appearing on the screen, use start instead.

Inherited from Curve.startOffset

stroke

readonly public stroke: CanvasStyleSignalPath
Inherited from Curve.stroke

strokeFirst

readonly public strokeFirst: SimpleSignalbooleanPath
Inherited from Curve.strokeFirst

styles

Inherited from Curve.styles

textAlign

readonly public textAlign: SimpleSignalCanvasTextAlignPath
Inherited from Curve.textAlign

textDirection

readonly public textDirection: SimpleSignalCanvasDirectionPath
Inherited from Curve.textDirection

textWrap

Inherited from Curve.textWrap

top

readonly public top: SimpleVector2SignalPath

The position of the top edge of this node.

When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.

When retrieved, it will return the position of the top edge in the parent space.

Inherited from Curve.top

topLeft

The position of the top left corner of this node.

When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.

When retrieved, it will return the position of the top left corner in the parent space.

Inherited from Curve.topLeft

topRight

The position of the top right corner of this node.

When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.

When retrieved, it will return the position of the top right corner in the parent space.

Inherited from Curve.topRight

wrap

Inherited from Curve.wrap

zIndex

readonly public zIndex: SimpleSignalnumberPath
Inherited from Curve.zIndex

Accessors

columnGap

public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Curve.columnGap

height

public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Curve.height

rowGap

public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Curve.rowGap

width

public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Curve.width

x

public get x(): SimpleSignalnumberthis
Inherited from Curve.x

y

public get y(): SimpleSignalnumberthis
Inherited from Curve.y

Methods

[iterator]

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Inherited from Curve.[iterator]

absoluteOpacity

public absoluteOpacity(): number
Inherited from Curve.absoluteOpacity

add

Add the given node(s) as the children of this node.

The nodes will be appended at the end of the children list.

Examples

Parameters

Inherited from Curve.add

anchorPosition

public anchorPosition(): Vector2
Inherited from Curve.anchorPosition

applyState

public applyStatestate: NodeState: void

Apply the given state to the node, setting all matching signal values to the provided values.

Parameters

Inherited from Curve.applyState

arcLength

public arcLength(): number

The visible arc length of this curve.

This arc length accounts for both the offset and the start and end properties.

Inherited from Curve.arcLength

baseArcLength

public baseArcLength(): number

The base arc length of this curve.

This is the entire length of this curve, not accounting for the offsets.

Inherited from Curve.baseArcLength

cacheBBox

public cacheBBox(): BBox

Get a bounding box for the contents rendered by this node as well as its children.

Inherited from Curve.cacheBBox

clone

public clonecustomProps: NodeProps = {}: Path

Create a copy of this node.

Parameters

Inherited from Curve.clone

completion

public completion(): number

The percentage of the curve that's currently visible.

The returned value is the ratio between the visible length (as defined by start and end) and the offset length of the curve.

Inherited from Curve.completion

compositeToLocal

public compositeToLocal(): DOMMatrix
Inherited from Curve.compositeToLocal

compositeToWorld

public compositeToWorld(): DOMMatrix

A matrix mapping composite space to world space.

Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closes composite root.

Inherited from Curve.compositeToWorld

computedPosition

public computedPosition(): Vector2
Inherited from Curve.computedPosition

dispose

public dispose(): void

Prepare this node to be disposed of.

This method is called automatically when a scene is refreshed. It will be called even if the node is not currently attached to the tree.

The goal of this method is to clean any external references to allow the node to be garbage collected.

Inherited from Curve.dispose

distanceToPercentage

public distanceToPercentagevalue: number: number

Convert a distance along the curve to a percentage.

The distance should be given in relation to the full curve, not accounting for startOffset and endOffset.

Parameters

  • value: number

    The distance along the curve.

Inherited from Curve.distanceToPercentage

drawOverlay

public override drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void

Draw an overlay for this node.

The overlay for the currently inspected node is displayed on top of the canvas.

The provided context is in screen space. The local-to-screen matrix can be used to transform all shapes that need to be displayed. This approach allows to keep the line widths and gizmo sizes consistent, no matter how zoomed-in the view is.

Parameters

Overwrites Curve.drawOverlay

getOriginDelta

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Curve.getOriginDelta

getPointAtPercentage

public getPointAtPercentagevalue: number: CurvePoint

Parameters

Inherited from Curve.getPointAtPercentage

getState

public getState(): NodeState

Return a snapshot of the node's current signal values.

This method will calculate the values of any reactive properties of the node at the time the method is called.

Inherited from Curve.getState

hit

public hitposition: Vector2: nullNode

Try to find a node intersecting the given position.

Parameters

Inherited from Curve.hit

insert

public insertnode: ComponentChildrenindex: number = 0: Path

Insert the given node(s) at the specified index in the children list.

Examples

Parameters

Inherited from Curve.insert

instantiate

public instantiateprops: NodeProps = {}: Path

Create an instance of this node's class.

Parameters

Inherited from Curve.instantiate

isLayoutRoot

public isLayoutRoot(): boolean
Inherited from Curve.isLayoutRoot

layoutEnabled

public layoutEnabled(): boolean

Get the resolved layout mode of this node.

When the mode is null, its value will be inherited from the parent.

Use layout to get the raw mode set for this node (without inheritance).

Inherited from Curve.layoutEnabled

localToParent

public localToParent(): DOMMatrix

Get the local-to-parent matrix for this node.

This matrix transforms vectors from local space of this node to local space of this node's parent.

Inherited from Curve.localToParent

localToWorld

public localToWorld(): DOMMatrix

Get the local-to-world matrix for this node.

This matrix transforms vectors from local space of this node to world space.

Examples

Inherited from Curve.localToWorld

lockSize

public lockSize(): void
Inherited from Curve.lockSize

move

public moveby: number = 1: Path

Rearrange this node in relation to its siblings.

Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.

A positive by arguments move the node up (it will be rendered on top of the elements it has passed). Negative values move it down.

Parameters

  • by: number = 1

    Number of places by which the node should be moved.

Inherited from Curve.move

moveAbove

public moveAbovenode: NodedirectlyAbove: boolean = false: Path

Move the node above the provided node in the parent's layout.

The node will be moved above the provided node and from then on will be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.

Parameters

  • node: Node

    The sibling node below which to move.

  • directlyAbove: boolean = false

    Whether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.

Inherited from Curve.moveAbove

moveBelow

public moveBelownode: NodedirectlyBelow: boolean = false: Path

Move the node below the provided node in the parent's layout.

The node will be moved below the provided node and from then on will be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.

Parameters

  • node: Node

    The sibling node below which to move.

  • directlyBelow: boolean = false

    Whether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.

Inherited from Curve.moveBelow

moveDown

public moveDown(): Path

Move the node down in relation to its siblings.

The node will exchange places with the sibling right below it (if any) and from then on will be rendered under it.

Inherited from Curve.moveDown

moveOffset

public moveOffsetoffset: Vector2: void

Update the offset of this node and adjust the position to keep it in the same place.

Parameters

Inherited from Curve.moveOffset

moveTo

public moveToindex: number: Path

Move the node to the provided position relative to its siblings.

If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).

Parameters

  • index: number

    The index to move the node to.

Inherited from Curve.moveTo

moveToBottom

public moveToBottom(): Path

Move the node to the bottom in relation to its siblings.

The node will be placed at the beginning of the children list and from then on will be rendered below all of its siblings.

Inherited from Curve.moveToBottom

moveToTop

public moveToTop(): Path

Move the node to the top in relation to its siblings.

The node will be placed at the end of the children list and from then on will be rendered on top of all of its siblings.

Inherited from Curve.moveToTop

moveUp

public moveUp(): Path

Move the node up in relation to its siblings.

The node will exchange places with the sibling right above it (if any) and from then on will be rendered on top of it.

Inherited from Curve.moveUp

offsetArcLength

public offsetArcLength(): number

The offset arc length of this curve.

This is the length of the curve that accounts for the offsets.

Inherited from Curve.offsetArcLength

percentageToDistance

public percentageToDistancevalue: number: number

Convert a percentage along the curve to a distance.

The returned distance is given in relation to the full curve, not accounting for startOffset and endOffset.

Parameters

  • value: number

    The percentage along the curve.

Inherited from Curve.percentageToDistance

profile

public override profile(): CurveProfile
Overwrites Curve.profile

reactiveClone

public reactiveClonecustomProps: NodeProps = {}: Path

Create a reactive copy of this node.

A reactive copy has all its properties dynamically updated to match the source node.

Parameters

Inherited from Curve.reactiveClone

releaseSize

public releaseSize(): void
Inherited from Curve.releaseSize

remove

public remove(): Path

Remove this node from the tree.

Inherited from Curve.remove

removeChildren

public removeChildren(): void

Remove all children of this node.

Inherited from Curve.removeChildren

render

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

Inherited from Curve.render

reparent

public reparentnewParent: Node: void

Change the parent of this node while keeping the absolute transform.

After performing this operation, the node will stay in the same place visually, but its parent will be changed.

Parameters

Inherited from Curve.reparent

restore

public restoreduration?: numbertiming: TimingFunction = easeInOutCubic: undefinedThreadGenerator

Restore the node to its last saved state.

This method can be used together with the save method to restore a node to a previously saved state. Restoring a node to a previous state removes that state from the state stack.

Providing a duration will tween the node to the restored state. Otherwise, it will be restored immediately.

Examples

Parameters

Inherited from Curve.restore

ripple

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

Inherited from Curve.ripple

save

public save(): void

Push a snapshot of the node's current state onto the node's state stack.

This method can be used together with the restore method to save a node's current state and later restore it. It is possible to store more than one state by calling save method multiple times.

Inherited from Curve.save

snapshotClone

public snapshotClonecustomProps: NodeProps = {}: Path

Create a copy of this node.

Unlike clone, a snapshot clone calculates any reactive properties at the moment of cloning and passes the raw values to the copy.

Parameters

Inherited from Curve.snapshotClone

toPromise

public toPromise(): PromisePath

Wait for any asynchronous resources that this node or its children have.

Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.

Inherited from Curve.toPromise

view

public view(): View2D
Inherited from Curve.view

worldToLocal

public worldToLocal(): DOMMatrix

Get the world-to-local matrix for this node.

This matrix transforms vectors from world space to local space of this node.

Examples

Inherited from Curve.worldToLocal

worldToParent

public worldToParent(): DOMMatrix

Get the world-to-parent matrix for this node.

This matrix transforms vectors from world space to local space of this node's parent.

Inherited from Curve.worldToParent