Circle
class
Circle
extends
Shape
A node for drawing circular shapes.
This node can be used to render shapes such as: circle, ellipse, arc, andsector (pie chart).
Examples
Constructors
constructor
Parameters
-
props : CircleProps
Shape.constructor
Properties
absolutePosition
readonly
public
absolutePosition
:
SimpleVector2Signal
Circle
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.
Shape.absolutePosition
absoluteRotation
readonly
public
absoluteRotation
:
SimpleSignal
number
Circle
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
Shape.absoluteRotation
absoluteScale
readonly
public
absoluteScale
:
SimpleVector2Signal
Circle
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.
Shape.absoluteScale
alignContent
readonly
public
alignContent
:
SimpleSignal
FlexContent
Circle
Shape.alignContent
alignItems
readonly
public
alignItems
:
SimpleSignal
FlexItems
Circle
Shape.alignItems
alignSelf
readonly
public
alignSelf
:
SimpleSignal
FlexItems
Circle
Shape.alignSelf
antialiased
readonly
public
antialiased
:
SimpleSignal
boolean
Circle
Shape.antialiased
basis
readonly
public
basis
:
SimpleSignal
FlexBasis
Circle
Shape.basis
cache
readonly
public
cache
:
SimpleSignal
boolean
Circle
Shape.cache
children
readonly
public
children
:
SimpleSignal
Node
[]
Circle
Shape.children
clip
readonly
public
clip
:
SimpleSignal
boolean
Circle
Shape.clip
closed
readonly
public
closed
:
SimpleSignal
boolean
Circle
Whether the path of this circle should be closed.
When set to true, the path of this circle will start and end at the center.This can be used to fine-tune how sectors are rendered.
Examples
Default Value:false
composite
readonly
public
composite
:
SimpleSignal
boolean
Circle
Shape.composite
compositeOperation
readonly
public
compositeOperation
:
SimpleSignal
GlobalCompositeOperation
Circle
Shape.compositeOperation
creationStack
readonly
public
creationStack
?:
string
Shape.creationStack
direction
readonly
public
direction
:
SimpleSignal
FlexDirection
Circle
Shape.direction
element
public
element
:
HTMLElement
Shape.element
endAngle
readonly
public
endAngle
:
SimpleSignal
number
Circle
The ending angle in degrees for the circle sector.
This property can be used together with
endAngle
to turn thiscircle into a sector (when using fill) or an arc (when using stroke).
360
fill
readonly
public
fill
:
CanvasStyleSignal
Circle
Shape.fill
filters
readonly
public
filters
:
FiltersSignal
Circle
Shape.filters
fontFamily
readonly
public
fontFamily
:
SimpleSignal
string
Circle
Shape.fontFamily
fontSize
readonly
public
fontSize
:
SimpleSignal
number
Circle
Shape.fontSize
fontStyle
readonly
public
fontStyle
:
SimpleSignal
string
Circle
Shape.fontStyle
fontWeight
readonly
public
fontWeight
:
SimpleSignal
number
Circle
Shape.fontWeight
gap
readonly
public
gap
:
Vector2LengthSignal
Circle
Shape.gap
grow
readonly
public
grow
:
SimpleSignal
number
Circle
Shape.grow
isClass
public
isClass
:
boolean
Shape.isClass
justifyContent
readonly
public
justifyContent
:
SimpleSignal
FlexContent
Circle
Shape.justifyContent
key
readonly
public
key
:
string
Shape.key
layout
readonly
public
layout
:
SimpleSignal
LayoutMode
Circle
Shape.layout
letterSpacing
readonly
public
letterSpacing
:
SimpleSignal
number
Circle
Shape.letterSpacing
lineCap
readonly
public
lineCap
:
SimpleSignal
CanvasLineCap
Circle
Shape.lineCap
lineDash
readonly
public
lineDash
:
SimpleSignal
number
[]
Circle
Shape.lineDash
lineDashOffset
readonly
public
lineDashOffset
:
SimpleSignal
number
Circle
Shape.lineDashOffset
lineHeight
readonly
public
lineHeight
:
SimpleSignal
Length
Circle
Shape.lineHeight
lineJoin
readonly
public
lineJoin
:
SimpleSignal
CanvasLineJoin
Circle
Shape.lineJoin
lineWidth
readonly
public
lineWidth
:
SimpleSignal
number
Circle
Shape.lineWidth
margin
readonly
public
margin
:
SpacingSignal
Circle
Shape.margin
maxHeight
readonly
public
maxHeight
:
SimpleSignal
LengthLimit
Circle
Shape.maxHeight
maxWidth
readonly
public
maxWidth
:
SimpleSignal
LengthLimit
Circle
Shape.maxWidth
minHeight
readonly
public
minHeight
:
SimpleSignal
LengthLimit
Circle
Shape.minHeight
minWidth
readonly
public
minWidth
:
SimpleSignal
LengthLimit
Circle
Shape.minWidth
offset
readonly
public
offset
:
Vector2Signal
Circle
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
Shape.offset
opacity
readonly
public
opacity
:
SimpleSignal
number
Circle
Shape.opacity
padding
readonly
public
padding
:
SpacingSignal
Circle
Shape.padding
parent
readonly
public
parent
:
SimpleSignal
null
Node
void
=
...
Shape.parent
position
readonly
public
position
:
Vector2Signal
Circle
Represents the position of this node in local space of its parent.
Examples
Inherited from
Shape.position
properties
readonly
public
properties
:
Record
string
PropertyMetadata
any
=
...
Shape.properties
ratio
readonly
public
ratio
:
SimpleSignal
null
number
Circle
Shape.ratio
rotation
readonly
public
rotation
:
SimpleSignal
number
Circle
Represents the rotation (in degrees) of this node relative to its parent.
Inherited from
Shape.rotation
scale
readonly
public
scale
:
Vector2Signal
Circle
Represents the scale of this node in local space of its parent.
Examples
Inherited from
Shape.scale
shadowBlur
readonly
public
shadowBlur
:
SimpleSignal
number
Circle
Shape.shadowBlur
shadowColor
readonly
public
shadowColor
:
ColorSignal
Circle
Shape.shadowColor
shadowOffset
readonly
public
shadowOffset
:
Vector2Signal
Circle
Shape.shadowOffset
shrink
readonly
public
shrink
:
SimpleSignal
number
Circle
Shape.shrink
size
readonly
public
size
:
Vector2LengthSignal
Circle
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
Shape.size
startAngle
readonly
public
startAngle
:
SimpleSignal
number
Circle
The starting angle in degrees for the circle sector.
This property can be used together with
startAngle
to turn thiscircle into a sector (when using fill) or an arc (when using stroke).
0
stroke
readonly
public
stroke
:
CanvasStyleSignal
Circle
Shape.stroke
strokeFirst
readonly
public
strokeFirst
:
SimpleSignal
boolean
Circle
Shape.strokeFirst
styles
public
styles
:
CSSStyleDeclaration
Shape.styles
textAlign
readonly
public
textAlign
:
SimpleSignal
CanvasTextAlign
Circle
Shape.textAlign
textDirection
readonly
public
textDirection
:
SimpleSignal
CanvasDirection
Circle
Shape.textDirection
textWrap
readonly
public
textWrap
:
SimpleSignal
TextWrap
Circle
Shape.textWrap
wrap
readonly
public
wrap
:
SimpleSignal
FlexWrap
Circle
Shape.wrap
zIndex
readonly
public
zIndex
:
SimpleSignal
number
Circle
Shape.zIndex
Accessors
columnGap
Inherited from
Shape.columnGap
height
Inherited from
Shape.height
rowGap
Inherited from
Shape.rowGap
width
Inherited from
Shape.width
Methods
[iterator]
public
[iterator]
():
Generator
key
:
string
meta
:
PropertyMetadata
any
signal
:
SimpleSignal
any
void
void
unknown
Shape.[iterator]
absoluteOpacity
public
absoluteOpacity
():
number
Shape.absoluteOpacity
add
public
add
node
:
ComponentChildren
:
Circle
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.
Shape.add
anchorPosition
public
anchorPosition
():
Vector2
Shape.anchorPosition
applyState
Apply the given state to the node, setting all matching signal values tothe provided values.
Parameters
Inherited from
Shape.applyState
cacheBBox
public
cacheBBox
():
BBox
Get a bounding box for the contents rendered by this node as wellas its children.
Inherited from
Shape.cacheBBox
clone
public
clone
customProps
:
NodeProps
=
{}
:
Circle
Create a copy of this node.
Parameters
-
customProps : NodeProps = {}Properties to override.
Shape.clone
compositeToLocal
public
compositeToLocal
():
DOMMatrix
Shape.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
Shape.compositeToWorld
computedPosition
public
computedPosition
():
Vector2
Shape.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
Shape.dispose
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.
Shape.drawOverlay
getOriginDelta
public
getOriginDelta
origin
:
Origin
:
Vector2
Parameters
-
origin : Origin
Shape.getOriginDelta
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
Shape.getState
hit
public
hit
position
:
Vector2
:
null
Node
Try to find a node intersecting the given position.
Parameters
-
position : Vector2The searched position.
Shape.hit
insert
public
insert
node
:
ComponentChildren
index
:
number
=
0
:
Circle
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).
Shape.insert
instantiate
public
instantiate
props
:
NodeProps
=
{}
:
Circle
Create an instance of this node's class.
Parameters
-
props : NodeProps = {}Properties to pass to the constructor.
Shape.instantiate
isLayoutRoot
public
isLayoutRoot
():
boolean
Shape.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).
Shape.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
Shape.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
Shape.localToWorld
lockSize
public
lockSize
():
void
Shape.lockSize
move
public
move
by
:
number
=
1
:
Circle
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.
Shape.move
moveAbove
public
moveAbove
node
:
Node
directlyAbove
:
boolean
=
false
:
Circle
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.
Shape.moveAbove
moveBelow
public
moveBelow
node
:
Node
directlyBelow
:
boolean
=
false
:
Circle
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.
Shape.moveBelow
moveDown
public
moveDown
():
Circle
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
Shape.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.
Shape.moveOffset
moveTo
public
moveTo
index
:
number
:
Circle
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.
Shape.moveTo
moveToBottom
public
moveToBottom
():
Circle
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
Shape.moveToBottom
moveToTop
public
moveToTop
():
Circle
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
Shape.moveToTop
moveUp
public
moveUp
():
Circle
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
Shape.moveUp
reactiveClone
public
reactiveClone
customProps
:
NodeProps
=
{}
:
Circle
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.
Shape.reactiveClone
releaseSize
public
releaseSize
():
void
Shape.releaseSize
remove
public
remove
():
Circle
Remove this node from the tree.
Inherited from
Shape.remove
removeChildren
public
removeChildren
():
void
Remove all children of this node.
Inherited from
Shape.removeChildren
render
public
render
context
:
CanvasRenderingContext2D
:
void
Render this node onto the given canvas.
Parameters
-
context : CanvasRenderingContext2DThe context to draw with.
Shape.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.
Shape.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 : numberThe duration of the transition
-
timing : TimingFunction = easeInOutCubicThe timing function to use for the transition
Shape.restore
ripple
public
ripple
duration
:
number
=
1
:
Generator
void
ThreadGenerator
Promise
any
Promisable
any
void
any
Parameters
-
duration : number = 1
Shape.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.
Shape.save
snapshotClone
public
snapshotClone
customProps
:
NodeProps
=
{}
:
Circle
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.
Shape.snapshotClone
toPromise
public
toPromise
():
Promise
Circle
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
Shape.toPromise
view
public
view
():
View2D
Shape.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
Shape.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
Shape.worldToParent