class Line extends Curve
A node for drawing lines and polygons.
This node can be used to render any polygonal shape defined by a set of points.
import ...
export default makeScene2D(function* (view) {
view.add(
<Line
points={[
[150, 50],
[0, -50],
[-150, 50],
]}
stroke={'lightseagreen'}
lineWidth={8}
radius={40}
startArrow
/>,
);
});
Constructors
constructor
Parameters
props: LineProps
Curve.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalLine
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: SimpleSignalnumberLine
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: SimpleVector2SignalLine
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: SimpleSignalFlexContentLine
Curve.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsLine
Curve.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsLine
Curve.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanLine
Curve.antialiasedarrowSize
readonly public arrowSize: SimpleSignalnumberLine
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: SimpleSignalFlexBasisLine
Curve.basisbottom
readonly public bottom: SimpleVector2SignalLine
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: SimpleVector2SignalLine
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: SimpleVector2SignalLine
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: SimpleSignalbooleanLine
Curve.cachecachePadding
readonly public cachePadding: SpacingSignalLine
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[]LineSignalContextComponentChildrenNode[]Line
Curve.childrenclip
readonly public clip: SimpleSignalbooleanLine
Curve.clipclosed
readonly public closed: SimpleSignalbooleanLine
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromCurve.closedcomposite
readonly public composite: SimpleSignalbooleanLine
Curve.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationLine
Curve.compositeOperationcreationStack
readonly public creationStack?: string
Curve.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionLine
Curve.directionelement
public element: HTMLElement
Curve.elementend
readonly public end: SimpleSignalnumberLine
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.endendArrow
readonly public endArrow: SimpleSignalbooleanLine
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: SimpleSignalnumberLine
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: CanvasStyleSignalLine
Curve.fillfilters
readonly public filters: FiltersSignalLine
Curve.filtersfontFamily
readonly public fontFamily: SimpleSignalstringLine
Curve.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberLine
Curve.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringLine
Curve.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberLine
Curve.fontWeightgap
readonly public gap: Vector2LengthSignalLine
Curve.gapgrow
readonly public grow: SimpleSignalnumberLine
Curve.growisClass
public isClass: boolean
Curve.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentLine
Curve.justifyContentkey
readonly public key: string
Curve.keylayout
readonly public layout: SimpleSignalLayoutModeLine
Curve.layoutleft
readonly public left: SimpleVector2SignalLine
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: SimpleSignalnumberLine
Curve.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapLine
Curve.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Line
Curve.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberLine
Curve.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthLine
Curve.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinLine
Curve.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberLine
Curve.lineWidthmargin
readonly public margin: SpacingSignalLine
Curve.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitLine
Curve.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitLine
Curve.maxWidthmiddle
readonly public middle: SimpleVector2SignalLine
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.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitLine
Curve.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitLine
Curve.minWidthoffset
readonly public offset: Vector2SignalLine
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
Curve.offsetopacity
readonly public opacity: SimpleSignalnumberLine
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromCurve.opacitypadding
readonly public padding: SpacingSignalLine
Curve.padding