@itwin/core-common 5.1.0-dev.56 → 5.1.0-dev.58

package/lib/cjs/annotation/TextAnnotation.d.ts

@@ -3,7 +3,7 @@
  */
 import { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
 import { TextBlock, TextBlockProps } from "./TextBlock";
-import { TextStyleColor } from "./TextStyle";
+import { TextStyleColor, TextStyleSettingsProps } from "./TextStyle";
 /** Describes how to compute the "anchor point" for a [[TextAnnotation]].
  * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].
  * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point
@@ -57,6 +57,73 @@ export interface TextFrameStyleProps {
     /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */
     borderWeight?: number;
 }
+/**
+ * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].
+ * Leader can be attached using one of the three modes:
+ * - KeyPoint: attach to a point on the frame specified by the given curveIndex and fractional position.
+ * - TextPoint: attach to a point that is projected on to the frame from the point on a particular line of text specified by [[LeaderTextPointOptions]].
+ * - Nearest: attach to the point on frame that is nearest to [[TextAnnotationLeader.startPoint]].
+ * @beta
+ */
+export type LeaderAttachment = {
+    mode: "KeyPoint";
+    curveIndex: number;
+    fraction: number;
+} | {
+    mode: "TextPoint";
+    position: LeaderTextPointOptions;
+} | {
+    mode: "Nearest";
+};
+/**
+ * Specifies the possible positions to attach a leader on the frame around a [[TextBlock]]
+ * when [[TextAnnotationLeader.attachment.mode]] is set to TextPoint.
+ * TopLeft : attach to a point projected onto the frame from the point on the left side of the first line of text.
+ * TopRight : attach to a point projected onto the frame from the point on the right side of the first line of text.
+ * BottomLeft : attach to a point projected onto the frame from the point on the left side of the last line of text.
+ * BottomRight : attach to a point projected onto the frame from the point on the right side of the last line of text.
+ * @beta
+ */
+export type LeaderTextPointOptions = "TopLeft" | "TopRight" | "BottomLeft" | "BottomRight";
+/**
+ * A line that connects a [[TextAnnotation]] to a point in space relative to another element in the iModel.
+ * A leader is always attached to the frame around the annotation's [[TextBlock]].
+ * If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.
+ * @see [[TextAnnotation.leaders]] for the leaders associated with an annotation.
+ * @see [[TextStyleSettings.leader]] and [[styleOverrides]] to customize the appearance of leaders.
+ * @beta
+*/
+export interface TextAnnotationLeader {
+    /** The point where the leader starts.
+     * This is the point on another element where the leader points to */
+    startPoint: Point3d;
+    /** Describes how to attach the leader to the frame around [[textBlock]].*/
+    attachment: LeaderAttachment;
+    /** Optional intermediate points that the leader should pass through.
+     * If not specified, the leader will be a straight line from startPoint to the point on the frame.
+     * For now, intermediate points are a set of points which create additional LineSegments in the leader, but there could be intermediate shapes instead of straight LineSegments in future*/
+    intermediatePoints?: Point3d[];
+    /** Optional style overrides for the leader. If not specified, the leader will use the style defined by [[TextBlock.styleName]] as it is.
+     * If specified, these overrides will be applied to the style.
+     */
+    styleOverrides?: TextStyleSettingsProps;
+}
+/**
+ * JSON representation of a [[TextAnnotationLeader]].
+ * @beta
+ */
+export interface TextAnnotationLeaderProps {
+    /** See [[TextAnnotationLeader.startPoint]]. */
+    startPoint: XYZProps;
+    /** See [[TextAnnotationLeader.attachment]]. */
+    attachment: LeaderAttachment;
+    /** See [[TextAnnotationLeader.intermediatePoints]]. Default: no intermediate points. */
+    intermediatePoints?: XYZProps[];
+    /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */
+    styleOverrides?: TextStyleSettingsProps;
+}
+/**
+
 /**
  * JSON representation of a [[TextAnnotation]].
  * @beta
@@ -72,6 +139,8 @@ export interface TextAnnotationProps {
     anchor?: TextAnnotationAnchor;
     /** See [[TextAnnotation.frame]]. Default: no frame */
     frame?: TextFrameStyleProps;
+    /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
+    leaders?: TextAnnotationLeaderProps[];
 }
 /** Arguments supplied to [[TextAnnotation.create]].
  * @beta
@@ -87,6 +156,8 @@ export interface TextAnnotationCreateArgs {
     anchor?: TextAnnotationAnchor;
     /** See [[TextAnnotation.frame]]. Default: no frame */
     frame?: TextFrameStyleProps;
+    /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
+    leaders?: TextAnnotationLeader[];
 }
 /**
  * Represents a formatted block of text positioned in 2d or 3d space.
@@ -114,6 +185,8 @@ export declare class TextAnnotation {
     offset: Point3d;
     /** The frame settings of the text annotation. */
     frame?: TextFrameStyleProps;
+    /** The leaders of the text annotation. */
+    leaders?: TextAnnotationLeader[];
     private constructor();
     /** Creates a new TextAnnotation. */
     static create(args?: TextAnnotationCreateArgs): TextAnnotation;
@@ -140,6 +213,8 @@ export declare class TextAnnotation {
      * @see [[computeTransform]] to compute the transform relative to the anchor point.
      */
     computeAnchorPoint(boundingBox: Range2d): Point3d;
+    /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */
+    private areLeadersEqual;
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other: TextAnnotation): boolean;
 }

