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

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

@@ -1,7 +1,23 @@
 /** @packageDocumentation
  * @module Annotation
  */
+import { DeepReadonlyObject, DeepRequiredObject } from "@itwin/core-bentley";
 import { ColorDefProps } from "../ColorDef";
+/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+export declare const textAnnotationFrameShapes: readonly ["none", "line", "rectangle", "circle", "equilateralTriangle", "diamond", "square", "pentagon", "hexagon", "octagon", "capsule", "roundedRectangle"];
+/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+export type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];
+/**
+ * Describes what color to use when filling the frame around a [[TextBlock]].
+ * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.
+ * If `none` is specified, no fill will be applied.
+ * @beta
+ */
+export type TextAnnotationFillColor = TextStyleColor | "background" | "none";
 /** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.
  * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].
  * @beta
@@ -13,7 +29,53 @@ export type StackedFractionType = "horizontal" | "diagonal";
  * @beta
  */
 export type TextStyleColor = ColorDefProps | "subcategory";
-/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.
+/**
+ * Describes how to draw the frame around a [[TextAnnotation]].
+ * The frame can be a simple line, a filled shape, or both.
+ * If only a subset of properties are specified, the others will be set to their default value.
+ * @beta
+ */
+export interface TextFrameStyleProps {
+    /** Shape of the frame. Default: "none" */
+    shape?: TextAnnotationFrameShape;
+    /** The color to fill the shape of the text frame. This fill is applied using [[FillDisplay.Blanking]]. Default: "none" */
+    fill?: TextAnnotationFillColor;
+    /** The color of the text frame's outline. Default: black */
+    border?: TextStyleColor;
+    /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */
+    borderWeight?: number;
+}
+/** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].
+ * Used when producing geometry for [[TextAnnotation]].
+ * @beta
+ */
+export interface TextLeaderStyleProps {
+    /** The color of the leader.
+     * If `inherit` is specified, the [[TextAnnotationLeader]] will use the color specified in the parent [[TextStyleSettings]]`.
+     * Default: "inherit".
+     */
+    color?: TextStyleColor | "inherit";
+    /** Whether to use an elbow in the leader.
+     * Default: false
+     */
+    wantElbow?: boolean;
+    /** Multiplier used to compute length of the elbow in the leader.
+     * The elbowLength is computed in meters as elbowLength * [[lineHeight]].
+     * Default: 1.0
+     */
+    elbowLength?: number;
+    /** Multiplier to compute height of the leader terminator.
+     * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].
+     * Default: 1.0
+     */
+    terminatorHeightFactor?: number;
+    /** Multiplier to compute width of the leader terminator.
+     * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].
+     * Default: 1.0
+     */
+    terminatorWidthFactor?: number;
+}
+/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [AnnotationTextStyle]($backend)'s properties.
  * @beta
  */
 export interface TextStyleSettingsProps {
@@ -21,12 +83,12 @@ export interface TextStyleSettingsProps {
      * Default: "subcategory".
      */
     color?: TextStyleColor;
-    /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].
+    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
      * Default: "" (an invalid font name).
      */
     fontName?: string;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
-     * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and
      * lineHeight * [[subScriptOffsetFactor]], respectively.
      * Default: 1.0. */
     lineHeight?: number;
@@ -80,9 +142,25 @@ export interface TextStyleSettingsProps {
      * Default: 1.0
      */
     widthFactor?: number;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]]
+     * Used when producing geometry for [[TextAnnotation]]
+     * Default: {color:"subcategory", wantElbow:"false",elbowLength:1, terminatorWidthFactor:1, terminatorHeightFactor:1}.
+     */
+    leader?: TextLeaderStyleProps;
+    /** The size (in meters) used to calculate the tab stops in a run.
+     * These are equally spaced from the left edge of the TextBlock.
+     * Default: 4 meters.
+     */
+    tabInterval?: number;
+    /**
+     * A description of the frame around the text annotation.
+     * Used when producing geometry for [[TextAnnotation]]s.
+     * Default: {shape: "none", fill: "none", border: black, borderWeight: 1} for no frame.
+     */
+    frame?: TextFrameStyleProps;
 }
 /** A description of the formatting to be applied to a [[TextBlockComponent]].
- * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).
+ * Named instances of these settings can be stored as [AnnotationTextStyle]($backend)s in an iModel.
  * @note This is an immutable type. Use [[clone]] to create a modified copy.
  * @see [[TextStyleSettingsProps]] for documentation of each of the settings.
  * @beta
@@ -90,11 +168,11 @@ export interface TextStyleSettingsProps {
 export declare class TextStyleSettings {
     /** The color of the text. */
     readonly color: TextStyleColor;
-    /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].
+    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
      */
     readonly fontName: string;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
-     * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and
      * lineHeight * [[subScriptOffsetFactor]], respectively.
      */
     readonly lineHeight: number;
@@ -132,42 +210,45 @@ export declare class TextStyleSettings {
     readonly superScriptScale: number;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     readonly widthFactor: number;
-    /** A fully-populated JSON representation of the default settings. */
-    static defaultProps: Readonly<Required<TextStyleSettingsProps>>;
+    /** Properties describing appearance of leaders in a [[TextAnnotation]].
+     * Used when producing geometry for [[TextAnnotation]].
+     */
+    readonly leader: Readonly<Required<TextLeaderStyleProps>>;
+    /** The size (in meters) used to calculate the tab stops in a run.
+     * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
+     */
+    readonly tabInterval: number;
+    /** The frame settings of the [[TextAnnotation]]. */
+    readonly frame: Readonly<Required<TextFrameStyleProps>>;
+    /** A fully-populated JSON representation of the default settings. A real `fontName` must be provided before use. */
+    static defaultProps: DeepReadonlyObject<DeepRequiredObject<TextStyleSettingsProps>>;
     /** Settings initialized to all default values. */
     static defaults: TextStyleSettings;
     private constructor();
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
     clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings;
+    /** Creates a deep copy of the `TextStyleSettingsProps`. */
+    static cloneProps(props: TextStyleSettingsProps): TextStyleSettingsProps;
     /** Create settings from their JSON representation. */
     static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings;
     toJSON(): TextStyleSettingsProps;
+    /** Compare two [[TextLeaderStyleProps]] for equality.
+     * @param other The other leader style properties to compare against.
+     * @returns true if the two leader styles are equal, false otherwise.
+     */
+    leaderEquals(other: TextLeaderStyleProps): boolean;
+    frameEquals(other: TextFrameStyleProps): boolean;
     equals(other: TextStyleSettings): boolean;
-}
-/** The JSON representation of a [[TextStyle]].
- * @beta
- */
-export interface TextStyleProps {
-    /** The name of the style. */
-    name: string;
-    /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */
-    settings?: TextStyleSettingsProps;
-}
-/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).
- * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].
- * @note This is an immutable type. Use [[clone]] to create a modified copy.
- * @beta
- */
-export declare class TextStyle {
-    readonly name: string;
-    readonly settings: TextStyleSettings;
-    private constructor();
-    /** Create a style from its JSON representation. */
-    static fromJSON(json: TextStyleProps): TextStyle;
-    /** Create a new style. */
-    static create(name: string, settings: TextStyleSettings): TextStyle;
-    /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */
-    clone(alteredSettings: TextStyleSettingsProps): TextStyle;
-    equals(other: TextStyle): boolean;
+    /**
+     * Returns a list of validation errors for this instance.
+     *
+     * A TextStyleSettings object may contain values that are invalid in all contexts.
+     * If this method returns any error strings, using the settings will likely result in rendering failures or runtime exceptions.
+     *
+     * This method only checks for universally invalid values. Additional domain-specific validation may be required depending on the context in which these settings are used.
+     *
+     * @returns An array of error strings describing the invalid values, or an empty array if the settings are valid.
+     */
+    getValidationErrors(): string[];
 }
 //# sourceMappingURL=TextStyle.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAepE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA8B;IAEvE,OAAO;IAqBP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIhC,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;CAQjD;AAKD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4IAA4I;IAC5I,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,OAAO;IAKP,mDAAmD;WACrC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;IAIvD,0BAA0B;WACZ,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,SAAS;IAI1E,sIAAsI;IAC/H,KAAK,CAAC,eAAe,EAAE,sBAAsB,GAAG,SAAS;IAIzD,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAGzC"}
