@itwin/core-common 5.1.0-dev.5 → 5.1.0-dev.52

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;AAExD;;;;;;;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;;;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;CAC/B;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;CAC/B;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;IAEvB,OAAO;IAOP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IASrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAS9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAsBpC;;;;;;;;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;CAK9C"}
+{"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,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,qBAAqB,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAGrM;;;;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"}

package/lib/cjs/annotation/TextAnnotation.js

@@ -20,7 +20,7 @@ const TextBlock_1 = require("./TextBlock");
  * edges, or in the center of the box.
  * - The [[orientation]] is applied to rotate the box around the anchor point.
  * - Finally, the [[offset]] is added to the anchor point to apply translation.
- * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].
+ * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].
  * @beta
  */
 class TextAnnotation {
@@ -34,11 +34,14 @@ class TextAnnotation {
     anchor;
     /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */
     offset;
-    constructor(offset, angles, textBlock, anchor) {
+    /** The frame settings of the text annotation. */
+    frame;
+    constructor(offset, angles, textBlock, anchor, frame) {
         this.offset = offset;
         this.orientation = angles;
         this.textBlock = textBlock;
         this.anchor = anchor;
+        this.frame = frame;
     }
     /** Creates a new TextAnnotation. */
     static create(args) {
@@ -46,7 +49,10 @@ class TextAnnotation {
         const angles = args?.orientation ?? new core_geometry_1.YawPitchRollAngles();
         const textBlock = args?.textBlock ?? TextBlock_1.TextBlock.createEmpty();
         const anchor = args?.anchor ?? { vertical: "top", horizontal: "left" };
-        return new TextAnnotation(offset, angles, textBlock, anchor);
+        // 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);
     }
     /**
      * Creates a new TextAnnotation instance from its JSON representation.
@@ -57,6 +63,7 @@ class TextAnnotation {
             orientation: props?.orientation ? core_geometry_1.YawPitchRollAngles.fromJSON(props.orientation) : undefined,
             textBlock: props?.textBlock ? TextBlock_1.TextBlock.create(props.textBlock) : undefined,
             anchor: props?.anchor ? { ...props.anchor } : undefined,
+            frame: props?.frame ? { shape: "rectangle", ...props.frame } : undefined,
         });
     }
     /**
@@ -76,6 +83,8 @@ class TextAnnotation {
         if (this.anchor.vertical !== "top" || this.anchor.horizontal !== "left") {
             props.anchor = { ...this.anchor };
         }
+        // Default frame to "none"
+        props.frame = this.frame ? { ...this.frame } : 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.
@@ -121,9 +130,14 @@ class TextAnnotation {
     }
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other) {
+        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);
+            && this.textBlock.equals(other.textBlock)
+            && framesMatch;
     }
 }
 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;AAyDxD;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IAEvB,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B;QACjH,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;IACvB,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;QAEvE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,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;SACxD,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,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,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,CAAC;IAC9C,CAAC;CACF;AAxHD,wCAwHC","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\";\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/**\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}\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}\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 [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].\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\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\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\n    return new TextAnnotation(offset, angles, textBlock, anchor);\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    });\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    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    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  }\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;AA2FxD;;;;;;;;;;;;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 type TextAnnotationFrameShape = \"none\" | \"line\" | \"rectangle\" | \"circle\" | \"equilateralTriangle\" | \"diamond\" | \"square\" | \"pentagon\" | \"hexagon\" | \"octagon\" | \"capsule\" | \"roundedRectangle\";\n\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"]}

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

@@ -42,6 +42,10 @@ export interface TextBlockStringifyOptions {
      * Default: "/"
      */
     fractionSeparator?: string;
+    /** The number of spaces to use for tabs. If not provided, tabs will be represented by a tab character: "\t".
+     * Default: "undefined" - use "\t".
+     */
+    tabsAsSpaces?: number;
 }
 /** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.
  * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.
@@ -74,6 +78,11 @@ export declare abstract class TextBlockComponent {
     abstract clone(): TextBlockComponent;
     /** Compute a string representation of the contents of this component and all of its sub-components. */
     abstract stringify(options?: TextBlockStringifyOptions): string;
+    /**
+    * Returns true if the string representation of this component consists only of whitespace characters.
+    * Useful for checking if the component is visually empty (producing no graphics) or contains only spaces, tabs, or line breaks.
+    */
+    get isWhitespace(): boolean;
     /** Convert this component to its JSON representation. */
     toJSON(): TextBlockComponentProps;
     /** Returns true if `this` is equivalent to `other`. */
@@ -82,12 +91,12 @@ export declare abstract class TextBlockComponent {
 /**
  * @beta
  */
-export type Run = TextRun | FractionRun | LineBreakRun;
+export type Run = TextRun | FractionRun | TabRun | LineBreakRun;
 /** The JSON representation of a [[Run]].
  * Use the `type` field to discriminate between the different kinds of runs.
  * @beta
  */
-export type RunProps = TextRunProps | FractionRunProps | LineBreakRunProps;
+export type RunProps = TextRunProps | FractionRunProps | TabRunProps | LineBreakRunProps;
 /** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span
  * multiple lines, but it will never contain different styling.
  * Use the `type` field to discriminate between the different kinds of runs.
@@ -189,6 +198,31 @@ export declare class LineBreakRun extends TextBlockComponent {
     stringify(options?: TextBlockStringifyOptions): string;
     equals(other: TextBlockComponent): boolean;
 }
+/** JSON representation of a [[TabRun]].
+ * @beta
+ */
+export interface TabRunProps extends TextBlockComponentProps {
+    /** Discriminator field for the [[RunProps]] union. */
+    readonly type: "tab";
+}
+/** A [[TabRun]] is used to shift the next tab stop.
+ * @note Only left-justified tabs are supported at this tab.
+ * @beta
+ */
+export declare class TabRun extends TextBlockComponent {
+    /** Discriminator field for the [[Run]] union. */
+    readonly type = "tab";
+    toJSON(): TabRunProps;
+    clone(): TabRun;
+    static create(props: Omit<TabRunProps, "type">): TabRun;
+    /**
+   * Converts a [[TabRun]] to its string representation.
+   * If the `tabsAsSpaces` option is provided, returns a string of spaces of the specified length.
+   * Otherwise, returns a tab character ("\t").
+   */
+    stringify(options?: TextBlockStringifyOptions): string;
+    equals(other: TextBlockComponent): boolean;
+}
 /** JSON representation of a [[Paragraph]].
  * @beta
  */

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

@@ -1 +1 @@
-{"version":3,"file":"TextBlock.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextBlock.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,mJAAmJ;IACnJ,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,8BAAsB,kBAAkB;IACtC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,uBAAuB;IAKpD;;;OAGG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,IAAW,SAAS,CAAC,SAAS,EAAE,MAAM,EAErC;IAED;;;OAGG;IACH,IAAW,cAAc,IAAI,sBAAsB,CAElD;IAED,IAAW,cAAc,CAAC,SAAS,EAAE,sBAAsB,EAE1D;IAED,8EAA8E;IACvE,mBAAmB,IAAI,IAAI;IAIlC,oKAAoK;IAC7J,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAQ3E,4GAA4G;IAC5G,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,4CAA4C;aAC5B,KAAK,IAAI,kBAAkB;IAE3C,uGAAuG;aACvF,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAEtE,yDAAyD;IAClD,MAAM,IAAI,uBAAuB;IAOxC,uDAAuD;IAChD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAgBlD;AAED;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE3E;;;;GAIG;AACH,yBAAiB,GAAG,CAAC;IACnB;;OAEG;IACH,SAAgB,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,CAM7C;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,aAAa,GAAG,MAAM,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,uBAAuB;IAC3D,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjD,SAAgB,IAAI,UAAU;IAC9B,6DAA6D;IACtD,OAAO,EAAE,MAAM,CAAC;IACvB,+EAA+E;IACxE,aAAa,EAAE,aAAa,CAAC;IAEpC,OAAO;IAMS,KAAK,IAAI,OAAO;IAIhB,MAAM,IAAI,YAAY;WASxB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,OAAO;IAIhE,kCAAkC;IAClB,SAAS,IAAI,MAAM;IAInB,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC/D,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,2IAA2I;IAC3I,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0IAA0I;IAC1I,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjD,SAAgB,IAAI,cAAc;IAClC,gCAAgC;IACzB,SAAS,EAAE,MAAM,CAAC;IACzB,kCAAkC;IAC3B,WAAW,EAAE,MAAM,CAAC;IAE3B,OAAO;IAMS,MAAM,IAAI,gBAAgB;IAS1B,KAAK,IAAI,WAAW;WAItB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG,WAAW;IAIxE,gJAAgJ;IAChI,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAKtD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjD,SAAgB,IAAI,eAAe;IAEnC,OAAO;IAIS,MAAM,IAAI,iBAAiB;WAO7B,MAAM,CAAC,KAAK,EAAE,uBAAuB;IAInC,KAAK,IAAI,YAAY;IAIrC,8DAA8D;IAC9C,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAItD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvH,SAAgB,IAAI,EAAE,GAAG,EAAE,CAAC;IAE5B,OAAO;IAKS,MAAM,IAAI,cAAc;IAOxC,uDAAuD;WACzC,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAItC,KAAK,IAAI,SAAS;IAIlC,qJAAqJ;IACrI,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IASpF,4HAA4H;IAC5G,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAItD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAW3D;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0GAA0G;IAC1G,IAAI,EAAE,MAAM,CAAC;IACb,2GAA2G;IAC3G,KAAK,EAAE,MAAM,CAAC;IACd,yGAAyG;IACzG,GAAG,EAAE,MAAM,CAAC;IACZ,4GAA4G;IAC5G,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,aAAa,CAAC,EAAE,sBAAsB,CAAC;IACvC,oFAAoF;IACpF,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpC,qEAAqE;IACrE,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,KAAK,EAAE,MAAM,CAAC;IACrB,+CAA+C;IACxC,aAAa,EAAE,sBAAsB,CAAC;IAC7C,mCAAmC;IAC5B,OAAO,EAAE,gBAAgB,CAAC;IACjC,0DAA0D;IAC1D,SAAgB,UAAU,EAAE,SAAS,EAAE,CAAC;IAExC,OAAO;IAgBS,MAAM,IAAI,cAAc;IAUxC,wDAAwD;WAC1C,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAItD,0FAA0F;WAC5E,WAAW,IAAI,SAAS;IAItC,mEAAmE;IACnE,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEe,KAAK,IAAI,SAAS;IAIlC,kJAAkJ;IAClI,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IASpF,uMAAuM;IAChM,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAI7D;;;OAGG;IACI,eAAe,IAAI,SAAS;IAWnC;;OAEG;IACI,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAKhB,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAiB3D"}
+{"version":3,"file":"TextBlock.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextBlock.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,mJAAmJ;IACnJ,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,8BAAsB,kBAAkB;IACtC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,uBAAuB;IAKpD;;;OAGG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,IAAW,SAAS,CAAC,SAAS,EAAE,MAAM,EAErC;IAED;;;OAGG;IACH,IAAW,cAAc,IAAI,sBAAsB,CAElD;IAED,IAAW,cAAc,CAAC,SAAS,EAAE,sBAAsB,EAE1D;IAED,8EAA8E;IACvE,mBAAmB,IAAI,IAAI;IAIlC,oKAAoK;IAC7J,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAQ3E,4GAA4G;IAC5G,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,4CAA4C;aAC5B,KAAK,IAAI,kBAAkB;IAE3C,uGAAuG;aACvF,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAEtE;;;MAGE;IACF,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED,yDAAyD;IAClD,MAAM,IAAI,uBAAuB;IAOxC,uDAAuD;IAChD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAgBlD;AAED;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,YAAY,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,WAAW,GAAG,iBAAiB,CAAC;AAEzF;;;;GAIG;AACH,yBAAiB,GAAG,CAAC;IACnB;;OAEG;IACH,SAAgB,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,CAO7C;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,aAAa,GAAG,MAAM,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,uBAAuB;IAC3D,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjD,SAAgB,IAAI,UAAU;IAC9B,6DAA6D;IACtD,OAAO,EAAE,MAAM,CAAC;IACvB,+EAA+E;IACxE,aAAa,EAAE,aAAa,CAAC;IAEpC,OAAO;IAMS,KAAK,IAAI,OAAO;IAIhB,MAAM,IAAI,YAAY;WASxB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,OAAO;IAIhE,kCAAkC;IAClB,SAAS,IAAI,MAAM;IAInB,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC/D,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,2IAA2I;IAC3I,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0IAA0I;IAC1I,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjD,SAAgB,IAAI,cAAc;IAClC,gCAAgC;IACzB,SAAS,EAAE,MAAM,CAAC;IACzB,kCAAkC;IAC3B,WAAW,EAAE,MAAM,CAAC;IAE3B,OAAO;IAMS,MAAM,IAAI,gBAAgB;IAS1B,KAAK,IAAI,WAAW;WAItB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG,WAAW;IAIxE,gJAAgJ;IAChI,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAKtD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjD,SAAgB,IAAI,eAAe;IAEnC,OAAO;IAIS,MAAM,IAAI,iBAAiB;WAO7B,MAAM,CAAC,KAAK,EAAE,uBAAuB;IAInC,KAAK,IAAI,YAAY;IAIrC,8DAA8D;IAC9C,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAItD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,uBAAuB;IAC1D,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,MAAO,SAAQ,kBAAkB;IAC5C,iDAAiD;IACjD,SAAgB,IAAI,SAAS;IAEb,MAAM,IAAI,WAAW;IAOrB,KAAK,IAAI,MAAM;WAIjB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,MAAM;IAI5D;;;;KAIC;IACa,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAQtD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAG3D;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvH,SAAgB,IAAI,EAAE,GAAG,EAAE,CAAC;IAE5B,OAAO;IAKS,MAAM,IAAI,cAAc;IAOxC,uDAAuD;WACzC,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAItC,KAAK,IAAI,SAAS;IAIlC,qJAAqJ;IACrI,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IASpF,4HAA4H;IAC5G,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAItD,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAW3D;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0GAA0G;IAC1G,IAAI,EAAE,MAAM,CAAC;IACb,2GAA2G;IAC3G,KAAK,EAAE,MAAM,CAAC;IACd,yGAAyG;IACzG,GAAG,EAAE,MAAM,CAAC;IACZ,4GAA4G;IAC5G,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,aAAa,CAAC,EAAE,sBAAsB,CAAC;IACvC,oFAAoF;IACpF,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpC,qEAAqE;IACrE,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,KAAK,EAAE,MAAM,CAAC;IACrB,+CAA+C;IACxC,aAAa,EAAE,sBAAsB,CAAC;IAC7C,mCAAmC;IAC5B,OAAO,EAAE,gBAAgB,CAAC;IACjC,0DAA0D;IAC1D,SAAgB,UAAU,EAAE,SAAS,EAAE,CAAC;IAExC,OAAO;IAgBS,MAAM,IAAI,cAAc;IAUxC,wDAAwD;WAC1C,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAItD,0FAA0F;WAC5E,WAAW,IAAI,SAAS;IAItC,mEAAmE;IACnE,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEe,KAAK,IAAI,SAAS;IAIlC,kJAAkJ;IAClI,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IASpF,uMAAuM;IAChM,SAAS,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM;IAI7D;;;OAGG;IACI,eAAe,IAAI,SAAS;IAWnC;;OAEG;IACI,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAKhB,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;CAiB3D"}

package/lib/cjs/annotation/TextBlock.js

@@ -7,7 +7,7 @@
  * @module Annotation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextBlock = exports.Paragraph = exports.LineBreakRun = exports.FractionRun = exports.TextRun = exports.Run = exports.TextBlockComponent = void 0;
+exports.TextBlock = exports.Paragraph = exports.TabRun = exports.LineBreakRun = exports.FractionRun = exports.TextRun = exports.Run = exports.TextBlockComponent = void 0;
 /** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.
  * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.
  * @beta
@@ -55,6 +55,14 @@ class TextBlockComponent {
     get overridesStyle() {
         return Object.keys(this.styleOverrides).length > 0;
     }
+    /**
+    * Returns true if the string representation of this component consists only of whitespace characters.
+    * Useful for checking if the component is visually empty (producing no graphics) or contains only spaces, tabs, or line breaks.
+    */
+    get isWhitespace() {
+        return /^\s*$/g.test(this.stringify());
+    }
+    ;
     /** Convert this component to its JSON representation. */
     toJSON() {
         return {
@@ -93,6 +101,7 @@ var Run;
         switch (props.type) {
             case "text": return TextRun.create(props);
             case "fraction": return FractionRun.create(props);
+            case "tab": return TabRun.create(props);
             case "linebreak": return LineBreakRun.create(props);
         }
     }
@@ -206,6 +215,41 @@ class LineBreakRun extends TextBlockComponent {
     }
 }
 exports.LineBreakRun = LineBreakRun;
+/** A [[TabRun]] is used to shift the next tab stop.
+ * @note Only left-justified tabs are supported at this tab.
+ * @beta
+ */
+class TabRun extends TextBlockComponent {
+    /** Discriminator field for the [[Run]] union. */
+    type = "tab";
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            type: "tab",
+        };
+    }
+    clone() {
+        return new TabRun(this.toJSON());
+    }
+    static create(props) {
+        return new TabRun(props);
+    }
+    /**
+   * Converts a [[TabRun]] to its string representation.
+   * If the `tabsAsSpaces` option is provided, returns a string of spaces of the specified length.
+   * Otherwise, returns a tab character ("\t").
+   */
+    stringify(options) {
+        if (options?.tabsAsSpaces) {
+            return " ".repeat(options.tabsAsSpaces);
+        }
+        return "\t";
+    }
+    equals(other) {
+        return other instanceof TabRun && super.equals(other);
+    }
+}
+exports.TabRun = TabRun;
 /** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.
  * @beta
  */

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

@@ -1 +1 @@
-{"version":3,"file":"TextBlock.js","sourceRoot":"","sources":["../../../src/annotation/TextBlock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAgDH;;;GAGG;AACH,MAAsB,kBAAkB;IAC9B,UAAU,CAAS;IACnB,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,YAAsB,KAA8B;QAClD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,SAAS,CAAC,SAAiB;QACpC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAW,cAAc,CAAC,SAAiC;QACzD,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;IAC1C,CAAC;IAED,8EAA8E;IACvE,mBAAmB;QACxB,IAAI,CAAC,cAAc,GAAG,EAAG,CAAC;IAC5B,CAAC;IAED,oKAAoK;IAC7J,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAClE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,CAAC,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,4GAA4G;IAC5G,IAAW,cAAc;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAQD,yDAAyD;IAClD,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,cAAc,EAAE,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAyB;QACrC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAoC,CAAC;YACjD,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AApFD,gDAoFC;AAaD;;;;GAIG;AACH,IAAiB,GAAG,CAWnB;AAXD,WAAiB,GAAG;IAClB;;OAEG;IACH,SAAgB,QAAQ,CAAC,KAAe;QACtC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,UAAU,CAAC,CAAC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IANe,YAAQ,WAMvB,CAAA;AACH,CAAC,EAXgB,GAAG,mBAAH,GAAG,QAWnB;AAyBD;;GAEG;AACH,MAAa,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjC,IAAI,GAAG,MAAM,CAAC;IAC9B,6DAA6D;IACtD,OAAO,CAAS;IACvB,+EAA+E;IACxE,aAAa,CAAgB;IAEpC,YAAoB,KAAiC;QACnD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;IACrD,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAiC;QACpD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,kCAAkC;IAClB,SAAS;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,OAAO,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzI,CAAC;CACF;AAvCD,0BAuCC;AAcD;;;GAGG;AACH,MAAa,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjC,IAAI,GAAG,UAAU,CAAC;IAClC,gCAAgC;IACzB,SAAS,CAAS;IACzB,kCAAkC;IAC3B,WAAW,CAAS;IAE3B,YAAoB,KAAqC;QACvD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAqC;QACxD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,gJAAgJ;IAChI,SAAS,CAAC,OAAmC;QAC3D,MAAM,GAAG,GAAG,OAAO,EAAE,iBAAiB,IAAI,GAAG,CAAC;QAC9C,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACtD,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7I,CAAC;CACF;AAxCD,kCAwCC;AAUD;;GAEG;AACH,MAAa,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjC,IAAI,GAAG,WAAW,CAAC;IAEnC,YAAoB,KAA8B;QAChD,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,WAAW;SAClB,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAA8B;QACjD,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,8DAA8D;IAC9C,SAAS,CAAC,OAAmC;QAC3D,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IACnC,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;CACF;AA/BD,oCA+BC;AAYD;;GAEG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvG,IAAI,CAAQ;IAE5B,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAChE,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,qJAAqJ;IACrI,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAC3E,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACnC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED,4HAA4H;IAC5G,SAAS,CAAC,OAAmC;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AAnDD,8BAmDC;AAmBA,CAAC;AAmBF;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,KAAK,CAAS;IACrB,+CAA+C;IACxC,aAAa,CAAyB;IAC7C,mCAAmC;IAC5B,OAAO,CAAmB;IACjC,0DAA0D;IAC1C,UAAU,CAAc;IAExC,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;QAEnD,yCAAyC;QACzC,IAAI,CAAC,OAAO,GAAG;YACb,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC;YAChC,GAAG,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;YAC5B,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;SACnC,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5E,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,WAAW;QACvB,OAAO,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,mEAAmE;IACnE,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,kJAAkJ;IAClI,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAC3E,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACnC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED,uMAAuM;IAChM,SAAS,CAAC,OAAmC;QAClD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,IAAI,GAAG,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,eAAe;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;YACjC,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,IAAI,CAAC,SAAS;YAC5C,cAAc,EAAE,IAAI,EAAE,cAAc,IAAI,SAAS;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,GAAQ;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACxF,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACnI,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAC1E,KAAK,KAAM,KAAK,CAAC,OAAe,CAAC,GAAG,CAAC,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe;YAAE,OAAO,KAAK,CAAC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;CACF;AAjHD,8BAiHC","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 { TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Options supplied to [[TextBlockComponent.applyStyle]] to control how the style is applied to the component and its child components.\n * @beta\n */\nexport interface ApplyTextStyleOptions {\n  /** Controls whether any deviations from the style's settings stored in [[TextBlockComponent.styleOverrides]] are retained.\n   * By default, all overrides are cleared.\n   */\n  preserveOverrides?: boolean;\n  /** Controls whether the style should be recursively applied to the [[Paragraph]]s belonging to a [[TextBlock]] and the [[Run]]s belonging to a [[Paragraph]].\n   * By default, the style change propagates to child components.\n   */\n  preventPropagation?: boolean;\n}\n\n/** The JSON representation of a [[TextBlockComponent]].\n * @beta\n */\nexport interface TextBlockComponentProps {\n  /** The name of a [[TextStyle]] stored in a [Workspace]($backend) from which the base [[TextStyleSettings]] applied to the component originates. */\n  styleName: string;\n  /** Deviations from the base [[TextStyleSettings]] defined by the [[TextStyle]] applied to this component.\n   * This permits you to, e.g., create a [[TextRun]] using \"Arial\" font and override it to use \"Comic Sans\" instead.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/** Options supplied to [[TextBlockComponent.stringify]] to control how the content is formatted.\n * @beta\n */\nexport interface TextBlockStringifyOptions {\n  /** A string to insert in between each [[Paragraph]].\n   * Default: \" \" - a single space.\n   */\n  paragraphBreak?: string;\n  /** A string to insert for each [[LineBreakRun]].\n   * Default: \" \" - a single space.\n   */\n  lineBreak?: string;\n  /** A string to insert between the numerator and denominator of each [[FractionRun]].\n   * Default: \"/\"\n   */\n  fractionSeparator?: string;\n}\n\n/** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.\n * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.\n * @beta\n */\nexport abstract class TextBlockComponent {\n  private _styleName: string;\n  private _styleOverrides: TextStyleSettingsProps;\n\n  /** @internal */\n  protected constructor(props: TextBlockComponentProps) {\n    this._styleName = props.styleName;\n    this._styleOverrides = { ...props.styleOverrides };\n  }\n\n  /** The name of the [[TextStyle]] that provides the base formatting for the contents of this component.\n   * @note Assigning to this property is equivalent to calling [[applyStyle]] with default [[ApplyTextStyleOptions]], which propagates the style change to all of\n   * the components sub-components and clears any [[styleOverrides]].\n   */\n  public get styleName(): string {\n    return this._styleName;\n  }\n\n  public set styleName(styleName: string) {\n    this.applyStyle(styleName);\n  }\n\n  /** Deviations in individual properties of the [[TextStyle]] specified by [[styleName]].\n   * For example, if the style uses the \"Arial\" font, you can override that by settings `styleOverrides.fontName` to \"Comic Sans\".\n   * @see [[clearStyleOverrides]] to reset this to an empty object.\n   */\n  public get styleOverrides(): TextStyleSettingsProps {\n    return this._styleOverrides;\n  }\n\n  public set styleOverrides(overrides: TextStyleSettingsProps) {\n    this._styleOverrides = { ...overrides };\n  }\n\n  /** Reset any [[styleOverrides]] applied to this component's [[TextStyle]]. */\n  public clearStyleOverrides(): void {\n    this.styleOverrides = { };\n  }\n\n  /** Apply the [[TextStyle]] specified by `styleName` to this component, optionally preserving [[styleOverrides]] and/or preventing propagation to sub-components. */\n  public applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    this._styleName = styleName;\n\n    if (!(options?.preserveOverrides)) {\n      this.clearStyleOverrides();\n    }\n  }\n\n  /** Returns true if [[styleOverrides]] specifies any deviations from this component's base [[TextStyle]]. */\n  public get overridesStyle(): boolean {\n    return Object.keys(this.styleOverrides).length > 0;\n  }\n\n  /** Create a deep copy of this component. */\n  public abstract clone(): TextBlockComponent;\n\n  /** Compute a string representation of the contents of this component and all of its sub-components. */\n  public abstract stringify(options?: TextBlockStringifyOptions): string;\n\n  /** Convert this component to its JSON representation. */\n  public toJSON(): TextBlockComponentProps {\n    return {\n      styleName: this.styleName,\n      styleOverrides: { ...this.styleOverrides },\n    };\n  }\n\n  /** Returns true if `this` is equivalent to `other`. */\n  public equals(other: TextBlockComponent): boolean {\n    const myKeys = Object.keys(this.styleOverrides);\n    const yrKeys = Object.keys(other._styleOverrides);\n    if (this.styleName !== other.styleName || myKeys.length !== yrKeys.length) {\n      return false;\n    }\n\n    for (const name of myKeys) {\n      const key = name as keyof TextStyleSettingsProps;\n      if (this.styleOverrides[key] !== other.styleOverrides[key]) {\n        return false;\n      }\n    }\n\n    return true;\n  }\n}\n\n/**\n * @beta\n */\nexport type Run = TextRun | FractionRun | LineBreakRun;\n\n/** The JSON representation of a [[Run]].\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport type RunProps = TextRunProps | FractionRunProps | LineBreakRunProps;\n\n/** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span\n * multiple lines, but it will never contain different styling.\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport namespace Run { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** Create a run from its JSON representation.\n   * @see [[TextRun.create]], [[FractionRun.create]], and [[LineBreakRun.create]] to create a run directly.\n   */\n  export function fromJSON(props: RunProps): Run {\n    switch (props.type) {\n      case \"text\": return TextRun.create(props);\n      case \"fraction\": return FractionRun.create(props);\n      case \"linebreak\": return LineBreakRun.create(props);\n    }\n  }\n}\n\n/** Describes whether the characters of a [[TextRun]] should be displayed normally, in subscript, or in superscript.\n * [[TextStyleSettings.superScriptScale]], [[TextStyleSettings.subScriptScale]], [[TextStyleSettings.superScriptOffsetFactor]], and [[TextStyleSettings.subScriptOffsetFactor]]\n * affect how the content is rendered.\n * @beta\n */\nexport type BaselineShift = \"subscript\" | \"superscript\" | \"none\";\n\n/** JSON representation of a [[TextRun]].\n * @beta\n */\nexport interface TextRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"text\";\n  /** The characters displayed by the run.\n   * Default: an empty string.\n   */\n  content?: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally.\n   * Default: \"none\"\n   */\n  baselineShift?: BaselineShift;\n}\n\n/** The most common type of [[Run]], containing a sequence of characters to be displayed using a single style.\n * @beta\n */\nexport class TextRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"text\";\n  /** The sequence of characters to be displayed by the run. */\n  public content: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally. */\n  public baselineShift: BaselineShift;\n\n  private constructor(props: Omit<TextRunProps, \"type\">) {\n    super(props);\n    this.content = props.content ?? \"\";\n    this.baselineShift = props.baselineShift ?? \"none\";\n  }\n\n  public override clone(): TextRun {\n    return new TextRun(this.toJSON());\n  }\n\n  public override toJSON(): TextRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"text\",\n      content: this.content,\n      baselineShift: this.baselineShift,\n    };\n  }\n\n  public static create(props: Omit<TextRunProps, \"type\">): TextRun {\n    return new TextRun(props);\n  }\n\n  /** Simply returns [[content]]. */\n  public override stringify(): string {\n    return this.content;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TextRun && this.content === other.content && this.baselineShift === other.baselineShift && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[FractionRun]].\n * @beta\n */\nexport interface FractionRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"fraction\";\n  /** The text displayed before or above the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */\n  numerator?: string;\n  /** The text displayed after or below the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */\n  denominator?: string;\n}\n\n/** A [[Run]] containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.\n * @note The [[numerator]] and [[denominator]] are stored as strings. They are not technically required to contain a numeric representation.\n * @beta\n */\nexport class FractionRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"fraction\";\n  /** The fraction's numerator. */\n  public numerator: string;\n  /** The fraction's denominator. */\n  public denominator: string;\n\n  private constructor(props: Omit<FractionRunProps, \"type\">) {\n    super(props);\n    this.numerator = props.numerator ?? \"\";\n    this.denominator = props.denominator ?? \"\";\n  }\n\n  public override toJSON(): FractionRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"fraction\",\n      numerator: this.numerator,\n      denominator: this.denominator,\n    };\n  }\n\n  public override clone(): FractionRun {\n    return new FractionRun(this.toJSON());\n  }\n\n  public static create(props: Omit<FractionRunProps, \"type\">): FractionRun {\n    return new FractionRun(props);\n  }\n\n  /** Formats the fraction as a string with the [[numerator]] and [[denominator]] separated by [[TextBlockStringifyOptions.fractionSeparator]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    const sep = options?.fractionSeparator ?? \"/\";\n    return `${this.numerator}${sep}${this.denominator}`;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof FractionRun && this.numerator === other.numerator && this.denominator === other.denominator && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[LineBreakRun]].\n * @beta\n */\nexport interface LineBreakRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"linebreak\";\n}\n\n/** A [[Run]] that represents the end of a line of text within a [[Paragraph]]. It contains no content of its own - it simply causes subsequent content to display on a new line.\n * @beta\n */\nexport class LineBreakRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"linebreak\";\n\n  private constructor(props: TextBlockComponentProps) {\n    super(props);\n  }\n\n  public override toJSON(): LineBreakRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"linebreak\",\n    };\n  }\n\n  public static create(props: TextBlockComponentProps) {\n    return new LineBreakRun(props);\n  }\n\n  public override clone(): LineBreakRun {\n    return new LineBreakRun(this.toJSON());\n  }\n\n  /** Simply returns [[TextBlockStringifyOptions.lineBreak]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return options?.lineBreak ?? \" \";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof LineBreakRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[Paragraph]].\n * @beta\n */\nexport interface ParagraphProps extends TextBlockComponentProps {\n  /** The collection of [[Run]]s within the paragraph.\n   * Default: an empty array.\n   */\n  runs?: RunProps[];\n}\n\n/** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.\n * @beta\n */\nexport class Paragraph extends TextBlockComponent {\n  /** The runs within the paragraph. You can modify the contents of this array to change the content of the paragraph. */\n  public readonly runs: Run[];\n\n  private constructor(props: ParagraphProps) {\n    super(props);\n    this.runs = props.runs?.map((run) => Run.fromJSON(run)) ?? [];\n  }\n\n  public override toJSON(): ParagraphProps {\n    return {\n      ...super.toJSON(),\n      runs: this.runs.map((run) => run.toJSON()),\n    };\n  }\n\n  /** Create a paragraph from its JSON representation. */\n  public static create(props: ParagraphProps): Paragraph {\n    return new Paragraph(props);\n  }\n\n  public override clone(): Paragraph {\n    return new Paragraph(this.toJSON());\n  }\n\n  /** Apply the specified style to this [[Paragraph]], and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[runs]]. */\n  public override applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    super.applyStyle(styleName, options);\n    if (!(options?.preventPropagation)) {\n      for (const run of this.runs) {\n        run.applyStyle(styleName, options);\n      }\n    }\n  }\n\n  /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return this.runs.map((x) => x.stringify(options)).join(\"\");\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof Paragraph)) {\n      return false;\n    }\n\n    if (this.runs.length !== other.runs.length || !super.equals(other)) {\n      return false;\n    }\n\n    return this.runs.every((run, index) => run.equals(other.runs[index]));\n  }\n}\n\n/** Describes the relative alignment of the content of a [[TextBlock]].\n * @beta\n */\nexport type TextBlockJustification = \"left\" | \"center\" | \"right\";\n\n/** Describes the margins around the content inside a [[TextBlock]]. It's measured in meters.\n * @beta\n */\nexport interface TextBlockMargins {\n  /** The left margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  left: number;\n  /** The right margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  right: number;\n  /** The top margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  top: number;\n  /** The bottom margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  bottom: number;\n};\n\n/** JSON representation of a [[TextBlock]].\n * @beta\n */\nexport interface TextBlockProps extends TextBlockComponentProps {\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  width?: number;\n  /** The alignment of the document content. Default: \"left\". */\n  justification?: TextBlockJustification;\n  /** The margins to surround the document content. Default: 0 margins on all sides */\n  margins?: Partial<TextBlockMargins>;\n  /** The paragraphs within the text block. Default: an empty array. */\n  paragraphs?: ParagraphProps[];\n}\n\n/** Represents a formatted text document consisting of a series of [[Paragraph]]s, each laid out on a separate line and containing their own content in the form of [[Run]]s.\n * You can change the content of the document by directly modifying the contents of its [[paragraphs]], or via [[appendParagraph]] and [[appendRun]].\n * No word-wrapping is applied to the document unless a [[width]] greater than zero is specified.\n * @see [[TextAnnotation]] to position a text block as an annotation in 2d or 3d space.\n * @beta\n */\nexport class TextBlock extends TextBlockComponent {\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  public width: number;\n  /** The alignment of the document's content. */\n  public justification: TextBlockJustification;\n  /** The margins of the document. */\n  public margins: TextBlockMargins;\n  /** The ordered list of paragraphs within the document. */\n  public readonly paragraphs: Paragraph[];\n\n  private constructor(props: TextBlockProps) {\n    super(props);\n    this.width = props.width ?? 0;\n    this.justification = props.justification ?? \"left\";\n\n    // Assign default margins if not provided\n    this.margins = {\n      left: props.margins?.left ?? 0,\n      right: props.margins?.right ?? 0,\n      top: props.margins?.top ?? 0,\n      bottom: props.margins?.bottom ?? 0,\n    };\n\n    this.paragraphs = props.paragraphs?.map((x) => Paragraph.create(x)) ?? [];\n  }\n\n  public override toJSON(): TextBlockProps {\n    return {\n      ...super.toJSON(),\n      width: this.width,\n      justification: this.justification,\n      margins: this.margins,\n      paragraphs: this.paragraphs.map((x) => x.toJSON()),\n    };\n  }\n\n  /** Create a text block from its JSON representation. */\n  public static create(props: TextBlockProps): TextBlock {\n    return new TextBlock(props);\n  }\n\n  /** Create an empty text block containing no [[paragraphs]] and an empty [[styleName]]. */\n  public static createEmpty(): TextBlock {\n    return TextBlock.create({ styleName: \"\" });\n  }\n\n  /** Returns true if every paragraph in this text block is empty. */\n  public get isEmpty(): boolean {\n    return this.paragraphs.every((p) => p.runs.length === 0);\n  }\n\n  public override clone(): TextBlock {\n    return new TextBlock(this.toJSON());\n  }\n\n  /** Apply the specified style to this block and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[paragraphs]]. */\n  public override applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    super.applyStyle(styleName, options);\n    if (!(options?.preventPropagation)) {\n      for (const paragraph of this.paragraphs) {\n        paragraph.applyStyle(styleName, options);\n      }\n    }\n  }\n\n  /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */\n  public stringify(options?: TextBlockStringifyOptions): string {\n    return this.paragraphs.map((x) => x.stringify(options)).join(options?.paragraphBreak ?? \" \");\n  }\n\n  /** Add and return a new paragraph.\n   * If [[paragraphs]] is not empty, the style and overrides of the last [[Paragraph]] in the block will be applied to the new paragraph; otherwise,\n   * the paragraph will inherit this block's style with no overrides.\n   */\n  public appendParagraph(): Paragraph {\n    const seed = this.paragraphs[0];\n    const paragraph = Paragraph.create({\n      styleName: seed?.styleName ?? this.styleName,\n      styleOverrides: seed?.styleOverrides ?? undefined,\n    });\n\n    this.paragraphs.push(paragraph);\n    return paragraph;\n  }\n\n  /** Append a run to the last [[Paragraph]] in this block.\n   * If the block contains no [[paragraphs]], a new one will first be created using [[appendParagraph]].\n   */\n  public appendRun(run: Run): void {\n    const paragraph = this.paragraphs[this.paragraphs.length - 1] ?? this.appendParagraph();\n    paragraph.runs.push(run);\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof TextBlock)) {\n      return false;\n    }\n\n    if (this.width !== other.width || this.justification !== other.justification || this.paragraphs.length !== other.paragraphs.length) {\n      return false;\n    }\n\n    const marginsAreEqual = Object.entries(this.margins).every(([key, value]) =>\n      value === (other.margins as any)[key]\n    );\n\n    if (!marginsAreEqual) return false;\n\n    return this.paragraphs.every((paragraph, index) => paragraph.equals(other.paragraphs[index]));\n  }\n}\n"]}
+{"version":3,"file":"TextBlock.js","sourceRoot":"","sources":["../../../src/annotation/TextBlock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAoDH;;;GAGG;AACH,MAAsB,kBAAkB;IAC9B,UAAU,CAAS;IACnB,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,YAAsB,KAA8B;QAClD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,SAAS,CAAC,SAAiB;QACpC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAW,cAAc,CAAC,SAAiC;QACzD,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;IAC1C,CAAC;IAED,8EAA8E;IACvE,mBAAmB;QACxB,IAAI,CAAC,cAAc,GAAG,EAAG,CAAC;IAC5B,CAAC;IAED,oKAAoK;IAC7J,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAClE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,CAAC,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,4GAA4G;IAC5G,IAAW,cAAc;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAQD;;;MAGE;IACF,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IAAA,CAAC;IAEF,yDAAyD;IAClD,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,cAAc,EAAE,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAyB;QACrC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAoC,CAAC;YACjD,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5FD,gDA4FC;AAaD;;;;GAIG;AACH,IAAiB,GAAG,CAYnB;AAZD,WAAiB,GAAG;IAClB;;OAEG;IACH,SAAgB,QAAQ,CAAC,KAAe;QACtC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,UAAU,CAAC,CAAC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,KAAK,KAAK,CAAC,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxC,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAPe,YAAQ,WAOvB,CAAA;AACH,CAAC,EAZgB,GAAG,mBAAH,GAAG,QAYnB;AAyBD;;GAEG;AACH,MAAa,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjC,IAAI,GAAG,MAAM,CAAC;IAC9B,6DAA6D;IACtD,OAAO,CAAS;IACvB,+EAA+E;IACxE,aAAa,CAAgB;IAEpC,YAAoB,KAAiC;QACnD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;IACrD,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAiC;QACpD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,kCAAkC;IAClB,SAAS;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,OAAO,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzI,CAAC;CACF;AAvCD,0BAuCC;AAcD;;;GAGG;AACH,MAAa,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjC,IAAI,GAAG,UAAU,CAAC;IAClC,gCAAgC;IACzB,SAAS,CAAS;IACzB,kCAAkC;IAC3B,WAAW,CAAS;IAE3B,YAAoB,KAAqC;QACvD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAqC;QACxD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,gJAAgJ;IAChI,SAAS,CAAC,OAAmC;QAC3D,MAAM,GAAG,GAAG,OAAO,EAAE,iBAAiB,IAAI,GAAG,CAAC;QAC9C,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACtD,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7I,CAAC;CACF;AAxCD,kCAwCC;AAUD;;GAEG;AACH,MAAa,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjC,IAAI,GAAG,WAAW,CAAC;IAEnC,YAAoB,KAA8B;QAChD,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,WAAW;SAClB,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAA8B;QACjD,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,8DAA8D;IAC9C,SAAS,CAAC,OAAmC;QAC3D,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IACnC,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;CACF;AA/BD,oCA+BC;AAUD;;;GAGG;AACH,MAAa,MAAO,SAAQ,kBAAkB;IAC5C,iDAAiD;IACjC,IAAI,GAAG,KAAK,CAAC;IAEb,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,KAAK;SACZ,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAgC;QACnD,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAEC;;;;KAIC;IACa,SAAS,CAAC,OAAmC;QAC3D,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;CACF;AAnCD,wBAmCC;AAYD;;GAEG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvG,IAAI,CAAQ;IAE5B,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAChE,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,qJAAqJ;IACrI,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAC3E,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACnC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED,4HAA4H;IAC5G,SAAS,CAAC,OAAmC;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AAnDD,8BAmDC;AAmBA,CAAC;AAmBF;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,KAAK,CAAS;IACrB,+CAA+C;IACxC,aAAa,CAAyB;IAC7C,mCAAmC;IAC5B,OAAO,CAAmB;IACjC,0DAA0D;IAC1C,UAAU,CAAc;IAExC,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;QAEnD,yCAAyC;QACzC,IAAI,CAAC,OAAO,GAAG;YACb,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC;YAChC,GAAG,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;YAC5B,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;SACnC,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5E,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,WAAW;QACvB,OAAO,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,mEAAmE;IACnE,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,kJAAkJ;IAClI,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAC3E,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACnC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED,uMAAuM;IAChM,SAAS,CAAC,OAAmC;QAClD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,IAAI,GAAG,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,eAAe;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;YACjC,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,IAAI,CAAC,SAAS;YAC5C,cAAc,EAAE,IAAI,EAAE,cAAc,IAAI,SAAS;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,GAAQ;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACxF,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACnI,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAC1E,KAAK,KAAM,KAAK,CAAC,OAAe,CAAC,GAAG,CAAC,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe;YAAE,OAAO,KAAK,CAAC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;CACF;AAjHD,8BAiHC","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 { TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Options supplied to [[TextBlockComponent.applyStyle]] to control how the style is applied to the component and its child components.\n * @beta\n */\nexport interface ApplyTextStyleOptions {\n  /** Controls whether any deviations from the style's settings stored in [[TextBlockComponent.styleOverrides]] are retained.\n   * By default, all overrides are cleared.\n   */\n  preserveOverrides?: boolean;\n  /** Controls whether the style should be recursively applied to the [[Paragraph]]s belonging to a [[TextBlock]] and the [[Run]]s belonging to a [[Paragraph]].\n   * By default, the style change propagates to child components.\n   */\n  preventPropagation?: boolean;\n}\n\n/** The JSON representation of a [[TextBlockComponent]].\n * @beta\n */\nexport interface TextBlockComponentProps {\n  /** The name of a [[TextStyle]] stored in a [Workspace]($backend) from which the base [[TextStyleSettings]] applied to the component originates. */\n  styleName: string;\n  /** Deviations from the base [[TextStyleSettings]] defined by the [[TextStyle]] applied to this component.\n   * This permits you to, e.g., create a [[TextRun]] using \"Arial\" font and override it to use \"Comic Sans\" instead.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/** Options supplied to [[TextBlockComponent.stringify]] to control how the content is formatted.\n * @beta\n */\nexport interface TextBlockStringifyOptions {\n  /** A string to insert in between each [[Paragraph]].\n   * Default: \" \" - a single space.\n   */\n  paragraphBreak?: string;\n  /** A string to insert for each [[LineBreakRun]].\n   * Default: \" \" - a single space.\n   */\n  lineBreak?: string;\n  /** A string to insert between the numerator and denominator of each [[FractionRun]].\n   * Default: \"/\"\n   */\n  fractionSeparator?: string;\n  /** The number of spaces to use for tabs. If not provided, tabs will be represented by a tab character: \"\\t\".\n   * Default: \"undefined\" - use \"\\t\".\n   */\n  tabsAsSpaces?: number;\n}\n\n/** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.\n * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.\n * @beta\n */\nexport abstract class TextBlockComponent {\n  private _styleName: string;\n  private _styleOverrides: TextStyleSettingsProps;\n\n  /** @internal */\n  protected constructor(props: TextBlockComponentProps) {\n    this._styleName = props.styleName;\n    this._styleOverrides = { ...props.styleOverrides };\n  }\n\n  /** The name of the [[TextStyle]] that provides the base formatting for the contents of this component.\n   * @note Assigning to this property is equivalent to calling [[applyStyle]] with default [[ApplyTextStyleOptions]], which propagates the style change to all of\n   * the components sub-components and clears any [[styleOverrides]].\n   */\n  public get styleName(): string {\n    return this._styleName;\n  }\n\n  public set styleName(styleName: string) {\n    this.applyStyle(styleName);\n  }\n\n  /** Deviations in individual properties of the [[TextStyle]] specified by [[styleName]].\n   * For example, if the style uses the \"Arial\" font, you can override that by settings `styleOverrides.fontName` to \"Comic Sans\".\n   * @see [[clearStyleOverrides]] to reset this to an empty object.\n   */\n  public get styleOverrides(): TextStyleSettingsProps {\n    return this._styleOverrides;\n  }\n\n  public set styleOverrides(overrides: TextStyleSettingsProps) {\n    this._styleOverrides = { ...overrides };\n  }\n\n  /** Reset any [[styleOverrides]] applied to this component's [[TextStyle]]. */\n  public clearStyleOverrides(): void {\n    this.styleOverrides = { };\n  }\n\n  /** Apply the [[TextStyle]] specified by `styleName` to this component, optionally preserving [[styleOverrides]] and/or preventing propagation to sub-components. */\n  public applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    this._styleName = styleName;\n\n    if (!(options?.preserveOverrides)) {\n      this.clearStyleOverrides();\n    }\n  }\n\n  /** Returns true if [[styleOverrides]] specifies any deviations from this component's base [[TextStyle]]. */\n  public get overridesStyle(): boolean {\n    return Object.keys(this.styleOverrides).length > 0;\n  }\n\n  /** Create a deep copy of this component. */\n  public abstract clone(): TextBlockComponent;\n\n  /** Compute a string representation of the contents of this component and all of its sub-components. */\n  public abstract stringify(options?: TextBlockStringifyOptions): string;\n\n  /**\n  * Returns true if the string representation of this component consists only of whitespace characters.\n  * Useful for checking if the component is visually empty (producing no graphics) or contains only spaces, tabs, or line breaks.\n  */\n  public get isWhitespace(): boolean {\n    return /^\\s*$/g.test(this.stringify());\n  };\n\n  /** Convert this component to its JSON representation. */\n  public toJSON(): TextBlockComponentProps {\n    return {\n      styleName: this.styleName,\n      styleOverrides: { ...this.styleOverrides },\n    };\n  }\n\n  /** Returns true if `this` is equivalent to `other`. */\n  public equals(other: TextBlockComponent): boolean {\n    const myKeys = Object.keys(this.styleOverrides);\n    const yrKeys = Object.keys(other._styleOverrides);\n    if (this.styleName !== other.styleName || myKeys.length !== yrKeys.length) {\n      return false;\n    }\n\n    for (const name of myKeys) {\n      const key = name as keyof TextStyleSettingsProps;\n      if (this.styleOverrides[key] !== other.styleOverrides[key]) {\n        return false;\n      }\n    }\n\n    return true;\n  }\n}\n\n/**\n * @beta\n */\nexport type Run = TextRun | FractionRun | TabRun | LineBreakRun;\n\n/** The JSON representation of a [[Run]].\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport type RunProps = TextRunProps | FractionRunProps | TabRunProps | LineBreakRunProps;\n\n/** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span\n * multiple lines, but it will never contain different styling.\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport namespace Run { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** Create a run from its JSON representation.\n   * @see [[TextRun.create]], [[FractionRun.create]], and [[LineBreakRun.create]] to create a run directly.\n   */\n  export function fromJSON(props: RunProps): Run {\n    switch (props.type) {\n      case \"text\": return TextRun.create(props);\n      case \"fraction\": return FractionRun.create(props);\n      case \"tab\": return TabRun.create(props);\n      case \"linebreak\": return LineBreakRun.create(props);\n    }\n  }\n}\n\n/** Describes whether the characters of a [[TextRun]] should be displayed normally, in subscript, or in superscript.\n * [[TextStyleSettings.superScriptScale]], [[TextStyleSettings.subScriptScale]], [[TextStyleSettings.superScriptOffsetFactor]], and [[TextStyleSettings.subScriptOffsetFactor]]\n * affect how the content is rendered.\n * @beta\n */\nexport type BaselineShift = \"subscript\" | \"superscript\" | \"none\";\n\n/** JSON representation of a [[TextRun]].\n * @beta\n */\nexport interface TextRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"text\";\n  /** The characters displayed by the run.\n   * Default: an empty string.\n   */\n  content?: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally.\n   * Default: \"none\"\n   */\n  baselineShift?: BaselineShift;\n}\n\n/** The most common type of [[Run]], containing a sequence of characters to be displayed using a single style.\n * @beta\n */\nexport class TextRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"text\";\n  /** The sequence of characters to be displayed by the run. */\n  public content: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally. */\n  public baselineShift: BaselineShift;\n\n  private constructor(props: Omit<TextRunProps, \"type\">) {\n    super(props);\n    this.content = props.content ?? \"\";\n    this.baselineShift = props.baselineShift ?? \"none\";\n  }\n\n  public override clone(): TextRun {\n    return new TextRun(this.toJSON());\n  }\n\n  public override toJSON(): TextRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"text\",\n      content: this.content,\n      baselineShift: this.baselineShift,\n    };\n  }\n\n  public static create(props: Omit<TextRunProps, \"type\">): TextRun {\n    return new TextRun(props);\n  }\n\n  /** Simply returns [[content]]. */\n  public override stringify(): string {\n    return this.content;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TextRun && this.content === other.content && this.baselineShift === other.baselineShift && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[FractionRun]].\n * @beta\n */\nexport interface FractionRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"fraction\";\n  /** The text displayed before or above the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */\n  numerator?: string;\n  /** The text displayed after or below the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */\n  denominator?: string;\n}\n\n/** A [[Run]] containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.\n * @note The [[numerator]] and [[denominator]] are stored as strings. They are not technically required to contain a numeric representation.\n * @beta\n */\nexport class FractionRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"fraction\";\n  /** The fraction's numerator. */\n  public numerator: string;\n  /** The fraction's denominator. */\n  public denominator: string;\n\n  private constructor(props: Omit<FractionRunProps, \"type\">) {\n    super(props);\n    this.numerator = props.numerator ?? \"\";\n    this.denominator = props.denominator ?? \"\";\n  }\n\n  public override toJSON(): FractionRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"fraction\",\n      numerator: this.numerator,\n      denominator: this.denominator,\n    };\n  }\n\n  public override clone(): FractionRun {\n    return new FractionRun(this.toJSON());\n  }\n\n  public static create(props: Omit<FractionRunProps, \"type\">): FractionRun {\n    return new FractionRun(props);\n  }\n\n  /** Formats the fraction as a string with the [[numerator]] and [[denominator]] separated by [[TextBlockStringifyOptions.fractionSeparator]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    const sep = options?.fractionSeparator ?? \"/\";\n    return `${this.numerator}${sep}${this.denominator}`;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof FractionRun && this.numerator === other.numerator && this.denominator === other.denominator && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[LineBreakRun]].\n * @beta\n */\nexport interface LineBreakRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"linebreak\";\n}\n\n/** A [[Run]] that represents the end of a line of text within a [[Paragraph]]. It contains no content of its own - it simply causes subsequent content to display on a new line.\n * @beta\n */\nexport class LineBreakRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"linebreak\";\n\n  private constructor(props: TextBlockComponentProps) {\n    super(props);\n  }\n\n  public override toJSON(): LineBreakRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"linebreak\",\n    };\n  }\n\n  public static create(props: TextBlockComponentProps) {\n    return new LineBreakRun(props);\n  }\n\n  public override clone(): LineBreakRun {\n    return new LineBreakRun(this.toJSON());\n  }\n\n  /** Simply returns [[TextBlockStringifyOptions.lineBreak]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return options?.lineBreak ?? \" \";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof LineBreakRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[TabRun]].\n * @beta\n */\nexport interface TabRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"tab\";\n}\n\n/** A [[TabRun]] is used to shift the next tab stop.\n * @note Only left-justified tabs are supported at this tab.\n * @beta\n */\nexport class TabRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"tab\";\n\n  public override toJSON(): TabRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"tab\",\n    };\n  }\n\n  public override clone(): TabRun {\n    return new TabRun(this.toJSON());\n  }\n\n  public static create(props: Omit<TabRunProps, \"type\">): TabRun {\n    return new TabRun(props);\n  }\n\n    /**\n   * Converts a [[TabRun]] to its string representation.\n   * If the `tabsAsSpaces` option is provided, returns a string of spaces of the specified length.\n   * Otherwise, returns a tab character (\"\\t\").\n   */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    if (options?.tabsAsSpaces) {\n      return \" \".repeat(options.tabsAsSpaces);\n    }\n\n    return \"\\t\";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TabRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[Paragraph]].\n * @beta\n */\nexport interface ParagraphProps extends TextBlockComponentProps {\n  /** The collection of [[Run]]s within the paragraph.\n   * Default: an empty array.\n   */\n  runs?: RunProps[];\n}\n\n/** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.\n * @beta\n */\nexport class Paragraph extends TextBlockComponent {\n  /** The runs within the paragraph. You can modify the contents of this array to change the content of the paragraph. */\n  public readonly runs: Run[];\n\n  private constructor(props: ParagraphProps) {\n    super(props);\n    this.runs = props.runs?.map((run) => Run.fromJSON(run)) ?? [];\n  }\n\n  public override toJSON(): ParagraphProps {\n    return {\n      ...super.toJSON(),\n      runs: this.runs.map((run) => run.toJSON()),\n    };\n  }\n\n  /** Create a paragraph from its JSON representation. */\n  public static create(props: ParagraphProps): Paragraph {\n    return new Paragraph(props);\n  }\n\n  public override clone(): Paragraph {\n    return new Paragraph(this.toJSON());\n  }\n\n  /** Apply the specified style to this [[Paragraph]], and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[runs]]. */\n  public override applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    super.applyStyle(styleName, options);\n    if (!(options?.preventPropagation)) {\n      for (const run of this.runs) {\n        run.applyStyle(styleName, options);\n      }\n    }\n  }\n\n  /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return this.runs.map((x) => x.stringify(options)).join(\"\");\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof Paragraph)) {\n      return false;\n    }\n\n    if (this.runs.length !== other.runs.length || !super.equals(other)) {\n      return false;\n    }\n\n    return this.runs.every((run, index) => run.equals(other.runs[index]));\n  }\n}\n\n/** Describes the relative alignment of the content of a [[TextBlock]].\n * @beta\n */\nexport type TextBlockJustification = \"left\" | \"center\" | \"right\";\n\n/** Describes the margins around the content inside a [[TextBlock]]. It's measured in meters.\n * @beta\n */\nexport interface TextBlockMargins {\n  /** The left margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  left: number;\n  /** The right margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  right: number;\n  /** The top margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  top: number;\n  /** The bottom margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  bottom: number;\n};\n\n/** JSON representation of a [[TextBlock]].\n * @beta\n */\nexport interface TextBlockProps extends TextBlockComponentProps {\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  width?: number;\n  /** The alignment of the document content. Default: \"left\". */\n  justification?: TextBlockJustification;\n  /** The margins to surround the document content. Default: 0 margins on all sides */\n  margins?: Partial<TextBlockMargins>;\n  /** The paragraphs within the text block. Default: an empty array. */\n  paragraphs?: ParagraphProps[];\n}\n\n/** Represents a formatted text document consisting of a series of [[Paragraph]]s, each laid out on a separate line and containing their own content in the form of [[Run]]s.\n * You can change the content of the document by directly modifying the contents of its [[paragraphs]], or via [[appendParagraph]] and [[appendRun]].\n * No word-wrapping is applied to the document unless a [[width]] greater than zero is specified.\n * @see [[TextAnnotation]] to position a text block as an annotation in 2d or 3d space.\n * @beta\n */\nexport class TextBlock extends TextBlockComponent {\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  public width: number;\n  /** The alignment of the document's content. */\n  public justification: TextBlockJustification;\n  /** The margins of the document. */\n  public margins: TextBlockMargins;\n  /** The ordered list of paragraphs within the document. */\n  public readonly paragraphs: Paragraph[];\n\n  private constructor(props: TextBlockProps) {\n    super(props);\n    this.width = props.width ?? 0;\n    this.justification = props.justification ?? \"left\";\n\n    // Assign default margins if not provided\n    this.margins = {\n      left: props.margins?.left ?? 0,\n      right: props.margins?.right ?? 0,\n      top: props.margins?.top ?? 0,\n      bottom: props.margins?.bottom ?? 0,\n    };\n\n    this.paragraphs = props.paragraphs?.map((x) => Paragraph.create(x)) ?? [];\n  }\n\n  public override toJSON(): TextBlockProps {\n    return {\n      ...super.toJSON(),\n      width: this.width,\n      justification: this.justification,\n      margins: this.margins,\n      paragraphs: this.paragraphs.map((x) => x.toJSON()),\n    };\n  }\n\n  /** Create a text block from its JSON representation. */\n  public static create(props: TextBlockProps): TextBlock {\n    return new TextBlock(props);\n  }\n\n  /** Create an empty text block containing no [[paragraphs]] and an empty [[styleName]]. */\n  public static createEmpty(): TextBlock {\n    return TextBlock.create({ styleName: \"\" });\n  }\n\n  /** Returns true if every paragraph in this text block is empty. */\n  public get isEmpty(): boolean {\n    return this.paragraphs.every((p) => p.runs.length === 0);\n  }\n\n  public override clone(): TextBlock {\n    return new TextBlock(this.toJSON());\n  }\n\n  /** Apply the specified style to this block and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[paragraphs]]. */\n  public override applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    super.applyStyle(styleName, options);\n    if (!(options?.preventPropagation)) {\n      for (const paragraph of this.paragraphs) {\n        paragraph.applyStyle(styleName, options);\n      }\n    }\n  }\n\n  /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */\n  public stringify(options?: TextBlockStringifyOptions): string {\n    return this.paragraphs.map((x) => x.stringify(options)).join(options?.paragraphBreak ?? \" \");\n  }\n\n  /** Add and return a new paragraph.\n   * If [[paragraphs]] is not empty, the style and overrides of the last [[Paragraph]] in the block will be applied to the new paragraph; otherwise,\n   * the paragraph will inherit this block's style with no overrides.\n   */\n  public appendParagraph(): Paragraph {\n    const seed = this.paragraphs[0];\n    const paragraph = Paragraph.create({\n      styleName: seed?.styleName ?? this.styleName,\n      styleOverrides: seed?.styleOverrides ?? undefined,\n    });\n\n    this.paragraphs.push(paragraph);\n    return paragraph;\n  }\n\n  /** Append a run to the last [[Paragraph]] in this block.\n   * If the block contains no [[paragraphs]], a new one will first be created using [[appendParagraph]].\n   */\n  public appendRun(run: Run): void {\n    const paragraph = this.paragraphs[this.paragraphs.length - 1] ?? this.appendParagraph();\n    paragraph.runs.push(run);\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof TextBlock)) {\n      return false;\n    }\n\n    if (this.width !== other.width || this.justification !== other.justification || this.paragraphs.length !== other.paragraphs.length) {\n      return false;\n    }\n\n    const marginsAreEqual = Object.entries(this.margins).every(([key, value]) =>\n      value === (other.margins as any)[key]\n    );\n\n    if (!marginsAreEqual) return false;\n\n    return this.paragraphs.every((paragraph, index) => paragraph.equals(other.paragraphs[index]));\n  }\n}\n"]}

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

@@ -29,7 +29,7 @@ export type TextBlockGeometryPropsEntry = {
 };
 /**
  * JSON representation of the geometric primitives that can be used to display a [[TextBlock]].
- * @see [produceTextAnnotationGeometry]($backend) to convert an annotation to its geometric representation.
+ * @see [appendTextAnnotationGeometry]($backend) to convert an annotation to its geometric representation.
  * @see [[GeometryStreamBuilder.appendTextBlock]] to add a block of text to a [GeometryStream]($docs/learning/common/GeometryStream.md).
  * @beta
  */

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

@@ -1 +1 @@
-{"version":3,"file":"TextBlockGeometryProps.js","sourceRoot":"","sources":["../../../src/annotation/TextBlockGeometryProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 { XYZProps } from \"@itwin/core-geometry\";\nimport { TextStringProps } from \"../geometry/TextString\";\nimport { TextStyleColor } from \"./TextStyle\";\n\n/**\n * A single entry in a [[TextBlockGeometryProps]], representing one of the following primitive types:\n * - A [[TextString]],\n * - A fraction separator described by a [LineSegment3d]($geometry), or\n * - A change in color, to be applied to all subsequent primitives.\n * @beta\n */\nexport type TextBlockGeometryPropsEntry = {\n  text: TextStringProps;\n  separator?: never;\n  color?: never;\n} | {\n  text?: never;\n  separator: {\n    startPoint: XYZProps;\n    endPoint: XYZProps;\n  };\n  color?: never;\n} | {\n  text?: never;\n  separator?: never;\n  color: TextStyleColor;\n};\n\n/**\n * JSON representation of the geometric primitives that can be used to display a [[TextBlock]].\n * @see [produceTextAnnotationGeometry]($backend) to convert an annotation to its geometric representation.\n * @see [[GeometryStreamBuilder.appendTextBlock]] to add a block of text to a [GeometryStream]($docs/learning/common/GeometryStream.md).\n * @beta\n */\nexport interface TextBlockGeometryProps {\n  /** The set of geometric primitives representing the contents of the [[TextBlock]]. */\n  entries: TextBlockGeometryPropsEntry[];\n}\n"]}
+{"version":3,"file":"TextBlockGeometryProps.js","sourceRoot":"","sources":["../../../src/annotation/TextBlockGeometryProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 { XYZProps } from \"@itwin/core-geometry\";\nimport { TextStringProps } from \"../geometry/TextString\";\nimport { TextStyleColor } from \"./TextStyle\";\n\n/**\n * A single entry in a [[TextBlockGeometryProps]], representing one of the following primitive types:\n * - A [[TextString]],\n * - A fraction separator described by a [LineSegment3d]($geometry), or\n * - A change in color, to be applied to all subsequent primitives.\n * @beta\n */\nexport type TextBlockGeometryPropsEntry = {\n  text: TextStringProps;\n  separator?: never;\n  color?: never;\n} | {\n  text?: never;\n  separator: {\n    startPoint: XYZProps;\n    endPoint: XYZProps;\n  };\n  color?: never;\n} | {\n  text?: never;\n  separator?: never;\n  color: TextStyleColor;\n};\n\n/**\n * JSON representation of the geometric primitives that can be used to display a [[TextBlock]].\n * @see [appendTextAnnotationGeometry]($backend) to convert an annotation to its geometric representation.\n * @see [[GeometryStreamBuilder.appendTextBlock]] to add a block of text to a [GeometryStream]($docs/learning/common/GeometryStream.md).\n * @beta\n */\nexport interface TextBlockGeometryProps {\n  /** The set of geometric primitives representing the contents of the [[TextBlock]]. */\n  entries: TextBlockGeometryPropsEntry[];\n}\n"]}

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

@@ -26,7 +26,7 @@ export interface TextStyleSettingsProps {
      */
     fontName?: string;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
-     * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and
      * lineHeight * [[subScriptOffsetFactor]], respectively.
      * Default: 1.0. */
     lineHeight?: number;
@@ -80,6 +80,11 @@ export interface TextStyleSettingsProps {
      * Default: 1.0
      */
     widthFactor?: number;
+    /** 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.
+     */
+    tabInterval?: number;
 }
 /** A description of the formatting to be applied to a [[TextBlockComponent]].
  * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).
@@ -94,7 +99,7 @@ export declare class TextStyleSettings {
      */
     readonly fontName: string;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
-     * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and
      * lineHeight * [[subScriptOffsetFactor]], respectively.
      */
     readonly lineHeight: number;
@@ -132,6 +137,10 @@ export declare class TextStyleSettings {
     readonly superScriptScale: number;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     readonly widthFactor: number;
+    /** 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.
+     */
+    readonly tabInterval: number;
     /** A fully-populated JSON representation of the default settings. */
     static defaultProps: Readonly<Required<TextStyleSettingsProps>>;
     /** Settings initialized to all default values. */

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;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;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAepE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA8B;IAEvE,OAAO;IAqBP,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;CAQjD;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;;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"}

package/lib/cjs/annotation/TextStyle.js

@@ -21,7 +21,7 @@ class TextStyleSettings {
      */
     fontName;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
-     * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and
      * lineHeight * [[subScriptOffsetFactor]], respectively.
      */
     lineHeight;
@@ -59,6 +59,10 @@ class TextStyleSettings {
     superScriptScale;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     widthFactor;
+    /** 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.
+     */
+    tabInterval;
     /** A fully-populated JSON representation of the default settings. */
     static defaultProps = {
         color: "subcategory",
@@ -75,6 +79,7 @@ class TextStyleSettings {
         superScriptOffsetFactor: 0.5,
         superScriptScale: 2 / 3,
         widthFactor: 1,
+        tabInterval: 4,
     };
     /** Settings initialized to all default values. */
     static defaults = new TextStyleSettings({});
@@ -96,6 +101,7 @@ class TextStyleSettings {
         this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;
         this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;
         this.widthFactor = props.widthFactor ?? defaults.widthFactor;
+        this.tabInterval = props.tabInterval ?? defaults.tabInterval;
     }
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
     clone(alteredProps) {
@@ -114,7 +120,8 @@ class TextStyleSettings {
             && 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.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale
+            && this.tabInterval === other.tabInterval;
     }
 }
 exports.TextStyleSettings = TextStyleSettings;