Skip to main content

Layout

                            
                              
                                class 
                                Layout
                                extends 
                                
                                  
                                    
                                      Node

Extended by

  • Shape

Constructors ​

constructor ​ 

                            
                              
                                public 
                                override
                                new
                                Layout
                                
                                  
                                    
                                      {...}
                                      : 
                                      LayoutProps
                                    
                                  
                                
                                : 
                                Layout

Parameters

Overwrites Node.constructor

Properties ​

absolutePosition ​ 

                            
                              
                                readonly 
                                public 
                                absolutePosition
                                : 
                                SimpleVector2Signal
                                
                                  
                                    
                                      Layout

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

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

If the new value is a function, the position of this node will becontinuously 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 itfollow another node's position.

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

Inherited from Node.absolutePosition

absoluteRotation ​ 

                            
                              
                                readonly 
                                public 
                                absoluteRotation
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

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

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

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

Inherited from Node.absoluteRotation

absoluteScale ​ 

                            
                              
                                readonly 
                                public 
                                absoluteScale
                                : 
                                SimpleVector2Signal
                                
                                  
                                    
                                      Layout

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 tolocal space.

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

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

Inherited from Node.absoluteScale

alignContent ​ 

                            
                              
                                readonly 
                                public 
                                alignContent
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexContent
                                    
                                    
                                      Layout

alignItems ​ 

                            
                              
                                readonly 
                                public 
                                alignItems
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexItems
                                    
                                    
                                      Layout

alignSelf ​ 

                            
                              
                                readonly 
                                public 
                                alignSelf
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexItems
                                    
                                    
                                      Layout

basis ​ 

                            
                              
                                readonly 
                                public 
                                basis
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexBasis
                                    
                                    
                                      Layout

cache ​ 

                            
                              
                                readonly 
                                public 
                                cache
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      boolean
                                    
                                    
                                      Layout
Inherited from Node.cache

children ​ 

                            
                              
                                readonly 
                                public 
                                children
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      Node
                                      []
                                    
                                    
                                      Layout
Inherited from Node.children

clip ​ 

                            
                              
                                readonly 
                                public 
                                clip
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      boolean
                                    
                                    
                                      Layout

composite ​ 

                            
                              
                                readonly 
                                public 
                                composite
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      boolean
                                    
                                    
                                      Layout
Inherited from Node.composite

compositeOperation ​ 

                            
                              
                                readonly 
                                public 
                                compositeOperation
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      GlobalCompositeOperation
                                    
                                    
                                      Layout
Inherited from Node.compositeOperation

creationStack ​ 

                            
                              
                                readonly 
                                public 
                                creationStack
                                ?: 
                                string
Inherited from Node.creationStack

direction ​ 

                            
                              
                                readonly 
                                public 
                                direction
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexDirection
                                    
                                    
                                      Layout

element ​ 

                            
                              
                                public 
                                element
                                : 
                                HTMLElement

filters ​ 

                            
                              
                                readonly 
                                public 
                                filters
                                : 
                                FiltersSignal
                                
                                  
                                    
                                      Layout
Inherited from Node.filters

fontFamily ​ 

                            
                              
                                readonly 
                                public 
                                fontFamily
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      string
                                    
                                    
                                      Layout

fontSize ​ 

                            
                              
                                readonly 
                                public 
                                fontSize
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

fontStyle ​ 

                            
                              
                                readonly 
                                public 
                                fontStyle
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      string
                                    
                                    
                                      Layout

fontWeight ​ 

                            
                              
                                readonly 
                                public 
                                fontWeight
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

gap ​ 

                            
                              
                                readonly 
                                public 
                                gap
                                : 
                                Vector2LengthSignal
                                
                                  
                                    
                                      Layout

grow ​ 

                            
                              
                                readonly 
                                public 
                                grow
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

isClass ​ 

                            
                              
                                public 
                                isClass
                                : 
                                boolean
Inherited from Node.isClass

justifyContent ​ 

                            
                              
                                readonly 
                                public 
                                justifyContent
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexContent
                                    
                                    
                                      Layout