+{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAY,aAAa,EAAE,MAAM,aAAa,CAAC;AAEtD;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,GAAG,MAAM,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,0HAA0H;IAC1H,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAcD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,oDAAoD;IACpD,SAAgB,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE/D,oHAAoH;IACpH,OAAc,YAAY,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CA6BxF;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IAsCP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,2DAA2D;WAC7C,UAAU,CAAC,KAAK,EAAE,sBAAsB,GAAG,sBAAsB;IAW/E,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,WAAW,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAOhD,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAYhD;;;;;;;;;OASG;IACI,mBAAmB,IAAI,MAAM,EAAE;CAgBvC"}

package/lib/esm/annotation/TextStyle.js

@@ -5,8 +5,25 @@
 /** @packageDocumentation
  * @module Annotation
  */
+import { ColorDef } from "../ColorDef";
+/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+export const textAnnotationFrameShapes = ["none", "line", "rectangle", "circle", "equilateralTriangle", "diamond", "square", "pentagon", "hexagon", "octagon", "capsule", "roundedRectangle"];
+;
+function deepFreeze(obj) {
+    if (obj === null || typeof obj !== "object" || Object.isFrozen(obj))
+        return;
+    Object.getOwnPropertyNames(obj).forEach((prop) => {
+        const value = obj[prop];
+        if (value && typeof value === "object") {
+            deepFreeze(value);
+        }
+    });
+    Object.freeze(obj);
+}
 /** A description of the formatting to be applied to a [[TextBlockComponent]].
- * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).
+ * Named instances of these settings can be stored as [AnnotationTextStyle]($backend)s in an iModel.
  * @note This is an immutable type. Use [[clone]] to create a modified copy.
  * @see [[TextStyleSettingsProps]] for documentation of each of the settings.
  * @beta
@@ -14,11 +31,11 @@
 export class TextStyleSettings {
     /** The color of the text. */
     color;
-    /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].
+    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
      */
     fontName;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
-     * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and
      * lineHeight * [[subScriptOffsetFactor]], respectively.
      */
     lineHeight;
@@ -56,7 +73,17 @@ export class TextStyleSettings {
     superScriptScale;
     /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
     widthFactor;
-    /** A fully-populated JSON representation of the default settings. */
+    /** Properties describing appearance of leaders in a [[TextAnnotation]].
+     * Used when producing geometry for [[TextAnnotation]].
+     */
+    leader;
+    /** The size (in meters) used to calculate the tab stops in a run.
+     * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
+     */
+    tabInterval;
+    /** The frame settings of the [[TextAnnotation]]. */
+    frame;
+    /** A fully-populated JSON representation of the default settings. A real `fontName` must be provided before use. */
     static defaultProps = {
         color: "subcategory",
         fontName: "",
@@ -72,6 +99,20 @@ export class TextStyleSettings {
         superScriptOffsetFactor: 0.5,
         superScriptScale: 2 / 3,
         widthFactor: 1,
+        leader: {
+            color: "inherit",
+            wantElbow: false,
+            elbowLength: 1.0,
+            terminatorHeightFactor: 1.0,
+            terminatorWidthFactor: 1.0,
+        },
+        tabInterval: 4,
+        frame: {
+            shape: "none",
+            fill: "none",
+            border: ColorDef.black.toJSON(),
+            borderWeight: 1,
+        },
     };
     /** Settings initialized to all default values. */
     static defaults = new TextStyleSettings({});
@@ -93,11 +134,39 @@ export class TextStyleSettings {
         this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;
         this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;
         this.widthFactor = props.widthFactor ?? defaults.widthFactor;
+        const leader = {
+            color: props.leader?.color ?? defaults.leader.color,
+            wantElbow: props.leader?.wantElbow ?? defaults.leader.wantElbow,
+            elbowLength: props.leader?.elbowLength ?? defaults.leader.elbowLength,
+            terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,
+            terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,
+        };
+        this.leader = Object.freeze(leader);
+        this.tabInterval = props.tabInterval ?? defaults.tabInterval;
+        const frame = {
+            shape: props.frame?.shape ?? defaults.frame.shape,
+            fill: props.frame?.fill ?? defaults.frame.fill,
+            border: props.frame?.border ?? defaults.frame.border,
+            borderWeight: props.frame?.borderWeight ?? defaults.frame.borderWeight,
+        };
+        // Cast to indicate to TypeScript that the frame properties are all defined
+        this.frame = Object.freeze(frame);
     }
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
     clone(alteredProps) {
         return alteredProps ? new TextStyleSettings(alteredProps, this) : this;
     }
+    /** Creates a deep copy of the `TextStyleSettingsProps`. */
+    static cloneProps(props) {
+        const copy = { ...props };
+        if (props.leader) {
+            copy.leader = { ...props.leader };
+        }
+        if (props.frame) {
+            copy.frame = { ...props.frame };
+        }
+        return copy;
+    }
     /** Create settings from their JSON representation. */
     static fromJSON(props) {
         return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;
@@ -105,43 +174,56 @@ export class TextStyleSettings {
     toJSON() {
         return { ...this };
     }
+    /** Compare two [[TextLeaderStyleProps]] for equality.
+     * @param other The other leader style properties to compare against.
+     * @returns true if the two leader styles are equal, false otherwise.
+     */
+    leaderEquals(other) {
+        return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow
+            && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor
+            && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;
+    }
+    frameEquals(other) {
+        return this.frame?.shape === other.shape
+            && this.frame?.fill === other.fill
+            && this.frame?.border === other.border
+            && this.frame?.borderWeight === other.borderWeight;
+    }
     equals(other) {
         return this.color === other.color && this.fontName === other.fontName
             && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor
             && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined
             && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale
             && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale
-            && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale;
-    }
-}
-Object.freeze(TextStyleSettings.defaultProps);
-Object.freeze(TextStyleSettings.defaults);
-/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).
- * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].
- * @note This is an immutable type. Use [[clone]] to create a modified copy.
- * @beta
- */
-export class TextStyle {
-    name;
-    settings;
-    constructor(name, settings) {
-        this.name = name;
-        this.settings = settings;
-    }
-    /** Create a style from its JSON representation. */
-    static fromJSON(json) {
-        return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));
-    }
-    /** Create a new style. */
-    static create(name, settings) {
-        return new TextStyle(name, settings);
+            && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale
+            && this.tabInterval === other.tabInterval
+            && this.leaderEquals(other.leader)
+            && this.frameEquals(other.frame);
     }
-    /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */
-    clone(alteredSettings) {
-        return TextStyle.create(this.name, this.settings.clone(alteredSettings));
-    }
-    equals(other) {
-        return this.name === other.name && this.settings.equals(other.settings);
+    /**
+     * Returns a list of validation errors for this instance.
+     *
+     * A TextStyleSettings object may contain values that are invalid in all contexts.
+     * If this method returns any error strings, using the settings will likely result in rendering failures or runtime exceptions.
+     *
+     * This method only checks for universally invalid values. Additional domain-specific validation may be required depending on the context in which these settings are used.
+     *
+     * @returns An array of error strings describing the invalid values, or an empty array if the settings are valid.
+     */
+    getValidationErrors() {
+        const errorMessages = [];
+        if (this.fontName.trim() === "") {
+            errorMessages.push("fontName must be provided");
+        }
+        if (this.lineHeight <= 0) {
+            errorMessages.push("lineHeight must be greater than 0");
+        }
+        if (this.stackedFractionScale <= 0) {
+            errorMessages.push("stackedFractionScale must be greater than 0");
+        }
+        return errorMessages;
     }
 }