package/lib/cjs/annotation/TextAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,gIAAgI;IAChI,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAA;CAC5B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,iDAAiD;IAC1C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAEnC,OAAO;IAQP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IAYrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAU9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAyBpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAW9C"}
+{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,gIAAgI;IAChI,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,aAAa,CAAA;AAE1F;;;;;;;EAOE;AACF,MAAM,WAAW,oBAAoB;IACnC;yEACqE;IACrE,UAAU,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,UAAU,EAAE,gBAAgB,CAAC;IAC7B;;+LAE2L;IAC3L,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,QAAQ,CAAC;IACrB,+CAA+C;IAC/C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChC,gFAAgF;IAChF,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,iDAAiD;IAC1C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IACnC,0CAA0C;IACnC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExC,OAAO;IASP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IAYrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAgB9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAgCpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0FAA0F;IAC1F,OAAO,CAAC,eAAe;IAsBvB,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAmB9C"}

package/lib/cjs/annotation/TextAnnotation.js

@@ -40,12 +40,15 @@ class TextAnnotation {
     offset;
     /** The frame settings of the text annotation. */
     frame;
-    constructor(offset, angles, textBlock, anchor, frame) {
+    /** The leaders of the text annotation. */
+    leaders;
+    constructor(offset, angles, textBlock, anchor, frame, leaders) {
         this.offset = offset;
         this.orientation = angles;
         this.textBlock = textBlock;
         this.anchor = anchor;
         this.frame = frame;
+        this.leaders = leaders;
     }
     /** Creates a new TextAnnotation. */
     static create(args) {
@@ -56,7 +59,8 @@ class TextAnnotation {
         // If the user supplies a frame, but doesn't supply a shape, default the shape to "rectangle"
         const shape = args?.frame?.shape ?? "rectangle";
         const frame = args?.frame ? { shape, ...args.frame } : undefined;
-        return new TextAnnotation(offset, angles, textBlock, anchor, frame);
+        const leaders = args?.leaders ?? undefined;
+        return new TextAnnotation(offset, angles, textBlock, anchor, frame, leaders);
     }
     /**
      * Creates a new TextAnnotation instance from its JSON representation.
@@ -68,6 +72,12 @@ class TextAnnotation {
             textBlock: props?.textBlock ? TextBlock_1.TextBlock.create(props.textBlock) : undefined,
             anchor: props?.anchor ? { ...props.anchor } : undefined,
             frame: props?.frame ? { shape: "rectangle", ...props.frame } : undefined,
+            leaders: props?.leaders ? props.leaders.map((leader) => ({
+                startPoint: core_geometry_1.Point3d.fromJSON(leader.startPoint),
+                attachment: leader.attachment,
+                styleOverrides: leader.styleOverrides ?? undefined,
+                intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => core_geometry_1.Point3d.fromJSON(point)) : undefined,
+            })) : undefined,
         });
     }
     /**
@@ -89,6 +99,12 @@ class TextAnnotation {
         }
         // Default frame to "none"
         props.frame = this.frame ? { ...this.frame } : undefined;
+        props.leaders = this.leaders?.map((leader) => ({
+            startPoint: leader.startPoint.toJSON(),
+            attachment: leader.attachment,
+            styleOverrides: leader.styleOverrides ?? undefined,
+            intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => point.toJSON()) : undefined,
+        })) ?? undefined;
         return props;
     }
     /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.
@@ -132,16 +148,47 @@ class TextAnnotation {
         }
         return new core_geometry_1.Point3d(x, y, 0);
     }
+    /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */
+    areLeadersEqual(leadersA, leadersB) {
+        if (leadersA === leadersB)
+            return true;
+        if (!leadersA || !leadersB || leadersA.length !== leadersB.length)
+            return false;
+        for (let i = 0; i < leadersA.length; ++i) {
+            const a = leadersA[i];
+            const b = leadersB[i];
+            if (!a.startPoint.isAlmostEqual(b.startPoint))
+                return false;
+            if (JSON.stringify(a.attachment) !== JSON.stringify(b.attachment))
+                return false;
+            if (JSON.stringify(a.styleOverrides) !== JSON.stringify(b.styleOverrides))
+                return false;
+            const pointsA = a.intermediatePoints ?? [];
+            const pointsB = b.intermediatePoints ?? [];
+            if (pointsA.length !== pointsB.length)
+                return false;
+            for (let j = 0; j < pointsA.length; ++j) {
+                if (!pointsA[j].isAlmostEqual(pointsB[j]))
+                    return false;
+            }
+        }
+        return true;
+    }
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other) {
+        if (this.anchor.horizontal !== other.anchor.horizontal ||
+            this.anchor.vertical !== other.anchor.vertical ||
+            !this.orientation.isAlmostEqual(other.orientation) ||
+            !this.offset.isAlmostEqual(other.offset) ||
+            !this.textBlock.equals(other.textBlock))
+            return false;
         const framesMatch = this.frame?.shape === other.frame?.shape
             && this.frame?.fill === other.frame?.fill
             && this.frame?.border === other.frame?.border
             && this.frame?.borderWeight === other.frame?.borderWeight;
-        return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical
-            && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)
-            && this.textBlock.equals(other.textBlock)
-            && framesMatch;
+        if (!framesMatch)
+            return false;
+        return this.areLeadersEqual(this.leaders, other.leaders);
     }
 }
 exports.TextAnnotation = TextAnnotation;

package/lib/cjs/annotation/TextAnnotation.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAoH;AACpH,2CAAwD;AA6BxD;;EAEE;AACW,QAAA,yBAAyB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAU,CAAC;AA+DvM;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IACvB,iDAAiD;IAC1C,KAAK,CAAuB;IAEnC,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B,EAAE,KAA2B;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,uBAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kCAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,qBAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACvE,6FAA6F;QAC7F,MAAM,KAAK,GAA6B,IAAI,EAAE,KAAK,EAAE,KAAK,IAAI,WAAW,CAAC;QAC1E,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEjE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kCAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;YACvD,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;SACzE,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,yFAAyF;QACzF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,0BAA0B;QAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAoB;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,yBAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,yBAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE7E,OAAO,WAAW,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,WAAoB;QAC5C,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3B,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,uBAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,KAAK;eACvD,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,IAAI;eACtC,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,KAAK,EAAE,MAAM;eAC1C,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC;QAE5D,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;eACtG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;eAC5F,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;eACtC,WAAW,CAAC;IACnB,CAAC;CACF;AAxID,wCAwIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\nimport { TextStyleColor } from \"./TextStyle\";\n\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\n * [[TextAnnotation.computeTransform]] will align the anchor point with (0, 0).\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\n * @beta\n */\nexport interface TextAnnotationAnchor {\n  /**\n   * The vertical alignment of the anchor point.\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\n   */\n  vertical: \"top\" | \"middle\" | \"bottom\";\n\n  /**\n   * The horizontal alignment of the anchor point.\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\n   */\n  horizontal: \"left\" | \"center\" | \"right\";\n}\n\n/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport const textAnnotationFrameShapes = [\"none\", \"line\", \"rectangle\", \"circle\", \"equilateralTriangle\", \"diamond\", \"square\", \"pentagon\", \"hexagon\", \"octagon\", \"capsule\", \"roundedRectangle\"] as const;\n\n/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];\n\n/**\n * Describes what color to use when filling the frame around a [[TextBlock]].\n * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.\n * @beta\n */\nexport type TextAnnotationFillColor = TextStyleColor | \"background\";\n\n/**\n * Describes how to draw the frame around a [[TextBlock]].\n * The frame can be a simple line, a filled shape, or both.\n * @beta\n */\nexport interface TextFrameStyleProps {\n  /** Shape of the frame. Default: \"rectangle\" */\n  shape?: TextAnnotationFrameShape;\n  /** The color to fill the shape of the text frame. This fill will is applied using [[FillDisplay.Blanking]]. Default: no fill */\n  fill?: TextAnnotationFillColor;\n  /** The color of the text frame's outline. Default: black */\n  border?: TextStyleColor;\n  /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */\n  borderWeight?: number;\n}\n\n/**\n * JSON representation of a [[TextAnnotation]].\n * @beta\n */\nexport interface TextAnnotationProps {\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\n  offset?: XYZProps;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollProps;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlockProps;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps\n}\n\n/** Arguments supplied to [[TextAnnotation.create]].\n * @beta\n */\nexport interface TextAnnotationCreateArgs {\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\n  offset?: Point3d;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollAngles;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlock;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps\n}\n\n/**\n * Represents a formatted block of text positioned in 2d or 3d space.\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\n * - First, a bounding box is computed enclosing the contents of the [[textBlock].\n * - Then, an \"anchor point\" is computed based on the bounding box and the [[anchor]] property. The anchor point can be at one of the four corners of the box, in the middle of one of its four\n * edges, or in the center of the box.\n * - The [[orientation]] is applied to rotate the box around the anchor point.\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\n * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].\n * @beta\n */\nexport class TextAnnotation {\n  /** The rotation of the annotation.\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\n   */\n  public orientation: YawPitchRollAngles;\n  /** The formatted document. */\n  public textBlock: TextBlock;\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\n  public anchor: TextAnnotationAnchor;\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\n  public offset: Point3d;\n  /** The frame settings of the text annotation. */\n  public frame?: TextFrameStyleProps;\n\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor, frame?: TextFrameStyleProps) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\n    this.frame = frame\n  }\n\n  /** Creates a new TextAnnotation. */\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\n    const offset = args?.offset ?? new Point3d();\n    const angles = args?.orientation ?? new YawPitchRollAngles();\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\n    // If the user supplies a frame, but doesn't supply a shape, default the shape to \"rectangle\"\n    const shape: TextAnnotationFrameShape = args?.frame?.shape ?? \"rectangle\";\n    const frame = args?.frame ? { shape, ...args.frame } : undefined;\n\n    return new TextAnnotation(offset, angles, textBlock, anchor, frame);\n  }\n\n  /**\n   * Creates a new TextAnnotation instance from its JSON representation.\n   */\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\n    return TextAnnotation.create({\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\n      frame: props?.frame ? { shape: \"rectangle\", ...props.frame } : undefined,\n    });\n  }\n\n  /**\n   * Converts this annotation to its JSON representation.\n   */\n  public toJSON(): TextAnnotationProps {\n    const props: TextAnnotationProps = {};\n\n    // Even if the text block is empty, we want to record its style name and overrides, e.g.,\n    // so the user can pick up where they left off editing it next time.\n    props.textBlock = this.textBlock.toJSON();\n\n    if (!this.offset.isZero) {\n      props.offset = this.offset.toJSON();\n    }\n\n    if (!this.orientation.isIdentity()) {\n      props.orientation = this.orientation.toJSON();\n    }\n\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\n      props.anchor = { ...this.anchor };\n    }\n\n    // Default frame to \"none\"\n    props.frame = this.frame ? { ...this.frame } : undefined;\n\n    return props;\n  }\n\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].\n   * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.\n   * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\n   * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n   */\n  public computeTransform(boundingBox: Range2d): Transform {\n    const anchorPt = this.computeAnchorPoint(boundingBox);\n    const matrix = this.orientation.toMatrix3d();\n\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\n    const translation = Transform.createTranslation(this.offset.minus(anchorPt));\n\n    return translation.multiplyTransformTransform(rotation, rotation);\n  }\n\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\n   * @param boundingBox A box fully containing the [[textBlock]].\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\n   */\n  public computeAnchorPoint(boundingBox: Range2d): Point3d {\n    let x = boundingBox.low.x;\n    let y = boundingBox.high.y;\n\n    switch (this.anchor.horizontal) {\n      case \"center\":\n        x += boundingBox.xLength() / 2;\n        break;\n      case \"right\":\n        x += boundingBox.xLength();\n        break;\n    }\n\n    switch (this.anchor.vertical) {\n      case \"middle\":\n        y -= boundingBox.yLength() / 2;\n        break;\n      case \"bottom\":\n        y -= boundingBox.yLength();\n        break;\n    }\n\n    return new Point3d(x, y, 0);\n  }\n\n  /** Returns true if this annotation is logically equivalent to `other`. */\n  public equals(other: TextAnnotation): boolean {\n    const framesMatch = this.frame?.shape === other.frame?.shape\n      && this.frame?.fill === other.frame?.fill\n      && this.frame?.border === other.frame?.border\n      && this.frame?.borderWeight === other.frame?.borderWeight;\n\n    return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical\n      && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)\n      && this.textBlock.equals(other.textBlock)\n      && framesMatch;\n  }\n}\n"]}
+{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAoH;AACpH,2CAAwD;AA6BxD;;EAEE;AACW,QAAA,yBAAyB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAU,CAAC;AAmIvM;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IACvB,iDAAiD;IAC1C,KAAK,CAAuB;IACnC,0CAA0C;IACnC,OAAO,CAA0B;IAExC,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B,EAAE,KAA2B,EAAE,OAAgC;QAChL,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,uBAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kCAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,qBAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACvE,6FAA6F;QAC7F,MAAM,KAAK,GAA6B,IAAI,EAAE,KAAK,EAAE,KAAK,IAAI,WAAW,CAAC;QAC1E,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,SAAS,CAAC;QAC3C,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kCAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;YACvD,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;YACxE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvD,UAAU,EAAE,uBAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC/C,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,SAAS;gBAClD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;aAC9H,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,yFAAyF;QACzF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,0BAA0B;QAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzD,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC7C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,SAAS;YAClD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;SACrH,CAAC,CAAC,IAAI,SAAS,CAAC;QAEjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAoB;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,yBAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,yBAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE7E,OAAO,WAAW,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,WAAoB;QAC5C,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3B,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,uBAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0FAA0F;IAClF,eAAe,CAAC,QAAiC,EAAE,QAAiC;QAC1F,IAAI,QAAQ,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACvC,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAEhF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAEtB,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC5D,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YAChF,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC;gBAAE,OAAO,KAAK,CAAC;YAExF,MAAM,OAAO,GAAG,CAAC,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,CAAC,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBAAE,OAAO,KAAK,CAAC;YAC1D,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU;YACpD,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;YAC9C,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAClD,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;YACxC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YACvC,OAAO,KAAK,CAAC;QAEf,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,KAAK;eACvD,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,IAAI;eACtC,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,KAAK,EAAE,MAAM;eAC1C,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC;QAE5D,IAAI,CAAC,WAAW;YACd,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3D,CAAC;CACF;AAvLD,wCAuLC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\nimport { TextStyleColor, TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\n * [[TextAnnotation.computeTransform]] will align the anchor point with (0, 0).\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\n * @beta\n */\nexport interface TextAnnotationAnchor {\n  /**\n   * The vertical alignment of the anchor point.\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\n   */\n  vertical: \"top\" | \"middle\" | \"bottom\";\n\n  /**\n   * The horizontal alignment of the anchor point.\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\n   */\n  horizontal: \"left\" | \"center\" | \"right\";\n}\n\n/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport const textAnnotationFrameShapes = [\"none\", \"line\", \"rectangle\", \"circle\", \"equilateralTriangle\", \"diamond\", \"square\", \"pentagon\", \"hexagon\", \"octagon\", \"capsule\", \"roundedRectangle\"] as const;\n\n/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];\n\n/**\n * Describes what color to use when filling the frame around a [[TextBlock]].\n * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.\n * @beta\n */\nexport type TextAnnotationFillColor = TextStyleColor | \"background\";\n\n/**\n * Describes how to draw the frame around a [[TextBlock]].\n * The frame can be a simple line, a filled shape, or both.\n * @beta\n */\nexport interface TextFrameStyleProps {\n  /** Shape of the frame. Default: \"rectangle\" */\n  shape?: TextAnnotationFrameShape;\n  /** The color to fill the shape of the text frame. This fill will is applied using [[FillDisplay.Blanking]]. Default: no fill */\n  fill?: TextAnnotationFillColor;\n  /** The color of the text frame's outline. Default: black */\n  border?: TextStyleColor;\n  /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */\n  borderWeight?: number;\n}\n\n/**\n * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].\n * Leader can be attached using one of the three modes:\n * - KeyPoint: attach to a point on the frame specified by the given curveIndex and fractional position.\n * - TextPoint: attach to a point that is projected on to the frame from the point on a particular line of text specified by [[LeaderTextPointOptions]].\n * - Nearest: attach to the point on frame that is nearest to [[TextAnnotationLeader.startPoint]].\n * @beta\n */\nexport type LeaderAttachment =\n  | { mode: \"KeyPoint\"; curveIndex: number; fraction: number }\n  | { mode: \"TextPoint\"; position: LeaderTextPointOptions }\n  | { mode: \"Nearest\" };\n\n/**\n * Specifies the possible positions to attach a leader on the frame around a [[TextBlock]]\n * when [[TextAnnotationLeader.attachment.mode]] is set to TextPoint.\n * TopLeft : attach to a point projected onto the frame from the point on the left side of the first line of text.\n * TopRight : attach to a point projected onto the frame from the point on the right side of the first line of text.\n * BottomLeft : attach to a point projected onto the frame from the point on the left side of the last line of text.\n * BottomRight : attach to a point projected onto the frame from the point on the right side of the last line of text.\n * @beta\n */\nexport type LeaderTextPointOptions = \"TopLeft\" | \"TopRight\" | \"BottomLeft\" | \"BottomRight\"\n\n/**\n * A line that connects a [[TextAnnotation]] to a point in space relative to another element in the iModel.\n * A leader is always attached to the frame around the annotation's [[TextBlock]].\n * If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.\n * @see [[TextAnnotation.leaders]] for the leaders associated with an annotation.\n * @see [[TextStyleSettings.leader]] and [[styleOverrides]] to customize the appearance of leaders.\n * @beta\n*/\nexport interface TextAnnotationLeader {\n  /** The point where the leader starts.\n   * This is the point on another element where the leader points to */\n  startPoint: Point3d;\n  /** Describes how to attach the leader to the frame around [[textBlock]].*/\n  attachment: LeaderAttachment;\n  /** Optional intermediate points that the leader should pass through.\n   * If not specified, the leader will be a straight line from startPoint to the point on the frame.\n   * For now, intermediate points are a set of points which create additional LineSegments in the leader, but there could be intermediate shapes instead of straight LineSegments in future*/\n  intermediatePoints?: Point3d[];\n  /** Optional style overrides for the leader. If not specified, the leader will use the style defined by [[TextBlock.styleName]] as it is.\n   * If specified, these overrides will be applied to the style.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n/**\n * JSON representation of a [[TextAnnotationLeader]].\n * @beta\n */\nexport interface TextAnnotationLeaderProps {\n  /** See [[TextAnnotationLeader.startPoint]]. */\n  startPoint: XYZProps;\n  /** See [[TextAnnotationLeader.attachment]]. */\n  attachment: LeaderAttachment;\n  /** See [[TextAnnotationLeader.intermediatePoints]]. Default: no intermediate points. */\n  intermediatePoints?: XYZProps[];\n  /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/**\n\n/**\n * JSON representation of a [[TextAnnotation]].\n * @beta\n */\nexport interface TextAnnotationProps {\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\n  offset?: XYZProps;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollProps;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlockProps;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps;\n  /** See [[TextAnnotation.leader]]. Default: an empty leader array  */\n  leaders?: TextAnnotationLeaderProps[];\n}\n\n/** Arguments supplied to [[TextAnnotation.create]].\n * @beta\n */\nexport interface TextAnnotationCreateArgs {\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\n  offset?: Point3d;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollAngles;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlock;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps;\n  /** See [[TextAnnotation.leader]]. Default: an empty leader array  */\n  leaders?: TextAnnotationLeader[];\n}\n\n/**\n * Represents a formatted block of text positioned in 2d or 3d space.\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\n * - First, a bounding box is computed enclosing the contents of the [[textBlock].\n * - Then, an \"anchor point\" is computed based on the bounding box and the [[anchor]] property. The anchor point can be at one of the four corners of the box, in the middle of one of its four\n * edges, or in the center of the box.\n * - The [[orientation]] is applied to rotate the box around the anchor point.\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\n * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].\n * @beta\n */\nexport class TextAnnotation {\n  /** The rotation of the annotation.\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\n   */\n  public orientation: YawPitchRollAngles;\n  /** The formatted document. */\n  public textBlock: TextBlock;\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\n  public anchor: TextAnnotationAnchor;\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\n  public offset: Point3d;\n  /** The frame settings of the text annotation. */\n  public frame?: TextFrameStyleProps;\n  /** The leaders of the text annotation. */\n  public leaders?: TextAnnotationLeader[];\n\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor, frame?: TextFrameStyleProps, leaders?: TextAnnotationLeader[]) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\n    this.frame = frame;\n    this.leaders = leaders;\n  }\n\n  /** Creates a new TextAnnotation. */\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\n    const offset = args?.offset ?? new Point3d();\n    const angles = args?.orientation ?? new YawPitchRollAngles();\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\n    // If the user supplies a frame, but doesn't supply a shape, default the shape to \"rectangle\"\n    const shape: TextAnnotationFrameShape = args?.frame?.shape ?? \"rectangle\";\n    const frame = args?.frame ? { shape, ...args.frame } : undefined;\n    const leaders = args?.leaders ?? undefined;\n    return new TextAnnotation(offset, angles, textBlock, anchor, frame, leaders);\n  }\n\n  /**\n   * Creates a new TextAnnotation instance from its JSON representation.\n   */\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\n    return TextAnnotation.create({\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\n      frame: props?.frame ? { shape: \"rectangle\", ...props.frame } : undefined,\n      leaders: props?.leaders ? props.leaders.map((leader) => ({\n        startPoint: Point3d.fromJSON(leader.startPoint),\n        attachment: leader.attachment,\n        styleOverrides: leader.styleOverrides ?? undefined,\n        intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => Point3d.fromJSON(point)) : undefined,\n      })) : undefined,\n    });\n  }\n\n  /**\n   * Converts this annotation to its JSON representation.\n   */\n  public toJSON(): TextAnnotationProps {\n    const props: TextAnnotationProps = {};\n\n    // Even if the text block is empty, we want to record its style name and overrides, e.g.,\n    // so the user can pick up where they left off editing it next time.\n    props.textBlock = this.textBlock.toJSON();\n\n    if (!this.offset.isZero) {\n      props.offset = this.offset.toJSON();\n    }\n\n    if (!this.orientation.isIdentity()) {\n      props.orientation = this.orientation.toJSON();\n    }\n\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\n      props.anchor = { ...this.anchor };\n    }\n\n    // Default frame to \"none\"\n    props.frame = this.frame ? { ...this.frame } : undefined;\n\n    props.leaders = this.leaders?.map((leader) => ({\n      startPoint: leader.startPoint.toJSON(),\n      attachment: leader.attachment,\n      styleOverrides: leader.styleOverrides ?? undefined,\n      intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => point.toJSON()) : undefined,\n    })) ?? undefined;\n\n    return props;\n  }\n\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].\n   * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.\n   * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\n   * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n   */\n  public computeTransform(boundingBox: Range2d): Transform {\n    const anchorPt = this.computeAnchorPoint(boundingBox);\n    const matrix = this.orientation.toMatrix3d();\n\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\n    const translation = Transform.createTranslation(this.offset.minus(anchorPt));\n\n    return translation.multiplyTransformTransform(rotation, rotation);\n  }\n\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\n   * @param boundingBox A box fully containing the [[textBlock]].\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\n   */\n  public computeAnchorPoint(boundingBox: Range2d): Point3d {\n    let x = boundingBox.low.x;\n    let y = boundingBox.high.y;\n\n    switch (this.anchor.horizontal) {\n      case \"center\":\n        x += boundingBox.xLength() / 2;\n        break;\n      case \"right\":\n        x += boundingBox.xLength();\n        break;\n    }\n\n    switch (this.anchor.vertical) {\n      case \"middle\":\n        y -= boundingBox.yLength() / 2;\n        break;\n      case \"bottom\":\n        y -= boundingBox.yLength();\n        break;\n    }\n\n    return new Point3d(x, y, 0);\n  }\n\n  /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */\n  private areLeadersEqual(leadersA?: TextAnnotationLeader[], leadersB?: TextAnnotationLeader[]): boolean {\n    if (leadersA === leadersB) return true;\n    if (!leadersA || !leadersB || leadersA.length !== leadersB.length) return false;\n\n    for (let i = 0; i < leadersA.length; ++i) {\n      const a = leadersA[i];\n      const b = leadersB[i];\n\n      if (!a.startPoint.isAlmostEqual(b.startPoint)) return false;\n      if (JSON.stringify(a.attachment) !== JSON.stringify(b.attachment)) return false;\n      if (JSON.stringify(a.styleOverrides) !== JSON.stringify(b.styleOverrides)) return false;\n\n      const pointsA = a.intermediatePoints ?? [];\n      const pointsB = b.intermediatePoints ?? [];\n      if (pointsA.length !== pointsB.length) return false;\n      for (let j = 0; j < pointsA.length; ++j) {\n        if (!pointsA[j].isAlmostEqual(pointsB[j])) return false;\n      }\n    }\n    return true;\n  }\n\n  /** Returns true if this annotation is logically equivalent to `other`. */\n  public equals(other: TextAnnotation): boolean {\n    if (this.anchor.horizontal !== other.anchor.horizontal ||\n      this.anchor.vertical !== other.anchor.vertical ||\n      !this.orientation.isAlmostEqual(other.orientation) ||\n      !this.offset.isAlmostEqual(other.offset) ||\n      !this.textBlock.equals(other.textBlock))\n      return false;\n\n    const framesMatch = this.frame?.shape === other.frame?.shape\n      && this.frame?.fill === other.frame?.fill\n      && this.frame?.border === other.frame?.border\n      && this.frame?.borderWeight === other.frame?.borderWeight;\n\n    if (!framesMatch)\n      return false;\n\n    return this.areLeadersEqual(this.leaders, other.leaders);\n\n  }\n}\n"]}

package/lib/cjs/annotation/TextStyle.d.ts

@@ -13,6 +13,35 @@ export type StackedFractionType = "horizontal" | "diagonal";
  * @beta
  */
 export type TextStyleColor = ColorDefProps | "subcategory";
+/** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].
+ * Used when producing geometry for [[TextAnnotation]].
+ * @beta
+ */
+export interface TextLeaderStyleProps {
+    /** The color of the leader.
+     * Default: "subcategory".
+     */
+    color?: TextStyleColor;
+    /** Whether to use an elbow in the leader.
+     * Default: false
+     */
+    wantElbow?: boolean;
+    /** Multiplier used to compute length of the elbow in the leader.
+     * The elbowLength is computed in meters as elbowLength * [[lineHeight]].
+     * Default: 1.0
+     */
+    elbowLength?: number;
+    /** Multiplier to compute height of the leader terminator.
+     * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].
+     * Default: 1.0
+     */
+    terminatorHeightFactor?: number;
+    /** Multiplier to compute width of the leader terminator.
+     * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].
+     * Default: 1.0
+     */
+    terminatorWidthFactor?: number;
+}
 /** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.
  * @beta
  */
@@ -80,6 +109,11 @@ export interface TextStyleSettingsProps {
      * Default: 1.0
      */
     widthFactor?: number;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]]