key ​ 

                            
                              
                                readonly 
                                public 
                                key
                                : 
                                string
Inherited from Node.key

layout ​ 

                            
                              
                                readonly 
                                public 
                                layout
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      LayoutMode
                                    
                                    
                                      Layout

letterSpacing ​ 

                            
                              
                                readonly 
                                public 
                                letterSpacing
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

lineHeight ​ 

                            
                              
                                readonly 
                                public 
                                lineHeight
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      Length
                                    
                                    
                                      Layout

margin ​ 

                            
                              
                                readonly 
                                public 
                                margin
                                : 
                                SpacingSignal
                                
                                  
                                    
                                      Layout

maxHeight ​ 

                            
                              
                                readonly 
                                public 
                                maxHeight
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      LengthLimit
                                    
                                    
                                      Layout

maxWidth ​ 

                            
                              
                                readonly 
                                public 
                                maxWidth
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      LengthLimit
                                    
                                    
                                      Layout

minHeight ​ 

                            
                              
                                readonly 
                                public 
                                minHeight
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      LengthLimit
                                    
                                    
                                      Layout

minWidth ​ 

                            
                              
                                readonly 
                                public 
                                minWidth
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      LengthLimit
                                    
                                    
                                      Layout

offset ​ 

                            
                              
                                readonly 
                                public 
                                offset
                                : 
                                Vector2Signal
                                
                                  
                                    
                                      Layout

Represents the offset of this node's origin.

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

The value is relative to the size of this node. A value of 1 means as farto 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

opacity ​ 

                            
                              
                                readonly 
                                public 
                                opacity
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout
Inherited from Node.opacity

padding ​ 

                            
                              
                                readonly 
                                public 
                                padding
                                : 
                                SpacingSignal
                                
                                  
                                    
                                      Layout

parent ​ 

                            
                              
                                readonly 
                                public 
                                parent
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      
                                        
                                          
                                            null
                                          
                                          
                                            Node
                                          
                                        
                                      
                                    
                                    
                                      void
                                    
                                  
                                
                                 = 
                                ...
Inherited from Node.parent

position ​ 

                            
                              
                                readonly 
                                public 
                                position
                                : 
                                Vector2Signal
                                
                                  
                                    
                                      Layout

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

Examples

Inherited from Node.position

properties ​ 

                            
                              
                                readonly 
                                public 
                                properties
                                : 
                                Record
                                
                                  
                                    
                                      string
                                    
                                    
                                      PropertyMetadata
                                      
                                        
                                          
                                            any
                                          
                                        
                                      
                                    
                                  
                                
                                 = 
                                ...
Inherited from Node.properties

ratio ​ 

                            
                              
                                readonly 
                                public 
                                ratio
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      
                                        
                                          
                                            null
                                          
                                          
                                            number
                                          
                                        
                                      
                                    
                                    
                                      Layout

rotation ​ 

                            
                              
                                readonly 
                                public 
                                rotation
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

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

Inherited from Node.rotation

scale ​ 

                            
                              
                                readonly 
                                public 
                                scale
                                : 
                                Vector2Signal
                                
                                  
                                    
                                      Layout

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

Examples

Inherited from Node.scale

shadowBlur ​ 

                            
                              
                                readonly 
                                public 
                                shadowBlur
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout
Inherited from Node.shadowBlur

shadowColor ​ 

                            
                              
                                readonly 
                                public 
                                shadowColor
                                : 
                                ColorSignal
                                
                                  
                                    
                                      Layout
Inherited from Node.shadowColor

shadowOffset ​ 

                            
                              
                                readonly 
                                public 
                                shadowOffset
                                : 
                                Vector2Signal
                                
                                  
                                    
                                      Layout
Inherited from Node.shadowOffset

shrink ​ 

                            
                              
                                readonly 
                                public 
                                shrink
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout

size ​ 

                            
                              
                                readonly 
                                public 
                                size
                                : 
                                Vector2LengthSignal
                                
                                  
                                    
                                      Layout

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 iseither:

  • 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 thecurrent 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 percentsrefers to the size of the entire scene.

Examples