+deepFreeze(TextStyleSettings.defaultProps);
+deepFreeze(TextStyleSettings.defaults);
 //# sourceMappingURL=TextStyle.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.js","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAsFH;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IAC5B,6BAA6B;IACb,KAAK,CAAiB;IACtC;OACG;IACa,QAAQ,CAAS;IACjC;;;OAGG;IACa,UAAU,CAAS;IACnC;;OAEG;IACa,iBAAiB,CAAS;IAC1C,kFAAkF;IAClE,MAAM,CAAU;IAChC,sFAAsF;IACtE,QAAQ,CAAU;IAClC,2EAA2E;IAC3D,YAAY,CAAU;IACtC;;OAEG;IACa,oBAAoB,CAAS;IAC7C,oFAAoF;IACpE,mBAAmB,CAAsB;IACzD;;OAEG;IACa,qBAAqB,CAAS;IAC9C;;OAEG;IACa,cAAc,CAAS;IACvC;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAS;IACzC,sFAAsF;IACtE,WAAW,CAAS;IAEpC,qEAAqE;IAC9D,MAAM,CAAC,YAAY,GAA+C;QACvE,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,CAAC;QACb,iBAAiB,EAAE,GAAG;QACtB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,oBAAoB,EAAE,GAAG;QACzB,mBAAmB,EAAE,YAAY;QACjC,qBAAqB,EAAE,CAAC,IAAI;QAC5B,cAAc,EAAE,CAAC,GAAG,CAAC;QACrB,uBAAuB,EAAE,GAAG;QAC5B,gBAAgB,EAAE,CAAC,GAAG,CAAC;QACvB,WAAW,EAAE,CAAC;KACf,CAAC;IAEF,kDAAkD;IAC3C,MAAM,CAAC,QAAQ,GAAsB,IAAI,iBAAiB,CAAC,EAAG,CAAC,CAAC;IAEvE,YAAoB,KAA6B,EAAE,QAA2C;QAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAChE,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QACxF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACrF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC;QACtE,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QACjG,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,IAAI,QAAQ,CAAC,gBAAgB,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;IAC/D,CAAC;IAED,uGAAuG;IAChG,KAAK,CAAC,YAAqC;QAChD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChE,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACpI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAC5G,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB;eAClH,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;eAC1G,IAAI,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,CAAC;IAC1H,CAAC;;AAGH,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAY1C;;;;GAIG;AACH,MAAM,OAAO,SAAS;IACJ,IAAI,CAAS;IACb,QAAQ,CAAoB;IAE5C,YAAoB,IAAY,EAAE,QAA2B;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,QAA2B;QAC5D,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,sIAAsI;IAC/H,KAAK,CAAC,eAAuC;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM,CAAC,KAAgB;QAC5B,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { ColorDefProps } from \"../ColorDef\";\n\n/** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.\n * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].\n * @beta\n */\nexport type StackedFractionType = \"horizontal\" | \"diagonal\";\n\n/** Describes the color in which to draw the text in a [[TextRun]].\n * \"subcategory\" indicates that the text should be drawn using the color of the [SubCategory]($backend) specified by the [GeometryStream]($docs/learning/common/GeometryStream.md) hosting the\n * text.\n * @beta\n */\nexport type TextStyleColor = ColorDefProps | \"subcategory\";\n\n/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.\n * @beta\n */\nexport interface TextStyleSettingsProps {\n  /** The color of the text.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   * Default: \"\" (an invalid font name).\n   */\n  fontName?: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   * Default: 1.0. */\n  lineHeight?: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   * Default: 0.5.\n   */\n  lineSpacingFactor?: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.\n   * Default: false.\n   */\n  isBold?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*.\n   * Default: false.\n   */\n  isItalic?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined.\n   * Default: false.\n   */\n  isUnderlined?: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   * Default: 0.7.\n   */\n  stackedFractionScale?: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]].\n   * Default: \"horizontal\".\n   */\n  stackedFractionType?: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.15.\n   */\n  subScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  subScriptScale?: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.5.\n   */\n  superScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  superScriptScale?: number;\n  /** A scale applied to the width of each glyph.\n   * Default: 1.0\n   */\n  widthFactor?: number;\n}\n\n/** A description of the formatting to be applied to a [[TextBlockComponent]].\n * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @see [[TextStyleSettingsProps]] for documentation of each of the settings.\n * @beta\n */\nexport class TextStyleSettings {\n  /** The color of the text. */\n  public readonly color: TextStyleColor;\n  /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].\n   */\n  public readonly fontName: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are compuated as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   */\n  public readonly lineHeight: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   */\n  public readonly lineSpacingFactor: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */\n  public readonly isBold: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */\n  public readonly isItalic: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined. */\n  public readonly isUnderlined: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   */\n  public readonly stackedFractionScale: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */\n  public readonly stackedFractionType: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly subScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   */\n  public readonly subScriptScale: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly superScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   */\n  public readonly superScriptScale: number;\n  /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */\n  public readonly widthFactor: number;\n\n  /** A fully-populated JSON representation of the default settings. */\n  public static defaultProps: Readonly<Required<TextStyleSettingsProps>> = {\n    color: \"subcategory\",\n    fontName: \"\",\n    lineHeight: 1,\n    lineSpacingFactor: 0.5,\n    isBold: false,\n    isItalic: false,\n    isUnderlined: false,\n    stackedFractionScale: 0.7,\n    stackedFractionType: \"horizontal\",\n    subScriptOffsetFactor: -0.15,\n    subScriptScale: 2 / 3,\n    superScriptOffsetFactor: 0.5,\n    superScriptScale: 2 / 3,\n    widthFactor: 1,\n  };\n\n  /** Settings initialized to all default values. */\n  public static defaults: TextStyleSettings = new TextStyleSettings({ });\n\n  private constructor(props: TextStyleSettingsProps, defaults?: Required<TextStyleSettingsProps>) {\n    if (!defaults) {\n      defaults = TextStyleSettings.defaultProps;\n    }\n\n    this.color = props.color ?? defaults.color;\n    this.fontName = props.fontName ?? defaults.fontName;\n    this.lineHeight = props.lineHeight ?? defaults.lineHeight;\n    this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;\n    this.isBold = props.isBold ?? defaults.isBold;\n    this.isItalic = props.isItalic ?? defaults.isItalic;\n    this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;\n    this.stackedFractionScale = props.stackedFractionScale ?? defaults.stackedFractionScale;\n    this.stackedFractionType = props.stackedFractionType ?? defaults.stackedFractionType;\n    this.subScriptOffsetFactor = props.subScriptOffsetFactor ?? defaults.subScriptOffsetFactor;\n    this.subScriptScale = props.subScriptScale ?? defaults.subScriptScale;\n    this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;\n    this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;\n    this.widthFactor = props.widthFactor ?? defaults.widthFactor;\n  }\n\n  /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */\n  public clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings {\n    return alteredProps ? new TextStyleSettings(alteredProps, this) : this;\n  }\n\n  /** Create settings from their JSON representation. */\n  public static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings {\n    return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;\n  }\n\n  public toJSON(): TextStyleSettingsProps {\n    return { ...this };\n  }\n\n  public equals(other: TextStyleSettings): boolean {\n    return this.color === other.color && this.fontName === other.fontName\n      && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor\n      && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined\n      && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale\n      && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale\n      && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale;\n  }\n}\n\nObject.freeze(TextStyleSettings.defaultProps);\nObject.freeze(TextStyleSettings.defaults);\n\n/** The JSON representation of a [[TextStyle]].\n * @beta\n */\nexport interface TextStyleProps {\n  /** The name of the style. */\n  name: string;\n  /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */\n  settings?: TextStyleSettingsProps;\n}\n\n/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).\n * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @beta\n */\nexport class TextStyle {\n  public readonly name: string;\n  public readonly settings: TextStyleSettings;\n\n  private constructor(name: string, settings: TextStyleSettings) {\n    this.name = name;\n    this.settings = settings;\n  }\n\n  /** Create a style from its JSON representation. */\n  public static fromJSON(json: TextStyleProps): TextStyle {\n    return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));\n  }\n\n  /** Create a new style. */\n  public static create(name: string, settings: TextStyleSettings): TextStyle {\n    return new TextStyle(name, settings);\n  }\n\n  /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */\n  public clone(alteredSettings: TextStyleSettingsProps): TextStyle {\n    return TextStyle.create(this.name, this.settings.clone(alteredSettings));\n  }\n\n  public equals(other: TextStyle): boolean {\n    return this.name === other.name && this.settings.equals(other.settings);\n  }\n}\n\n"]}
