class Circle extends Curve
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
Parameters
props: CircleProps
Curve.constructorProperties
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.
Curve.absolutePositionabsoluteRotation
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 fromCurve.absoluteRotationabsoluteScale
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.
Curve.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentCircle
Curve.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsCircle
Curve.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsCircle
Curve.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanCircle
Curve.antialiasedarrowSize
readonly public arrowSize: SimpleSignalnumberCircle
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow and/or
endArrow.
Curve.arrowSizebasis
readonly public basis: SimpleSignalFlexBasisCircle
Curve.basisbottom
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 fromCurve.bottombottomLeft
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 fromCurve.bottomLeftbottomRight
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 fromCurve.bottomRightcache
readonly public cache: SimpleSignalbooleanCircle
Curve.cachecachePadding
readonly public cachePadding: SpacingSignalCircle
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.
Curve.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]CircleSignalContextComponentChildrenNode[]Circle
Curve.childrenclip
readonly public clip: SimpleSignalbooleanCircle
Curve.clipclosed
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:falsecomposite
readonly public composite: SimpleSignalbooleanCircle
Curve.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationCircle
Curve.compositeOperationcounterclockwise
readonly public counterclockwise: SimpleSignalbooleanCircle
Whether the circle sector should be drawn counterclockwise.
By default, the circle begins at startAngle and is drawn clockwise
until reaching endAngle. Setting this property to true will reverse
this direction.
creationStack
readonly public creationStack?: string
Curve.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionCircle
Curve.directionelement
public element: HTMLElement
Curve.elementend
readonly public end: SimpleSignalnumberCircle
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).
Curve.endendAngle
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).
360endArrow
readonly public endArrow: SimpleSignalbooleanCircle
Whether to display an arrow at the end of the visible curve.
Use arrowSize to control the size of the arrow.
Curve.endArrowendOffset
readonly public endOffset: SimpleSignalnumberCircle
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.
Curve.endOffsetfill
readonly public fill: CanvasStyleSignalCircle
Curve.fillfilters
readonly public filters: FiltersSignalCircle
Curve.filtersfontFamily
readonly public fontFamily: SimpleSignalstringCircle
Curve.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberCircle
Curve.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringCircle
Curve.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberCircle
Curve.fontWeightgap
readonly public gap: Vector2LengthSignalCircle
Curve.gapgrow
readonly public grow: SimpleSignalnumberCircle
Curve.growisClass
public isClass: boolean
Curve.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentCircle
Curve.justifyContentkey
readonly public key: string
Curve.keylayout
readonly public layout: SimpleSignalLayoutModeCircle
Curve.layoutleft
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 fromCurve.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberCircle
Curve.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapCircle
Curve.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Circle
Curve.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberCircle
Curve.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthCircle
Curve.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinCircle
Curve.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberCircle
Curve.lineWidthmargin
readonly public margin: SpacingSignalCircle
Curve.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitCircle
Curve.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitCircle
Curve.maxWidthmiddle
readonly public middle: SimpleVector2SignalCircle
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 fromCurve.middle