styles ​ 

                            
                              
                                public 
                                styles
                                : 
                                CSSStyleDeclaration

textAlign ​ 

                            
                              
                                readonly 
                                public 
                                textAlign
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      CanvasTextAlign
                                    
                                    
                                      Layout

textDirection ​ 

                            
                              
                                readonly 
                                public 
                                textDirection
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      CanvasDirection
                                    
                                    
                                      Layout

textWrap ​ 

                            
                              
                                readonly 
                                public 
                                textWrap
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      TextWrap
                                    
                                    
                                      Layout

wrap ​ 

                            
                              
                                readonly 
                                public 
                                wrap
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      FlexWrap
                                    
                                    
                                      Layout

zIndex ​ 

                            
                              
                                readonly 
                                public 
                                zIndex
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      number
                                    
                                    
                                      Layout
Inherited from Node.zIndex

Accessors ​

columnGap ​ 

                            
                              
                                public 
                                get 
                                columnGap
                                (): 
                                Signal
                                
                                  
                                    
                                      Length
                                    
                                    
                                      number
                                    
                                    
                                      this
                                    
                                    
                                      SignalContext
                                      
                                        
                                          
                                            Length
                                          
                                          
                                            number
                                          
                                          
                                            this

height ​ 

                            
                              
                                public 
                                get 
                                height
                                (): 
                                Signal
                                
                                  
                                    
                                      Length
                                    
                                    
                                      number
                                    
                                    
                                      this
                                    
                                    
                                      SignalContext
                                      
                                        
                                          
                                            Length
                                          
                                          
                                            number
                                          
                                          
                                            this

rowGap ​ 

                            
                              
                                public 
                                get 
                                rowGap
                                (): 
                                Signal
                                
                                  
                                    
                                      Length
                                    
                                    
                                      number
                                    
                                    
                                      this
                                    
                                    
                                      SignalContext
                                      
                                        
                                          
                                            Length
                                          
                                          
                                            number
                                          
                                          
                                            this

width ​ 

                            
                              
                                public 
                                get 
                                width
                                (): 
                                Signal
                                
                                  
                                    
                                      Length
                                    
                                    
                                      number
                                    
                                    
                                      this
                                    
                                    
                                      SignalContext
                                      
                                        
                                          
                                            Length
                                          
                                          
                                            number
                                          
                                          
                                            this

Methods ​

[iterator] ​ 

                            
                              
                                public 
                                [iterator]
                                (): 
                                Generator
                                
                                  
                                    
                                      
                                        
                                          
                                            key
                                            : 
                                            string
                                          
                                          
                                            meta
                                            : 
                                            PropertyMetadata
                                            
                                              
                                                
                                                  any
                                                
                                              
                                            
                                          
                                          
                                            signal
                                            : 
                                            SimpleSignal
                                            
                                              
                                                
                                                  any
                                                
                                                
                                                  void
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                    
                                      void
                                    
                                    
                                      unknown
Inherited from Node.[iterator]

absoluteOpacity ​ 

                            
                              
                                public 
                                absoluteOpacity
                                (): 
                                number
Inherited from Node.absoluteOpacity

add ​ 

                            
                              
                                public 
                                add
                                
                                  
                                    
                                      node
                                      : 
                                      ComponentChildren
                                    
                                  
                                
                                : 
                                Layout

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 Node.add

anchorPosition ​ 

                            
                              
                                public 
                                anchorPosition
                                (): 
                                Vector2

applyState ​ 

                            
                              
                                public 
                                applyState
                                
                                  
                                    
                                      state
                                      : 
                                      NodeState
                                    
                                  
                                
                                : 
                                void

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

Parameters

Inherited from Node.applyState

cacheBBox ​ 

                            
                              
                                public 
                                cacheBBox
                                (): 
                                BBox

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

Inherited from Node.cacheBBox

clone ​ 

                            
                              
                                public 
                                clone
                                
                                  
                                    
                                      customProps
                                      : 
                                      NodeProps
                                       = 
                                      {}
                                    
                                  
                                
                                : 
                                Layout

Create a copy of this node.

Parameters

Inherited from Node.clone