+     * Used when producing geometry for [[TextAnnotation]]
+     * Default: {color:"subcategory", wantElbow:"false",elbowLength:1, terminatorWidthFactor:1, terminatorHeightFactor:1}.
+     */
+    leader?: TextLeaderStyleProps;
     /** The size (in meters) used to calculate the tab stops in a run.
      * These are equally spaced from the left edge of the TextBlock.
      * Default: 4 meters.
@@ -137,6 +171,10 @@ export declare class TextStyleSettings {
     readonly superScriptScale: number;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     readonly widthFactor: number;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]].
+     * Used when producing geometry for [[TextAnnotation]].
+     */
+    readonly leader: Readonly<Required<TextLeaderStyleProps>>;
     /** The size (in meters) used to calculate the tab stops in a run.
      * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
      */
@@ -151,6 +189,11 @@ export declare class TextStyleSettings {
     /** Create settings from their JSON representation. */
     static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings;
     toJSON(): TextStyleSettingsProps;
+    /** Compare two [[TextLeaderStyleProps]] for equality.
+     * @param other The other leader style properties to compare against.
+     * @returns true if the two leader styles are equal, false otherwise.
+     */
+    leaderEquals(other: TextLeaderStyleProps): boolean;
     equals(other: TextStyleSettings): boolean;
 }
 /** The JSON representation of a [[TextStyle]].

package/lib/cjs/annotation/TextStyle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAgBpE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA8B;IAEvE,OAAO;IAsBP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIhC,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;CASjD;AAKD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4IAA4I;IAC5I,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,OAAO;IAKP,mDAAmD;WACrC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;IAIvD,0BAA0B;WACZ,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,SAAS;IAI1E,sIAAsI;IAC/H,KAAK,CAAC,eAAe,EAAE,sBAAsB,GAAG,SAAS;IAIzD,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAGzC"}
+{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAuBpE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IA8BP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAGvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;CAUjD;AAKD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4IAA4I;IAC5I,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,OAAO;IAKP,mDAAmD;WACrC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;IAIvD,0BAA0B;WACZ,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,SAAS;IAI1E,sIAAsI;IAC/H,KAAK,CAAC,eAAe,EAAE,sBAAsB,GAAG,SAAS;IAIzD,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAGzC"}

package/lib/cjs/annotation/TextStyle.js

@@ -59,6 +59,10 @@ class TextStyleSettings {
     superScriptScale;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     widthFactor;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]].
+     * Used when producing geometry for [[TextAnnotation]].
+     */
+    leader;
     /** The size (in meters) used to calculate the tab stops in a run.
      * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
      */
@@ -79,6 +83,13 @@ class TextStyleSettings {
         superScriptOffsetFactor: 0.5,
         superScriptScale: 2 / 3,
         widthFactor: 1,
+        leader: {
+            color: "subcategory",
+            wantElbow: false,
+            elbowLength: 1.0,
+            terminatorHeightFactor: 1.0,
+            terminatorWidthFactor: 1.0,
+        },
         tabInterval: 4,
     };
     /** Settings initialized to all default values. */
@@ -101,6 +112,14 @@ class TextStyleSettings {
         this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;
         this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;
         this.widthFactor = props.widthFactor ?? defaults.widthFactor;
+        const leader = {
+            color: props.leader?.color ?? defaults.leader.color,
+            wantElbow: props.leader?.wantElbow ?? defaults.leader.wantElbow,
+            elbowLength: props.leader?.elbowLength ?? defaults.leader.elbowLength,
+            terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,
+            terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,
+        };
+        this.leader = Object.freeze(leader);
         this.tabInterval = props.tabInterval ?? defaults.tabInterval;
     }
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
@@ -114,14 +133,24 @@ class TextStyleSettings {
     toJSON() {
         return { ...this };
     }
+    /** Compare two [[TextLeaderStyleProps]] for equality.
+     * @param other The other leader style properties to compare against.
+     * @returns true if the two leader styles are equal, false otherwise.
+     */
+    leaderEquals(other) {
+        return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow
+            && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor
+            && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;
+    }
     equals(other) {
         return this.color === other.color && this.fontName === other.fontName
             && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor
             && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined
             && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale
             && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale
-            && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale
-            && this.tabInterval === other.tabInterval;
+            && this.superScriptOffsetFactor === other.superScriptOffsetFactor
+            && this.superScriptScale === other.superScriptScale
+            && this.tabInterval === other.tabInterval && this.leaderEquals(other.leader);
     }
 }
 exports.TextStyleSettings = TextStyleSettings;

