Circle
class Circle extends Shape
A node for drawing circular shapes.
This node can be used to render shapes such as: circle, ellipse, arc, and sector (pie chart).
import ...
export default makeScene2D(function* (view) {
view.add(
<Circle
size={160}
fill={'lightseagreen'}
/>
);
});
Constructors
constructor
public override new Circleprops: CircleProps: Circle
Parameters
OverwritesShape.constructor
Properties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalCircle
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.
Shape.absolutePosition
absoluteRotation
readonly public absoluteRotation: SimpleSignalnumberCircle
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 fromShape.absoluteRotation
absoluteScale
readonly public absoluteScale: SimpleVector2SignalCircle
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.
Shape.absoluteScale
alignContent
readonly public alignContent: SimpleSignalFlexContentCircle
Shape.alignContent
alignItems
readonly public alignItems: SimpleSignalFlexItemsCircle
Shape.alignItems
alignSelf
readonly public alignSelf: SimpleSignalFlexItemsCircle
Shape.alignSelf
antialiased
readonly public antialiased: SimpleSignalbooleanCircle
Shape.antialiased
basis
readonly public basis: SimpleSignalFlexBasisCircle
Shape.basis
bottom
readonly public bottom: SimpleVector2SignalCircle
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 fromShape.bottom
bottomLeft
readonly public bottomLeft: SimpleVector2SignalCircle
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 fromShape.bottomLeft
bottomRight
readonly public bottomRight: SimpleVector2SignalCircle
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 fromShape.bottomRight
cache
readonly public cache: SimpleSignalbooleanCircle
Shape.cache
children
readonly public children: SimpleSignalNode[]Circle
Shape.children
clip
readonly public clip: SimpleSignalbooleanCircle
Shape.clip
closed
readonly public closed: SimpleSignalbooleanCircle
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: SimpleSignalbooleanCircle
Shape.composite
compositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationCircle
Shape.compositeOperation
creationStack
readonly public creationStack?: string
Shape.creationStack
direction
readonly public direction: SimpleSignalFlexDirectionCircle
Shape.direction
element
public element: HTMLElement
Shape.element
endAngle
readonly public endAngle: SimpleSignalnumberCircle
The ending angle in degrees for the circle sector.
This property can be used together with endAngle
to turn this
circle into a sector (when using fill) or an arc (when using stroke).
360
fill
readonly public fill: CanvasStyleSignalCircle
Shape.fill
filters
readonly public filters: FiltersSignalCircle
Shape.filters
fontFamily
readonly public fontFamily: SimpleSignalstringCircle
Shape.fontFamily
fontSize
readonly public fontSize: SimpleSignalnumberCircle
Shape.fontSize
fontStyle
readonly public fontStyle: SimpleSignalstringCircle
Shape.fontStyle
fontWeight
readonly public fontWeight: SimpleSignalnumberCircle
Shape.fontWeight
gap
readonly public gap: Vector2LengthSignalCircle
Shape.gap
grow
readonly public grow: SimpleSignalnumberCircle
Shape.grow
isClass
public isClass: boolean
Shape.isClass
justifyContent
readonly public justifyContent: SimpleSignalFlexContentCircle
Shape.justifyContent
key
readonly public key: string
Shape.key
layout
readonly public layout: SimpleSignalLayoutModeCircle
Shape.layout
left
readonly public left: SimpleVector2SignalCircle
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 fromShape.left
letterSpacing
readonly public letterSpacing: SimpleSignalnumberCircle
Shape.letterSpacing
lineCap
readonly public lineCap: SimpleSignalCanvasLineCapCircle
Shape.lineCap
lineDash
readonly public lineDash: SimpleSignalnumber[]Circle
Shape.lineDash
lineDashOffset
readonly public lineDashOffset: SimpleSignalnumberCircle
Shape.lineDashOffset
lineHeight
readonly public lineHeight: SimpleSignalLengthCircle
Shape.lineHeight
lineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinCircle
Shape.lineJoin
lineWidth
readonly public lineWidth: SimpleSignalnumberCircle
Shape.lineWidth
margin
readonly public margin: SpacingSignalCircle
Shape.margin
maxHeight
readonly public maxHeight: SimpleSignalLengthLimitCircle
Shape.maxHeight
maxWidth
readonly public maxWidth: SimpleSignalLengthLimitCircle
Shape.maxWidth
minHeight
readonly public minHeight: SimpleSignalLengthLimitCircle
Shape.minHeight
minWidth
readonly public minWidth: SimpleSignalLengthLimitCircle
Shape.minWidth
offset
readonly public offset: Vector2SignalCircle
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
Shape.offset
opacity
readonly public opacity: SimpleSignalnumberCircle
Shape.opacity
padding
readonly public padding: SpacingSignalCircle
Shape.padding
parent
readonly public parent: SimpleSignalnullNodevoid = ...
Shape.parent
position
readonly public position: Vector2SignalCircle
Represents the position of this node in local space of its parent.
Examples
Inherited fromShape.position
properties
readonly public properties: RecordstringPropertyMetadataany = ...
Shape.properties
ratio
readonly public ratio: SimpleSignalnullnumberCircle
Shape.ratio
right
readonly public right: SimpleVector2SignalCircle
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 fromShape.right
rotation
readonly public rotation: SimpleSignalnumberCircle
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromShape.rotation
scale
readonly public scale: Vector2SignalCircle
Represents the scale of this node in local space of its parent.
Examples
Inherited fromShape.scale
shadowBlur
readonly public shadowBlur: SimpleSignalnumberCircle
Shape.shadowBlur
shadowColor
readonly public shadowColor: ColorSignalCircle
Shape.shadowColor
shadowOffset
readonly public shadowOffset: Vector2SignalCircle
Shape.shadowOffset
shrink
readonly public shrink: SimpleSignalnumberCircle
Shape.shrink
size
readonly public size: Vector2LengthSignalCircle
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 fromShape.size
startAngle
readonly public startAngle: SimpleSignalnumberCircle
The starting angle in degrees for the circle sector.
This property can be used together with startAngle
to turn this
circle into a sector (when using fill) or an arc (when using stroke).
0
stroke
readonly public stroke: CanvasStyleSignalCircle
Shape.stroke
strokeFirst
readonly public strokeFirst: SimpleSignalbooleanCircle
Shape.strokeFirst
styles
public styles: CSSStyleDeclaration
Shape.styles
textAlign
readonly public textAlign: SimpleSignalCanvasTextAlignCircle
Shape.textAlign
textDirection
readonly public textDirection: SimpleSignalCanvasDirectionCircle
Shape.textDirection
textWrap
readonly public textWrap: SimpleSignalTextWrapCircle
Shape.textWrap
top
readonly public top: SimpleVector2SignalCircle
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 fromShape.top
topLeft
readonly public topLeft: SimpleVector2SignalCircle
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 fromShape.topLeft
topRight
readonly public topRight: SimpleVector2SignalCircle
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 fromShape.topRight
wrap
readonly public wrap: SimpleSignalFlexWrapCircle
Shape.wrap
zIndex
readonly public zIndex: SimpleSignalnumberCircle
Shape.zIndex
Accessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.columnGap
height
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.height
rowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.rowGap
width
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.width
x
public get x(): SimpleSignalnumberthis
Shape.x
y
public get y(): SimpleSignalnumberthis
Shape.y
Methods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Shape.[iterator]
absoluteOpacity
public absoluteOpacity(): number
Shape.absoluteOpacity
add
public addnode: 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: ComponentChildren
A 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 to the provided values.
Parameters
Inherited fromShape.applyState
cacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromShape.cacheBBox
clone
public clonecustomProps: 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 effect appears relative to the closes composite root.
Inherited fromShape.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 will be called even if the node is not currently attached to the tree.
The goal of this method is to clean any external references to allow the node to be garbage collected.
Inherited fromShape.dispose
drawOverlay
public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void
Draw an overlay for this node.
The overlay for the currently inspected node is displayed on top of the canvas.
The provided context is in screen space. The local-to-screen matrix can be used to transform all shapes that need to be displayed. This approach allows to keep the line widths and gizmo sizes consistent, no matter how zoomed-in the view is.
Parameters
context: CanvasRenderingContext2D
The context to draw with.
matrix: DOMMatrix
A local-to-screen matrix.
Shape.drawOverlay
getOriginDelta
Parameters
Inherited fromShape.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 the node at the time the method is called.
Inherited fromShape.getState
hit
Try to find a node intersecting the given position.
Parameters
Inherited fromShape.hit
insert
public insertnode: ComponentChildrenindex: number = 0: Circle
Insert the given node(s) at the specified index in the children list.
Examples
Parameters
node: ComponentChildren
A node or an array of nodes to insert.
index: number = 0
An index at which to insert the node(s).
Shape.insert
instantiate
Create an instance of this node's class.
Parameters
Inherited fromShape.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 (without
inheritance).
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 space of this node's parent.
Inherited fromShape.localToParent
localToWorld
public localToWorld(): DOMMatrix
Get the local-to-world matrix for this node.
This matrix transforms vectors from local space of this node to world space.
Examples
Inherited fromShape.localToWorld
lockSize
public lockSize(): void
Shape.lockSize
move
Rearrange this node in relation to its siblings.
Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.
A positive by
arguments move the node up (it will be rendered on top of
the elements it has passed). Negative values move it down.
Parameters
by: number = 1
Number of places by which the node should be moved.
Shape.move
moveAbove
public moveAbovenode: NodedirectlyAbove: 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 be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.
Parameters
node: Node
The sibling node below which to move.
directlyAbove: boolean = false
Whether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Shape.moveAbove
moveBelow
public moveBelownode: NodedirectlyBelow: 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 be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.
Parameters
node: Node
The sibling node below which to move.
directlyBelow: boolean = false
Whether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.
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) and from then on will be rendered under it.
Inherited fromShape.moveDown
moveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromShape.moveOffset
moveTo
Move the node to the provided position relative to its siblings.
If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).
Parameters
index: number
The index to move the node to.
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 then on will be rendered below all of its siblings.
Inherited fromShape.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 on will be rendered on top of all of its siblings.
Inherited fromShape.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) and from then on will be rendered on top of it.
Inherited fromShape.moveUp
reactiveClone
public reactiveClonecustomProps: NodeProps = {}: Circle
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match the source 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 fromShape.remove
removeChildren
public removeChildren(): void
Remove all children of this node.
Inherited fromShape.removeChildren
render
public rendercontext: CanvasRenderingContext2D: void
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2D
The context to draw with.
Shape.render
reparent
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 fromShape.reparent
restore
public restoreduration: numbertiming: TimingFunction = easeInOutCubic: undefinedThreadGenerator
Restore the node to its last saved state.
This method can be used together with the save
method to restore a
node to a previously saved state. Restoring a node to a previous state
removes that state from the state stack.
Examples
Parameters
duration: number
The duration of the transition
timing: TimingFunction = easeInOutCubic
The timing function to use for the transition
Shape.restore
ripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
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 a
node's current state and later restore it. It is possible to store more
than one state by calling save
method multiple times.
Shape.save
snapshotClone
public snapshotClonecustomProps: NodeProps = {}: Circle
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: NodeProps = {}
Properties to override.
Shape.snapshotClone
toPromise
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 fromShape.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 this node.
Examples
Inherited fromShape.worldToLocal
worldToParent
public worldToParent(): DOMMatrix
Get the world-to-parent matrix for this node.
This matrix transforms vectors from world space to local space of this node's parent.
Inherited fromShape.worldToParent