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
OverwritesImg.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalIcon
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Img.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberIcon
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Inherited fromImg.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalIcon
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Img.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentIcon
Img.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsIcon
Img.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsIcon
Img.alignSelfalpha
readonly public alpha: SimpleSignalnumberIcon
The alpha value of this image.
Unlike opacity, the alpha value affects only the image itself, leaving the fill, stroke, and children intact.
Inherited fromImg.alphaantialiased
readonly public antialiased: SimpleSignalbooleanIcon
Img.antialiasedarrowSize
readonly public arrowSize: SimpleSignalnumberIcon
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow and/or
endArrow.
Img.arrowSizeassetRoot
public assetRoot?: `${string}/`
Img.assetRootbasis
readonly public basis: SimpleSignalFlexBasisIcon
Img.basisbottom
readonly public bottom: SimpleVector2SignalIcon
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromImg.bottombottomLeft
readonly public bottomLeft: SimpleVector2SignalIcon
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromImg.bottomLeftbottomRight
readonly public bottomRight: SimpleVector2SignalIcon
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromImg.bottomRightcache
readonly public cache: SimpleSignalbooleanIcon
Img.cachecachePadding
readonly public cachePadding: SpacingSignalIcon
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
Img.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]IconSignalContextComponentChildrenNode[]Icon
Img.childrenclip
readonly public clip: SimpleSignalbooleanIcon
Img.clipclosed
readonly public closed: SimpleSignalbooleanIcon
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromImg.closedcolor
public color: ColorSignalIcon
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: SimpleSignalbooleanIcon
Img.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationIcon
Img.compositeOperationcornerSharpness
readonly public cornerSharpness: SimpleSignalnumberIcon
Controls the sharpness of smoothCorners.
This property only affects the way rounded corners are drawn. To control
the 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 fromImg.cornerSharpnesscreationStack
readonly public creationStack?: string
Img.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionIcon
Img.directionelement
public element: HTMLElement
Img.elementend
readonly public end: SimpleSignalnumberIcon
A percentage from the start after which the curve should be clipped.
The portion of the curve that comes after the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0 means the very start of the curve (accounting for the
startOffset) while 1 means the very end (accounting for the
endOffset).
Img.endendArrow
readonly public endArrow: SimpleSignalbooleanIcon
Whether to display an arrow at the end of the visible curve.
Use arrowSize to control the size of the arrow.
Img.endArrowendOffset
readonly public endOffset: SimpleSignalnumberIcon
The offset in pixels from the end of the curve.
This property lets you specify where along the defined curve the actual
visible portion ends. For example, setting it to 20 will make the last
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use end
instead.
Img.endOffsetfill
readonly public fill: CanvasStyleSignalIcon
Img.fillfilters
readonly public filters: FiltersSignalIcon
Img.filtersfontFamily
readonly public fontFamily: SimpleSignalstringIcon
Img.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberIcon
Img.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringIcon
Img.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberIcon
Img.fontWeightgap
readonly public gap: Vector2LengthSignalIcon
Img.gapgrow
readonly public grow: SimpleSignalnumberIcon
Img.growicon
public icon: SimpleSignalstringIcon
The identifier of the icon.
You can find identifiers on Icônes. They can look like this:
mdi:language-typescriptph:anchor-simple-boldph:activity-bold
isClass
public isClass: boolean
Img.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentIcon
Img.justifyContentkey
readonly public key: string
Img.keylayout
readonly public layout: SimpleSignalLayoutModeIcon
Img.layoutleft
readonly public left: SimpleVector2SignalIcon
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parent space.
Inherited fromImg.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberIcon
Img.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapIcon
Img.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Icon
Img.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberIcon
Img.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthIcon
Img.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinIcon
Img.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberIcon
Img.lineWidthmargin
readonly public margin: SpacingSignalIcon
Img.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitIcon
Img.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitIcon
Img.maxWidthmiddle
readonly public middle: SimpleVector2SignalIcon
The position of the center of this node.
When set, this shortcut property will modify the node's position so that the center ends up in the given place.
If the offset has not been changed, this will be the same as the
position.
When retrieved, it will return the position of the center in the parent space.
Inherited fromImg.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitIcon
Img.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitIcon
Img.minWidthoffset
readonly public offset: Vector2SignalIcon
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.
The value is relative to the size of this node. A value of 1 means as far
to the right/bottom as possible. Here are a few examples of offsets:
[-1, -1]- top left corner[1, -1]- top right corner[0, 1]- bottom edge[-1, 1]- bottom left corner
Img.offsetopacity
readonly public opacity: SimpleSignalnumberIcon
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromImg.opacitypadding
readonly public padding: SpacingSignalIcon
Img.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
Img.parentposition
readonly public position: Vector2SignalIcon
Represents the position of this node in local space of its parent.
Examples
Inherited fromImg.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Img.propertiesradius
readonly public radius: SpacingSignalIcon
Rounds the corners of this rectangle.
The value represents the radius of the quarter circle that is used to round the corners. If the value is a number, the same radius is used for all corners. Passing an array of two to four numbers will set individual radii for each corner. Individual radii correspond to different corners depending on 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 fromImg.radiusratio
readonly public ratio: SimpleSignalnullnumberIcon
Img.ratioright
readonly public right: SimpleVector2SignalIcon
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parent space.
Inherited fromImg.rightrotation
readonly public rotation: SimpleSignalnumberIcon
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromImg.rotationscale
readonly public scale: Vector2SignalIcon
Represents the scale of this node in local space of its parent.
Examples
Inherited fromImg.scaleshaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]IconSignalContextPossibleShaderConfigShaderConfig[]Icon
Img.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberIcon
Img.shadowBlurshadowColor
readonly public shadowColor: ColorSignalIcon
Img.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalIcon
Img.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberIcon
Img.shrinksize
readonly public size: Vector2LengthSignalIcon
Represents the size of this node.
A size is a two-dimensional vector, where x represents the width, and y
represents the height.
The value of both x and y is of type Length which is
either:
number- the desired length in pixels${number}%- a string with the desired length in percents, for example'50%'null- an automatic length
When retrieving the size, all units are converted to pixels, using the
current state of the layout. For example, retrieving the width set to
'50%', while the parent has a width of 200px will result in the number
100 being returned.
When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.
Examples
Inherited fromImg.sizeskew
readonly public skew: Vector2SignalIcon
Represents the skew of this node in local space of its parent.
Examples
Inherited fromImg.skewsmoothCorners
readonly public smoothCorners: SimpleSignalbooleanIcon
Enables corner smoothing.
This property only affects the way rounded corners are drawn. To control
the corner radius use the radius property.
When enabled, rounded corners are drawn continuously using Bézier curves
rather than quarter circles. The sharpness of the curve can be controlled
with cornerSharpness.
You can read more about corner smoothing in this article by Nick Lawrence.
Examples
Inherited fromImg.smoothCornerssmoothing
readonly public smoothing: SimpleSignalbooleanIcon
Whether the image should be smoothed.
When disabled, the image will be scaled using the nearest neighbor interpolation with no smoothing. The resulting image will appear pixelated.
Default Value:trueInherited from Img.smoothingsrc
readonly public src: SimpleSignalstringIcon
The source of this asset.
Examples
Inherited fromImg.srcstart
readonly public start: SimpleSignalnumberIcon
A percentage from the start before which the curve should be clipped.
The portion of the curve that comes before the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0 means the very start of the curve (accounting for the
startOffset) while 1 means the very end (accounting for the
endOffset).
Img.startstartArrow
readonly public startArrow: SimpleSignalbooleanIcon
Whether to display an arrow at the start of the visible curve.
Use arrowSize to control the size of the arrow.
Img.startArrowstartOffset
readonly public startOffset: SimpleSignalnumberIcon
The offset in pixels from the start of the curve.
This property lets you specify where along the defined curve the actual
visible portion starts. For example, setting it to 20 will make the first
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use start
instead.
Img.startOffsetstroke
readonly public stroke: CanvasStyleSignalIcon
Img.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanIcon
Img.strokeFirststyles
public styles: CSSStyleDeclaration
Img.stylestextAlign
readonly public textAlign: SimpleSignalCanvasTextAlignIcon
Img.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionIcon
Img.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapIcon
Img.textWraptop
readonly public top: SimpleVector2SignalIcon
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parent space.
Inherited fromImg.toptopLeft
readonly public topLeft: SimpleVector2SignalIcon
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in the parent space.
Inherited fromImg.topLefttopRight
readonly public topRight: SimpleVector2SignalIcon
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in the parent space.
Inherited fromImg.topRightwrap
readonly public wrap: SimpleSignalFlexWrapIcon
Img.wrapzIndex
readonly public zIndex: SimpleSignalnumberIcon
Img.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Img.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Img.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Img.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Img.widthx
public get x(): SimpleSignalnumberthis
Img.xy
public get y(): SimpleSignalnumberthis
Img.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Img.[iterator]absoluteOpacity
public absoluteOpacity(): number
Img.absoluteOpacityadd
public addnode: 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.addanchorPosition
public anchorPosition(): Vector2
Img.anchorPositionapplyState
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
Inherited fromImg.applyStatearcLength
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.arcLengthbaseArcLength
public baseArcLength(): number
The base arc length of this curve.
This is the entire length of this curve, not accounting for
the offsets.
Img.baseArcLengthcacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromImg.cacheBBoxchildAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: numberThe index of the child to retrieve.
Img.childAschildrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromImg.childrenAsclone
public clonecustomProps: NodeState = {}: Icon
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Img.clonecompletion
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.completioncompositeToLocal
public compositeToLocal(): DOMMatrix
Img.compositeToLocalcompositeToWorld
public compositeToWorld(): DOMMatrix
A matrix mapping composite space to world space.
Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closest composite root.
Inherited fromImg.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Img.computedPositiondispose
public dispose(): void
Img.disposedistanceToPercentage
public distanceToPercentagevalue: number: number
Convert a distance along the curve to a percentage.
The distance should be given in relation to the full curve, not
accounting for startOffset and endOffset.
Parameters
value: numberThe distance along the curve.
Img.distanceToPercentagedrawOverlay
public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void
Parameters
Inherited fromImg.drawOverlayfindAll
Find all descendants of this node that match the given predicate.
Type Parameters
Parameters
Inherited fromImg.findAllfindAncestor
Find the closest ancestor of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromImg.findAncestorfindFirst
Find the first descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromImg.findFirstfindLast
Find the last descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromImg.findLastfullSource
public fullSource(): string
Img.fullSourcegetColorAtPoint
public getColorAtPointposition: PossibleVector2number: Color
Get color of the image at the given position.
Parameters
position: PossibleVector2numberThe position in local space at which to sample the color.
Img.getColorAtPointgetOriginDelta
Parameters
Inherited fromImg.getOriginDeltagetPixelColor
public getPixelColorposition: PossibleVector2number: Color
Get color of the image at the given pixel.
Parameters
position: PossibleVector2numberThe pixel's position.
Img.getPixelColorgetPointAtPercentage
public getPointAtPercentagevalue: number: CurvePoint
Parameters
value: number
Img.getPointAtPercentagegetState
public getState(): NodeState
Return a snapshot of the node's current signal values.
This method will calculate the values of any reactive properties of the node at the time the method is called.
Inherited fromImg.getStatehit
Parameters
Inherited fromImg.hitinsert
public insertnode: ComponentChildrenindex: 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.insertinstantiate
Create an instance of this node's class.
Parameters
Inherited fromImg.instantiateisLayoutRoot
public isLayoutRoot(): boolean
Img.isLayoutRootlayoutEnabled
public layoutEnabled(): boolean
Get the resolved layout mode of this node.
When the mode is null, its value will be inherited from the parent.
Use layout to get the raw mode set for this node (without
inheritance).
Img.layoutEnabledlocalToParent
public localToParent(): DOMMatrix
Img.localToParentlocalToWorld
public localToWorld(): DOMMatrix
Get the local-to-world matrix for this node.
This matrix transforms vectors from local space of this node to world space.
Examples
Inherited fromImg.localToWorldlockSize
public lockSize(): void
Img.lockSizemove
Rearrange this node in relation to its siblings.
Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.
A positive by arguments move the node up (it will be rendered on top of
the elements it has passed). Negative values move it down.
Parameters
by: number = 1Number of places by which the node should be moved.
Img.movemoveAbove
public moveAbovenode: NodedirectlyAbove: 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 be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyAbove: boolean = falseWhether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Img.moveAbovemoveBelow
public moveBelownode: NodedirectlyBelow: 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 be rendered below it. By default, if the node is already positioned lower than the 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 below the sibling. When true, will move the node even if it is already positioned below the sibling.
Img.moveBelowmoveDown
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) and from then on will be rendered under it.
Inherited fromImg.moveDownmoveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromImg.moveOffsetmoveTo
Move the node to the provided position relative to its siblings.
If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).
Parameters
index: numberThe index to move the node to.
Img.moveTomoveToBottom
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 then on will be rendered below all of its siblings.
Inherited fromImg.moveToBottommoveToTop
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 on will be rendered on top of all of its siblings.
Inherited fromImg.moveToTopmoveUp
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) and from then on will be rendered on top of it.
Inherited fromImg.moveUpnaturalSize
public naturalSize(): Vector2
The natural size of this image.
The natural size is the size of the source image unaffected by the size and scale properties.
Inherited fromImg.naturalSizeoffsetArcLength
public offsetArcLength(): number
The offset arc length of this curve.
This is the length of the curve that accounts for
the offsets.
Img.offsetArcLengthparentAs
Get the parent cast to the specified type.
Type Parameters
Inherited fromImg.parentAspeekChildren
public peekChildren(): readonly Node[]
Get the current children of this node.
Unlike children, this method does not have any side effects.
It does not register the children signal as a dependency, and it does not
spawn any children. It can be used to safely retrieve the current state of
the scene graph for debugging purposes.
Img.peekChildrenpercentageToDistance
public percentageToDistancevalue: number: number
Convert a percentage along the curve to a distance.
The returned distance is given in relation to the full curve, not
accounting for startOffset and endOffset.
Parameters
value: numberThe percentage along the curve.
Img.percentageToDistanceprofile
public profile(): CurveProfile
Img.profilereactiveClone
public reactiveClonecustomProps: NodeState = {}: Icon
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match the source node.
Parameters
customProps: NodeState = {}Properties to override.
Img.reactiveClonereleaseSize
public releaseSize(): void
Img.releaseSizeremove
public remove(): Icon
Remove this node from the tree.
Inherited fromImg.removeremoveChildren
public removeChildren(): void
Remove all children of this node.
Inherited fromImg.removeChildrenrender
public rendercontext: CanvasRenderingContext2D: Promisevoid
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
Img.renderreparent
Change the parent of this node while keeping the absolute transform.
After performing this operation, the node will stay in the same place visually, but its parent will be changed.
Parameters
Inherited fromImg.reparentrestore
public restore(): void
public restoreduration: numbertiming?: TimingFunction: ThreadGenerator
Restore the node to its last saved state.
This method can be used together with the save method to restore a
node to a previously saved state. Restoring a node to a previous state
removes that state from the state stack.
Examples
Inherited fromImg.restoreripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
Parameters
duration: number = 1
Img.ripplesave
public save(): void
Push a snapshot of the node's current state onto the node's state stack.
This method can be used together with the restore method to save a
node's current state and later restore it. It is possible to store more
than one state by calling save method multiple times.
Img.savesnapshotClone
public snapshotClonecustomProps: NodeState = {}: Icon
Create a copy of this node.
Unlike clone, a snapshot clone calculates any reactive properties
at the moment of cloning and passes the raw values to the copy.
Parameters
customProps: NodeState = {}Properties to override.
Img.snapshotClonetoPromise
Wait for any asynchronous resources that this node or its children have.
Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.
Inherited fromImg.toPromiseview
public view(): View2D
Img.viewworldToLocal
public worldToLocal(): DOMMatrix
Get the world-to-local matrix for this node.
This matrix transforms vectors from world space to local space of this node.
Examples
Inherited fromImg.worldToLocalworldToParent
public worldToParent(): DOMMatrix
Get the world-to-parent matrix for this node.
This matrix transforms vectors from world space to local space of this node's parent.
Inherited fromImg.worldToParent