package/lib/cjs/annotation/TextStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.js","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA2FH;;;;;GAKG;AACH,MAAa,iBAAiB;IAC5B,6BAA6B;IACb,KAAK,CAAiB;IACtC;OACG;IACa,QAAQ,CAAS;IACjC;;;OAGG;IACa,UAAU,CAAS;IACnC;;OAEG;IACa,iBAAiB,CAAS;IAC1C,kFAAkF;IAClE,MAAM,CAAU;IAChC,sFAAsF;IACtE,QAAQ,CAAU;IAClC,2EAA2E;IAC3D,YAAY,CAAU;IACtC;;OAEG;IACa,oBAAoB,CAAS;IAC7C,oFAAoF;IACpE,mBAAmB,CAAsB;IACzD;;OAEG;IACa,qBAAqB,CAAS;IAC9C;;OAEG;IACa,cAAc,CAAS;IACvC;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAS;IACzC,sFAAsF;IACtE,WAAW,CAAS;IACpC;;OAEG;IACa,WAAW,CAAS;IAEpC,qEAAqE;IAC9D,MAAM,CAAC,YAAY,GAA+C;QACvE,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,CAAC;QACb,iBAAiB,EAAE,GAAG;QACtB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,oBAAoB,EAAE,GAAG;QACzB,mBAAmB,EAAE,YAAY;QACjC,qBAAqB,EAAE,CAAC,IAAI;QAC5B,cAAc,EAAE,CAAC,GAAG,CAAC;QACrB,uBAAuB,EAAE,GAAG;QAC5B,gBAAgB,EAAE,CAAC,GAAG,CAAC;QACvB,WAAW,EAAE,CAAC;QACd,WAAW,EAAE,CAAC;KACf,CAAC;IAEF,kDAAkD;IAC3C,MAAM,CAAC,QAAQ,GAAsB,IAAI,iBAAiB,CAAC,EAAG,CAAC,CAAC;IAEvE,YAAoB,KAA6B,EAAE,QAA2C;QAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAChE,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QACxF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACrF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC;QACtE,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QACjG,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,IAAI,QAAQ,CAAC,gBAAgB,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;IAC/D,CAAC;IAED,uGAAuG;IAChG,KAAK,CAAC,YAAqC;QAChD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChE,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACpI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAC5G,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB;eAClH,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;eAC1G,IAAI,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAClH,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,CAAC;IAC9C,CAAC;;AApHH,8CAqHC;AAED,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAY1C;;;;GAIG;AACH,MAAa,SAAS;IACJ,IAAI,CAAS;IACb,QAAQ,CAAoB;IAE5C,YAAoB,IAAY,EAAE,QAA2B;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,QAA2B;QAC5D,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,sIAAsI;IAC/H,KAAK,CAAC,eAAuC;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM,CAAC,KAAgB;QAC5B,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;CACF;AA3BD,8BA2BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { ColorDefProps } from \"../ColorDef\";\n\n/** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.\n * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].\n * @beta\n */\nexport type StackedFractionType = \"horizontal\" | \"diagonal\";\n\n/** Describes the color in which to draw the text in a [[TextRun]].\n * \"subcategory\" indicates that the text should be drawn using the color of the [SubCategory]($backend) specified by the [GeometryStream]($docs/learning/common/GeometryStream.md) hosting the\n * text.\n * @beta\n */\nexport type TextStyleColor = ColorDefProps | \"subcategory\";\n\n/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.\n * @beta\n */\nexport interface TextStyleSettingsProps {\n  /** The color of the text.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   * Default: \"\" (an invalid font name).\n   */\n  fontName?: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   * Default: 1.0. */\n  lineHeight?: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   * Default: 0.5.\n   */\n  lineSpacingFactor?: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.\n   * Default: false.\n   */\n  isBold?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*.\n   * Default: false.\n   */\n  isItalic?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined.\n   * Default: false.\n   */\n  isUnderlined?: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   * Default: 0.7.\n   */\n  stackedFractionScale?: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]].\n   * Default: \"horizontal\".\n   */\n  stackedFractionType?: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.15.\n   */\n  subScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  subScriptScale?: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.5.\n   */\n  superScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  superScriptScale?: number;\n  /** A scale applied to the width of each glyph.\n   * Default: 1.0\n   */\n  widthFactor?: number;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock.\n   * Default: 4 meters.\n   */\n  tabInterval?: number;\n}\n\n/** A description of the formatting to be applied to a [[TextBlockComponent]].\n * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @see [[TextStyleSettingsProps]] for documentation of each of the settings.\n * @beta\n */\nexport class TextStyleSettings {\n  /** The color of the text. */\n  public readonly color: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   */\n  public readonly fontName: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   */\n  public readonly lineHeight: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   */\n  public readonly lineSpacingFactor: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */\n  public readonly isBold: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */\n  public readonly isItalic: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined. */\n  public readonly isUnderlined: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   */\n  public readonly stackedFractionScale: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */\n  public readonly stackedFractionType: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly subScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   */\n  public readonly subScriptScale: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly superScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   */\n  public readonly superScriptScale: number;\n  /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */\n  public readonly widthFactor: number;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.\n   */\n  public readonly tabInterval: number;\n\n  /** A fully-populated JSON representation of the default settings. */\n  public static defaultProps: Readonly<Required<TextStyleSettingsProps>> = {\n    color: \"subcategory\",\n    fontName: \"\",\n    lineHeight: 1,\n    lineSpacingFactor: 0.5,\n    isBold: false,\n    isItalic: false,\n    isUnderlined: false,\n    stackedFractionScale: 0.7,\n    stackedFractionType: \"horizontal\",\n    subScriptOffsetFactor: -0.15,\n    subScriptScale: 2 / 3,\n    superScriptOffsetFactor: 0.5,\n    superScriptScale: 2 / 3,\n    widthFactor: 1,\n    tabInterval: 4,\n  };\n\n  /** Settings initialized to all default values. */\n  public static defaults: TextStyleSettings = new TextStyleSettings({ });\n\n  private constructor(props: TextStyleSettingsProps, defaults?: Required<TextStyleSettingsProps>) {\n    if (!defaults) {\n      defaults = TextStyleSettings.defaultProps;\n    }\n\n    this.color = props.color ?? defaults.color;\n    this.fontName = props.fontName ?? defaults.fontName;\n    this.lineHeight = props.lineHeight ?? defaults.lineHeight;\n    this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;\n    this.isBold = props.isBold ?? defaults.isBold;\n    this.isItalic = props.isItalic ?? defaults.isItalic;\n    this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;\n    this.stackedFractionScale = props.stackedFractionScale ?? defaults.stackedFractionScale;\n    this.stackedFractionType = props.stackedFractionType ?? defaults.stackedFractionType;\n    this.subScriptOffsetFactor = props.subScriptOffsetFactor ?? defaults.subScriptOffsetFactor;\n    this.subScriptScale = props.subScriptScale ?? defaults.subScriptScale;\n    this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;\n    this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;\n    this.widthFactor = props.widthFactor ?? defaults.widthFactor;\n    this.tabInterval = props.tabInterval ?? defaults.tabInterval;\n  }\n\n  /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */\n  public clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings {\n    return alteredProps ? new TextStyleSettings(alteredProps, this) : this;\n  }\n\n  /** Create settings from their JSON representation. */\n  public static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings {\n    return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;\n  }\n\n  public toJSON(): TextStyleSettingsProps {\n    return { ...this };\n  }\n\n  public equals(other: TextStyleSettings): boolean {\n    return this.color === other.color && this.fontName === other.fontName\n      && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor\n      && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined\n      && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale\n      && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale\n      && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale\n      && this.tabInterval === other.tabInterval;\n  }\n}\n\nObject.freeze(TextStyleSettings.defaultProps);\nObject.freeze(TextStyleSettings.defaults);\n\n/** The JSON representation of a [[TextStyle]].\n * @beta\n */\nexport interface TextStyleProps {\n  /** The name of the style. */\n  name: string;\n  /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */\n  settings?: TextStyleSettingsProps;\n}\n\n/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).\n * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @beta\n */\nexport class TextStyle {\n  public readonly name: string;\n  public readonly settings: TextStyleSettings;\n\n  private constructor(name: string, settings: TextStyleSettings) {\n    this.name = name;\n    this.settings = settings;\n  }\n\n  /** Create a style from its JSON representation. */\n  public static fromJSON(json: TextStyleProps): TextStyle {\n    return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));\n  }\n\n  /** Create a new style. */\n  public static create(name: string, settings: TextStyleSettings): TextStyle {\n    return new TextStyle(name, settings);\n  }\n\n  /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */\n  public clone(alteredSettings: TextStyleSettingsProps): TextStyle {\n    return TextStyle.create(this.name, this.settings.clone(alteredSettings));\n  }\n\n  public equals(other: TextStyle): boolean {\n    return this.name === other.name && this.settings.equals(other.settings);\n  }\n}\n\n"]}
+{"version":3,"file":"TextStyle.js","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA+HH;;;;;GAKG;AACH,MAAa,iBAAiB;IAC5B,6BAA6B;IACb,KAAK,CAAiB;IACtC;OACG;IACa,QAAQ,CAAS;IACjC;;;OAGG;IACa,UAAU,CAAS;IACnC;;OAEG;IACa,iBAAiB,CAAS;IAC1C,kFAAkF;IAClE,MAAM,CAAU;IAChC,sFAAsF;IACtE,QAAQ,CAAU;IAClC,2EAA2E;IAC3D,YAAY,CAAU;IACtC;;OAEG;IACa,oBAAoB,CAAS;IAC7C,oFAAoF;IACpE,mBAAmB,CAAsB;IACzD;;OAEG;IACa,qBAAqB,CAAS;IAC9C;;OAEG;IACa,cAAc,CAAS;IACvC;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAS;IACzC,sFAAsF;IACtE,WAAW,CAAS;IACpC;;OAEG;IACa,MAAM,CAA2C;IACjE;;OAEG;IACa,WAAW,CAAS;IAEpC,qEAAqE;IAC9D,MAAM,CAAC,YAAY,GAA+C;QACvE,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,CAAC;QACb,iBAAiB,EAAE,GAAG;QACtB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,oBAAoB,EAAE,GAAG;QACzB,mBAAmB,EAAE,YAAY;QACjC,qBAAqB,EAAE,CAAC,IAAI;QAC5B,cAAc,EAAE,CAAC,GAAG,CAAC;QACrB,uBAAuB,EAAE,GAAG;QAC5B,gBAAgB,EAAE,CAAC,GAAG,CAAC;QACvB,WAAW,EAAE,CAAC;QACd,MAAM,EAAE;YACN,KAAK,EAAE,aAAa;YACpB,SAAS,EAAE,KAAK;YAChB,WAAW,EAAE,GAAG;YAChB,sBAAsB,EAAE,GAAG;YAC3B,qBAAqB,EAAE,GAAG;SAC3B;QACD,WAAW,EAAE,CAAC;KACf,CAAC;IAEF,kDAAkD;IAC3C,MAAM,CAAC,QAAQ,GAAsB,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC;IAEtE,YAAoB,KAA6B,EAAE,QAA2C;QAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAChE,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QACxF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACrF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC;QACtE,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QACjG,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,IAAI,QAAQ,CAAC,gBAAgB,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;QAC7D,MAAM,MAAM,GAAG;YACb,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK;YACnD,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,SAAS;YAC/D,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,MAAM,CAAC,WAAW;YACrE,sBAAsB,EAAE,KAAK,CAAC,MAAM,EAAE,sBAAsB,IAAI,QAAQ,CAAC,MAAM,CAAC,sBAAsB;YACtG,qBAAqB,EAAE,KAAK,CAAC,MAAM,EAAE,qBAAqB,IAAI,QAAQ,CAAC,MAAM,CAAC,qBAAqB;SACpG,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA6C,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;IAC/D,CAAC;IAED,uGAAuG;IAChG,KAAK,CAAC,YAAqC;QAChD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IACD;;;OAGG;IACI,YAAY,CAAC,KAA2B;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAChF,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAsB,KAAK,KAAK,CAAC,sBAAsB;eACpH,IAAI,CAAC,MAAM,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IACzE,CAAC;IAEM,MAAM,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChE,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACpI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAC5G,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB;eAClH,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;eAC1G,IAAI,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB;eAC9D,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAChD,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;;AAjJH,8CAkJC;AAED,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAY1C;;;;GAIG;AACH,MAAa,SAAS;IACJ,IAAI,CAAS;IACb,QAAQ,CAAoB;IAE5C,YAAoB,IAAY,EAAE,QAA2B;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,QAA2B;QAC5D,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,sIAAsI;IAC/H,KAAK,CAAC,eAAuC;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM,CAAC,KAAgB;QAC5B,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;CACF;AA3BD,8BA2BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { ColorDefProps } from \"../ColorDef\";\n\n/** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.\n * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].\n * @beta\n */\nexport type StackedFractionType = \"horizontal\" | \"diagonal\";\n\n/** Describes the color in which to draw the text in a [[TextRun]].\n * \"subcategory\" indicates that the text should be drawn using the color of the [SubCategory]($backend) specified by the [GeometryStream]($docs/learning/common/GeometryStream.md) hosting the\n * text.\n * @beta\n */\nexport type TextStyleColor = ColorDefProps | \"subcategory\";\n\n/** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].\n * Used when producing geometry for [[TextAnnotation]].\n * @beta\n */\nexport interface TextLeaderStyleProps {\n  /** The color of the leader.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** Whether to use an elbow in the leader.\n   * Default: false\n   */\n  wantElbow?: boolean;\n  /** Multiplier used to compute length of the elbow in the leader.\n   * The elbowLength is computed in meters as elbowLength * [[lineHeight]].\n   * Default: 1.0\n   */\n  elbowLength?: number;\n  /** Multiplier to compute height of the leader terminator.\n   * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].\n   * Default: 1.0\n   */\n  terminatorHeightFactor?: number;\n  /** Multiplier to compute width of the leader terminator.\n   * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].\n   * Default: 1.0\n   */\n  terminatorWidthFactor?: number;\n}\n\n/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.\n * @beta\n */\nexport interface TextStyleSettingsProps {\n  /** The color of the text.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   * Default: \"\" (an invalid font name).\n   */\n  fontName?: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   * Default: 1.0. */\n  lineHeight?: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   * Default: 0.5.\n   */\n  lineSpacingFactor?: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.\n   * Default: false.\n   */\n  isBold?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*.\n   * Default: false.\n   */\n  isItalic?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined.\n   * Default: false.\n   */\n  isUnderlined?: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   * Default: 0.7.\n   */\n  stackedFractionScale?: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]].\n   * Default: \"horizontal\".\n   */\n  stackedFractionType?: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.15.\n   */\n  subScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  subScriptScale?: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.5.\n   */\n  superScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  superScriptScale?: number;\n  /** A scale applied to the width of each glyph.\n   * Default: 1.0\n   */\n  widthFactor?: number;\n\n  /** Properties describing appearance of leaders in a [[TextAnnotation]]\n   * Used when producing geometry for [[TextAnnotation]]\n   * Default: {color:\"subcategory\", wantElbow:\"false\",elbowLength:1, terminatorWidthFactor:1, terminatorHeightFactor:1}.\n   */\n  leader?: TextLeaderStyleProps;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock.\n   * Default: 4 meters.\n   */\n  tabInterval?: number;\n}\n\n/** A description of the formatting to be applied to a [[TextBlockComponent]].\n * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @see [[TextStyleSettingsProps]] for documentation of each of the settings.\n * @beta\n */\nexport class TextStyleSettings {\n  /** The color of the text. */\n  public readonly color: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   */\n  public readonly fontName: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   */\n  public readonly lineHeight: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   */\n  public readonly lineSpacingFactor: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */\n  public readonly isBold: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */\n  public readonly isItalic: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined. */\n  public readonly isUnderlined: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   */\n  public readonly stackedFractionScale: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */\n  public readonly stackedFractionType: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly subScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   */\n  public readonly subScriptScale: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly superScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   */\n  public readonly superScriptScale: number;\n  /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */\n  public readonly widthFactor: number;\n  /** Properties describing appearance of leaders in a [[TextAnnotation]].\n   * Used when producing geometry for [[TextAnnotation]].\n   */\n  public readonly leader: Readonly<Required<TextLeaderStyleProps>>;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.\n   */\n  public readonly tabInterval: number;\n\n  /** A fully-populated JSON representation of the default settings. */\n  public static defaultProps: Readonly<Required<TextStyleSettingsProps>> = {\n    color: \"subcategory\",\n    fontName: \"\",\n    lineHeight: 1,\n    lineSpacingFactor: 0.5,\n    isBold: false,\n    isItalic: false,\n    isUnderlined: false,\n    stackedFractionScale: 0.7,\n    stackedFractionType: \"horizontal\",\n    subScriptOffsetFactor: -0.15,\n    subScriptScale: 2 / 3,\n    superScriptOffsetFactor: 0.5,\n    superScriptScale: 2 / 3,\n    widthFactor: 1,\n    leader: {\n      color: \"subcategory\",\n      wantElbow: false,\n      elbowLength: 1.0,\n      terminatorHeightFactor: 1.0,\n      terminatorWidthFactor: 1.0,\n    },\n    tabInterval: 4,\n  };\n\n  /** Settings initialized to all default values. */\n  public static defaults: TextStyleSettings = new TextStyleSettings({});\n\n  private constructor(props: TextStyleSettingsProps, defaults?: Required<TextStyleSettingsProps>) {\n    if (!defaults) {\n      defaults = TextStyleSettings.defaultProps;\n    }\n\n    this.color = props.color ?? defaults.color;\n    this.fontName = props.fontName ?? defaults.fontName;\n    this.lineHeight = props.lineHeight ?? defaults.lineHeight;\n    this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;\n    this.isBold = props.isBold ?? defaults.isBold;\n    this.isItalic = props.isItalic ?? defaults.isItalic;\n    this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;\n    this.stackedFractionScale = props.stackedFractionScale ?? defaults.stackedFractionScale;\n    this.stackedFractionType = props.stackedFractionType ?? defaults.stackedFractionType;\n    this.subScriptOffsetFactor = props.subScriptOffsetFactor ?? defaults.subScriptOffsetFactor;\n    this.subScriptScale = props.subScriptScale ?? defaults.subScriptScale;\n    this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;\n    this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;\n    this.widthFactor = props.widthFactor ?? defaults.widthFactor;\n    const leader = {\n      color: props.leader?.color ?? defaults.leader.color,\n      wantElbow: props.leader?.wantElbow ?? defaults.leader.wantElbow,\n      elbowLength: props.leader?.elbowLength ?? defaults.leader.elbowLength,\n      terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,\n      terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,\n    }\n    this.leader = Object.freeze(leader) as Readonly<Required<TextLeaderStyleProps>>;\n    this.tabInterval = props.tabInterval ?? defaults.tabInterval;\n  }\n\n  /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */\n  public clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings {\n    return alteredProps ? new TextStyleSettings(alteredProps, this) : this;\n  }\n\n  /** Create settings from their JSON representation. */\n  public static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings {\n    return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;\n  }\n\n  public toJSON(): TextStyleSettingsProps {\n    return { ...this };\n  }\n  /** Compare two [[TextLeaderStyleProps]] for equality.\n   * @param other The other leader style properties to compare against.\n   * @returns true if the two leader styles are equal, false otherwise.\n   */\n  public leaderEquals(other: TextLeaderStyleProps): boolean {\n    return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow\n      && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor\n      && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;\n  }\n\n  public equals(other: TextStyleSettings): boolean {\n    return this.color === other.color && this.fontName === other.fontName\n      && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor\n      && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined\n      && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale\n      && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale\n      && this.superScriptOffsetFactor === other.superScriptOffsetFactor\n      && this.superScriptScale === other.superScriptScale\n      && this.tabInterval === other.tabInterval && this.leaderEquals(other.leader);\n  }\n}\n\nObject.freeze(TextStyleSettings.defaultProps);\nObject.freeze(TextStyleSettings.defaults);\n\n/** The JSON representation of a [[TextStyle]].\n * @beta\n */\nexport interface TextStyleProps {\n  /** The name of the style. */\n  name: string;\n  /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */\n  settings?: TextStyleSettingsProps;\n}\n\n/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).\n * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @beta\n */\nexport class TextStyle {\n  public readonly name: string;\n  public readonly settings: TextStyleSettings;\n\n  private constructor(name: string, settings: TextStyleSettings) {\n    this.name = name;\n    this.settings = settings;\n  }\n\n  /** Create a style from its JSON representation. */\n  public static fromJSON(json: TextStyleProps): TextStyle {\n    return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));\n  }\n\n  /** Create a new style. */\n  public static create(name: string, settings: TextStyleSettings): TextStyle {\n    return new TextStyle(name, settings);\n  }\n\n  /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */\n  public clone(alteredSettings: TextStyleSettingsProps): TextStyle {\n    return TextStyle.create(this.name, this.settings.clone(alteredSettings));\n  }\n\n  public equals(other: TextStyle): boolean {\n    return this.name === other.name && this.settings.equals(other.settings);\n  }\n}\n\n"]}

package/lib/esm/annotation/TextAnnotation.d.ts

