TextAnnotation Class
Represents a formatted block of text positioned in 2d or 3d space. TextAnnotation2d and TextAnnotation3d elements store a TextAnnotation from which their geometric representation is generated.
@see produceTextAnnotationGeometry to decompose the annotation into a set of geometric primitives suitable for use with appendTextBlock.
Methods
| Name | Description | |
|---|---|---|
| equals(other: TextAnnotation): boolean | Returns true if this annotation is logically equivalent to other. |
|
| toJSON(): TextAnnotationProps | Converts this annotation to its JSON representation. | |
| create(args?: TextAnnotationCreateArgs): TextAnnotation Static | Creates a new TextAnnotation. | |
| fromJSON(props: TextAnnotationProps): TextAnnotation Static | Creates a new TextAnnotation instance from its JSON representation. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| anchor | TextAnnotationAnchor | Describes how the textBlock's content should be aligned relative to the host element's origin. | |
| orientation | YawPitchRollAngles | The rotation of the annotation. | |
| textBlock | TextBlock | The formatted document. |
Defined in
Last Updated: 06 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.