+{"version":3,"file":"TextStyle.js","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAiB,MAAM,aAAa,CAAC;AAEtD;;EAEE;AACF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAU,CAAC;AA2CtM,CAAC;AAuHF,SAAS,UAAU,CAAI,GAAM;IAC3B,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QACjE,OAAO;IACT,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/C,MAAM,KAAK,GAAI,GAAW,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IAC5B,6BAA6B;IACb,KAAK,CAAiB;IACtC;OACG;IACa,QAAQ,CAAS;IACjC;;;OAGG;IACa,UAAU,CAAS;IACnC;;OAEG;IACa,iBAAiB,CAAS;IAC1C,kFAAkF;IAClE,MAAM,CAAU;IAChC,sFAAsF;IACtE,QAAQ,CAAU;IAClC,2EAA2E;IAC3D,YAAY,CAAU;IACtC;;OAEG;IACa,oBAAoB,CAAS;IAC7C,oFAAoF;IACpE,mBAAmB,CAAsB;IACzD;;OAEG;IACa,qBAAqB,CAAS;IAC9C;;OAEG;IACa,cAAc,CAAS;IACvC;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAS;IACzC,sFAAsF;IACtE,WAAW,CAAS;IACpC;;OAEG;IACa,MAAM,CAA2C;IACjE;;OAEG;IACa,WAAW,CAAS;IACpC,oDAAoD;IACpC,KAAK,CAA0C;IAE/D,oHAAoH;IAC7G,MAAM,CAAC,YAAY,GAAmE;QAC3F,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,CAAC;QACb,iBAAiB,EAAE,GAAG;QACtB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,oBAAoB,EAAE,GAAG;QACzB,mBAAmB,EAAE,YAAY;QACjC,qBAAqB,EAAE,CAAC,IAAI;QAC5B,cAAc,EAAE,CAAC,GAAG,CAAC;QACrB,uBAAuB,EAAE,GAAG;QAC5B,gBAAgB,EAAE,CAAC,GAAG,CAAC;QACvB,WAAW,EAAE,CAAC;QACd,MAAM,EAAE;YACN,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,KAAK;YAChB,WAAW,EAAE,GAAG;YAChB,sBAAsB,EAAE,GAAG;YAC3B,qBAAqB,EAAE,GAAG;SAC3B;QACD,WAAW,EAAE,CAAC;QACd,KAAK,EAAE;YACL,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;YAC/B,YAAY,EAAE,CAAC;SAChB;KACF,CAAC;IAEF,kDAAkD;IAC3C,MAAM,CAAC,QAAQ,GAAsB,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC;IAEtE,YAAoB,KAA6B,EAAE,QAA2C;QAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAChE,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QACxF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACrF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC;QACtE,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,IAAI,QAAQ,CAAC,uBAAuB,CAAC;QACjG,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,IAAI,QAAQ,CAAC,gBAAgB,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;QAC7D,MAAM,MAAM,GAAG;YACb,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK;YACnD,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,SAAS;YAC/D,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,MAAM,CAAC,WAAW;YACrE,sBAAsB,EAAE,KAAK,CAAC,MAAM,EAAE,sBAAsB,IAAI,QAAQ,CAAC,MAAM,CAAC,sBAAsB;YACtG,qBAAqB,EAAE,KAAK,CAAC,MAAM,EAAE,qBAAqB,IAAI,QAAQ,CAAC,MAAM,CAAC,qBAAqB;SACpG,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA6C,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC;QAC7D,MAAM,KAAK,GAAG;YACZ,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,KAAK;YACjD,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI;YAC9C,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM;YACpD,YAAY,EAAE,KAAK,CAAC,KAAK,EAAE,YAAY,IAAI,QAAQ,CAAC,KAAK,CAAC,YAAY;SACtE,CAAC;QACH,2EAA2E;QAC3E,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAA4C,CAAC;IAC/E,CAAC;IAED,uGAAuG;IAChG,KAAK,CAAC,YAAqC;QAChD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,UAAU,CAAC,KAA6B;QACpD,MAAM,IAAI,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;QAC1B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QAClC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,KAA2B;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAChF,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAsB,KAAK,KAAK,CAAC,sBAAsB;eACpH,IAAI,CAAC,MAAM,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IACzE,CAAC;IAEM,WAAW,CAAC,KAA0B;QAC3C,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,KAAK;eACnC,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,IAAI;eAC/B,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,MAAM;eACnC,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IACvD,CAAC;IAEM,MAAM,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChE,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACpI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAC5G,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB;eAClH,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;eAC1G,IAAI,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAClH,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACtC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;eAC/B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED;;;;;;;;;OASG;IACI,mBAAmB;QACxB,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAChC,aAAa,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;YACzB,aAAa,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,IAAI,CAAC,oBAAoB,IAAI,CAAC,EAAE,CAAC;YACnC,aAAa,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;;AAGH,UAAU,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC3C,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC","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 { DeepReadonlyObject, DeepRequiredObject } from \"@itwin/core-bentley\";\nimport { ColorDef, ColorDefProps } from \"../ColorDef\";\n\n/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport const textAnnotationFrameShapes = [\"none\", \"line\", \"rectangle\", \"circle\", \"equilateralTriangle\", \"diamond\", \"square\", \"pentagon\", \"hexagon\", \"octagon\", \"capsule\", \"roundedRectangle\"] as const;\n\n/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]\n * @beta\n*/\nexport type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];\n\n/**\n * Describes what color to use when filling the frame around a [[TextBlock]].\n * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.\n * If `none` is specified, no fill will be applied.\n * @beta\n */\nexport type TextAnnotationFillColor = TextStyleColor | \"background\" | \"none\";\n\n/** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.\n * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].\n * @beta\n */\nexport type StackedFractionType = \"horizontal\" | \"diagonal\";\n\n/** Describes the color in which to draw the text in a [[TextRun]].\n * \"subcategory\" indicates that the text should be drawn using the color of the [SubCategory]($backend) specified by the [GeometryStream]($docs/learning/common/GeometryStream.md) hosting the\n * text.\n * @beta\n */\nexport type TextStyleColor = ColorDefProps | \"subcategory\";\n\n/**\n * Describes how to draw the frame around a [[TextAnnotation]].\n * The frame can be a simple line, a filled shape, or both.\n * If only a subset of properties are specified, the others will be set to their default value.\n * @beta\n */\nexport interface TextFrameStyleProps {\n  /** Shape of the frame. Default: \"none\" */\n  shape?: TextAnnotationFrameShape;\n  /** The color to fill the shape of the text frame. This fill is applied using [[FillDisplay.Blanking]]. Default: \"none\" */\n  fill?: TextAnnotationFillColor;\n  /** The color of the text frame's outline. Default: black */\n  border?: TextStyleColor;\n  /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */\n  borderWeight?: number;\n};\n\n/** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].\n * Used when producing geometry for [[TextAnnotation]].\n * @beta\n */\nexport interface TextLeaderStyleProps {\n  /** The color of the leader.\n   * If `inherit` is specified, the [[TextAnnotationLeader]] will use the color specified in the parent [[TextStyleSettings]]`.\n   * Default: \"inherit\".\n   */\n  color?: TextStyleColor | \"inherit\";\n  /** Whether to use an elbow in the leader.\n   * Default: false\n   */\n  wantElbow?: boolean;\n  /** Multiplier used to compute length of the elbow in the leader.\n   * The elbowLength is computed in meters as elbowLength * [[lineHeight]].\n   * Default: 1.0\n   */\n  elbowLength?: number;\n  /** Multiplier to compute height of the leader terminator.\n   * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].\n   * Default: 1.0\n   */\n  terminatorHeightFactor?: number;\n  /** Multiplier to compute width of the leader terminator.\n   * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].\n   * Default: 1.0\n   */\n  terminatorWidthFactor?: number;\n}\n\n/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [AnnotationTextStyle]($backend)'s properties.\n * @beta\n */\nexport interface TextStyleSettingsProps {\n  /** The color of the text.\n   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\n  /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].\n   * Default: \"\" (an invalid font name).\n   */\n  fontName?: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   * Default: 1.0. */\n  lineHeight?: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   * Default: 0.5.\n   */\n  lineSpacingFactor?: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.\n   * Default: false.\n   */\n  isBold?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*.\n   * Default: false.\n   */\n  isItalic?: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined.\n   * Default: false.\n   */\n  isUnderlined?: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   * Default: 0.7.\n   */\n  stackedFractionScale?: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]].\n   * Default: \"horizontal\".\n   */\n  stackedFractionType?: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.15.\n   */\n  subScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  subScriptScale?: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   * Default: -0.5.\n   */\n  superScriptOffsetFactor?: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   * Default: 2/3\n   */\n  superScriptScale?: number;\n  /** A scale applied to the width of each glyph.\n   * Default: 1.0\n   */\n  widthFactor?: number;\n\n  /** Properties describing appearance of leaders in a [[TextAnnotation]]\n   * Used when producing geometry for [[TextAnnotation]]\n   * Default: {color:\"subcategory\", wantElbow:\"false\",elbowLength:1, terminatorWidthFactor:1, terminatorHeightFactor:1}.\n   */\n  leader?: TextLeaderStyleProps;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock.\n   * Default: 4 meters.\n   */\n  tabInterval?: number;\n  /**\n   * A description of the frame around the text annotation.\n   * Used when producing geometry for [[TextAnnotation]]s.\n   * Default: {shape: \"none\", fill: \"none\", border: black, borderWeight: 1} for no frame.\n   */\n  frame?: TextFrameStyleProps;\n}\n\nfunction deepFreeze<T>(obj: T) {\n  if (obj === null || typeof obj !== \"object\" || Object.isFrozen(obj))\n    return;\n  Object.getOwnPropertyNames(obj).forEach((prop) => {\n    const value = (obj as any)[prop];\n    if (value && typeof value === \"object\") {\n      deepFreeze(value);\n    }\n  });\n  Object.freeze(obj);\n}\n\n/** A description of the formatting to be applied to a [[TextBlockComponent]].\n * Named instances of these settings can be stored as [AnnotationTextStyle]($backend)s in an iModel.\n * @note This is an immutable type. Use [[clone]] to create a modified copy.\n * @see [[TextStyleSettingsProps]] for documentation of each of the settings.\n * @beta\n */\nexport class TextStyleSettings {\n  /** The color of the text. */\n  public readonly color: TextStyleColor;\n  /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].\n   */\n  public readonly fontName: string;\n  /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.\n   * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as lineHeight * [[subScriptScale]] and\n   * lineHeight * [[subScriptOffsetFactor]], respectively.\n   */\n  public readonly lineHeight: number;\n  /** Multiplier used to compute the vertical distance between two lines of text.\n   * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].\n   */\n  public readonly lineSpacingFactor: number;\n  /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */\n  public readonly isBold: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */\n  public readonly isItalic: boolean;\n  /** Specifies whether the content of a [[TextRun]] should be underlined. */\n  public readonly isUnderlined: boolean;\n  /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].\n   * The height is computed in meters as stackedFractionScale * [[lineHeight]].\n   */\n  public readonly stackedFractionScale: number;\n  /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */\n  public readonly stackedFractionType: StackedFractionType;\n  /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].\n   * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly subScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a subscript [[TextRun]].\n   * The height is computed as subScriptScale * [[lineHeight]].\n   */\n  public readonly subScriptScale: number;\n  /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].\n   * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].\n   */\n  public readonly superScriptOffsetFactor: number;\n  /** Multiplier used to compute the height of a superscript [[TextRun]].\n   * The height is computed as superScriptScale * [[lineHeight]].\n   */\n  public readonly superScriptScale: number;\n  /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */\n  public readonly widthFactor: number;\n  /** Properties describing appearance of leaders in a [[TextAnnotation]].\n   * Used when producing geometry for [[TextAnnotation]].\n   */\n  public readonly leader: Readonly<Required<TextLeaderStyleProps>>;\n  /** The size (in meters) used to calculate the tab stops in a run.\n   * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.\n   */\n  public readonly tabInterval: number;\n  /** The frame settings of the [[TextAnnotation]]. */\n  public readonly frame: Readonly<Required<TextFrameStyleProps>>;\n\n  /** A fully-populated JSON representation of the default settings. A real `fontName` must be provided before use. */\n  public static defaultProps: DeepReadonlyObject<DeepRequiredObject<TextStyleSettingsProps>> = {\n    color: \"subcategory\",\n    fontName: \"\",\n    lineHeight: 1,\n    lineSpacingFactor: 0.5,\n    isBold: false,\n    isItalic: false,\n    isUnderlined: false,\n    stackedFractionScale: 0.7,\n    stackedFractionType: \"horizontal\",\n    subScriptOffsetFactor: -0.15,\n    subScriptScale: 2 / 3,\n    superScriptOffsetFactor: 0.5,\n    superScriptScale: 2 / 3,\n    widthFactor: 1,\n    leader: {\n      color: \"inherit\",\n      wantElbow: false,\n      elbowLength: 1.0,\n      terminatorHeightFactor: 1.0,\n      terminatorWidthFactor: 1.0,\n    },\n    tabInterval: 4,\n    frame: {\n      shape: \"none\",\n      fill: \"none\",\n      border: ColorDef.black.toJSON(),\n      borderWeight: 1,\n    },\n  };\n\n  /** Settings initialized to all default values. */\n  public static defaults: TextStyleSettings = new TextStyleSettings({});\n\n  private constructor(props: TextStyleSettingsProps, defaults?: Required<TextStyleSettingsProps>) {\n    if (!defaults) {\n      defaults = TextStyleSettings.defaultProps;\n    }\n\n    this.color = props.color ?? defaults.color;\n    this.fontName = props.fontName ?? defaults.fontName;\n    this.lineHeight = props.lineHeight ?? defaults.lineHeight;\n    this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;\n    this.isBold = props.isBold ?? defaults.isBold;\n    this.isItalic = props.isItalic ?? defaults.isItalic;\n    this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;\n    this.stackedFractionScale = props.stackedFractionScale ?? defaults.stackedFractionScale;\n    this.stackedFractionType = props.stackedFractionType ?? defaults.stackedFractionType;\n    this.subScriptOffsetFactor = props.subScriptOffsetFactor ?? defaults.subScriptOffsetFactor;\n    this.subScriptScale = props.subScriptScale ?? defaults.subScriptScale;\n    this.superScriptOffsetFactor = props.superScriptOffsetFactor ?? defaults.superScriptOffsetFactor;\n    this.superScriptScale = props.superScriptScale ?? defaults.superScriptScale;\n    this.widthFactor = props.widthFactor ?? defaults.widthFactor;\n    const leader = {\n      color: props.leader?.color ?? defaults.leader.color,\n      wantElbow: props.leader?.wantElbow ?? defaults.leader.wantElbow,\n      elbowLength: props.leader?.elbowLength ?? defaults.leader.elbowLength,\n      terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,\n      terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,\n    }\n    this.leader = Object.freeze(leader) as Readonly<Required<TextLeaderStyleProps>>;\n    this.tabInterval = props.tabInterval ?? defaults.tabInterval;\n    const frame = {\n      shape: props.frame?.shape ?? defaults.frame.shape,\n      fill: props.frame?.fill ?? defaults.frame.fill,\n      border: props.frame?.border ?? defaults.frame.border,\n      borderWeight: props.frame?.borderWeight ?? defaults.frame.borderWeight,\n     };\n    // Cast to indicate to TypeScript that the frame properties are all defined\n    this.frame = Object.freeze(frame) as Readonly<Required<TextFrameStyleProps>>;\n  }\n\n  /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */\n  public clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings {\n    return alteredProps ? new TextStyleSettings(alteredProps, this) : this;\n  }\n\n  /** Creates a deep copy of the `TextStyleSettingsProps`. */\n  public static cloneProps(props: TextStyleSettingsProps): TextStyleSettingsProps {\n    const copy = { ...props };\n    if (props.leader) {\n      copy.leader = { ...props.leader };\n    }\n    if (props.frame) {\n      copy.frame = { ...props.frame };\n    }\n    return copy;\n  }\n\n  /** Create settings from their JSON representation. */\n  public static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings {\n    return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;\n  }\n\n  public toJSON(): TextStyleSettingsProps {\n    return { ...this };\n  }\n\n  /** Compare two [[TextLeaderStyleProps]] for equality.\n   * @param other The other leader style properties to compare against.\n   * @returns true if the two leader styles are equal, false otherwise.\n   */\n  public leaderEquals(other: TextLeaderStyleProps): boolean {\n    return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow\n      && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor\n      && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;\n  }\n\n  public frameEquals(other: TextFrameStyleProps): boolean {\n    return this.frame?.shape === other.shape\n      && this.frame?.fill === other.fill\n      && this.frame?.border === other.border\n      && this.frame?.borderWeight === other.borderWeight;\n  }\n\n  public equals(other: TextStyleSettings): boolean {\n    return this.color === other.color && this.fontName === other.fontName\n      && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor\n      && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined\n      && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale\n      && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale\n      && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale\n      && this.tabInterval === other.tabInterval\n      && this.leaderEquals(other.leader)\n      && this.frameEquals(other.frame)\n  }\n\n  /**\n   * Returns a list of validation errors for this instance.\n   *\n   * A TextStyleSettings object may contain values that are invalid in all contexts.\n   * If this method returns any error strings, using the settings will likely result in rendering failures or runtime exceptions.\n   *\n   * This method only checks for universally invalid values. Additional domain-specific validation may be required depending on the context in which these settings are used.\n   *\n   * @returns An array of error strings describing the invalid values, or an empty array if the settings are valid.\n   */\n  public getValidationErrors(): string[] {\n    const errorMessages: string[] = [];\n    if (this.fontName.trim() === \"\") {\n      errorMessages.push(\"fontName must be provided\");\n    }\n\n    if (this.lineHeight <= 0) {\n      errorMessages.push(\"lineHeight must be greater than 0\");\n    }\n\n    if (this.stackedFractionScale <= 0) {\n      errorMessages.push(\"stackedFractionScale must be greater than 0\");\n    }\n\n    return errorMessages;\n  }\n}\n\ndeepFreeze(TextStyleSettings.defaultProps);\ndeepFreeze(TextStyleSettings.defaults);"]}