@@ -3,7 +3,7 @@
  */
 import { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
 import { TextBlock, TextBlockProps } from "./TextBlock";
-import { TextStyleColor } from "./TextStyle";
+import { TextStyleColor, TextStyleSettingsProps } from "./TextStyle";
 /** Describes how to compute the "anchor point" for a [[TextAnnotation]].
  * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].
  * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point
@@ -57,6 +57,73 @@ export interface TextFrameStyleProps {
     /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */
     borderWeight?: number;
 }
+/**
+ * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].
+ * Leader can be attached using one of the three modes:
+ * - KeyPoint: attach to a point on the frame specified by the given curveIndex and fractional position.
+ * - TextPoint: attach to a point that is projected on to the frame from the point on a particular line of text specified by [[LeaderTextPointOptions]].
+ * - Nearest: attach to the point on frame that is nearest to [[TextAnnotationLeader.startPoint]].
+ * @beta
+ */
+export type LeaderAttachment = {
+    mode: "KeyPoint";
+    curveIndex: number;
+    fraction: number;
+} | {
+    mode: "TextPoint";
+    position: LeaderTextPointOptions;
+} | {
+    mode: "Nearest";
+};
+/**
+ * Specifies the possible positions to attach a leader on the frame around a [[TextBlock]]
+ * when [[TextAnnotationLeader.attachment.mode]] is set to TextPoint.
+ * TopLeft : attach to a point projected onto the frame from the point on the left side of the first line of text.
+ * TopRight : attach to a point projected onto the frame from the point on the right side of the first line of text.
+ * BottomLeft : attach to a point projected onto the frame from the point on the left side of the last line of text.
+ * BottomRight : attach to a point projected onto the frame from the point on the right side of the last line of text.
+ * @beta
+ */
+export type LeaderTextPointOptions = "TopLeft" | "TopRight" | "BottomLeft" | "BottomRight";
+/**
+ * A line that connects a [[TextAnnotation]] to a point in space relative to another element in the iModel.
+ * A leader is always attached to the frame around the annotation's [[TextBlock]].
+ * If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.
+ * @see [[TextAnnotation.leaders]] for the leaders associated with an annotation.
+ * @see [[TextStyleSettings.leader]] and [[styleOverrides]] to customize the appearance of leaders.
+ * @beta
+*/
+export interface TextAnnotationLeader {
+    /** The point where the leader starts.
+     * This is the point on another element where the leader points to */
+    startPoint: Point3d;
+    /** Describes how to attach the leader to the frame around [[textBlock]].*/
+    attachment: LeaderAttachment;
+    /** Optional intermediate points that the leader should pass through.
+     * If not specified, the leader will be a straight line from startPoint to the point on the frame.
+     * For now, intermediate points are a set of points which create additional LineSegments in the leader, but there could be intermediate shapes instead of straight LineSegments in future*/
+    intermediatePoints?: Point3d[];
+    /** Optional style overrides for the leader. If not specified, the leader will use the style defined by [[TextBlock.styleName]] as it is.
+     * If specified, these overrides will be applied to the style.
+     */
+    styleOverrides?: TextStyleSettingsProps;
+}
+/**
+ * JSON representation of a [[TextAnnotationLeader]].
+ * @beta
+ */
+export interface TextAnnotationLeaderProps {
+    /** See [[TextAnnotationLeader.startPoint]]. */
+    startPoint: XYZProps;
+    /** See [[TextAnnotationLeader.attachment]]. */
+    attachment: LeaderAttachment;
+    /** See [[TextAnnotationLeader.intermediatePoints]]. Default: no intermediate points. */
+    intermediatePoints?: XYZProps[];
+    /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */
+    styleOverrides?: TextStyleSettingsProps;
+}
+/**
+
 /**
  * JSON representation of a [[TextAnnotation]].
  * @beta
@@ -72,6 +139,8 @@ export interface TextAnnotationProps {
     anchor?: TextAnnotationAnchor;
     /** See [[TextAnnotation.frame]]. Default: no frame */
     frame?: TextFrameStyleProps;
+    /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
+    leaders?: TextAnnotationLeaderProps[];
 }
 /** Arguments supplied to [[TextAnnotation.create]].
  * @beta
@@ -87,6 +156,8 @@ export interface TextAnnotationCreateArgs {
     anchor?: TextAnnotationAnchor;
     /** See [[TextAnnotation.frame]]. Default: no frame */
     frame?: TextFrameStyleProps;
+    /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
+    leaders?: TextAnnotationLeader[];
 }
 /**
  * Represents a formatted block of text positioned in 2d or 3d space.
@@ -114,6 +185,8 @@ export declare class TextAnnotation {
     offset: Point3d;
     /** The frame settings of the text annotation. */
     frame?: TextFrameStyleProps;
+    /** The leaders of the text annotation. */
+    leaders?: TextAnnotationLeader[];
     private constructor();
     /** Creates a new TextAnnotation. */
     static create(args?: TextAnnotationCreateArgs): TextAnnotation;
@@ -140,6 +213,8 @@ export declare class TextAnnotation {
      * @see [[computeTransform]] to compute the transform relative to the anchor point.
      */
     computeAnchorPoint(boundingBox: Range2d): Point3d;
+    /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */
+    private areLeadersEqual;
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other: TextAnnotation): boolean;
 }