compositeToLocal ​ 

                            
                              
                                public 
                                compositeToLocal
                                (): 
                                DOMMatrix
Inherited from Node.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 effectappears relative to the closes composite root.

Inherited from Node.compositeToWorld

computedPosition ​ 

                            
                              
                                public 
                                computedPosition
                                (): 
                                Vector2

dispose ​ 

                            
                              
                                public 
                                override
                                dispose
                                (): 
                                void

Prepare this node to be disposed of.

This method is called automatically when a scene is refreshed. It willbe 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 thenode to be garbage collected.

Overwrites Node.dispose

drawOverlay ​ 

                            
                              
                                public 
                                override
                                drawOverlay
                                
                                  
                                    
                                      context
                                      : 
                                      CanvasRenderingContext2D
                                    
                                    
                                      matrix
                                      : 
                                      DOMMatrix
                                    
                                  
                                
                                : 
                                void

Draw an overlay for this node.

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

The provided context is in screen space. The local-to-screen matrix can beused 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 Node.drawOverlay

getOriginDelta ​ 

                            
                              
                                public 
                                getOriginDelta
                                
                                  
                                    
                                      origin
                                      : 
                                      Origin
                                    
                                  
                                
                                : 
                                Vector2

Parameters

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 thenode at the time the method is called.

Inherited from Node.getState

hit ​ 

                            
                              
                                public 
                                override
                                hit
                                
                                  
                                    
                                      position
                                      : 
                                      Vector2
                                    
                                  
                                
                                : 
                                
                                  
                                    
                                      null
                                    
                                    
                                      Node

Try to find a node intersecting the given position.

Parameters

  • position : Vector2

    The searched position.

Overwrites Node.hit

insert ​ 

                            
                              
                                public 
                                insert
                                
                                  
                                    
                                      node
                                      : 
                                      ComponentChildren
                                    
                                    
                                      index
                                      : 
                                      number
                                       = 
                                      0
                                    
                                  
                                
                                : 
                                Layout

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

Examples

Parameters

Inherited from Node.insert

instantiate ​ 

                            
                              
                                public 
                                instantiate
                                
                                  
                                    
                                      props
                                      : 
                                      NodeProps
                                       = 
                                      {}
                                    
                                  
                                
                                : 
                                Layout

Create an instance of this node's class.

Parameters

  • props : NodeProps = {}

    Properties to pass to the constructor.

Inherited from Node.instantiate

isLayoutRoot ​ 

                            
                              
                                public 
                                isLayoutRoot
                                (): 
                                boolean

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 (withoutinheritance).

localToParent ​ 

                            
                              
                                public 
                                override
                                localToParent
                                (): 
                                DOMMatrix

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

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

Overwrites Node.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 worldspace.

Examples

Inherited from Node.localToWorld

lockSize ​ 

                            
                              
                                public 
                                lockSize
                                (): 
                                void

move ​ 

                            
                              
                                public 
                                move
                                
                                  
                                    
                                      by
                                      : 
                                      number
                                       = 
                                      1
                                    
                                  
                                
                                : 
                                Layout

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 ofthe 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 Node.move

moveAbove ​ 

                            
                              
                                public 
                                moveAbove
                                
                                  
                                    
                                      node
                                      : 
                                      Node
                                    
                                    
                                      directlyAbove
                                      : 
                                      boolean
                                       = 
                                      false
                                    
                                  
                                
                                : 
                                Layout

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 berendered on top of it. By default, if the node is already positionedhigher 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 thesibling. When true, will move the node even if it isalready positioned above the sibling.

Inherited from Node.moveAbove

moveBelow ​ 

                            
                              
                                public 
                                moveBelow
                                
                                  
                                    
                                      node
                                      : 
                                      Node
                                    
                                    
                                      directlyBelow
                                      : 
                                      boolean
                                       = 
                                      false
                                    
                                  
                                
                                : 
                                Layout

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 berendered below it. By default, if the node is already positioned lower thanthe 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 belowthe sibling. When true, will move the node even ifit is already positioned below the sibling.

Inherited from Node.moveBelow