package/lib/esm/geometry/AdditionalTransform.d.ts

@@ -1,6 +1,7 @@
 /** @packageDocumentation
  * @module Geometry
  */
+import { Transform } from "@itwin/core-geometry";
 /** An affine transformation with an additional Z Offset.
  *  The equations are:
  *  given a = scale * cos(rotation) and b = scale * sin(rotation)
@@ -53,6 +54,9 @@ export declare class Helmert2DWithZOffset implements Helmert2DWithZOffsetProps {
     /** Compares two Helmert2DWithZOffset objects applying a minuscule tolerance.
      *  @public */
     equals(other: Helmert2DWithZOffset): boolean;
+    /** Convert Helmert2DWithZOffset object into Transfrom object
+     * @public */
+    convertHelmertToTransform(): Transform;
 }
 /** Additional Transform definition
  * @public

package/lib/esm/geometry/AdditionalTransform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AdditionalTransform.d.ts","sourceRoot":"","sources":["../../../src/geometry/AdditionalTransform.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB;IACxC,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;GASG;AACH,qBAAa,oBAAqB,YAAW,yBAAyB;IACpE,6BAA6B;IACtB,YAAY,EAAG,MAAM,CAAC;IAC7B,6BAA6B;IACtB,YAAY,EAAG,MAAM,CAAC;IAC7B,wCAAwC;IACjC,YAAY,EAAG,MAAM,CAAC;IAC7B,oEAAoE;IAC7D,MAAM,EAAG,MAAM,CAAC;IACvB,iFAAiF;IAC1E,KAAK,EAAG,MAAM,CAAC;gBAEV,IAAI,CAAC,EAAE,yBAAyB;IAU5C;iBACa;WACC,QAAQ,CAAC,IAAI,EAAE,yBAAyB,GAAG,oBAAoB;IAI7E;iBACa;IACN,MAAM,IAAI,yBAAyB;IAI1C;kBACc;IACP,MAAM,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;CAOpD;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,gFAAgF;IAChF,oBAAoB,CAAC,EAAE,yBAAyB,CAAC;CAClD;AAED;;;;;EAKE;AACF,qBAAa,mBAAoB,YAAW,wBAAwB;IAElE,gFAAgF;IAChF,SAAgB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;gBAEzC,IAAI,CAAC,EAAE,wBAAwB;IAKlD;iBACa;WACC,QAAQ,CAAC,IAAI,EAAE,wBAAwB,GAAG,mBAAmB;IAI3E;iBACa;IACN,MAAM,IAAI,wBAAwB;IAIzC;kBACc;IACP,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;CASnD"}
+{"version":3,"file":"AdditionalTransform.d.ts","sourceRoot":"","sources":["../../../src/geometry/AdditionalTransform.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAwC,SAAS,EAAY,MAAM,sBAAsB,CAAC;AAEjG;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB;IACxC,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;GASG;AACH,qBAAa,oBAAqB,YAAW,yBAAyB;IACpE,6BAA6B;IACtB,YAAY,EAAG,MAAM,CAAC;IAC7B,6BAA6B;IACtB,YAAY,EAAG,MAAM,CAAC;IAC7B,wCAAwC;IACjC,YAAY,EAAG,MAAM,CAAC;IAC7B,oEAAoE;IAC7D,MAAM,EAAG,MAAM,CAAC;IACvB,iFAAiF;IAC1E,KAAK,EAAG,MAAM,CAAC;gBAEV,IAAI,CAAC,EAAE,yBAAyB;IAU5C;iBACa;WACC,QAAQ,CAAC,IAAI,EAAE,yBAAyB,GAAG,oBAAoB;IAI7E;iBACa;IACN,MAAM,IAAI,yBAAyB;IAI1C;kBACc;IACP,MAAM,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAQnD;iBACa;IACN,yBAAyB,IAAI,SAAS;CAe9C;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,gFAAgF;IAChF,oBAAoB,CAAC,EAAE,yBAAyB,CAAC;CAClD;AAED;;;;;EAKE;AACF,qBAAa,mBAAoB,YAAW,wBAAwB;IAElE,gFAAgF;IAChF,SAAgB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;gBAEzC,IAAI,CAAC,EAAE,wBAAwB;IAKlD;iBACa;WACC,QAAQ,CAAC,IAAI,EAAE,wBAAwB,GAAG,mBAAmB;IAI3E;iBACa;IACN,MAAM,IAAI,wBAAwB;IAIzC;kBACc;IACP,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;CASnD"}

package/lib/esm/geometry/AdditionalTransform.js

@@ -6,7 +6,7 @@
  * @module Geometry
  */
 // cspell:ignore Helmert