package/lib/esm/annotation/TextAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,gIAAgI;IAChI,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAA;CAC5B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,iDAAiD;IAC1C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAEnC,OAAO;IAQP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IAYrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAU9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAyBpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAW9C"}
+{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,gIAAgI;IAChI,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,aAAa,CAAA;AAE1F;;;;;;;EAOE;AACF,MAAM,WAAW,oBAAoB;IACnC;yEACqE;IACrE,UAAU,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,UAAU,EAAE,gBAAgB,CAAC;IAC7B;;+LAE2L;IAC3L,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,QAAQ,CAAC;IACrB,+CAA+C;IAC/C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChC,gFAAgF;IAChF,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,iDAAiD;IAC1C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IACnC,0CAA0C;IACnC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExC,OAAO;IASP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IAYrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAgB9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAgCpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0FAA0F;IAC1F,OAAO,CAAC,eAAe;IAsBvB,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAmB9C"}

package/lib/esm/annotation/TextAnnotation.js

@@ -37,12 +37,15 @@ export class TextAnnotation {
     offset;
     /** The frame settings of the text annotation. */
     frame;
-    constructor(offset, angles, textBlock, anchor, frame) {
+    /** The leaders of the text annotation. */
+    leaders;
+    constructor(offset, angles, textBlock, anchor, frame, leaders) {
         this.offset = offset;
         this.orientation = angles;
         this.textBlock = textBlock;
         this.anchor = anchor;
         this.frame = frame;
+        this.leaders = leaders;
     }
     /** Creates a new TextAnnotation. */
     static create(args) {
@@ -53,7 +56,8 @@ export class TextAnnotation {
         // If the user supplies a frame, but doesn't supply a shape, default the shape to "rectangle"
         const shape = args?.frame?.shape ?? "rectangle";
         const frame = args?.frame ? { shape, ...args.frame } : undefined;
-        return new TextAnnotation(offset, angles, textBlock, anchor, frame);
+        const leaders = args?.leaders ?? undefined;
+        return new TextAnnotation(offset, angles, textBlock, anchor, frame, leaders);
     }
     /**
      * Creates a new TextAnnotation instance from its JSON representation.
@@ -65,6 +69,12 @@ export class TextAnnotation {
             textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,
             anchor: props?.anchor ? { ...props.anchor } : undefined,
             frame: props?.frame ? { shape: "rectangle", ...props.frame } : undefined,
+            leaders: props?.leaders ? props.leaders.map((leader) => ({
+                startPoint: Point3d.fromJSON(leader.startPoint),
+                attachment: leader.attachment,
+                styleOverrides: leader.styleOverrides ?? undefined,
+                intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => Point3d.fromJSON(point)) : undefined,
+            })) : undefined,
         });
     }
     /**
@@ -86,6 +96,12 @@ export class TextAnnotation {
         }
         // Default frame to "none"
         props.frame = this.frame ? { ...this.frame } : undefined;
+        props.leaders = this.leaders?.map((leader) => ({
+            startPoint: leader.startPoint.toJSON(),
+            attachment: leader.attachment,
+            styleOverrides: leader.styleOverrides ?? undefined,
+            intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => point.toJSON()) : undefined,
+        })) ?? undefined;
         return props;
     }
     /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.
@@ -129,16 +145,47 @@ export class TextAnnotation {
         }
         return new Point3d(x, y, 0);
     }
+    /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */
+    areLeadersEqual(leadersA, leadersB) {
+        if (leadersA === leadersB)
+            return true;
+        if (!leadersA || !leadersB || leadersA.length !== leadersB.length)
+            return false;
+        for (let i = 0; i < leadersA.length; ++i) {
+            const a = leadersA[i];
+            const b = leadersB[i];
+            if (!a.startPoint.isAlmostEqual(b.startPoint))
+                return false;
+            if (JSON.stringify(a.attachment) !== JSON.stringify(b.attachment))
+                return false;
+            if (JSON.stringify(a.styleOverrides) !== JSON.stringify(b.styleOverrides))
+                return false;
+            const pointsA = a.intermediatePoints ?? [];
+            const pointsB = b.intermediatePoints ?? [];
+            if (pointsA.length !== pointsB.length)
+                return false;
+            for (let j = 0; j < pointsA.length; ++j) {
+                if (!pointsA[j].isAlmostEqual(pointsB[j]))
+                    return false;
+            }
+        }
+        return true;
+    }
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other) {
+        if (this.anchor.horizontal !== other.anchor.horizontal ||
+            this.anchor.vertical !== other.anchor.vertical ||
+            !this.orientation.isAlmostEqual(other.orientation) ||
+            !this.offset.isAlmostEqual(other.offset) ||
+            !this.textBlock.equals(other.textBlock))
+            return false;
         const framesMatch = this.frame?.shape === other.frame?.shape
             && this.frame?.fill === other.frame?.fill
             && this.frame?.border === other.frame?.border
             && this.frame?.borderWeight === other.frame?.borderWeight;
-        return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical
-            && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)
-            && this.textBlock.equals(other.textBlock)
-            && framesMatch;
+        if (!framesMatch)
+            return false;
+        return this.areLeadersEqual(this.leaders, other.leaders);
     }
 }
 //# sourceMappingURL=TextAnnotation.js.map

package/lib/esm/annotation/TextAnnotation.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAW,SAAS,EAAY,kBAAkB,EAAqB,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAkB,MAAM,aAAa,CAAC;AA6BxD;;EAEE;AACF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAU,CAAC;AA+DvM;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IACvB,iDAAiD;IAC1C,KAAK,CAAuB;IAEnC,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B,EAAE,KAA2B;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kBAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACvE,6FAA6F;QAC7F,MAAM,KAAK,GAA6B,IAAI,EAAE,KAAK,EAAE,KAAK,IAAI,WAAW,CAAC;QAC1E,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEjE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;YACvD,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;SACzE,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,yFAAyF;QACzF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,0BAA0B;QAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAoB;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,SAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE7E,OAAO,WAAW,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,WAAoB;QAC5C,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3B,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,KAAK;eACvD,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,IAAI;eACtC,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,KAAK,EAAE,MAAM;eAC1C,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC;QAE5D,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;eACtG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;eAC5F,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;eACtC,WAAW,CAAC;IACnB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\nimport { TextStyleColor } from \"./TextStyle\";\n\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\n * [[TextAnnotation.computeTransform]] will align the anchor point with (0, 0).\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\n * @beta\n */\nexport interface TextAnnotationAnchor {\n  /**\n   * The vertical alignment of the anchor point.\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\n   */\n  vertical: \"top\" | \"middle\" | \"bottom\";\n\n  /**\n   * The horizontal alignment of the anchor point.\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\n   */\n  horizontal: \"left\" | \"center\" | \"right\";\n}\n\n/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport const textAnnotationFrameShapes = [\"none\", \"line\", \"rectangle\", \"circle\", \"equilateralTriangle\", \"diamond\", \"square\", \"pentagon\", \"hexagon\", \"octagon\", \"capsule\", \"roundedRectangle\"] as const;\n\n/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];\n\n/**\n * Describes what color to use when filling the frame around a [[TextBlock]].\n * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.\n * @beta\n */\nexport type TextAnnotationFillColor = TextStyleColor | \"background\";\n\n/**\n * Describes how to draw the frame around a [[TextBlock]].\n * The frame can be a simple line, a filled shape, or both.\n * @beta\n */\nexport interface TextFrameStyleProps {\n  /** Shape of the frame. Default: \"rectangle\" */\n  shape?: TextAnnotationFrameShape;\n  /** The color to fill the shape of the text frame. This fill will is applied using [[FillDisplay.Blanking]]. Default: no fill */\n  fill?: TextAnnotationFillColor;\n  /** The color of the text frame's outline. Default: black */\n  border?: TextStyleColor;\n  /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */\n  borderWeight?: number;\n}\n\n/**\n * JSON representation of a [[TextAnnotation]].\n * @beta\n */\nexport interface TextAnnotationProps {\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\n  offset?: XYZProps;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollProps;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlockProps;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps\n}\n\n/** Arguments supplied to [[TextAnnotation.create]].\n * @beta\n */\nexport interface TextAnnotationCreateArgs {\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\n  offset?: Point3d;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollAngles;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlock;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps\n}\n\n/**\n * Represents a formatted block of text positioned in 2d or 3d space.\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\n * - First, a bounding box is computed enclosing the contents of the [[textBlock].\n * - Then, an \"anchor point\" is computed based on the bounding box and the [[anchor]] property. The anchor point can be at one of the four corners of the box, in the middle of one of its four\n * edges, or in the center of the box.\n * - The [[orientation]] is applied to rotate the box around the anchor point.\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\n * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].\n * @beta\n */\nexport class TextAnnotation {\n  /** The rotation of the annotation.\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\n   */\n  public orientation: YawPitchRollAngles;\n  /** The formatted document. */\n  public textBlock: TextBlock;\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\n  public anchor: TextAnnotationAnchor;\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\n  public offset: Point3d;\n  /** The frame settings of the text annotation. */\n  public frame?: TextFrameStyleProps;\n\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor, frame?: TextFrameStyleProps) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\n    this.frame = frame\n  }\n\n  /** Creates a new TextAnnotation. */\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\n    const offset = args?.offset ?? new Point3d();\n    const angles = args?.orientation ?? new YawPitchRollAngles();\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\n    // If the user supplies a frame, but doesn't supply a shape, default the shape to \"rectangle\"\n    const shape: TextAnnotationFrameShape = args?.frame?.shape ?? \"rectangle\";\n    const frame = args?.frame ? { shape, ...args.frame } : undefined;\n\n    return new TextAnnotation(offset, angles, textBlock, anchor, frame);\n  }\n\n  /**\n   * Creates a new TextAnnotation instance from its JSON representation.\n   */\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\n    return TextAnnotation.create({\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\n      frame: props?.frame ? { shape: \"rectangle\", ...props.frame } : undefined,\n    });\n  }\n\n  /**\n   * Converts this annotation to its JSON representation.\n   */\n  public toJSON(): TextAnnotationProps {\n    const props: TextAnnotationProps = {};\n\n    // Even if the text block is empty, we want to record its style name and overrides, e.g.,\n    // so the user can pick up where they left off editing it next time.\n    props.textBlock = this.textBlock.toJSON();\n\n    if (!this.offset.isZero) {\n      props.offset = this.offset.toJSON();\n    }\n\n    if (!this.orientation.isIdentity()) {\n      props.orientation = this.orientation.toJSON();\n    }\n\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\n      props.anchor = { ...this.anchor };\n    }\n\n    // Default frame to \"none\"\n    props.frame = this.frame ? { ...this.frame } : undefined;\n\n    return props;\n  }\n\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].\n   * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.\n   * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\n   * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n   */\n  public computeTransform(boundingBox: Range2d): Transform {\n    const anchorPt = this.computeAnchorPoint(boundingBox);\n    const matrix = this.orientation.toMatrix3d();\n\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\n    const translation = Transform.createTranslation(this.offset.minus(anchorPt));\n\n    return translation.multiplyTransformTransform(rotation, rotation);\n  }\n\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\n   * @param boundingBox A box fully containing the [[textBlock]].\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\n   */\n  public computeAnchorPoint(boundingBox: Range2d): Point3d {\n    let x = boundingBox.low.x;\n    let y = boundingBox.high.y;\n\n    switch (this.anchor.horizontal) {\n      case \"center\":\n        x += boundingBox.xLength() / 2;\n        break;\n      case \"right\":\n        x += boundingBox.xLength();\n        break;\n    }\n\n    switch (this.anchor.vertical) {\n      case \"middle\":\n        y -= boundingBox.yLength() / 2;\n        break;\n      case \"bottom\":\n        y -= boundingBox.yLength();\n        break;\n    }\n\n    return new Point3d(x, y, 0);\n  }\n\n  /** Returns true if this annotation is logically equivalent to `other`. */\n  public equals(other: TextAnnotation): boolean {\n    const framesMatch = this.frame?.shape === other.frame?.shape\n      && this.frame?.fill === other.frame?.fill\n      && this.frame?.border === other.frame?.border\n      && this.frame?.borderWeight === other.frame?.borderWeight;\n\n    return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical\n      && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)\n      && this.textBlock.equals(other.textBlock)\n      && framesMatch;\n  }\n}\n"]}
+{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAW,SAAS,EAAY,kBAAkB,EAAqB,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAkB,MAAM,aAAa,CAAC;AA6BxD;;EAEE;AACF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAU,CAAC;AAmIvM;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IACvB,iDAAiD;IAC1C,KAAK,CAAuB;IACnC,0CAA0C;IACnC,OAAO,CAA0B;IAExC,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B,EAAE,KAA2B,EAAE,OAAgC;QAChL,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kBAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACvE,6FAA6F;QAC7F,MAAM,KAAK,GAA6B,IAAI,EAAE,KAAK,EAAE,KAAK,IAAI,WAAW,CAAC;QAC1E,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,SAAS,CAAC;QAC3C,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;YACvD,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;YACxE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvD,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC/C,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,SAAS;gBAClD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;aAC9H,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,yFAAyF;QACzF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,0BAA0B;QAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzD,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC7C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,SAAS;YAClD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;SACrH,CAAC,CAAC,IAAI,SAAS,CAAC;QAEjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAoB;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,SAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE7E,OAAO,WAAW,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,WAAoB;QAC5C,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3B,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0FAA0F;IAClF,eAAe,CAAC,QAAiC,EAAE,QAAiC;QAC1F,IAAI,QAAQ,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACvC,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAEhF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAEtB,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC5D,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YAChF,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC;gBAAE,OAAO,KAAK,CAAC;YAExF,MAAM,OAAO,GAAG,CAAC,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,CAAC,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBAAE,OAAO,KAAK,CAAC;YAC1D,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU;YACpD,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;YAC9C,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAClD,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;YACxC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YACvC,OAAO,KAAK,CAAC;QAEf,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,KAAK;eACvD,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,IAAI;eACtC,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,KAAK,EAAE,MAAM;eAC1C,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC;QAE5D,IAAI,CAAC,WAAW;YACd,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3D,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\nimport { TextStyleColor, TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\n * [[TextAnnotation.computeTransform]] will align the anchor point with (0, 0).\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\n * @beta\n */\nexport interface TextAnnotationAnchor {\n  /**\n   * The vertical alignment of the anchor point.\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\n   */\n  vertical: \"top\" | \"middle\" | \"bottom\";\n\n  /**\n   * The horizontal alignment of the anchor point.\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\n   */\n  horizontal: \"left\" | \"center\" | \"right\";\n}\n\n/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport const textAnnotationFrameShapes = [\"none\", \"line\", \"rectangle\", \"circle\", \"equilateralTriangle\", \"diamond\", \"square\", \"pentagon\", \"hexagon\", \"octagon\", \"capsule\", \"roundedRectangle\"] as const;\n\n/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];\n\n/**\n * Describes what color to use when filling the frame around a [[TextBlock]].\n * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.\n * @beta\n */\nexport type TextAnnotationFillColor = TextStyleColor | \"background\";\n\n/**\n * Describes how to draw the frame around a [[TextBlock]].\n * The frame can be a simple line, a filled shape, or both.\n * @beta\n */\nexport interface TextFrameStyleProps {\n  /** Shape of the frame. Default: \"rectangle\" */\n  shape?: TextAnnotationFrameShape;\n  /** The color to fill the shape of the text frame. This fill will is applied using [[FillDisplay.Blanking]]. Default: no fill */\n  fill?: TextAnnotationFillColor;\n  /** The color of the text frame's outline. Default: black */\n  border?: TextStyleColor;\n  /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */\n  borderWeight?: number;\n}\n\n/**\n * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].\n * Leader can be attached using one of the three modes:\n * - KeyPoint: attach to a point on the frame specified by the given curveIndex and fractional position.\n * - TextPoint: attach to a point that is projected on to the frame from the point on a particular line of text specified by [[LeaderTextPointOptions]].\n * - Nearest: attach to the point on frame that is nearest to [[TextAnnotationLeader.startPoint]].\n * @beta\n */\nexport type LeaderAttachment =\n  | { mode: \"KeyPoint\"; curveIndex: number; fraction: number }\n  | { mode: \"TextPoint\"; position: LeaderTextPointOptions }\n  | { mode: \"Nearest\" };\n\n/**\n * Specifies the possible positions to attach a leader on the frame around a [[TextBlock]]\n * when [[TextAnnotationLeader.attachment.mode]] is set to TextPoint.\n * TopLeft : attach to a point projected onto the frame from the point on the left side of the first line of text.\n * TopRight : attach to a point projected onto the frame from the point on the right side of the first line of text.\n * BottomLeft : attach to a point projected onto the frame from the point on the left side of the last line of text.\n * BottomRight : attach to a point projected onto the frame from the point on the right side of the last line of text.\n * @beta\n */\nexport type LeaderTextPointOptions = \"TopLeft\" | \"TopRight\" | \"BottomLeft\" | \"BottomRight\"\n\n/**\n * A line that connects a [[TextAnnotation]] to a point in space relative to another element in the iModel.\n * A leader is always attached to the frame around the annotation's [[TextBlock]].\n * If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.\n * @see [[TextAnnotation.leaders]] for the leaders associated with an annotation.\n * @see [[TextStyleSettings.leader]] and [[styleOverrides]] to customize the appearance of leaders.\n * @beta\n*/\nexport interface TextAnnotationLeader {\n  /** The point where the leader starts.\n   * This is the point on another element where the leader points to */\n  startPoint: Point3d;\n  /** Describes how to attach the leader to the frame around [[textBlock]].*/\n  attachment: LeaderAttachment;\n  /** Optional intermediate points that the leader should pass through.\n   * If not specified, the leader will be a straight line from startPoint to the point on the frame.\n   * For now, intermediate points are a set of points which create additional LineSegments in the leader, but there could be intermediate shapes instead of straight LineSegments in future*/\n  intermediatePoints?: Point3d[];\n  /** Optional style overrides for the leader. If not specified, the leader will use the style defined by [[TextBlock.styleName]] as it is.\n   * If specified, these overrides will be applied to the style.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n/**\n * JSON representation of a [[TextAnnotationLeader]].\n * @beta\n */\nexport interface TextAnnotationLeaderProps {\n  /** See [[TextAnnotationLeader.startPoint]]. */\n  startPoint: XYZProps;\n  /** See [[TextAnnotationLeader.attachment]]. */\n  attachment: LeaderAttachment;\n  /** See [[TextAnnotationLeader.intermediatePoints]]. Default: no intermediate points. */\n  intermediatePoints?: XYZProps[];\n  /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/**\n\n/**\n * JSON representation of a [[TextAnnotation]].\n * @beta\n */\nexport interface TextAnnotationProps {\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\n  offset?: XYZProps;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollProps;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlockProps;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps;\n  /** See [[TextAnnotation.leader]]. Default: an empty leader array  */\n  leaders?: TextAnnotationLeaderProps[];\n}\n\n/** Arguments supplied to [[TextAnnotation.create]].\n * @beta\n */\nexport interface TextAnnotationCreateArgs {\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\n  offset?: Point3d;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollAngles;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlock;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.frame]]. Default: no frame */\n  frame?: TextFrameStyleProps;\n  /** See [[TextAnnotation.leader]]. Default: an empty leader array  */\n  leaders?: TextAnnotationLeader[];\n}\n\n/**\n * Represents a formatted block of text positioned in 2d or 3d space.\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\n * - First, a bounding box is computed enclosing the contents of the [[textBlock].\n * - Then, an \"anchor point\" is computed based on the bounding box and the [[anchor]] property. The anchor point can be at one of the four corners of the box, in the middle of one of its four\n * edges, or in the center of the box.\n * - The [[orientation]] is applied to rotate the box around the anchor point.\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\n * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].\n * @beta\n */\nexport class TextAnnotation {\n  /** The rotation of the annotation.\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\n   */\n  public orientation: YawPitchRollAngles;\n  /** The formatted document. */\n  public textBlock: TextBlock;\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\n  public anchor: TextAnnotationAnchor;\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\n  public offset: Point3d;\n  /** The frame settings of the text annotation. */\n  public frame?: TextFrameStyleProps;\n  /** The leaders of the text annotation. */\n  public leaders?: TextAnnotationLeader[];\n\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor, frame?: TextFrameStyleProps, leaders?: TextAnnotationLeader[]) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\n    this.frame = frame;\n    this.leaders = leaders;\n  }\n\n  /** Creates a new TextAnnotation. */\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\n    const offset = args?.offset ?? new Point3d();\n    const angles = args?.orientation ?? new YawPitchRollAngles();\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\n    // If the user supplies a frame, but doesn't supply a shape, default the shape to \"rectangle\"\n    const shape: TextAnnotationFrameShape = args?.frame?.shape ?? \"rectangle\";\n    const frame = args?.frame ? { shape, ...args.frame } : undefined;\n    const leaders = args?.leaders ?? undefined;\n    return new TextAnnotation(offset, angles, textBlock, anchor, frame, leaders);\n  }\n\n  /**\n   * Creates a new TextAnnotation instance from its JSON representation.\n   */\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\n    return TextAnnotation.create({\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\n      frame: props?.frame ? { shape: \"rectangle\", ...props.frame } : undefined,\n      leaders: props?.leaders ? props.leaders.map((leader) => ({\n        startPoint: Point3d.fromJSON(leader.startPoint),\n        attachment: leader.attachment,\n        styleOverrides: leader.styleOverrides ?? undefined,\n        intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => Point3d.fromJSON(point)) : undefined,\n      })) : undefined,\n    });\n  }\n\n  /**\n   * Converts this annotation to its JSON representation.\n   */\n  public toJSON(): TextAnnotationProps {\n    const props: TextAnnotationProps = {};\n\n    // Even if the text block is empty, we want to record its style name and overrides, e.g.,\n    // so the user can pick up where they left off editing it next time.\n    props.textBlock = this.textBlock.toJSON();\n\n    if (!this.offset.isZero) {\n      props.offset = this.offset.toJSON();\n    }\n\n    if (!this.orientation.isIdentity()) {\n      props.orientation = this.orientation.toJSON();\n    }\n\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\n      props.anchor = { ...this.anchor };\n    }\n\n    // Default frame to \"none\"\n    props.frame = this.frame ? { ...this.frame } : undefined;\n\n    props.leaders = this.leaders?.map((leader) => ({\n      startPoint: leader.startPoint.toJSON(),\n      attachment: leader.attachment,\n      styleOverrides: leader.styleOverrides ?? undefined,\n      intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => point.toJSON()) : undefined,\n    })) ?? undefined;\n\n    return props;\n  }\n\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].\n   * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.\n   * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\n   * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n   */\n  public computeTransform(boundingBox: Range2d): Transform {\n    const anchorPt = this.computeAnchorPoint(boundingBox);\n    const matrix = this.orientation.toMatrix3d();\n\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\n    const translation = Transform.createTranslation(this.offset.minus(anchorPt));\n\n    return translation.multiplyTransformTransform(rotation, rotation);\n  }\n\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\n   * @param boundingBox A box fully containing the [[textBlock]].\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\n   */\n  public computeAnchorPoint(boundingBox: Range2d): Point3d {\n    let x = boundingBox.low.x;\n    let y = boundingBox.high.y;\n\n    switch (this.anchor.horizontal) {\n      case \"center\":\n        x += boundingBox.xLength() / 2;\n        break;\n      case \"right\":\n        x += boundingBox.xLength();\n        break;\n    }\n\n    switch (this.anchor.vertical) {\n      case \"middle\":\n        y -= boundingBox.yLength() / 2;\n        break;\n      case \"bottom\":\n        y -= boundingBox.yLength();\n        break;\n    }\n\n    return new Point3d(x, y, 0);\n  }\n\n  /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */\n  private areLeadersEqual(leadersA?: TextAnnotationLeader[], leadersB?: TextAnnotationLeader[]): boolean {\n    if (leadersA === leadersB) return true;\n    if (!leadersA || !leadersB || leadersA.length !== leadersB.length) return false;\n\n    for (let i = 0; i < leadersA.length; ++i) {\n      const a = leadersA[i];\n      const b = leadersB[i];\n\n      if (!a.startPoint.isAlmostEqual(b.startPoint)) return false;\n      if (JSON.stringify(a.attachment) !== JSON.stringify(b.attachment)) return false;\n      if (JSON.stringify(a.styleOverrides) !== JSON.stringify(b.styleOverrides)) return false;\n\n      const pointsA = a.intermediatePoints ?? [];\n      const pointsB = b.intermediatePoints ?? [];\n      if (pointsA.length !== pointsB.length) return false;\n      for (let j = 0; j < pointsA.length; ++j) {\n        if (!pointsA[j].isAlmostEqual(pointsB[j])) return false;\n      }\n    }\n    return true;\n  }\n\n  /** Returns true if this annotation is logically equivalent to `other`. */\n  public equals(other: TextAnnotation): boolean {\n    if (this.anchor.horizontal !== other.anchor.horizontal ||\n      this.anchor.vertical !== other.anchor.vertical ||\n      !this.orientation.isAlmostEqual(other.orientation) ||\n      !this.offset.isAlmostEqual(other.offset) ||\n      !this.textBlock.equals(other.textBlock))\n      return false;\n\n    const framesMatch = this.frame?.shape === other.frame?.shape\n      && this.frame?.fill === other.frame?.fill\n      && this.frame?.border === other.frame?.border\n      && this.frame?.borderWeight === other.frame?.borderWeight;\n\n    if (!framesMatch)\n      return false;\n\n    return this.areLeadersEqual(this.leaders, other.leaders);\n\n  }\n}\n"]}

package/lib/esm/annotation/TextStyle.d.ts

@@ -13,6 +13,35 @@ export type StackedFractionType = "horizontal" | "diagonal";
  * @beta
  */
 export type TextStyleColor = ColorDefProps | "subcategory";
+/** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].
+ * Used when producing geometry for [[TextAnnotation]].
+ * @beta
+ */
+export interface TextLeaderStyleProps {
+    /** The color of the leader.
+     * Default: "subcategory".
+     */
+    color?: TextStyleColor;
+    /** Whether to use an elbow in the leader.
+     * Default: false
+     */
+    wantElbow?: boolean;
+    /** Multiplier used to compute length of the elbow in the leader.
+     * The elbowLength is computed in meters as elbowLength * [[lineHeight]].
+     * Default: 1.0
+     */
+    elbowLength?: number;
+    /** Multiplier to compute height of the leader terminator.
+     * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].
+     * Default: 1.0
+     */
+    terminatorHeightFactor?: number;
+    /** Multiplier to compute width of the leader terminator.
+     * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].
+     * Default: 1.0
+     */
+    terminatorWidthFactor?: number;
+}
 /** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.
  * @beta
  */
@@ -80,6 +109,11 @@ export interface TextStyleSettingsProps {
      * Default: 1.0
      */
     widthFactor?: number;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]]
