@add-on-hlapi-sdk / Stroke

Interface: Stroke

Represents a stroke in the scenegraph. See StrokableNode.

Hierarchy

• StrokeOptions

  ↳ Stroke

Table of contents

Properties

• color
• dashOffset
• dashPattern
• position
• width

Properties

color

• Readonly color: Color

The color of a stroke.

Inherited from

StrokeOptions.color

dashOffset

• Readonly dashOffset: number

Number of pixels the beginning of dash pattern should be offset along the stroke.

Inherited from

StrokeOptions.dashOffset

dashPattern

• Readonly dashPattern: number[]

If empty, this is a solid stroke. If non-empty, the values alternate between length of a rendered and blank segment, repeated along the length of the stroke. The first value represents the first solid segment.

Inherited from

StrokeOptions.dashPattern

position

• Readonly position: StrokePositionValue

The position of the stroke relative to the outline of the shape.

width

• Readonly width: number

The thickness of a stroke. Must be from MIN_STROKE_WIDTH to MAX_STROKE_WIDTH.

Inherited from

StrokeOptions.width

Last updated 8/25/2023

Was this helpful?

Yes

No