-import { Geometry } from "@itwin/core-geometry";
+import { Angle, AxisIndex, Geometry, Matrix3d, Transform, Vector3d } from "@itwin/core-geometry";
 /** An affine transformation with an additional Z Offset.
  *  The equations are:
  *  given a = scale * cos(rotation) and b = scale * sin(rotation)
@@ -56,6 +56,15 @@ export class Helmert2DWithZOffset {
             Math.abs(this.rotDeg - other.rotDeg) < Geometry.smallAngleDegrees &&
             Math.abs(this.scale - other.scale) < Geometry.smallFraction);
     }
+    /** Convert Helmert2DWithZOffset object into Transfrom object
+     * @public */
+    convertHelmertToTransform() {
+        const rotationXY = Matrix3d.createRotationAroundAxisIndex(AxisIndex.Z, Angle.createDegrees(this?.rotDeg));
+        rotationXY.scaleColumnsInPlace(this.scale, this.scale, 1.0);
+        const translation = Vector3d.create(this.translationX, this.translationY, this.translationZ);
+        const helmertTransform = Transform.createRefs(translation, rotationXY);
+        return helmertTransform;
+    }
 }
 /** Additional Transform implementation.
  *  An additional transform is a transformation that can apply to either the horizontal or vertical coordinates of a

package/lib/esm/geometry/AdditionalTransform.js.map

@@ -1 +1 @@
-{"version":3,"file":"AdditionalTransform.js","sourceRoot":"","sources":["../../../src/geometry/AdditionalTransform.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,wBAAwB;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAwBhD;;;;;;;;;GASG;AACH,MAAM,OAAO,oBAAoB;IAC/B,6BAA6B;IACtB,YAAY,CAAU;IAC7B,6BAA6B;IACtB,YAAY,CAAU;IAC7B,wCAAwC;IACjC,YAAY,CAAU;IAC7B,oEAAoE;IAC7D,MAAM,CAAU;IACvB,iFAAiF;IAC1E,KAAK,CAAU;IAEtB,YAAY,IAAgC;QAC1C,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;iBACa;IACN,MAAM,CAAC,QAAQ,CAAC,IAA+B;QACpD,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;iBACa;IACN,MAAM;QACX,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IACvJ,CAAC;IAED;kBACc;IACP,MAAM,CAAC,KAA2B;QACvC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,mBAAmB;YACrF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,mBAAmB;YAC/E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,mBAAmB;YAC/E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,iBAAiB;YACjE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IACjE,CAAC;CACF;AAWD;;;;;EAKE;AACF,MAAM,OAAO,mBAAmB;IAE9B,gFAAgF;IAChE,oBAAoB,CAAwB;IAE5D,YAAmB,IAA+B;QAChD,IAAI,IAAI;YACN,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjI,CAAC;IAED;iBACa;IACN,MAAM,CAAC,QAAQ,CAAC,IAA8B;QACnD,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;iBACa;IACN,MAAM;QACX,OAAO,EAAE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC7D,CAAC;IAED;kBACc;IACP,MAAM,CAAC,KAA0B;QACtC,IAAI,CAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,KAAK,SAAS,CAAC;YAC1F,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAqB,CAAC;YAC7F,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,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 Geometry\n */\n// cspell:ignore Helmert\n\nimport { Geometry } from \"@itwin/core-geometry\";\n\n/** An affine transformation with an additional Z Offset.\n *  The equations are:\n *  given a = scale * cos(rotation) and b = scale * sin(rotation)\n *  X = a * x - b * y + translationX\n *  Y = b * x + a * y + translationY\n *  Z = z + translationZ\n *  @public\n *  @extensions\n */\nexport interface Helmert2DWithZOffsetProps {\n  /** The X post translation */\n  translationX: number;\n  /** The Y post-translation */\n  translationY: number;\n  /** The Z post-translation or Z offset*/\n  translationZ: number;\n  /** The rotation in the trigonometric (CCW) direction in degrees. */\n  rotDeg: number;\n  /** The scale. This scale applies to both X and Y axises. Does not apply to Z. */\n  scale: number;\n}\n\n/** An affine transformation with an additional Z Offset.\n *  The equations are:\n *  given a = scale * cos(rotation) and b = scale * sin(rotation)\n *  X = a * x - b * y + translationX\n *  Y = b * x + a * y + translationY\n *  Z = z + translationZ\n *\n *  Note that the class only implements the definition and not the operation.\n *  @public\n */\nexport class Helmert2DWithZOffset implements Helmert2DWithZOffsetProps {\n  /** The X post translation */\n  public translationX!: number;\n  /** The Y post-translation */\n  public translationY!: number;\n  /** The Z post-translation or Z offset*/\n  public translationZ!: number;\n  /** The rotation in the trigonometric (CCW) direction in degrees. */\n  public rotDeg!: number;\n  /** The scale. This scale applies to both X and Y axises. Does not apply to Z. */\n  public scale!: number;\n\n  constructor(data?: Helmert2DWithZOffsetProps) {\n    if (data) {\n      this.translationX = data.translationX;\n      this.translationY = data.translationY;\n      this.translationZ = data.translationZ;\n      this.rotDeg = data.rotDeg;\n      this.scale = data.scale;\n    }\n  }\n\n  /** Creates an Helmert Transform from JSON representation.\n   * @public */\n  public static fromJSON(data: Helmert2DWithZOffsetProps): Helmert2DWithZOffset {\n    return new Helmert2DWithZOffset(data);\n  }\n\n  /** Creates a JSON from the Helmert Transform definition\n   * @public */\n  public toJSON(): Helmert2DWithZOffsetProps {\n    return { translationX: this.translationX, translationY: this.translationY, translationZ: this.translationZ, rotDeg: this.rotDeg, scale: this.scale };\n  }\n\n  /** Compares two Helmert2DWithZOffset objects applying a minuscule tolerance.\n   *  @public */\n  public equals(other: Helmert2DWithZOffset): boolean {\n    return (Math.abs(this.translationX - other.translationX) < Geometry.smallMetricDistance &&\n      Math.abs(this.translationY - other.translationY) < Geometry.smallMetricDistance &&\n      Math.abs(this.translationZ - other.translationZ) < Geometry.smallMetricDistance &&\n      Math.abs(this.rotDeg - other.rotDeg) < Geometry.smallAngleDegrees &&\n      Math.abs(this.scale - other.scale) < Geometry.smallFraction);\n  }\n}\n\n/** Additional Transform definition\n * @public\n * @extensions\n */\nexport interface AdditionalTransformProps {\n  /** The properties of a 2D Helmert transform with Z offset if one is defined. */\n  helmert2DWithZOffset?: Helmert2DWithZOffsetProps;\n}\n\n/** Additional Transform implementation.\n *  An additional transform is a transformation that can apply to either the horizontal or vertical coordinates of a\n *  geographic CRS. The transformation is applied after the latitude/longitude have been projected thus the process\n *  is applied to the result Cartesian coordinates of the projection process.\n *  @public\n*/\nexport class AdditionalTransform implements AdditionalTransformProps {\n\n  /** The properties of a 2D Helmert transform with Z offset if one is defined. */\n  public readonly helmert2DWithZOffset?: Helmert2DWithZOffset;\n\n  public constructor(data?: AdditionalTransformProps) {\n    if (data)\n      this.helmert2DWithZOffset = data.helmert2DWithZOffset ? Helmert2DWithZOffset.fromJSON(data.helmert2DWithZOffset) : undefined;\n  }\n\n  /** Creates an Additional Transform from JSON representation.\n   * @public */\n  public static fromJSON(data: AdditionalTransformProps): AdditionalTransform {\n    return new AdditionalTransform(data);\n  }\n\n  /** Creates a JSON from the Additional Transform definition\n   * @public */\n  public toJSON(): AdditionalTransformProps {\n    return { helmert2DWithZOffset: this.helmert2DWithZOffset };\n  }\n\n  /** Compares two additional transforms applying a minuscule tolerance to comparing numbers.\n   *  @public */\n  public equals(other: AdditionalTransform): boolean {\n    if ((this.helmert2DWithZOffset === undefined) !== (other.helmert2DWithZOffset === undefined))\n      return false;\n\n    if (this.helmert2DWithZOffset && !this.helmert2DWithZOffset.equals(other.helmert2DWithZOffset!))\n      return false;\n\n    return true;\n  }\n}\n\n"]}
+{"version":3,"file":"AdditionalTransform.js","sourceRoot":"","sources":["../../../src/geometry/AdditionalTransform.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,wBAAwB;AAExB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAwBjG;;;;;;;;;GASG;AACH,MAAM,OAAO,oBAAoB;IAC/B,6BAA6B;IACtB,YAAY,CAAU;IAC7B,6BAA6B;IACtB,YAAY,CAAU;IAC7B,wCAAwC;IACjC,YAAY,CAAU;IAC7B,oEAAoE;IAC7D,MAAM,CAAU;IACvB,iFAAiF;IAC1E,KAAK,CAAU;IAEtB,YAAY,IAAgC;QAC1C,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;iBACa;IACN,MAAM,CAAC,QAAQ,CAAC,IAA+B;QACpD,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;iBACa;IACN,MAAM;QACX,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IACvJ,CAAC;IAED;kBACc;IACP,MAAM,CAAC,KAA2B;QACvC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,mBAAmB;YACrF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,mBAAmB;YAC/E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,mBAAmB;YAC/E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,iBAAiB;YACjE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IACjE,CAAC;IAED;iBACa;IACN,yBAAyB;QAC9B,MAAM,UAAU,GAAG,QAAQ,CAAC,6BAA6B,CACvD,SAAS,CAAC,CAAC,EACX,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAClC,CAAC;QACF,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CACjC,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,YAAY,CAClB,CAAC;QACF,MAAM,gBAAgB,GAAG,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAEvE,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF;AAWD;;;;;EAKE;AACF,MAAM,OAAO,mBAAmB;IAE9B,gFAAgF;IAChE,oBAAoB,CAAwB;IAE5D,YAAmB,IAA+B;QAChD,IAAI,IAAI;YACN,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjI,CAAC;IAED;iBACa;IACN,MAAM,CAAC,QAAQ,CAAC,IAA8B;QACnD,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;iBACa;IACN,MAAM;QACX,OAAO,EAAE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC7D,CAAC;IAED;kBACc;IACP,MAAM,CAAC,KAA0B;QACtC,IAAI,CAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,KAAK,SAAS,CAAC;YAC1F,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAqB,CAAC;YAC7F,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,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 Geometry\n */\n// cspell:ignore Helmert\n\nimport { Angle, AxisIndex, Geometry, Matrix3d, Transform, Vector3d } from \"@itwin/core-geometry\";\n\n/** An affine transformation with an additional Z Offset.\n *  The equations are:\n *  given a = scale * cos(rotation) and b = scale * sin(rotation)\n *  X = a * x - b * y + translationX\n *  Y = b * x + a * y + translationY\n *  Z = z + translationZ\n *  @public\n *  @extensions\n */\nexport interface Helmert2DWithZOffsetProps {\n  /** The X post translation */\n  translationX: number;\n  /** The Y post-translation */\n  translationY: number;\n  /** The Z post-translation or Z offset*/\n  translationZ: number;\n  /** The rotation in the trigonometric (CCW) direction in degrees. */\n  rotDeg: number;\n  /** The scale. This scale applies to both X and Y axises. Does not apply to Z. */\n  scale: number;\n}\n\n/** An affine transformation with an additional Z Offset.\n *  The equations are:\n *  given a = scale * cos(rotation) and b = scale * sin(rotation)\n *  X = a * x - b * y + translationX\n *  Y = b * x + a * y + translationY\n *  Z = z + translationZ\n *\n *  Note that the class only implements the definition and not the operation.\n *  @public\n */\nexport class Helmert2DWithZOffset implements Helmert2DWithZOffsetProps {\n  /** The X post translation */\n  public translationX!: number;\n  /** The Y post-translation */\n  public translationY!: number;\n  /** The Z post-translation or Z offset*/\n  public translationZ!: number;\n  /** The rotation in the trigonometric (CCW) direction in degrees. */\n  public rotDeg!: number;\n  /** The scale. This scale applies to both X and Y axises. Does not apply to Z. */\n  public scale!: number;\n\n  constructor(data?: Helmert2DWithZOffsetProps) {\n    if (data) {\n      this.translationX = data.translationX;\n      this.translationY = data.translationY;\n      this.translationZ = data.translationZ;\n      this.rotDeg = data.rotDeg;\n      this.scale = data.scale;\n    }\n  }\n\n  /** Creates an Helmert Transform from JSON representation.\n   * @public */\n  public static fromJSON(data: Helmert2DWithZOffsetProps): Helmert2DWithZOffset {\n    return new Helmert2DWithZOffset(data);\n  }\n\n  /** Creates a JSON from the Helmert Transform definition\n   * @public */\n  public toJSON(): Helmert2DWithZOffsetProps {\n    return { translationX: this.translationX, translationY: this.translationY, translationZ: this.translationZ, rotDeg: this.rotDeg, scale: this.scale };\n  }\n\n  /** Compares two Helmert2DWithZOffset objects applying a minuscule tolerance.\n   *  @public */\n  public equals(other: Helmert2DWithZOffset): boolean {\n    return (Math.abs(this.translationX - other.translationX) < Geometry.smallMetricDistance &&\n      Math.abs(this.translationY - other.translationY) < Geometry.smallMetricDistance &&\n      Math.abs(this.translationZ - other.translationZ) < Geometry.smallMetricDistance &&\n      Math.abs(this.rotDeg - other.rotDeg) < Geometry.smallAngleDegrees &&\n      Math.abs(this.scale - other.scale) < Geometry.smallFraction);\n  }\n\n  /** Convert Helmert2DWithZOffset object into Transfrom object\n   * @public */\n  public convertHelmertToTransform(): Transform {\n    const rotationXY = Matrix3d.createRotationAroundAxisIndex(\n      AxisIndex.Z,\n      Angle.createDegrees(this?.rotDeg)\n    );\n    rotationXY.scaleColumnsInPlace(this.scale, this.scale, 1.0);\n    const translation = Vector3d.create(\n      this.translationX,\n      this.translationY,\n      this.translationZ\n    );\n    const helmertTransform = Transform.createRefs(translation, rotationXY);\n\n    return helmertTransform;\n  }\n}\n\n/** Additional Transform definition\n * @public\n * @extensions\n */\nexport interface AdditionalTransformProps {\n  /** The properties of a 2D Helmert transform with Z offset if one is defined. */\n  helmert2DWithZOffset?: Helmert2DWithZOffsetProps;\n}\n\n/** Additional Transform implementation.\n *  An additional transform is a transformation that can apply to either the horizontal or vertical coordinates of a\n *  geographic CRS. The transformation is applied after the latitude/longitude have been projected thus the process\n *  is applied to the result Cartesian coordinates of the projection process.\n *  @public\n*/\nexport class AdditionalTransform implements AdditionalTransformProps {\n\n  /** The properties of a 2D Helmert transform with Z offset if one is defined. */\n  public readonly helmert2DWithZOffset?: Helmert2DWithZOffset;\n\n  public constructor(data?: AdditionalTransformProps) {\n    if (data)\n      this.helmert2DWithZOffset = data.helmert2DWithZOffset ? Helmert2DWithZOffset.fromJSON(data.helmert2DWithZOffset) : undefined;\n  }\n\n  /** Creates an Additional Transform from JSON representation.\n   * @public */\n  public static fromJSON(data: AdditionalTransformProps): AdditionalTransform {\n    return new AdditionalTransform(data);\n  }\n\n  /** Creates a JSON from the Additional Transform definition\n   * @public */\n  public toJSON(): AdditionalTransformProps {\n    return { helmert2DWithZOffset: this.helmert2DWithZOffset };\n  }\n\n  /** Compares two additional transforms applying a minuscule tolerance to comparing numbers.\n   *  @public */\n  public equals(other: AdditionalTransform): boolean {\n    if ((this.helmert2DWithZOffset === undefined) !== (other.helmert2DWithZOffset === undefined))\n      return false;\n\n    if (this.helmert2DWithZOffset && !this.helmert2DWithZOffset.equals(other.helmert2DWithZOffset!))\n      return false;\n\n    return true;\n  }\n}\n\n"]}