+     * Used when producing geometry for [[TextAnnotation]]
+     * Default: {color:"subcategory", wantElbow:"false",elbowLength:1, terminatorWidthFactor:1, terminatorHeightFactor:1}.
+     */
+    leader?: TextLeaderStyleProps;
     /** The size (in meters) used to calculate the tab stops in a run.
      * These are equally spaced from the left edge of the TextBlock.
      * Default: 4 meters.
@@ -137,6 +171,10 @@ export declare class TextStyleSettings {
     readonly superScriptScale: number;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     readonly widthFactor: number;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]].
+     * Used when producing geometry for [[TextAnnotation]].
+     */
+    readonly leader: Readonly<Required<TextLeaderStyleProps>>;
     /** The size (in meters) used to calculate the tab stops in a run.
      * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
      */
@@ -151,6 +189,11 @@ export declare class TextStyleSettings {
     /** Create settings from their JSON representation. */
     static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings;
     toJSON(): TextStyleSettingsProps;
+    /** Compare two [[TextLeaderStyleProps]] for equality.
+     * @param other The other leader style properties to compare against.
+     * @returns true if the two leader styles are equal, false otherwise.
+     */
+    leaderEquals(other: TextLeaderStyleProps): boolean;
     equals(other: TextStyleSettings): boolean;
 }
 /** The JSON representation of a [[TextStyle]].

package/lib/esm/annotation/TextStyle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAgBpE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA8B;IAEvE,OAAO;IAsBP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIhC,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;CASjD;AAKD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4IAA4I;IAC5I,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,OAAO;IAKP,mDAAmD;WACrC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;IAIvD,0BAA0B;WACZ,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,SAAS;IAI1E,sIAAsI;IAC/H,KAAK,CAAC,eAAe,EAAE,sBAAsB,GAAG,SAAS;IAIzD,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAGzC"}
+{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAuBpE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IA8BP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAGvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;CAUjD;AAKD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4IAA4I;IAC5I,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,OAAO;IAKP,mDAAmD;WACrC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;IAIvD,0BAA0B;WACZ,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,SAAS;IAI1E,sIAAsI;IAC/H,KAAK,CAAC,eAAe,EAAE,sBAAsB,GAAG,SAAS;IAIzD,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAGzC"}

package/lib/esm/annotation/TextStyle.js

@@ -56,6 +56,10 @@ export class TextStyleSettings {
     superScriptScale;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     widthFactor;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]].
+     * Used when producing geometry for [[TextAnnotation]].
+     */
+    leader;
     /** The size (in meters) used to calculate the tab stops in a run.
      * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
      */
@@ -76,6 +80,13 @@ export class TextStyleSettings {
         superScriptOffsetFactor: 0.5,
         superScriptScale: 2 / 3,
         widthFactor: 1,
+        leader: {
+            color: "subcategory",
+            wantElbow: false,
+            elbowLength: 1.0,
+            terminatorHeightFactor: 1.0,
+            terminatorWidthFactor: 1.0,
+        },
         tabInterval: 4,
     };
     /** Settings initialized to all default values. */
@@ -98,6 +109,14 @@ export class TextStyleSettings {
         this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;
         this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;
         this.widthFactor = props.widthFactor ?? defaults.widthFactor;
+        const leader = {
+            color: props.leader?.color ?? defaults.leader.color,
+            wantElbow: props.leader?.wantElbow ?? defaults.leader.wantElbow,
+            elbowLength: props.leader?.elbowLength ?? defaults.leader.elbowLength,
+            terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,
+            terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,
+        };
+        this.leader = Object.freeze(leader);
         this.tabInterval = props.tabInterval ?? defaults.tabInterval;
     }
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
@@ -111,14 +130,24 @@ export class TextStyleSettings {
     toJSON() {
         return { ...this };
     }
+    /** Compare two [[TextLeaderStyleProps]] for equality.
+     * @param other The other leader style properties to compare against.
+     * @returns true if the two leader styles are equal, false otherwise.
+     */
+    leaderEquals(other) {
+        return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow
+            && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor
+            && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;
+    }
     equals(other) {
         return this.color === other.color && this.fontName === other.fontName
             && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor
             && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined
             && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale
             && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale
-            && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale
-            && this.tabInterval === other.tabInterval;
+            && this.superScriptOffsetFactor === other.superScriptOffsetFactor
+            && this.superScriptScale === other.superScriptScale
+            && this.tabInterval === other.tabInterval && this.leaderEquals(other.leader);
     }
 }
 Object.freeze(TextStyleSettings.defaultProps);