moveDown ​ 

                            
                              
                                public 
                                moveDown
                                (): 
                                Layout

Move the node down in relation to its siblings.

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

Inherited from Node.moveDown

moveOffset ​ 

                            
                              
                                public 
                                moveOffset
                                
                                  
                                    
                                      offset
                                      : 
                                      Vector2
                                    
                                  
                                
                                : 
                                void

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

Parameters

  • offset : Vector2

    The new offset.

moveTo ​ 

                            
                              
                                public 
                                moveTo
                                
                                  
                                    
                                      index
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Layout

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 belowthe sibling that's currently at the provided index (if any).If the node is getting moved to a higher position, it will be placed abovethe sibling that's currently at the provided index (if any).

Parameters

  • index : number

    The index to move the node to.

Inherited from Node.moveTo

moveToBottom ​ 

                            
                              
                                public 
                                moveToBottom
                                (): 
                                Layout

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 thenon will be rendered below all of its siblings.

Inherited from Node.moveToBottom

moveToTop ​ 

                            
                              
                                public 
                                moveToTop
                                (): 
                                Layout

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 onwill be rendered on top of all of its siblings.

Inherited from Node.moveToTop

moveUp ​ 

                            
                              
                                public 
                                moveUp
                                (): 
                                Layout

Move the node up in relation to its siblings.

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

Inherited from Node.moveUp

reactiveClone ​ 

                            
                              
                                public 
                                reactiveClone
                                
                                  
                                    
                                      customProps
                                      : 
                                      NodeProps
                                       = 
                                      {}
                                    
                                  
                                
                                : 
                                Layout

Create a reactive copy of this node.

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

Parameters

Inherited from Node.reactiveClone

releaseSize ​ 

                            
                              
                                public 
                                releaseSize
                                (): 
                                void

remove ​ 

                            
                              
                                public 
                                remove
                                (): 
                                Layout

Remove this node from the tree.

Inherited from Node.remove

removeChildren ​ 

                            
                              
                                public 
                                removeChildren
                                (): 
                                void

Remove all children of this node.

Inherited from Node.removeChildren

render ​ 

                            
                              
                                public 
                                render
                                
                                  
                                    
                                      context
                                      : 
                                      CanvasRenderingContext2D
                                    
                                  
                                
                                : 
                                void

Render this node onto the given canvas.

Parameters

Inherited from Node.render

reparent ​ 

                            
                              
                                public 
                                reparent
                                
                                  
                                    
                                      newParent
                                      : 
                                      Node
                                    
                                  
                                
                                : 
                                void

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

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

Parameters

  • newParent : Node

    The new parent of this node.

Inherited from Node.reparent

restore ​ 

                            
                              
                                public 
                                restore
                                
                                  
                                    
                                      duration
                                      : 
                                      number
                                    
                                    
                                      timing
                                      : 
                                      TimingFunction
                                       = 
                                      easeInOutCubic
                                    
                                  
                                
                                : 
                                
                                  
                                    
                                      undefined
                                    
                                    
                                      ThreadGenerator

Restore the node to its last saved state.

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

Examples

Parameters

  • duration : number

    The duration of the transition

  • timing : TimingFunction = easeInOutCubic

    The timing function to use for the transition

Inherited from Node.restore

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 anode's current state and later restore it. It is possible to store morethan one state by calling save method multiple times.

Inherited from Node.save

snapshotClone ​ 

                            
                              
                                public 
                                snapshotClone
                                
                                  
                                    
                                      customProps
                                      : 
                                      NodeProps
                                       = 
                                      {}
                                    
                                  
                                
                                : 
                                Layout

Create a copy of this node.

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

Parameters

Inherited from Node.snapshotClone

toPromise ​ 

                            
                              
                                public 
                                toPromise
                                (): 
                                Promise
                                
                                  
                                    
                                      Layout

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 loadingbefore continuing the animation.

Inherited from Node.toPromise

view ​ 

                            
                              
                                public 
                                view
                                (): 
                                View2D
Inherited from Node.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 thisnode.

Examples

Inherited from Node.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 thisnode's parent.

Inherited from Node.worldToParent