@itwin/core-common 5.1.0-dev.9 → 5.2.0-dev.2

package/lib/esm/annotation/TextBlock.js

@@ -5,29 +5,18 @@
 /** @packageDocumentation
  * @module Annotation
  */
+import { TextStyleSettings } from "./TextStyle";
 /** 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.
+ * The [[TextBlock]] can specify an [AnnotationTextStyle]($backend) that formats its contents. Each component can specify an optional [[styleOverrides]] to customize that formatting.
  * @beta
  */
 export class TextBlockComponent {
-    _styleName;
     _styleOverrides;
     /** @internal */
     constructor(props) {
-        this._styleName = props.styleName;
-        this._styleOverrides = { ...props.styleOverrides };
+        this._styleOverrides = TextStyleSettings.cloneProps(props?.styleOverrides ?? {});
     }
-    /** The name of the [[TextStyle]] that provides the base formatting for the contents of this component.
-     * @note Assigning to this property is equivalent to calling [[applyStyle]] with default [[ApplyTextStyleOptions]], which propagates the style change to all of
-     * the components sub-components and clears any [[styleOverrides]].
-     */
-    get styleName() {
-        return this._styleName;
-    }
-    set styleName(styleName) {
-        this.applyStyle(styleName);
-    }
-    /** Deviations in individual properties of the [[TextStyle]] specified by [[styleName]].
+    /** Deviations in individual properties of the [[TextStyleSettings]] in the [AnnotationTextStyle]($backend) specified by `styleId` on the [[TextBlock]].
      * For example, if the style uses the "Arial" font, you can override that by settings `styleOverrides.fontName` to "Comic Sans".
      * @see [[clearStyleOverrides]] to reset this to an empty object.
      */
@@ -35,35 +24,35 @@ export class TextBlockComponent {
         return this._styleOverrides;
     }
     set styleOverrides(overrides) {
-        this._styleOverrides = { ...overrides };
+        this._styleOverrides = TextStyleSettings.cloneProps(overrides);
     }
-    /** Reset any [[styleOverrides]] applied to this component's [[TextStyle]]. */
-    clearStyleOverrides() {
+    /** Reset any [[styleOverrides]] applied to this component. */
+    clearStyleOverrides(_options) {
         this.styleOverrides = {};
     }
-    /** Apply the [[TextStyle]] specified by `styleName` to this component, optionally preserving [[styleOverrides]] and/or preventing propagation to sub-components. */
-    applyStyle(styleName, options) {
-        this._styleName = styleName;
-        if (!(options?.preserveOverrides)) {
-            this.clearStyleOverrides();
-        }
-    }
-    /** Returns true if [[styleOverrides]] specifies any deviations from this component's base [[TextStyle]]. */
+    /** Returns true if [[styleOverrides]] specifies any deviations from the [[TextBlock]]'s [AnnotationTextStyle]($backend). */
     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 {
-            styleName: this.styleName,
-            styleOverrides: { ...this.styleOverrides },
+            styleOverrides: TextStyleSettings.cloneProps(this.styleOverrides),
         };
     }
     /** Returns true if `this` is equivalent to `other`. */
     equals(other) {
         const myKeys = Object.keys(this.styleOverrides);
         const yrKeys = Object.keys(other._styleOverrides);
-        if (this.styleName !== other.styleName || myKeys.length !== yrKeys.length) {
+        if (myKeys.length !== yrKeys.length) {
             return false;
         }
         for (const name of myKeys) {
@@ -89,7 +78,9 @@ export 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);
+            case "field": return FieldRun.create(props);
         }
     }
     Run.fromJSON = fromJSON;
@@ -106,8 +97,8 @@ export class TextRun extends TextBlockComponent {
     baselineShift;
     constructor(props) {
         super(props);
-        this.content = props.content ?? "";
-        this.baselineShift = props.baselineShift ?? "none";
+        this.content = props?.content ?? "";
+        this.baselineShift = props?.baselineShift ?? "none";
     }
     clone() {
         return new TextRun(this.toJSON());
@@ -144,8 +135,8 @@ export class FractionRun extends TextBlockComponent {
     denominator;
     constructor(props) {
         super(props);
-        this.numerator = props.numerator ?? "";
-        this.denominator = props.denominator ?? "";
+        this.numerator = props?.numerator ?? "";
+        this.denominator = props?.denominator ?? "";
     }
     toJSON() {
         return {
@@ -199,6 +190,147 @@ export class LineBreakRun extends TextBlockComponent {
         return other instanceof LineBreakRun && super.equals(other);
     }
 }
+/** A [[TabRun]] is used to shift the next tab stop.
+ * @note Only left-justified tabs are supported at this tab.
+ * @beta
+ */
+export 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);
+    }
+}
+/** A [[Run]] that displays the formatted value of a property of some [Element]($backend).
+ * When a [[TextBlock]] containing a [[FieldRun]] is written into the iModel as an [ITextAnnotation]($backend) element,
+ * a dependency is established between the two elements via the [ElementDrivesTextAnnotation]($backend) relationship such that
+ * whenever the source element specified by [[propertyHost]] is modified, the field(s) in the `ITextAnnotation` element are automatically
+ * recalculated, causing their [[cachedContent]] to update. If the field's display string cannot be evaluated (for example, because the specified element or
+ * property does not exist), then its cached content is set to [[FieldRun.invalidContentIndicator]].
+ * A [[FieldRun]] displays its [[cachedContent]] in the same way that [[TextRun]]s display their `content`, including word wrapping where appropriate.
+ * @beta
+ */
+export class FieldRun extends TextBlockComponent {
+    /** Display string used to signal an error in computing the field's value. */
+    static invalidContentIndicator = "####";
+    /** Discriminator field for the [[Run]] union. */
+    type = "field";
+    /** The element and BIS class containing the property described by [[propertyPath]]. */
+    propertyHost;
+    /** Describes how to obtain the property value from [[propertyHost]]. */
+    propertyPath;
+    /** Specifies how to format the property value obtained from [[propertyPath]] into a string to be stored in [[cachedContent]]. */
+    formatter;
+    _cachedContent;
+    /** The field's most recently evaluated display string. */
+    get cachedContent() {
+        return this._cachedContent;
+    }
+    /** @internal Used by core-backend when re-evaluating field content. */
+    setCachedContent(content) {
+        this._cachedContent = content ?? FieldRun.invalidContentIndicator;
+    }
+    constructor(props) {
+        super(props);
+        this._cachedContent = props.cachedContent ?? FieldRun.invalidContentIndicator;
+        this.propertyHost = props.propertyHost;
+        this.propertyPath = props.propertyPath;
+        this.formatter = props.formatter;
+    }
+    /** Create a FieldRun from its JSON representation. */
+    static create(props) {
+        return new FieldRun({
+            ...props,
+            propertyHost: { ...props.propertyHost },
+            propertyPath: structuredClone(props.propertyPath),
+            formatter: structuredClone(props.formatter),
+        });
+    }
+    /** Convert the FieldRun to its JSON representation. */
+    toJSON() {
+        const json = {
+            ...super.toJSON(),
+            type: "field",
+            propertyHost: { ...this.propertyHost },
+            propertyPath: structuredClone(this.propertyPath),
+        };
+        if (this.cachedContent !== FieldRun.invalidContentIndicator) {
+            json.cachedContent = this.cachedContent;
+        }
+        if (this.formatter) {
+            json.formatter = structuredClone(this.formatter);
+        }
+        return json;
+    }
+    /** Create a deep copy of this FieldRun. */
+    clone() {
+        return new FieldRun(this.toJSON());
+    }
+    /** Convert this FieldRun to a simple string representation. */
+    stringify() {
+        return this.cachedContent;
+    }
+    /** Returns true if `this` is equivalent to `other`. */
+    equals(other) {
+        if (!(other instanceof FieldRun) || !super.equals(other)) {
+            return false;
+        }
+        if (this.propertyHost.elementId !== other.propertyHost.elementId ||
+            this.propertyHost.className !== other.propertyHost.className ||
+            this.propertyHost.schemaName !== other.propertyHost.schemaName) {
+            return false;
+        }
+        if (this.propertyPath.propertyName !== other.propertyPath.propertyName) {
+            return false;
+        }
+        const thisAccessors = this.propertyPath.accessors ?? [];
+        const otherAccessors = other.propertyPath.accessors ?? [];
+        const thisJsonAccessors = this.propertyPath.jsonAccessors ?? [];
+        const otherJsonAccessors = other.propertyPath.jsonAccessors ?? [];
+        if (thisAccessors.length !== otherAccessors.length || thisJsonAccessors.length !== otherJsonAccessors.length) {
+            return false;
+        }
+        if (!thisAccessors.every((value, index) => value === otherAccessors[index])) {
+            return false;
+        }
+        if (!thisJsonAccessors.every((value, index) => value === otherJsonAccessors[index])) {
+            return false;
+        }
+        if (this.formatter && other.formatter) {
+            // ###TODO better comparison of formatter objects.
+            if (JSON.stringify(this.formatter) !== JSON.stringify(other.formatter)) {
+                return false;
+            }
+        }
+        else if (this.formatter || other.formatter) {
+            return false;
+        }
+        return true;
+    }
+}
 /** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.
  * @beta
  */
@@ -207,7 +339,7 @@ export class Paragraph extends TextBlockComponent {
     runs;
     constructor(props) {
         super(props);
-        this.runs = props.runs?.map((run) => Run.fromJSON(run)) ?? [];
+        this.runs = props?.runs?.map((run) => Run.fromJSON(run)) ?? [];
     }
     toJSON() {
         return {
@@ -222,13 +354,16 @@ export class Paragraph extends TextBlockComponent {
     clone() {
         return new Paragraph(this.toJSON());
     }
-    /** Apply the specified style to this [[Paragraph]], and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[runs]]. */
-    applyStyle(styleName, options) {
-        super.applyStyle(styleName, options);
-        if (!(options?.preventPropagation)) {
-            for (const run of this.runs) {
-                run.applyStyle(styleName, options);
-            }
+    /**
+     * Clears any [[styleOverrides]] applied to this Paragraph.
+     * Will also clear [[styleOverrides]] from all child components unless [[ClearTextStyleOptions.preserveChildrenOverrides]] is `true`.
+     */
+    clearStyleOverrides(options) {
+        super.clearStyleOverrides();
+        if (options?.preserveChildrenOverrides)
+            return;
+        for (const run of this.runs) {
+            run.clearStyleOverrides();
         }
     }
     /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */
@@ -253,6 +388,11 @@ export class Paragraph extends TextBlockComponent {
  * @beta
  */
 export class TextBlock extends TextBlockComponent {
+    /** The ID of the [AnnotationTextStyle]($backend) that provides the base formatting for the contents of this TextBlock.
+     * @note Assigning to this property retains all style overrides on the TextBlock and its child components.
+     * Call [[clearStyleOverrides]] to clear the TextBlock's and optionally all children's style overrides.
+     */
+    styleId;
     /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.
      * A value less than or equal to zero indicates no wrapping is to be applied.
      * Default: 0
@@ -266,6 +406,7 @@ export class TextBlock extends TextBlockComponent {
     paragraphs;
     constructor(props) {
         super(props);
+        this.styleId = props.styleId;
         this.width = props.width ?? 0;
         this.justification = props.justification ?? "left";
         // Assign default margins if not provided
@@ -280,6 +421,7 @@ export class TextBlock extends TextBlockComponent {
     toJSON() {
         return {
             ...super.toJSON(),
+            styleId: this.styleId,
             width: this.width,
             justification: this.justification,
             margins: this.margins,
@@ -290,9 +432,9 @@ export class TextBlock extends TextBlockComponent {
     static create(props) {
         return new TextBlock(props);
     }
-    /** Create an empty text block containing no [[paragraphs]] and an empty [[styleName]]. */
+    /** Create an empty text block containing no [[paragraphs]] and an empty [[styleId]]. */
     static createEmpty() {
-        return TextBlock.create({ styleName: "" });
+        return TextBlock.create({ styleId: "" });
     }
     /** Returns true if every paragraph in this text block is empty. */
     get isEmpty() {
@@ -301,13 +443,16 @@ export class TextBlock extends TextBlockComponent {
     clone() {
         return new TextBlock(this.toJSON());
     }
-    /** Apply the specified style to this block and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[paragraphs]]. */
-    applyStyle(styleName, options) {
-        super.applyStyle(styleName, options);
-        if (!(options?.preventPropagation)) {
-            for (const paragraph of this.paragraphs) {
-                paragraph.applyStyle(styleName, options);
-            }
+    /**
+     * Clears any [[styleOverrides]] applied to this TextBlock.
+     * Will also clear [[styleOverrides]] from all child components unless [[ClearTextStyleOptions.preserveChildrenOverrides]] is `true`.
+     */
+    clearStyleOverrides(options) {
+        super.clearStyleOverrides();
+        if (options?.preserveChildrenOverrides)
+            return;
+        for (const paragraph of this.paragraphs) {
+            paragraph.clearStyleOverrides();
         }
     }
     /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */
@@ -315,14 +460,17 @@ export class TextBlock extends TextBlockComponent {
         return this.paragraphs.map((x) => x.stringify(options)).join(options?.paragraphBreak ?? " ");
     }
     /** Add and return a new paragraph.
-     * If [[paragraphs]] is not empty, the style and overrides of the last [[Paragraph]] in the block will be applied to the new paragraph; otherwise,
-     * the paragraph will inherit this block's style with no overrides.
+     * By default, the paragraph will be created with no [[styleOverrides]], so that it inherits the style of this block.
+     * @param seedFromLast If true and [[paragraphs]] is not empty, the new paragraph will inherit the style overrides of the last [[Paragraph]] in this block.
      */
-    appendParagraph() {
-        const seed = this.paragraphs[0];
+    appendParagraph(seedFromLast = false) {
+        let styleOverrides = {};
+        if (seedFromLast && this.paragraphs.length > 0) {
+            const seed = this.paragraphs[this.paragraphs.length - 1];
+            styleOverrides = { ...seed.styleOverrides };
+        }
         const paragraph = Paragraph.create({
-            styleName: seed?.styleName ?? this.styleName,
-            styleOverrides: seed?.styleOverrides ?? undefined,
+            styleOverrides
         });
         this.paragraphs.push(paragraph);
         return paragraph;
@@ -338,6 +486,9 @@ export class TextBlock extends TextBlockComponent {
         if (!(other instanceof TextBlock)) {
             return false;
         }
+        if (this.styleId !== other.styleId || !super.equals(other)) {
+            return false;
+        }
         if (this.width !== other.width || this.justification !== other.justification || this.paragraphs.length !== other.paragraphs.length) {
             return false;
         }

package/lib/esm/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,MAAM,OAAgB,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;AAaD;;;;GAIG;AACH,MAAM,KAAW,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,KAAH,GAAG,QAWnB;AAyBD;;GAEG;AACH,MAAM,OAAO,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;AAcD;;;GAGG;AACH,MAAM,OAAO,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;AAUD;;GAEG;AACH,MAAM,OAAO,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;AAYD;;GAEG;AACH,MAAM,OAAO,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;AAmBA,CAAC;AAmBF;;;;;GAKG;AACH,MAAM,OAAO,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","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;AAGH,OAAO,EAAE,iBAAiB,EAA0B,MAAM,aAAa,CAAC;AA4CxE;;;GAGG;AACH,MAAM,OAAgB,kBAAkB;IAC9B,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,YAAsB,KAA+B;QACnD,IAAI,CAAC,eAAe,GAAG,iBAAiB,CAAC,UAAU,CAAC,KAAK,EAAE,cAAc,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAW,cAAc,CAAC,SAAiC;QACzD,IAAI,CAAC,eAAe,GAAG,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,8DAA8D;IACvD,mBAAmB,CAAC,QAAgC;QACzD,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED,4HAA4H;IAC5H,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,cAAc,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC;SAClE,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,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,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;AAaD;;;;GAIG;AACH,MAAM,KAAW,GAAG,CAanB;AAbD,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;YACpD,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IARe,YAAQ,WAQvB,CAAA;AACH,CAAC,EAbgB,GAAG,KAAH,GAAG,QAanB;AAyBD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjC,IAAI,GAAG,MAAM,CAAC;IAC9B,6DAA6D;IACtD,OAAO,CAAS;IACvB,+EAA+E;IACxE,aAAa,CAAgB;IAEpC,YAAoB,KAAkC;QACpD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,MAAM,CAAC;IACtD,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,KAAkC;QACrD,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;AAcD;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjC,IAAI,GAAG,UAAU,CAAC;IAClC,gCAAgC;IACzB,SAAS,CAAS;IACzB,kCAAkC;IAC3B,WAAW,CAAS;IAE3B,YAAoB,KAAsC;QACxD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,IAAI,EAAE,CAAC;IAC9C,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,KAAsC;QACzD,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;AAUD;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjC,IAAI,GAAG,WAAW,CAAC;IAEnC,YAAoB,KAA+B;QACjD,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,KAA+B;QAClD,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;AAUD;;;GAGG;AACH,MAAM,OAAO,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,KAAiC;QACpD,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;KAIC;IACe,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;AAqED;;;;;;;;GAQG;AACH,MAAM,OAAO,QAAS,SAAQ,kBAAkB;IAC9C,6EAA6E;IACtE,MAAM,CAAC,uBAAuB,GAAG,MAAM,CAAC;IAE/C,iDAAiD;IACjC,IAAI,GAAG,OAAO,CAAC;IAC/B,uFAAuF;IACvE,YAAY,CAA8B;IAC1D,wEAAwE;IACxD,YAAY,CAA8B;IAC1D,iIAAiI;IACjH,SAAS,CAAkB;IACnC,cAAc,CAAS;IAE/B,0DAA0D;IAC1D,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,uEAAuE;IAChE,gBAAgB,CAAC,OAA2B;QACjD,IAAI,CAAC,cAAc,GAAG,OAAO,IAAI,QAAQ,CAAC,uBAAuB,CAAC;IACpE,CAAC;IAED,YAAoB,KAAkC;QACpD,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,aAAa,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QAC9E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,MAAM,CAAC,KAAkC;QACrD,OAAO,IAAI,QAAQ,CAAC;YAClB,GAAG,KAAK;YACR,YAAY,EAAE,EAAE,GAAG,KAAK,CAAC,YAAY,EAAE;YACvC,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;YACjD,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;SAC5C,CAAC,CAAC;IACL,CAAC;IAED,uDAAuD;IACvC,MAAM;QACpB,MAAM,IAAI,GAAkB;YAC1B,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,OAAO;YACb,YAAY,EAAE,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE;YACtC,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC;SACjD,CAAC;QAEF,IAAI,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,uBAAuB,EAAE,CAAC;YAC5D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2CAA2C;IAC3B,KAAK;QACnB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,+DAA+D;IAC/C,SAAS;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,uDAAuD;IACvC,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IACE,IAAI,CAAC,YAAY,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC,SAAS;YAC5D,IAAI,CAAC,YAAY,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC,SAAS;YAC5D,IAAI,CAAC,YAAY,CAAC,UAAU,KAAK,KAAK,CAAC,YAAY,CAAC,UAAU,EAC9D,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;YACvE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC;QACxD,MAAM,cAAc,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC;QAC1D,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,IAAI,EAAE,CAAC;QAChE,MAAM,kBAAkB,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,IAAI,EAAE,CAAC;QAElE,IAAI,aAAa,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,IAAI,iBAAiB,CAAC,MAAM,KAAK,kBAAkB,CAAC,MAAM,EAAE,CAAC;YAC7G,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACpF,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACtC,kDAAkD;YAClD,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACvE,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAaH;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvG,IAAI,CAAQ;IAE5B,YAAoB,KAAsB;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACjE,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,KAAsB;QACzC,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;;;OAGG;IACa,mBAAmB,CAAC,OAA+B;QACjE,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAC5B,IAAI,OAAO,EAAE,yBAAyB;YACpC,OAAO;QAET,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,GAAG,CAAC,mBAAmB,EAAE,CAAC;QAC5B,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;AAmBA,CAAC;AAqBF;;;;;GAKG;AACH,MAAM,OAAO,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,OAAO,CAAa;IAC3B;;;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,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,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,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,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,wFAAwF;IACjF,MAAM,CAAC,WAAW;QACvB,OAAO,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3C,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;;;OAGG;IACa,mBAAmB,CAAC,OAA+B;QACjE,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAC5B,IAAI,OAAO,EAAE,yBAAyB;YACpC,OAAO;QAET,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,SAAS,CAAC,mBAAmB,EAAE,CAAC;QAClC,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,CAAC,eAAwB,KAAK;QAClD,IAAI,cAAc,GAA2B,EAAE,CAAC;QAEhD,IAAI,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzD,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC9C,CAAC;QAED,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;YACjC,cAAc;SACf,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,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3D,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","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 { Id64String } from \"@itwin/core-bentley\";\nimport { TextStyleSettings, TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Options supplied to [[TextBlockComponent.clearStyleOverrides]] to control how the style overrides are cleared on the component and its child components.\n * @beta\n */\nexport interface ClearTextStyleOptions {\n  /** Controls whether the styleOverrides of any child components are retained.\n   * By default, all overrides are cleared.\n   */\n  preserveChildrenOverrides?: boolean;\n}\n\n/** The JSON representation of a [[TextBlockComponent]].\n * @beta\n */\nexport interface TextBlockComponentProps {\n  /** Deviations from the base [[TextStyleSettings]] defined by the [AnnotationTextStyle]($backend) applied to this component.\n   * This permits you to, e.g., create a [[TextBlock]] using \"Arial\" font and override one of its [[TextRun]]s 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 * The [[TextBlock]] can specify an [AnnotationTextStyle]($backend) that formats its contents. Each component can specify an optional [[styleOverrides]] to customize that formatting.\n * @beta\n */\nexport abstract class TextBlockComponent {\n  private _styleOverrides: TextStyleSettingsProps;\n\n  /** @internal */\n  protected constructor(props?: TextBlockComponentProps) {\n    this._styleOverrides = TextStyleSettings.cloneProps(props?.styleOverrides ?? {});\n  }\n\n  /** Deviations in individual properties of the [[TextStyleSettings]] in the [AnnotationTextStyle]($backend) specified by `styleId` on the [[TextBlock]].\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 = TextStyleSettings.cloneProps(overrides);\n  }\n\n  /** Reset any [[styleOverrides]] applied to this component. */\n  public clearStyleOverrides(_options?: ClearTextStyleOptions): void {\n    this.styleOverrides = {};\n  }\n\n  /** Returns true if [[styleOverrides]] specifies any deviations from the [[TextBlock]]'s [AnnotationTextStyle]($backend). */\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      styleOverrides: TextStyleSettings.cloneProps(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 (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/** [[TextBlockComponent]]s contained within a [[Paragraph]].\n * @beta\n */\nexport type Run = TextRun | FractionRun | TabRun | LineBreakRun | FieldRun;\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 | FieldRunProps;\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      case \"field\": return FieldRun.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 [[TextStyleSettings.stackedFractionType]]. Default: an empty string. */\n  numerator?: string;\n  /** The text displayed after or below the fraction separator, depending on [[TextStyleSettings.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/** A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content\n * of a [[FieldRun]].\n   * The simplest property paths consist of a [[propertyName]] and nothing else, where `propertyName` identifies\n   * a primitive property.\n   * If `propertyName` identifies a struct or array property, then additional [[accessors]] are required to identify the specific value.\n   * If `propertyName` (including any [[accessors]]) resolves to a JSON property, then additional [[jsonAccessors]] are required to identify a specific value within the JSON.\n   * Some examples:\n   * ```\n   * | Access String | propertyName | accessors | jsonAccessors |\n   * | ------------- | ------------ | --------- | ------------- |\n   * | name          | \"name\"       | undefined | undefined     |\n   * | spouse.name   | \"spouse\"     | [name]    | undefined     |\n   * | colors[2]     | \"colors\"     | [2]       | undefined     |\n   * | spouse.favoriteRestaurants[1].address | \"spouse\" | [\"favoriteRestaurants\", 1, \"address\"] | undefined |\n   * | jsonProperties.contactInfo.email | \"jsonProperties\" | undefined | [\"contactInfo\", \"email\"] |\n   * | spouse.jsonProperties.contactInfo.phoneNumbers[0].areaCode | \"spouse\" | [\"jsonProperties\"] | [\"contactInfo\", \"phoneNumbers\", 0, \"areaCode\"] |\n   * ```\n * @beta\n */\nexport interface FieldPropertyPath {\n  /** The name of the BIS property of the [[FieldPropertyHost]] that serves as the root of the path. */\n  propertyName: string;\n  /** Property names and/or array indices describing the path from [[propertyName]] to the ultimate BIS property. */\n  accessors?: Array<string | number>;\n  /** If [[propertyName]] and [[accessors]] (if defined) resolve to a BIS property of extended type `Json`, property names and/or\n   * array indices for selecting a primitive value within the JSON.\n   */\n  jsonAccessors?: Array<string | number>;\n}\n\n/** Describes the source of the property value against which a [[FieldPropertyPath]] is evaluated.\n * A field property is always hosted by an [Element]($backend). It may be a property of the element's BIS class itself,\n * or that of one of its [ElementAspect]($backend)s.\n * The [[schemaName]] and [[className]] should always identify the exact class that contains [[FieldPropertyPath.propertyName]] - not a subclass thereof.\n * @beta\n */\nexport interface FieldPropertyHost {\n  /** The Id of the [Element]($backend) that hosts the property. */\n  elementId: Id64String;\n  /** The name of the schema containing the class identified by [[className]]. */\n  schemaName: string;\n  /** The name of the exact class (not a subclass) containing the property identified by [[FieldPropertyPath.propertyName]]. */\n  className: string;\n}\n\n/** Placeholder type for a description of how to format the raw property value resolved by a [[FieldPropertyPath]] into a [[FieldRun]]'s display string.\n * *** COMING SOON ***\n * @beta\n */\nexport interface FieldFormatter { [k: string]: any }\n\n/** JSON representation of a [[FieldRun]].\n * @beta\n */\nexport interface FieldRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"field\";\n  /** The element and BIS class containing the property described by [[propertyPath]]. */\n  propertyHost: FieldPropertyHost;\n  /** Describes how to obtain the property value from [[propertyHost]]. */\n  propertyPath: FieldPropertyPath;\n  /** Specifies how to format the property value obtained from [[propertyPath]] into a string to be stored in [[cachedContent]]. */\n  formatter?: FieldFormatter;\n  /** The field's most recently evaluated display string. */\n  cachedContent?: string;\n}\n\n/** A [[Run]] that displays the formatted value of a property of some [Element]($backend).\n * When a [[TextBlock]] containing a [[FieldRun]] is written into the iModel as an [ITextAnnotation]($backend) element,\n * a dependency is established between the two elements via the [ElementDrivesTextAnnotation]($backend) relationship such that\n * whenever the source element specified by [[propertyHost]] is modified, the field(s) in the `ITextAnnotation` element are automatically\n * recalculated, causing their [[cachedContent]] to update. If the field's display string cannot be evaluated (for example, because the specified element or\n * property does not exist), then its cached content is set to [[FieldRun.invalidContentIndicator]].\n * A [[FieldRun]] displays its [[cachedContent]] in the same way that [[TextRun]]s display their `content`, including word wrapping where appropriate.\n * @beta\n */\nexport class FieldRun extends TextBlockComponent {\n  /** Display string used to signal an error in computing the field's value. */\n  public static invalidContentIndicator = \"####\";\n\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"field\";\n  /** The element and BIS class containing the property described by [[propertyPath]]. */\n  public readonly propertyHost: Readonly<FieldPropertyHost>;\n  /** Describes how to obtain the property value from [[propertyHost]]. */\n  public readonly propertyPath: Readonly<FieldPropertyPath>;\n  /** Specifies how to format the property value obtained from [[propertyPath]] into a string to be stored in [[cachedContent]]. */\n  public readonly formatter?: FieldFormatter;\n  private _cachedContent: string;\n\n  /** The field's most recently evaluated display string. */\n  public get cachedContent(): string {\n    return this._cachedContent;\n  }\n\n  /** @internal Used by core-backend when re-evaluating field content. */\n  public setCachedContent(content: string | undefined): void {\n    this._cachedContent = content ?? FieldRun.invalidContentIndicator;\n  }\n\n  private constructor(props: Omit<FieldRunProps, \"type\">) {\n    super(props);\n\n    this._cachedContent = props.cachedContent ?? FieldRun.invalidContentIndicator;\n    this.propertyHost = props.propertyHost\n    this.propertyPath = props.propertyPath;\n    this.formatter = props.formatter;\n  }\n\n  /** Create a FieldRun from its JSON representation. */\n  public static create(props: Omit<FieldRunProps, \"type\">): FieldRun {\n    return new FieldRun({\n      ...props,\n      propertyHost: { ...props.propertyHost },\n      propertyPath: structuredClone(props.propertyPath),\n      formatter: structuredClone(props.formatter),\n    });\n  }\n\n  /** Convert the FieldRun to its JSON representation. */\n  public override toJSON(): FieldRunProps {\n    const json: FieldRunProps = {\n      ...super.toJSON(),\n      type: \"field\",\n      propertyHost: { ...this.propertyHost },\n      propertyPath: structuredClone(this.propertyPath),\n    };\n\n    if (this.cachedContent !== FieldRun.invalidContentIndicator) {\n      json.cachedContent = this.cachedContent;\n    }\n\n    if (this.formatter) {\n      json.formatter = structuredClone(this.formatter);\n    }\n\n    return json;\n  }\n\n  /** Create a deep copy of this FieldRun. */\n  public override clone(): FieldRun {\n    return new FieldRun(this.toJSON());\n  }\n\n  /** Convert this FieldRun to a simple string representation. */\n  public override stringify(): string {\n    return this.cachedContent;\n  }\n\n  /** Returns true if `this` is equivalent to `other`. */\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof FieldRun) || !super.equals(other)) {\n      return false;\n    }\n\n    if (\n      this.propertyHost.elementId !== other.propertyHost.elementId ||\n      this.propertyHost.className !== other.propertyHost.className ||\n      this.propertyHost.schemaName !== other.propertyHost.schemaName\n    ) {\n      return false;\n    }\n\n    if (this.propertyPath.propertyName !== other.propertyPath.propertyName) {\n      return false;\n    }\n\n    const thisAccessors = this.propertyPath.accessors ?? [];\n    const otherAccessors = other.propertyPath.accessors ?? [];\n    const thisJsonAccessors = this.propertyPath.jsonAccessors ?? [];\n    const otherJsonAccessors = other.propertyPath.jsonAccessors ?? [];\n\n    if (thisAccessors.length !== otherAccessors.length || thisJsonAccessors.length !== otherJsonAccessors.length) {\n      return false;\n    }\n\n    if (!thisAccessors.every((value, index) => value === otherAccessors[index])) {\n      return false;\n    }\n\n    if (!thisJsonAccessors.every((value, index) => value === otherJsonAccessors[index])) {\n      return false;\n    }\n\n    if (this.formatter && other.formatter) {\n      // ###TODO better comparison of formatter objects.\n      if (JSON.stringify(this.formatter) !== JSON.stringify(other.formatter)) {\n        return false;\n      }\n    } else if (this.formatter || other.formatter) {\n      return false;\n    }\n\n    return true;\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  /**\n   * Clears any [[styleOverrides]] applied to this Paragraph.\n   * Will also clear [[styleOverrides]] from all child components unless [[ClearTextStyleOptions.preserveChildrenOverrides]] is `true`.\n   */\n  public override clearStyleOverrides(options?: ClearTextStyleOptions): void {\n    super.clearStyleOverrides();\n    if (options?.preserveChildrenOverrides)\n      return;\n\n    for (const run of this.runs) {\n      run.clearStyleOverrides();\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 ID of an [AnnotationTextStyle]($backend) stored in the iModel from which the base [[TextStyleSettings]] applied to the [[TextBlock]] originates. */\n  styleId: Id64String;\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 ID of the [AnnotationTextStyle]($backend) that provides the base formatting for the contents of this TextBlock.\n   * @note Assigning to this property retains all style overrides on the TextBlock and its child components.\n   * Call [[clearStyleOverrides]] to clear the TextBlock's and optionally all children's style overrides.\n   */\n  public styleId: Id64String;\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.styleId = props.styleId;\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      styleId: this.styleId,\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 [[styleId]]. */\n  public static createEmpty(): TextBlock {\n    return TextBlock.create({ styleId: \"\" });\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  /**\n   * Clears any [[styleOverrides]] applied to this TextBlock.\n   * Will also clear [[styleOverrides]] from all child components unless [[ClearTextStyleOptions.preserveChildrenOverrides]] is `true`.\n   */\n  public override clearStyleOverrides(options?: ClearTextStyleOptions): void {\n    super.clearStyleOverrides();\n    if (options?.preserveChildrenOverrides)\n      return;\n\n    for (const paragraph of this.paragraphs) {\n      paragraph.clearStyleOverrides();\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   * By default, the paragraph will be created with no [[styleOverrides]], so that it inherits the style of this block.\n   * @param seedFromLast If true and [[paragraphs]] is not empty, the new paragraph will inherit the style overrides of the last [[Paragraph]] in this block.\n   */\n  public appendParagraph(seedFromLast: boolean = false): Paragraph {\n    let styleOverrides: TextStyleSettingsProps = {};\n\n    if (seedFromLast && this.paragraphs.length > 0) {\n      const seed = this.paragraphs[this.paragraphs.length - 1];\n      styleOverrides = { ...seed.styleOverrides };\n    }\n\n    const paragraph = Paragraph.create({\n      styleOverrides\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.styleId !== other.styleId || !super.equals(other)) {\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/esm/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/esm/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/esm/annotation/TextBlockLayoutResult.d.ts

@@ -25,7 +25,7 @@ export interface RunLayoutResult {
     offsetFromLine: XAndY;
     /** Bounding box enclosing this RunLayoutResult's content. */
     range: Range2dProps;
-    /** The [[TextStyleSettings]] for the run. */
+    /** The resolved [[TextStyleSettings]] for the run. Takes into account overrides and styles on the parent classes. */
     textStyle: TextStyleSettingsProps;
     /** Bounding box used when justifying the run. This may be smaller than [[range]]. */
     justificationRange?: Range2dProps;

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

@@ -1 +1 @@
-{"version":3,"file":"TextBlockLayoutResult.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,0FAA0F;IAC1F,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,eAAe,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,cAAc,EAAE,MAAM,CAAC;IACvB,0FAA0F;IAC1F,cAAc,EAAE,KAAK,CAAC;IACtB,6DAA6D;IAC7D,KAAK,EAAE,YAAY,CAAC;IACpB,6CAA6C;IAC7C,SAAS,EAAE,sBAAsB,CAAC;IAClC,qFAAqF;IACrF,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClC,4EAA4E;IAC5E,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uGAAuG;IACvG,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,qDAAqD;IACrD,KAAK,EAAE,YAAY,CAAC;IACpB,sFAAsF;IACtF,kBAAkB,EAAE,YAAY,CAAC;IACjC,yEAAyE;IACzE,kBAAkB,EAAE,KAAK,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,4DAA4D;IAC5D,KAAK,EAAE,YAAY,CAAC;CACrB"}
+{"version":3,"file":"TextBlockLayoutResult.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,0FAA0F;IAC1F,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,eAAe,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,cAAc,EAAE,MAAM,CAAC;IACvB,0FAA0F;IAC1F,cAAc,EAAE,KAAK,CAAC;IACtB,6DAA6D;IAC7D,KAAK,EAAE,YAAY,CAAC;IACpB,qHAAqH;IACrH,SAAS,EAAE,sBAAsB,CAAC;IAClC,qFAAqF;IACrF,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClC,4EAA4E;IAC5E,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uGAAuG;IACvG,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,qDAAqD;IACrD,KAAK,EAAE,YAAY,CAAC;IACpB,sFAAsF;IACtF,kBAAkB,EAAE,YAAY,CAAC;IACjC,yEAAyE;IACzE,kBAAkB,EAAE,KAAK,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,4DAA4D;IAC5D,KAAK,EAAE,YAAY,CAAC;CACrB"}

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

@@ -1 +1 @@
-{"version":3,"file":"TextBlockLayoutResult.js","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.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 { Range2dProps, XAndY } from \"@itwin/core-geometry\";\nimport { FontId } from \"../Fonts\";\nimport { TextStyleSettingsProps } from \"./TextStyle\";\n\n/**\n * Represents a single run in a [[LineLayoutResult]].\n * @note Get the text content of the RunLayoutResult using a combination of the `sourceRunIndex`, `characterOffset`, and `characterCount`.\n * @beta\n */\nexport interface RunLayoutResult {\n  /** The index of the Run this RunLayoutResult was generated from in [[Paragraph.runs]]. */\n  sourceRunIndex: number;\n  /** The ID of the font for the run. */\n  fontId: FontId;\n  /**\n   * The number of characters from the source [[Run]] that have already appeared in the layout.\n   * @note A single source [[TextRun]] can be split into multiple lines to respect the [[TextBlock.width]].\n  */\n  characterOffset: number;\n  /** The number of characters in the RunLayoutResult. */\n  characterCount: number;\n  /** The offset of the RunLayoutResult from the top and left of the [[LineLayoutResult]] */\n  offsetFromLine: XAndY;\n  /** Bounding box enclosing this RunLayoutResult's content. */\n  range: Range2dProps;\n  /** The [[TextStyleSettings]] for the run. */\n  textStyle: TextStyleSettingsProps;\n  /** Bounding box used when justifying the run. This may be smaller than [[range]]. */\n  justificationRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s numerator. */\n  numeratorRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s denominator. */\n  denominatorRange?: Range2dProps;\n}\n\n/**\n * Represents a single line in a [[TextBlockLayoutResult]].\n * @beta\n */\nexport interface LineLayoutResult {\n  /** The index of the paragraph this LineLayoutResult was generated from in [[TextBlock.paragraphs]]. */\n  sourceParagraphIndex: number;\n  /** The runs contained in the line. */\n  runs: RunLayoutResult[];\n  /** The range containing the contents of the line. */\n  range: Range2dProps;\n  /** Bounding box used when justifying the line. This may be smaller than [[range]]. */\n  justificationRange: Range2dProps;\n  /** The offset of the line from the top and left of the [[TextBlock]]. */\n  offsetFromDocument: XAndY;\n}\n\n/**\n * Represents the result of laying out a [[TextBlock]]'s contents into a series of lines containing runs.\n * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n * @beta\n */\nexport interface TextBlockLayoutResult {\n  /** The laid out lines of a [[TextBlock]]. */\n  lines: LineLayoutResult[];\n  /** The range containing the contents of a [[TextBlock]]. */\n  range: Range2dProps;\n}\n"]}
+{"version":3,"file":"TextBlockLayoutResult.js","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.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 { Range2dProps, XAndY } from \"@itwin/core-geometry\";\nimport { FontId } from \"../Fonts\";\nimport { TextStyleSettingsProps } from \"./TextStyle\";\n\n/**\n * Represents a single run in a [[LineLayoutResult]].\n * @note Get the text content of the RunLayoutResult using a combination of the `sourceRunIndex`, `characterOffset`, and `characterCount`.\n * @beta\n */\nexport interface RunLayoutResult {\n  /** The index of the Run this RunLayoutResult was generated from in [[Paragraph.runs]]. */\n  sourceRunIndex: number;\n  /** The ID of the font for the run. */\n  fontId: FontId;\n  /**\n   * The number of characters from the source [[Run]] that have already appeared in the layout.\n   * @note A single source [[TextRun]] can be split into multiple lines to respect the [[TextBlock.width]].\n  */\n  characterOffset: number;\n  /** The number of characters in the RunLayoutResult. */\n  characterCount: number;\n  /** The offset of the RunLayoutResult from the top and left of the [[LineLayoutResult]] */\n  offsetFromLine: XAndY;\n  /** Bounding box enclosing this RunLayoutResult's content. */\n  range: Range2dProps;\n  /** The resolved [[TextStyleSettings]] for the run. Takes into account overrides and styles on the parent classes. */\n  textStyle: TextStyleSettingsProps;\n  /** Bounding box used when justifying the run. This may be smaller than [[range]]. */\n  justificationRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s numerator. */\n  numeratorRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s denominator. */\n  denominatorRange?: Range2dProps;\n}\n\n/**\n * Represents a single line in a [[TextBlockLayoutResult]].\n * @beta\n */\nexport interface LineLayoutResult {\n  /** The index of the paragraph this LineLayoutResult was generated from in [[TextBlock.paragraphs]]. */\n  sourceParagraphIndex: number;\n  /** The runs contained in the line. */\n  runs: RunLayoutResult[];\n  /** The range containing the contents of the line. */\n  range: Range2dProps;\n  /** Bounding box used when justifying the line. This may be smaller than [[range]]. */\n  justificationRange: Range2dProps;\n  /** The offset of the line from the top and left of the [[TextBlock]]. */\n  offsetFromDocument: XAndY;\n}\n\n/**\n * Represents the result of laying out a [[TextBlock]]'s contents into a series of lines containing runs.\n * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n * @beta\n */\nexport interface TextBlockLayoutResult {\n  /** The laid out lines of a [[TextBlock]]. */\n  lines: LineLayoutResult[];\n  /** The range containing the contents of a [[TextBlock]]. */\n  range: Range2dProps;\n}\n"]}