package/lib/esm/annotation/TextStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.js","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA2FH;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IAC5B,6BAA6B;IACb,KAAK,CAAiB;IACtC;OACG;IACa,QAAQ,CAAS;IACjC;;;OAGG;IACa,UAAU,CAAS;IACnC;;OAEG;IACa,iBAAiB,CAAS;IAC1C,kFAAkF;IAClE,MAAM,CAAU;IAChC,sFAAsF;IACtE,QAAQ,CAAU;IAClC,2EAA2E;IAC3D,YAAY,CAAU;IACtC;;OAEG;IACa,oBAAoB,CAAS;IAC7C,oFAAoF;IACpE,mBAAmB,CAAsB;IACzD;;OAEG;IACa,qBAAqB,CAAS;IAC9C;;OAEG;IACa,cAAc,CAAS;IACvC;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAS;IACzC,sFAAsF;IACtE,WAAW,CAAS;IACpC;;OAEG;IACa,WAAW,CAAS;IAEpC,qEAAqE;IAC9D,MAAM,CAAC,YAAY,GAA+C;QACvE,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,CAAC;QACb,iBAAiB,EAAE,GAAG;QACtB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,oBAAoB,EAAE,GAAG;QACzB,mBAAmB,EAAE,YAAY;QACjC,qBAAqB,EAAE,CAAC,IAAI;QAC5B,cAAc,EAAE,CAAC,GAAG,CAAC;QACrB,uBAAuB,EAAE,GAAG;QAC5B,gBAAgB,EAAE,CAAC,GAAG,CAAC;QACvB,WAAW,EAAE,CAAC;QACd,WAAW,EAAE,CAAC;KACf,CAAC;IAEF,kDAAkD;IAC3C,MAAM,CAAC,QAAQ,GAAsB,IAAI,iBAAiB,CAAC,EAAG,CAAC,CAAC;IAEvE,YAAoB,KAA6B,EAAE,QAA2C;QAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAChE,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QACxF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACrF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC;QACtE,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QACjG,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,IAAI,QAAQ,CAAC,gBAAgB,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;IAC/D,CAAC;IAED,uGAAuG;IAChG,KAAK,CAAC,YAAqC;QAChD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChE,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACpI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAC5G,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB;eAClH,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;eAC1G,IAAI,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAClH,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,CAAC;IAC9C,CAAC;;AAGH,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAY1C;;;;GAIG;AACH,MAAM,OAAO,SAAS;IACJ,IAAI,CAAS;IACb,QAAQ,CAAoB;IAE5C,YAAoB,IAAY,EAAE,QAA2B;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,QAA2B;QAC5D,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,sIAAsI;IAC/H,KAAK,CAAC,eAAuC;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM,CAAC,KAAgB;QAC5B,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { ColorDefProps } from \"../ColorDef\";\n\n/** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.\n * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].\n * @beta\n */\nexport type StackedFractionType = \"horizontal\" | \"diagonal\";\n\n/** Describes the color in which to draw the text in a [[TextRun]].\n * \"subcategory\" indicates that the text should be drawn using the color of the [SubCategory]($backend) specified by the [GeometryStream]($docs/learning/common/GeometryStream.md) hosting the\n * text.\n * @beta\n */\nexport type TextStyleColor = ColorDefProps | \"subcategory\";\n\n/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.\n * @beta\n */\nexport interface TextStyleSettingsProps {\n  /** The color of the text.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   * Default: \"\" (an invalid font name).\n   */\n  fontName?: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   * Default: 1.0. */\n  lineHeight?: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   * Default: 0.5.\n   */\n  lineSpacingFactor?: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.\n   * Default: false.\n   */\n  isBold?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*.\n   * Default: false.\n   */\n  isItalic?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined.\n   * Default: false.\n   */\n  isUnderlined?: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   * Default: 0.7.\n   */\n  stackedFractionScale?: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]].\n   * Default: \"horizontal\".\n   */\n  stackedFractionType?: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.15.\n   */\n  subScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  subScriptScale?: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.5.\n   */\n  superScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  superScriptScale?: number;\n  /** A scale applied to the width of each glyph.\n   * Default: 1.0\n   */\n  widthFactor?: number;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock.\n   * Default: 4 meters.\n   */\n  tabInterval?: number;\n}\n\n/** A description of the formatting to be applied to a [[TextBlockComponent]].\n * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @see [[TextStyleSettingsProps]] for documentation of each of the settings.\n * @beta\n */\nexport class TextStyleSettings {\n  /** The color of the text. */\n  public readonly color: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   */\n  public readonly fontName: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   */\n  public readonly lineHeight: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   */\n  public readonly lineSpacingFactor: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */\n  public readonly isBold: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */\n  public readonly isItalic: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined. */\n  public readonly isUnderlined: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   */\n  public readonly stackedFractionScale: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */\n  public readonly stackedFractionType: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly subScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   */\n  public readonly subScriptScale: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly superScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   */\n  public readonly superScriptScale: number;\n  /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */\n  public readonly widthFactor: number;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.\n   */\n  public readonly tabInterval: number;\n\n  /** A fully-populated JSON representation of the default settings. */\n  public static defaultProps: Readonly<Required<TextStyleSettingsProps>> = {\n    color: \"subcategory\",\n    fontName: \"\",\n    lineHeight: 1,\n    lineSpacingFactor: 0.5,\n    isBold: false,\n    isItalic: false,\n    isUnderlined: false,\n    stackedFractionScale: 0.7,\n    stackedFractionType: \"horizontal\",\n    subScriptOffsetFactor: -0.15,\n    subScriptScale: 2 / 3,\n    superScriptOffsetFactor: 0.5,\n    superScriptScale: 2 / 3,\n    widthFactor: 1,\n    tabInterval: 4,\n  };\n\n  /** Settings initialized to all default values. */\n  public static defaults: TextStyleSettings = new TextStyleSettings({ });\n\n  private constructor(props: TextStyleSettingsProps, defaults?: Required<TextStyleSettingsProps>) {\n    if (!defaults) {\n      defaults = TextStyleSettings.defaultProps;\n    }\n\n    this.color = props.color ?? defaults.color;\n    this.fontName = props.fontName ?? defaults.fontName;\n    this.lineHeight = props.lineHeight ?? defaults.lineHeight;\n    this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;\n    this.isBold = props.isBold ?? defaults.isBold;\n    this.isItalic = props.isItalic ?? defaults.isItalic;\n    this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;\n    this.stackedFractionScale = props.stackedFractionScale ?? defaults.stackedFractionScale;\n    this.stackedFractionType = props.stackedFractionType ?? defaults.stackedFractionType;\n    this.subScriptOffsetFactor = props.subScriptOffsetFactor ?? defaults.subScriptOffsetFactor;\n    this.subScriptScale = props.subScriptScale ?? defaults.subScriptScale;\n    this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;\n    this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;\n    this.widthFactor = props.widthFactor ?? defaults.widthFactor;\n    this.tabInterval = props.tabInterval ?? defaults.tabInterval;\n  }\n\n  /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */\n  public clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings {\n    return alteredProps ? new TextStyleSettings(alteredProps, this) : this;\n  }\n\n  /** Create settings from their JSON representation. */\n  public static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings {\n    return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;\n  }\n\n  public toJSON(): TextStyleSettingsProps {\n    return { ...this };\n  }\n\n  public equals(other: TextStyleSettings): boolean {\n    return this.color === other.color && this.fontName === other.fontName\n      && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor\n      && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined\n      && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale\n      && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale\n      && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale\n      && this.tabInterval === other.tabInterval;\n  }\n}\n\nObject.freeze(TextStyleSettings.defaultProps);\nObject.freeze(TextStyleSettings.defaults);\n\n/** The JSON representation of a [[TextStyle]].\n * @beta\n */\nexport interface TextStyleProps {\n  /** The name of the style. */\n  name: string;\n  /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */\n  settings?: TextStyleSettingsProps;\n}\n\n/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).\n * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @beta\n */\nexport class TextStyle {\n  public readonly name: string;\n  public readonly settings: TextStyleSettings;\n\n  private constructor(name: string, settings: TextStyleSettings) {\n    this.name = name;\n    this.settings = settings;\n  }\n\n  /** Create a style from its JSON representation. */\n  public static fromJSON(json: TextStyleProps): TextStyle {\n    return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));\n  }\n\n  /** Create a new style. */\n  public static create(name: string, settings: TextStyleSettings): TextStyle {\n    return new TextStyle(name, settings);\n  }\n\n  /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */\n  public clone(alteredSettings: TextStyleSettingsProps): TextStyle {\n    return TextStyle.create(this.name, this.settings.clone(alteredSettings));\n  }\n\n  public equals(other: TextStyle): boolean {\n    return this.name === other.name && this.settings.equals(other.settings);\n  }\n}\n\n"]}
+{"version":3,"file":"TextStyle.js","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA+HH;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IAC5B,6BAA6B;IACb,KAAK,CAAiB;IACtC;OACG;IACa,QAAQ,CAAS;IACjC;;;OAGG;IACa,UAAU,CAAS;IACnC;;OAEG;IACa,iBAAiB,CAAS;IAC1C,kFAAkF;IAClE,MAAM,CAAU;IAChC,sFAAsF;IACtE,QAAQ,CAAU;IAClC,2EAA2E;IAC3D,YAAY,CAAU;IACtC;;OAEG;IACa,oBAAoB,CAAS;IAC7C,oFAAoF;IACpE,mBAAmB,CAAsB;IACzD;;OAEG;IACa,qBAAqB,CAAS;IAC9C;;OAEG;IACa,cAAc,CAAS;IACvC;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAS;IACzC,sFAAsF;IACtE,WAAW,CAAS;IACpC;;OAEG;IACa,MAAM,CAA2C;IACjE;;OAEG;IACa,WAAW,CAAS;IAEpC,qEAAqE;IAC9D,MAAM,CAAC,YAAY,GAA+C;QACvE,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,CAAC;QACb,iBAAiB,EAAE,GAAG;QACtB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,oBAAoB,EAAE,GAAG;QACzB,mBAAmB,EAAE,YAAY;QACjC,qBAAqB,EAAE,CAAC,IAAI;QAC5B,cAAc,EAAE,CAAC,GAAG,CAAC;QACrB,uBAAuB,EAAE,GAAG;QAC5B,gBAAgB,EAAE,CAAC,GAAG,CAAC;QACvB,WAAW,EAAE,CAAC;QACd,MAAM,EAAE;YACN,KAAK,EAAE,aAAa;YACpB,SAAS,EAAE,KAAK;YAChB,WAAW,EAAE,GAAG;YAChB,sBAAsB,EAAE,GAAG;YAC3B,qBAAqB,EAAE,GAAG;SAC3B;QACD,WAAW,EAAE,CAAC;KACf,CAAC;IAEF,kDAAkD;IAC3C,MAAM,CAAC,QAAQ,GAAsB,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC;IAEtE,YAAoB,KAA6B,EAAE,QAA2C;QAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAChE,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QACxF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACrF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC;QACtE,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QACjG,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,IAAI,QAAQ,CAAC,gBAAgB,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;QAC7D,MAAM,MAAM,GAAG;YACb,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK;YACnD,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,SAAS;YAC/D,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,MAAM,CAAC,WAAW;YACrE,sBAAsB,EAAE,KAAK,CAAC,MAAM,EAAE,sBAAsB,IAAI,QAAQ,CAAC,MAAM,CAAC,sBAAsB;YACtG,qBAAqB,EAAE,KAAK,CAAC,MAAM,EAAE,qBAAqB,IAAI,QAAQ,CAAC,MAAM,CAAC,qBAAqB;SACpG,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA6C,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;IAC/D,CAAC;IAED,uGAAuG;IAChG,KAAK,CAAC,YAAqC;QAChD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IACD;;;OAGG;IACI,YAAY,CAAC,KAA2B;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAChF,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAsB,KAAK,KAAK,CAAC,sBAAsB;eACpH,IAAI,CAAC,MAAM,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IACzE,CAAC;IAEM,MAAM,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChE,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACpI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAC5G,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB;eAClH,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;eAC1G,IAAI,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB;eAC9D,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAChD,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;;AAGH,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAY1C;;;;GAIG;AACH,MAAM,OAAO,SAAS;IACJ,IAAI,CAAS;IACb,QAAQ,CAAoB;IAE5C,YAAoB,IAAY,EAAE,QAA2B;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,QAA2B;QAC5D,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,sIAAsI;IAC/H,KAAK,CAAC,eAAuC;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM,CAAC,KAAgB;QAC5B,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { ColorDefProps } from \"../ColorDef\";\n\n/** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.\n * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].\n * @beta\n */\nexport type StackedFractionType = \"horizontal\" | \"diagonal\";\n\n/** Describes the color in which to draw the text in a [[TextRun]].\n * \"subcategory\" indicates that the text should be drawn using the color of the [SubCategory]($backend) specified by the [GeometryStream]($docs/learning/common/GeometryStream.md) hosting the\n * text.\n * @beta\n */\nexport type TextStyleColor = ColorDefProps | \"subcategory\";\n\n/** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].\n * Used when producing geometry for [[TextAnnotation]].\n * @beta\n */\nexport interface TextLeaderStyleProps {\n  /** The color of the leader.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** Whether to use an elbow in the leader.\n   * Default: false\n   */\n  wantElbow?: boolean;\n  /** Multiplier used to compute length of the elbow in the leader.\n   * The elbowLength is computed in meters as elbowLength * [[lineHeight]].\n   * Default: 1.0\n   */\n  elbowLength?: number;\n  /** Multiplier to compute height of the leader terminator.\n   * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].\n   * Default: 1.0\n   */\n  terminatorHeightFactor?: number;\n  /** Multiplier to compute width of the leader terminator.\n   * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].\n   * Default: 1.0\n   */\n  terminatorWidthFactor?: number;\n}\n\n/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.\n * @beta\n */\nexport interface TextStyleSettingsProps {\n  /** The color of the text.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   * Default: \"\" (an invalid font name).\n   */\n  fontName?: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   * Default: 1.0. */\n  lineHeight?: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   * Default: 0.5.\n   */\n  lineSpacingFactor?: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.\n   * Default: false.\n   */\n  isBold?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*.\n   * Default: false.\n   */\n  isItalic?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined.\n   * Default: false.\n   */\n  isUnderlined?: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   * Default: 0.7.\n   */\n  stackedFractionScale?: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]].\n   * Default: \"horizontal\".\n   */\n  stackedFractionType?: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.15.\n   */\n  subScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  subScriptScale?: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.5.\n   */\n  superScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  superScriptScale?: number;\n  /** A scale applied to the width of each glyph.\n   * Default: 1.0\n   */\n  widthFactor?: number;\n\n  /** Properties describing appearance of leaders in a [[TextAnnotation]]\n   * Used when producing geometry for [[TextAnnotation]]\n   * Default: {color:\"subcategory\", wantElbow:\"false\",elbowLength:1, terminatorWidthFactor:1, terminatorHeightFactor:1}.\n   */\n  leader?: TextLeaderStyleProps;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock.\n   * Default: 4 meters.\n   */\n  tabInterval?: number;\n}\n\n/** A description of the formatting to be applied to a [[TextBlockComponent]].\n * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @see [[TextStyleSettingsProps]] for documentation of each of the settings.\n * @beta\n */\nexport class TextStyleSettings {\n  /** The color of the text. */\n  public readonly color: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   */\n  public readonly fontName: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   */\n  public readonly lineHeight: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   */\n  public readonly lineSpacingFactor: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */\n  public readonly isBold: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */\n  public readonly isItalic: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined. */\n  public readonly isUnderlined: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   */\n  public readonly stackedFractionScale: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */\n  public readonly stackedFractionType: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly subScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   */\n  public readonly subScriptScale: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly superScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   */\n  public readonly superScriptScale: number;\n  /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */\n  public readonly widthFactor: number;\n  /** Properties describing appearance of leaders in a [[TextAnnotation]].\n   * Used when producing geometry for [[TextAnnotation]].\n   */\n  public readonly leader: Readonly<Required<TextLeaderStyleProps>>;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.\n   */\n  public readonly tabInterval: number;\n\n  /** A fully-populated JSON representation of the default settings. */\n  public static defaultProps: Readonly<Required<TextStyleSettingsProps>> = {\n    color: \"subcategory\",\n    fontName: \"\",\n    lineHeight: 1,\n    lineSpacingFactor: 0.5,\n    isBold: false,\n    isItalic: false,\n    isUnderlined: false,\n    stackedFractionScale: 0.7,\n    stackedFractionType: \"horizontal\",\n    subScriptOffsetFactor: -0.15,\n    subScriptScale: 2 / 3,\n    superScriptOffsetFactor: 0.5,\n    superScriptScale: 2 / 3,\n    widthFactor: 1,\n    leader: {\n      color: \"subcategory\",\n      wantElbow: false,\n      elbowLength: 1.0,\n      terminatorHeightFactor: 1.0,\n      terminatorWidthFactor: 1.0,\n    },\n    tabInterval: 4,\n  };\n\n  /** Settings initialized to all default values. */\n  public static defaults: TextStyleSettings = new TextStyleSettings({});\n\n  private constructor(props: TextStyleSettingsProps, defaults?: Required<TextStyleSettingsProps>) {\n    if (!defaults) {\n      defaults = TextStyleSettings.defaultProps;\n    }\n\n    this.color = props.color ?? defaults.color;\n    this.fontName = props.fontName ?? defaults.fontName;\n    this.lineHeight = props.lineHeight ?? defaults.lineHeight;\n    this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;\n    this.isBold = props.isBold ?? defaults.isBold;\n    this.isItalic = props.isItalic ?? defaults.isItalic;\n    this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;\n    this.stackedFractionScale = props.stackedFractionScale ?? defaults.stackedFractionScale;\n    this.stackedFractionType = props.stackedFractionType ?? defaults.stackedFractionType;\n    this.subScriptOffsetFactor = props.subScriptOffsetFactor ?? defaults.subScriptOffsetFactor;\n    this.subScriptScale = props.subScriptScale ?? defaults.subScriptScale;\n    this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;\n    this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;\n    this.widthFactor = props.widthFactor ?? defaults.widthFactor;\n    const leader = {\n      color: props.leader?.color ?? defaults.leader.color,\n      wantElbow: props.leader?.wantElbow ?? defaults.leader.wantElbow,\n      elbowLength: props.leader?.elbowLength ?? defaults.leader.elbowLength,\n      terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,\n      terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,\n    }\n    this.leader = Object.freeze(leader) as Readonly<Required<TextLeaderStyleProps>>;\n    this.tabInterval = props.tabInterval ?? defaults.tabInterval;\n  }\n\n  /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */\n  public clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings {\n    return alteredProps ? new TextStyleSettings(alteredProps, this) : this;\n  }\n\n  /** Create settings from their JSON representation. */\n  public static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings {\n    return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;\n  }\n\n  public toJSON(): TextStyleSettingsProps {\n    return { ...this };\n  }\n  /** Compare two [[TextLeaderStyleProps]] for equality.\n   * @param other The other leader style properties to compare against.\n   * @returns true if the two leader styles are equal, false otherwise.\n   */\n  public leaderEquals(other: TextLeaderStyleProps): boolean {\n    return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow\n      && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor\n      && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;\n  }\n\n  public equals(other: TextStyleSettings): boolean {\n    return this.color === other.color && this.fontName === other.fontName\n      && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor\n      && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined\n      && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale\n      && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale\n      && this.superScriptOffsetFactor === other.superScriptOffsetFactor\n      && this.superScriptScale === other.superScriptScale\n      && this.tabInterval === other.tabInterval && this.leaderEquals(other.leader);\n  }\n}\n\nObject.freeze(TextStyleSettings.defaultProps);\nObject.freeze(TextStyleSettings.defaults);\n\n/** The JSON representation of a [[TextStyle]].\n * @beta\n */\nexport interface TextStyleProps {\n  /** The name of the style. */\n  name: string;\n  /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */\n  settings?: TextStyleSettingsProps;\n}\n\n/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).\n * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @beta\n */\nexport class TextStyle {\n  public readonly name: string;\n  public readonly settings: TextStyleSettings;\n\n  private constructor(name: string, settings: TextStyleSettings) {\n    this.name = name;\n    this.settings = settings;\n  }\n\n  /** Create a style from its JSON representation. */\n  public static fromJSON(json: TextStyleProps): TextStyle {\n    return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));\n  }\n\n  /** Create a new style. */\n  public static create(name: string, settings: TextStyleSettings): TextStyle {\n    return new TextStyle(name, settings);\n  }\n\n  /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */\n  public clone(alteredSettings: TextStyleSettingsProps): TextStyle {\n    return TextStyle.create(this.name, this.settings.clone(alteredSettings));\n  }\n\n  public equals(other: TextStyle): boolean {\n    return this.name === other.name && this.settings.equals(other.settings);\n  }\n}\n\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "5.1.0-dev.56",
+  "version": "5.1.0-dev.58",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -27,8 +27,8 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.1.0-dev.56",
-    "@itwin/core-geometry": "5.1.0-dev.56"
+    "@itwin/core-bentley": "5.1.0-dev.58",
+    "@itwin/core-geometry": "5.1.0-dev.58"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "5.0.0-dev.1",
@@ -42,9 +42,9 @@
     "rimraf": "^6.0.1",
     "typescript": "~5.6.2",
     "vitest": "^3.0.6",
-    "@itwin/build-tools": "5.1.0-dev.56",
-    "@itwin/core-geometry": "5.1.0-dev.56",
-    "@itwin/core-bentley": "5.1.0-dev.56"
+    "@itwin/build-tools": "5.1.0-dev.58",
+    "@itwin/core-geometry": "5.1.0-dev.58",
+    "@itwin/core-bentley": "5.1.0-dev.58"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc",