Icon
class
Icon
extends
Img
An Icon Component that provides easy access to over 150k icons.See https://icones.js.org/collection/all for all available Icons.
Constructors
constructor
Parameters
-
props : IconProps
Img.constructor
Properties
absolutePosition
readonly
public
absolutePosition
:
SimpleVector2Signal
Icon
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.
Img.absolutePosition
absoluteRotation
readonly
public
absoluteRotation
:
SimpleSignal
number
Icon
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
Img.absoluteRotation
absoluteScale
readonly
public
absoluteScale
:
SimpleVector2Signal
Icon
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.
Img.absoluteScale
alignContent
readonly
public
alignContent
:
SimpleSignal
FlexContent
Icon
Img.alignContent
alignItems
readonly
public
alignItems
:
SimpleSignal
FlexItems
Icon
Img.alignItems
alignSelf
readonly
public
alignSelf
:
SimpleSignal
FlexItems
Icon
Img.alignSelf
alpha
readonly
public
alpha
:
SimpleSignal
number
Icon
The alpha value of this image.
Unlike opacity, the alpha value affects only the image itself, leaving thefill, stroke, and children intact.
Inherited from
Img.alpha
antialiased
readonly
public
antialiased
:
SimpleSignal
boolean
Icon
Img.antialiased
arrowSize
readonly
public
arrowSize
:
SimpleSignal
number
Icon
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable
startArrow
and/or
endArrow
.
Img.arrowSize
basis
readonly
public
basis
:
SimpleSignal
FlexBasis
Icon
Img.basis
bottom
readonly
public
bottom
:
SimpleVector2Signal
Icon
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so thatthe bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in theparent space.
Inherited from
Img.bottom
bottomLeft
readonly
public
bottomLeft
:
SimpleVector2Signal
Icon
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so thatthe bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner inthe parent space.
Inherited from
Img.bottomLeft
bottomRight
readonly
public
bottomRight
:
SimpleVector2Signal
Icon
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so thatthe bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner inthe parent space.
Inherited from
Img.bottomRight
cache
readonly
public
cache
:
SimpleSignal
boolean
Icon
Img.cache
children
readonly
public
children
:
SimpleSignal
Node
[]
Icon
Img.children
clip
readonly
public
clip
:
SimpleSignal
boolean
Icon
Img.clip
closed
readonly
public
closed
:
SimpleSignal
boolean
Icon
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited from
Img.closed
color
public
color
:
ColorSignal
Icon
The color of the icon
Provide the color in one of the following formats:
-
named color like
red,darkgray, … -
hexadecimal string with # like
#bada55,#141414Value can be either RGB or RGBA:#bada55,#bada55aa(latter is partially transparent)The shorthand version (e.g.#abcfor#aabbccis also possible.)
'white'
composite
readonly
public
composite
:
SimpleSignal
boolean
Icon
Img.composite
compositeOperation
readonly
public
compositeOperation
:
SimpleSignal
GlobalCompositeOperation
Icon
Img.compositeOperation
cornerSharpness
readonly
public
cornerSharpness
:
SimpleSignal
number
Icon
Controls the sharpness of
smoothCorners
.
This property only affects the way rounded corners are drawn. To controlthe corner radius use the
radius
property.
Requires
smoothCorners
to be enabled to have any effect.By default, corner sharpness is set to
0.6
which represents a smooth,circle-like rounding. At
0
the edges are squared off.
Examples
Inherited from
Img.cornerSharpness
creationStack
readonly
public
creationStack
?:
string
Img.creationStack
direction
readonly
public
direction
:
SimpleSignal
FlexDirection
Icon
Img.direction
element
public
element
:
HTMLElement
Img.element
end
readonly
public
end
:
SimpleSignal
number
Icon
A percentage from the start after which the curve should be clipped.
The portion of the curve that comes after the given percentage will bemade invisible.
This property is usefully for animating the curve appearing on the screen.The value of
0
means the very start of the curve (accounting for the
startOffset
) while
1
means the very end (accounting for the
endOffset
).
Img.end
endArrow
readonly
public
endArrow
:
SimpleSignal
boolean
Icon
Whether to display an arrow at the end of the visible curve.
Use
arrowSize
to control the size of the arrow.
Img.endArrow
endOffset
readonly
public
endOffset
:
SimpleSignal
number
Icon
The offset in pixels from the end of the curve.
This property lets you specify where along the defined curve the actualvisible portion ends. For example, setting it to
20
will make the last20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.If you want to animate the curve appearing on the screen, use
end
instead.
Img.endOffset
fill
readonly
public
fill
:
CanvasStyleSignal
Icon
Img.fill
filters
readonly
public
filters
:
FiltersSignal
Icon
Img.filters
fontFamily
readonly
public
fontFamily
:
SimpleSignal
string
Icon
Img.fontFamily
fontSize
readonly
public
fontSize
:
SimpleSignal
number
Icon
Img.fontSize
fontStyle
readonly
public
fontStyle
:
SimpleSignal
string
Icon
Img.fontStyle
fontWeight
readonly
public
fontWeight
:
SimpleSignal
number
Icon
Img.fontWeight
gap
readonly
public
gap
:
Vector2LengthSignal
Icon
Img.gap
grow
readonly
public
grow
:
SimpleSignal
number
Icon
Img.grow
icon
public
icon
:
SimpleSignal
string
Icon
The identifier of the icon.
You can find identifiers on Icônes .They can look like this:
-
mdi:language-typescript -
ph:anchor-simple-bold -
ph:activity-bold
isClass
public
isClass
:
boolean
Img.isClass
justifyContent
readonly
public
justifyContent
:
SimpleSignal
FlexContent
Icon
Img.justifyContent
key
readonly
public
key
:
string
Img.key
layout
readonly
public
layout
:
SimpleSignal
LayoutMode
Icon
Img.layout
left
readonly
public
left
:
SimpleVector2Signal
Icon
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so thatthe left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parentspace.
Inherited from
Img.left
letterSpacing
readonly
public
letterSpacing
:
SimpleSignal
number
Icon
Img.letterSpacing
lineCap
readonly
public
lineCap
:
SimpleSignal
CanvasLineCap
Icon
Img.lineCap
lineDash
readonly
public
lineDash
:
SimpleSignal
number
[]
Icon
Img.lineDash
lineDashOffset
readonly
public
lineDashOffset
:
SimpleSignal
number
Icon
Img.lineDashOffset
lineHeight
readonly
public
lineHeight
:
SimpleSignal
Length
Icon
Img.lineHeight
lineJoin
readonly
public
lineJoin
:
SimpleSignal
CanvasLineJoin
Icon
Img.lineJoin
lineWidth
readonly
public
lineWidth
:
SimpleSignal
number
Icon
Img.lineWidth
margin
readonly
public
margin
:
SpacingSignal
Icon
Img.margin
maxHeight
readonly
public
maxHeight
:
SimpleSignal
LengthLimit
Icon
Img.maxHeight
maxWidth
readonly
public
maxWidth
:
SimpleSignal
LengthLimit
Icon
Img.maxWidth
middle
readonly
public
middle
:
SimpleVector2Signal
Icon
The position of the center of this node.
When set, this shortcut property will modify the node's position so thatthe 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 parentspace.
Inherited from
Img.middle
minHeight
readonly
public
minHeight
:
SimpleSignal
LengthLimit
Icon
Img.minHeight
minWidth
readonly
public
minWidth
:
SimpleSignal
LengthLimit
Icon
Img.minWidth
offset
readonly
public
offset
:
Vector2Signal
Icon
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
Img.offset
opacity
readonly
public
opacity
:
SimpleSignal
number
Icon
Img.opacity
padding
readonly
public
padding
:
SpacingSignal
Icon
Img.padding
parent
readonly
public
parent
:
SimpleSignal
null
Node
void
=
...
Img.parent
position
readonly
public
position
:
Vector2Signal
Icon
Represents the position of this node in local space of its parent.
Examples
Inherited from
Img.position
properties
readonly
public
properties
:
Record
string
PropertyMetadata
any
=
...
Img.properties
radius
readonly
public
radius
:
SpacingSignal
Icon
Rounds the corners of this rectangle.
The value represents the radius of the quarter circle that is used to roundthe corners. If the value is a number, the same radius is used for allcorners. Passing an array of two to four numbers will set individual radiifor each corner. Individual radii correspond to different corners dependingon the number of values passed:
// top-left-and-bottom-right | top-right-and-bottom-left
[
10
,
30
]
// top-left | top-right-and-bottom-left | bottom-right
[
10
,
20
,
30
]
// top-left | top-right | bottom-right | bottom-left
[
10
,
20
,
30
,
40
]
Examples
Inherited from
Img.radius
ratio
readonly
public
ratio
:
SimpleSignal
null
number
Icon
Img.ratio
right
readonly
public
right
:
SimpleVector2Signal
Icon
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so thatthe right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parentspace.
Inherited from
Img.right
rotation
readonly
public
rotation
:
SimpleSignal
number
Icon
Represents the rotation (in degrees) of this node relative to its parent.
Inherited from
Img.rotation
scale
readonly
public
scale
:
Vector2Signal
Icon
Represents the scale of this node in local space of its parent.
Examples
Inherited from
Img.scale
shadowBlur
readonly
public
shadowBlur
:
SimpleSignal
number
Icon
Img.shadowBlur
shadowColor
readonly
public
shadowColor
:
ColorSignal
Icon
Img.shadowColor
shadowOffset
readonly
public
shadowOffset
:
Vector2Signal
Icon
Img.shadowOffset
shrink
readonly
public
shrink
:
SimpleSignal
number
Icon
Img.shrink
size
readonly
public
size
:
Vector2LengthSignal
Icon
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
Inherited from
Img.size
smoothCorners
readonly
public
smoothCorners
:
SimpleSignal
boolean
Icon
Enables corner smoothing.
This property only affects the way rounded corners are drawn. To controlthe corner radius use the
radius
property.
When enabled, rounded corners are drawn continuously using Bézier curvesrather than quarter circles. The sharpness of the curve can be controlledwith
cornerSharpness
.
You can read more about corner smoothing in this article by Nick Lawrence .
Examples
Inherited from
Img.smoothCorners
smoothing
readonly
public
smoothing
:
SimpleSignal
boolean
Icon
Whether the image should be smoothed.
When disabled, the image will be scaled using the nearest neighborinterpolation with no smoothing. The resulting image will appear pixelated.
Default Value:true
Inherited from
Img.smoothing
src
readonly
public
src
:
SimpleSignal
string
Icon
The source of this image.
Examples
Inherited from
Img.src
start
readonly
public
start
:
SimpleSignal
number
Icon
A percentage from the start before which the curve should be clipped.
The portion of the curve that comes before the given percentage will bemade invisible.
This property is usefully for animating the curve appearing on the screen.The value of
0
means the very start of the curve (accounting for the
startOffset
) while
1
means the very end (accounting for the
endOffset
).
Img.start
startArrow
readonly
public
startArrow
:
SimpleSignal
boolean
Icon
Whether to display an arrow at the start of the visible curve.
Use
arrowSize
to control the size of the arrow.
Img.startArrow
startOffset
readonly
public
startOffset
:
SimpleSignal
number
Icon
The offset in pixels from the start of the curve.
This property lets you specify where along the defined curve the actualvisible portion starts. For example, setting it to
20
will make the first20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.If you want to animate the curve appearing on the screen, use
start
instead.
Img.startOffset
stroke
readonly
public
stroke
:
CanvasStyleSignal
Icon
Img.stroke
strokeFirst
readonly
public
strokeFirst
:
SimpleSignal
boolean
Icon
Img.strokeFirst
styles
public
styles
:
CSSStyleDeclaration
Img.styles
textAlign
readonly
public
textAlign
:
SimpleSignal
CanvasTextAlign
Icon
Img.textAlign
textDirection
readonly
public
textDirection
:
SimpleSignal
CanvasDirection
Icon
Img.textDirection
textWrap
readonly
public
textWrap
:
SimpleSignal
TextWrap
Icon
Img.textWrap
top
readonly
public
top
:
SimpleVector2Signal
Icon
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so thatthe top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parentspace.
Inherited from
Img.top
topLeft
readonly
public
topLeft
:
SimpleVector2Signal
Icon
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so thatthe top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in theparent space.
Inherited from
Img.topLeft
topRight
readonly
public
topRight
:
SimpleVector2Signal
Icon
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so thatthe top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in theparent space.
Inherited from
Img.topRight
wrap
readonly
public
wrap
:
SimpleSignal
FlexWrap
Icon
Img.wrap
zIndex
readonly
public
zIndex
:
SimpleSignal
number
Icon
Img.zIndex
Accessors
columnGap
Inherited from
Img.columnGap
height
Inherited from
Img.height
rowGap
Inherited from
Img.rowGap
width
Inherited from
Img.width
x
public
get
x
():
SimpleSignal
number
this
Img.x
y
public
get
y
():
SimpleSignal
number
this
Img.y
Methods
[iterator]
public
[iterator]
():
Generator
key
:
string
meta
:
PropertyMetadata
any
signal
:
SimpleSignal
any
void
void
unknown
Img.[iterator]
absoluteOpacity
public
absoluteOpacity
():
number
Img.absoluteOpacity
add
public
add
node
:
ComponentChildren
:
Icon
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
-
node : ComponentChildrenA node or an array of nodes to append.
Img.add
anchorPosition
public
anchorPosition
():
Vector2
Img.anchorPosition
applyState
Apply the given state to the node, setting all matching signal values tothe provided values.
Parameters
Inherited from
Img.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.
Img.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
.
Img.baseArcLength
cacheBBox
public
cacheBBox
():
BBox
Get a bounding box for the contents rendered by this node as wellas its children.
Inherited from
Img.cacheBBox
clone
public
clone
customProps
:
NodeProps
=
{}
:
Icon
Create a copy of this node.
Parameters
-
customProps : NodeProps = {}Properties to override.
Img.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.
Img.completion
compositeToLocal
public
compositeToLocal
():
DOMMatrix
Img.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
Img.compositeToWorld
computedPosition
public
computedPosition
():
Vector2
Img.computedPosition
dispose
public
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.
Inherited from
Img.dispose
distanceToPercentage
public
distanceToPercentage
value
:
number
:
number
Convert a distance along the curve to a percentage.
The distance should be given in relation to the full curve, notaccounting for
startOffset
and
endOffset
.
Parameters
-
value : numberThe distance along the curve.
Img.distanceToPercentage
drawOverlay
public
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
-
context : CanvasRenderingContext2DThe context to draw with.
-
matrix : DOMMatrixA local-to-screen matrix.
Img.drawOverlay
getColorAtPoint
public
getColorAtPoint
position
:
PossibleVector2
number
:
Color
Get color of the image at the given position.
Parameters
-
position : PossibleVector2 numberThe position in local space at which to sample the color.
Img.getColorAtPoint
getOriginDelta
public
getOriginDelta
origin
:
Origin
:
Vector2
Parameters
-
origin : Origin
Img.getOriginDelta
getPixelColor
public
getPixelColor
position
:
PossibleVector2
number
:
Color
Get color of the image at the given pixel.
Parameters
-
position : PossibleVector2 numberThe pixel's position.
Img.getPixelColor
getPointAtPercentage
public
getPointAtPercentage
value
:
number
:
CurvePoint
Parameters
-
value : number
Img.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 thenode at the time the method is called.
Inherited from
Img.getState
hit
public
hit
position
:
Vector2
:
null
Node
Try to find a node intersecting the given position.
Parameters
-
position : Vector2The searched position.
Img.hit
insert
public
insert
node
:
ComponentChildren
index
:
number
=
0
:
Icon
Insert the given node(s) at the specified index in the children list.
Examples
Parameters
-
node : ComponentChildrenA node or an array of nodes to insert.
-
index : number = 0An index at which to insert the node(s).
Img.insert
instantiate
public
instantiate
props
:
NodeProps
=
{}
:
Icon
Create an instance of this node's class.
Parameters
-
props : NodeProps = {}Properties to pass to the constructor.
Img.instantiate
isLayoutRoot
public
isLayoutRoot
():
boolean
Img.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 (withoutinheritance).
Img.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 spaceof this node's parent.
Inherited from
Img.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
Img.localToWorld
lockSize
public
lockSize
():
void
Img.lockSize
move
public
move
by
:
number
=
1
:
Icon
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 = 1Number of places by which the node should be moved.
Img.move
moveAbove
public
moveAbove
node
:
Node
directlyAbove
:
boolean
=
false
:
Icon
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 : NodeThe sibling node below which to move.
-
directlyAbove : boolean = falseWhether the node should be positioned directly above thesibling. When true, will move the node even if it isalready positioned above the sibling.
Img.moveAbove
moveBelow
public
moveBelow
node
:
Node
directlyBelow
:
boolean
=
false
:
Icon
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 : NodeThe sibling node below which to move.
-
directlyBelow : boolean = falseWhether the node should be positioned directly belowthe sibling. When true, will move the node even ifit is already positioned below the sibling.
Img.moveBelow
moveDown
public
moveDown
():
Icon
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
Img.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 : Vector2The new offset.
Img.moveOffset
moveTo
public
moveTo
index
:
number
:
Icon
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 : numberThe index to move the node to.
Img.moveTo
moveToBottom
public
moveToBottom
():
Icon
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
Img.moveToBottom
moveToTop
public
moveToTop
():
Icon
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
Img.moveToTop
moveUp
public
moveUp
():
Icon
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
Img.moveUp
naturalSize
public
naturalSize
():
Vector2
The natural size of this image.
The natural size is the size of the source image unaffected by the sizeand scale properties.
Inherited from
Img.naturalSize
offsetArcLength
public
offsetArcLength
():
number
The offset arc length of this curve.
This is the length of the curve that accounts for
the offsets
.
Img.offsetArcLength
percentageToDistance
public
percentageToDistance
value
:
number
:
number
Convert a percentage along the curve to a distance.
The returned distance is given in relation to the full curve, notaccounting for
startOffset
and
endOffset
.
Parameters
-
value : numberThe percentage along the curve.
Img.percentageToDistance
profile
public
profile
():
CurveProfile
Img.profile
reactiveClone
public
reactiveClone
customProps
:
NodeProps
=
{}
:
Icon
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match thesource node.
Parameters
-
customProps : NodeProps = {}Properties to override.
Img.reactiveClone
releaseSize
public
releaseSize
():
void
Img.releaseSize
remove
public
remove
():
Icon
Remove this node from the tree.
Inherited from
Img.remove
removeChildren
public
removeChildren
():
void
Remove all children of this node.
Inherited from
Img.removeChildren
render
public
render
context
:
CanvasRenderingContext2D
:
void
Render this node onto the given canvas.
Parameters
-
context : CanvasRenderingContext2DThe context to draw with.
Img.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 : NodeThe new parent of this node.
Img.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.
Providing a duration will tween the node to the restored state. Otherwise,it will be restored immediately.
Examples
Parameters
-
duration ?: numberThe duration of the transition.
-
timing : TimingFunction = easeInOutCubicThe timing function to use for the transition.
Img.restore
ripple
public
ripple
duration
:
number
=
1
:
Generator
void
ThreadGenerator
Promise
any
Promisable
any
void
any
Parameters
-
duration : number = 1
Img.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 anode's current state and later restore it. It is possible to store morethan one state by calling
save
method multiple times.
Img.save
snapshotClone
public
snapshotClone
customProps
:
NodeProps
=
{}
:
Icon
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
-
customProps : NodeProps = {}Properties to override.
Img.snapshotClone
toPromise
public
toPromise
():
Promise
Icon
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
Img.toPromise
view
public
view
():
View2D
Img.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
Img.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
Img.worldToParent