@itwin/core-common 5.2.0-dev.8 → 5.2.0

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

@@ -3,6 +3,33 @@
  */
 import { DeepReadonlyObject, DeepRequiredObject } from "@itwin/core-bentley";
 import { ColorDefProps } from "../ColorDef";
+import { FontFamilySelector } from "../Fonts";
+/** Predefined markers for list items in text annotations.
+ * These values control the appearance of list item markers (e.g., bullet, circle, square, dash, number) that denote the start of a list item in a list.
+ * @beta
+ */
+export declare enum ListMarkerEnumerator {
+    /** English Alphabet */
+    Letter = "A",
+    RomanNumeral = "I",
+    Number = "1",
+    Bullet = "\u2022",
+    Circle = "\u25CB",
+    Square = "\u25A0",
+    /** EM Dash */
+    Dash = "\u2013"
+}
+/** A settings to specify how to mark or denote the start of a list item in a [[List]].
+ * @beta
+ */
+export interface ListMarker {
+    /** This can be either one of the predefined markers in [[ListMarkerEnumerator]], or any arbitrary string. */
+    enumerator: ListMarkerEnumerator | string;
+    /** The punctuation to follow the enumerator. */
+    terminator?: "parenthesis" | "period";
+    /** Whether to use upper or lower case for alphabetic or roman numeral enumerators. Ignored if [[enumerator]] is not alphabetic or roman numeral. */
+    case?: "upper" | "lower";
+}
 /** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
  * @beta
 */
@@ -18,6 +45,24 @@ export type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];
  * @beta
  */
 export type TextAnnotationFillColor = TextStyleColor | "background" | "none";
+/** Describes the margins around the content inside a [[TextBlock]], measured in meters.
+ * All margins default to zero if `undefined`.
+ * @beta
+ */
+export interface TextBlockMargins {
+    /** The left margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */
+    left?: number;
+    /** The right margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */
+    right?: number;
+    /** The top margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */
+    top?: number;
+    /** The bottom margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */
+    bottom?: number;
+}
+/** Describes the relative alignment of text.
+ * @beta
+*/
+export type TextJustification = "left" | "center" | "right";
 /** 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
@@ -39,9 +84,9 @@ 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;
+    fillColor?: TextAnnotationFillColor;
     /** The color of the text frame's outline. Default: black */
-    border?: TextStyleColor;
+    borderColor?: TextStyleColor;
     /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */
     borderWeight?: number;
 }
@@ -60,17 +105,17 @@ export interface TextLeaderStyleProps {
      */
     wantElbow?: boolean;
     /** Multiplier used to compute length of the elbow in the leader.
-     * The elbowLength is computed in meters as elbowLength * [[lineHeight]].
+     * The elbowLength is computed in meters as elbowLength * [[textHeight]].
      * Default: 1.0
      */
     elbowLength?: number;
     /** Multiplier to compute height of the leader terminator.
-     * The terminator height is computed in meters as terminatorHeight * [[lineHeight]].
+     * The terminator height is computed in meters as terminatorHeight * [[textHeight]].
      * Default: 1.0
      */
     terminatorHeightFactor?: number;
     /** Multiplier to compute width of the leader terminator.
-     * The terminator width is computed in meters as terminatorWidth * [[lineHeight]].
+     * The terminator width is computed in meters as terminatorWidth * [[textHeight]].
      * Default: 1.0
      */
     terminatorWidthFactor?: number;
@@ -83,20 +128,25 @@ export interface TextStyleSettingsProps {
      * Default: "subcategory".
      */
     color?: TextStyleColor;
-    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
-     * Default: "" (an invalid font name).
+    /** The font stored in an iModel, used to draw the contents of a [[TextRun]].
+     * Default: { name: "" } (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 computed as lineHeight * [[subScriptScale]] and
-     * lineHeight * [[subScriptOffsetFactor]], respectively.
+    font?: FontFamilySelector;
+    /** The height of the text, in meters. Many other settings use the text height as the basis for computing their own values.
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as textHeight * [[subScriptScale]] and
+     * textHeight * [[subScriptOffsetFactor]], respectively.
      * Default: 1.0. */
-    lineHeight?: number;
+    textHeight?: number;
     /** Multiplier used to compute the vertical distance between two lines of text.
-     * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].
+     * The distance is computed in meters as lineSpacingFactor * [[textHeight]].
      * Default: 0.5.
      */
     lineSpacingFactor?: number;
+    /** Multiplier used to compute the vertical distance between two paragraphs of text.
+     * The distance is computed in meters as paragraphSpacingFactor * [[textHeight]].
+     * Default: 0.5.
+     */
+    paragraphSpacingFactor?: number;
     /** Specifies whether the content of a [[TextRun]] should be rendered **bold**.
      * Default: false.
      */
@@ -110,7 +160,7 @@ export interface TextStyleSettingsProps {
      */
     isUnderlined?: boolean;
     /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].
-     * The height is computed in meters as stackedFractionScale * [[lineHeight]].
+     * The height is computed in meters as stackedFractionScale * [[textHeight]].
      * Default: 0.7.
      */
     stackedFractionScale?: number;
@@ -119,22 +169,22 @@ export interface TextStyleSettingsProps {
      */
     stackedFractionType?: StackedFractionType;
     /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].
-     * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].
+     * The offset is computed in meters as subScriptOffsetFactor * [[textHeight]].
      * Default: -0.15.
      */
     subScriptOffsetFactor?: number;
     /** Multiplier used to compute the height of a subscript [[TextRun]].
-     * The height is computed as subScriptScale * [[lineHeight]].
+     * The height is computed as subScriptScale * [[textHeight]].
      * Default: 2/3
      */
     subScriptScale?: number;
     /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].
-     * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].
+     * The offset is computed in meters as superScriptOffsetFactor * [[textHeight]].
      * Default: -0.5.
      */
     superScriptOffsetFactor?: number;
     /** Multiplier used to compute the height of a superscript [[TextRun]].
-     * The height is computed as superScriptScale * [[lineHeight]].
+     * The height is computed as superScriptScale * [[textHeight]].
      * Default: 2/3
      */
     superScriptScale?: number;
@@ -149,6 +199,9 @@ export interface TextStyleSettingsProps {
     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.
+     * [[tabInterval]] is also used in lists to compute the offset of each child or [[Paragraph]].
+     * The [[listMarker]] is right justified on [[indentation]] + [[tabInterval]]*(depth - 1/2).
+     * [[Paragraph]]s will start at [[indentation]] + [[tabInterval]]*depth.
      * Default: 4 meters.
      */
     tabInterval?: number;
@@ -158,6 +211,23 @@ export interface TextStyleSettingsProps {
      * Default: {shape: "none", fill: "none", border: black, borderWeight: 1} for no frame.
      */
     frame?: TextFrameStyleProps;
+    /** The margins to surround the document content.
+     * Default: 0 margins on all sides */
+    margins?: TextBlockMargins;
+    /** The offset (in meters) from the left edge of the text block to the start of the line of text.
+     * In lists, the indentation is added to offset of list items.
+     * The [[listMarker]] is right justified on [[indentation]] + [[tabInterval]]*(depth - 1/2).
+     * [[Paragraph]]s will start at [[indentation]] + [[tabInterval]]*depth.
+     * Default: 0 meters.
+     */
+    indentation?: number;
+    /** The marker used to indicate the start of a list item.
+     * Default: "1.".
+     */
+    listMarker?: ListMarker;
+    /** The alignment of the text content.
+     * Default: "left". */
+    justification?: TextJustification;
 }
 /** A description of the formatting to be applied to a [[TextBlockComponent]].
  * Named instances of these settings can be stored as [AnnotationTextStyle]($backend)s in an iModel.
@@ -168,18 +238,22 @@ export interface TextStyleSettingsProps {
 export declare class TextStyleSettings {
     /** The color of the text. */
     readonly color: TextStyleColor;
-    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
+    /** The 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 computed as lineHeight * [[subScriptScale]] and
-     * lineHeight * [[subScriptOffsetFactor]], respectively.
+    readonly font: Readonly<Required<FontFamilySelector>>;
+    /** The height of the text, in meters. Many other settings use the text height as the basis for computing their own values.
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as textHeight * [[subScriptScale]] and
+     * textHeight * [[subScriptOffsetFactor]], respectively.
      */
-    readonly lineHeight: number;
+    readonly textHeight: number;
     /** Multiplier used to compute the vertical distance between two lines of text.
-     * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].
+     * The distance is computed in meters as lineSpacingFactor * [[textHeight]] of the [[TextBlock]].
      */
     readonly lineSpacingFactor: number;
+    /** Multiplier used to compute the vertical distance between two paragraphs of text.
+     * The distance is computed in meters as paragraphSpacingFactor * the [[TextBlock]]'s [[textHeight]].
+     */
+    readonly paragraphSpacingFactor: number;
     /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */
     readonly isBold: boolean;
     /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */
@@ -187,48 +261,63 @@ export declare class TextStyleSettings {
     /** Specifies whether the content of a [[TextRun]] should be underlined. */
     readonly isUnderlined: boolean;
     /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].
-     * The height is computed in meters as stackedFractionScale * [[lineHeight]].
+     * The height is computed in meters as stackedFractionScale * [[textHeight]].
      */
     readonly stackedFractionScale: number;
     /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */
     readonly stackedFractionType: StackedFractionType;
     /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].
-     * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].
+     * The offset is computed in meters as subScriptOffsetFactor * [[textHeight]].
      */
     readonly subScriptOffsetFactor: number;
     /** Multiplier used to compute the height of a subscript [[TextRun]].
-     * The height is computed as subScriptScale * [[lineHeight]].
+     * The height is computed as subScriptScale * [[textHeight]].
      */
     readonly subScriptScale: number;
     /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].
-     * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].
+     * The offset is computed in meters as superScriptOffsetFactor * [[textHeight]].
      */
     readonly superScriptOffsetFactor: number;
     /** Multiplier used to compute the height of a superscript [[TextRun]].
-     * The height is computed as superScriptScale * [[lineHeight]].
+     * The height is computed as superScriptScale * [[textHeight]].
      */
     readonly superScriptScale: number;
-    /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
+    /** Multiplier used to compute the width of each glyph, relative to [[textHeight]]. */
     readonly widthFactor: number;
     /** Properties describing appearance of leaders in a [[TextAnnotation]].
      * Used when producing geometry for [[TextAnnotation]].
      */
     readonly leader: Readonly<Required<TextLeaderStyleProps>>;
     /** The size (in meters) used to calculate the tab stops in a run.
-     * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
+     * These are equally spaced from the left edge of the TextBlock.
+     * [[tabInterval]] is also used in lists to compute the offset of each child or [[Paragraph]].
+     * The [[listMarker]] is right justified on [[indentation]] + [[tabInterval]]*(depth - 1/2).
+     * [[Paragraph]]s will start at [[indentation]] + [[tabInterval]]*depth.
      */
     readonly tabInterval: number;
+    /** The offset (in meters) from the left edge of the text block to the start of the line of text.
+     * In lists, the indentation is added to offset of list items.
+     * The [[listMarker]] is right justified on [[indentation]] + [[tabInterval]]*(depth - 1/2).
+     * [[Paragraph]]s will start at [[indentation]] + [[tabInterval]]*depth.
+     */
+    readonly indentation: number;
+    /** The marker used to indicate the start of a list item.
+     * Default: [[ListMarkerEnumerator.Number]].
+     */
+    readonly listMarker: ListMarker;
     /** 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. */
+    /** The margins to surround the document content. */
+    readonly margins: Readonly<Required<TextBlockMargins>>;
+    /** The alignment of the text content. */
+    readonly justification: TextJustification;
+    /** A fully-populated JSON representation of the default settings. A real `font` 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;
@@ -238,6 +327,7 @@ export declare class TextStyleSettings {
      */
     leaderEquals(other: TextLeaderStyleProps): boolean;
     frameEquals(other: TextFrameStyleProps): boolean;
+    marginsEqual(other: TextBlockMargins): boolean;
     equals(other: TextStyleSettings): boolean;
     /**
      * Returns a list of validation errors for this instance.

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

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,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"}
+{"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;AACtD,OAAO,EAAE,kBAAkB,EAAY,MAAM,UAAU,CAAC;AAExD;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,uBAAuB;IACvB,MAAM,MAAM;IACZ,YAAY,MAAM;IAClB,MAAM,MAAM;IACZ,MAAM,WAAM;IACZ,MAAM,WAAM;IACZ,MAAM,WAAM;IACZ,cAAc;IACd,IAAI,WAAM;CACX;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6GAA6G;IAC7G,UAAU,EAAE,oBAAoB,GAAG,MAAM,CAAC;IAC1C,gDAAgD;IAChD,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IACtC,oJAAoJ;IACpJ,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC1B;AAED;;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,WAAW,gBAAgB;IAC/B,0GAA0G;IAC1G,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2GAA2G;IAC3G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yGAAyG;IACzG,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4GAA4G;IAC5G,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;EAEE;AACF,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE5D;;;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,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,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,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;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;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;yCACqC;IACrC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;0BACsB;IACtB,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AAcD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC7D;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,sBAAsB,EAAE,MAAM,CAAC;IAC/C,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;;;;;OAKG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,oDAAoD;IACpD,SAAgB,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/D,oDAAoD;IACpD,SAAgB,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9D,yCAAyC;IACzC,SAAgB,aAAa,EAAE,iBAAiB,CAAC;IAEjD,gHAAgH;IAChH,OAAc,YAAY,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAuCxF;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IAoDP,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;IAIvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,WAAW,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAOhD,YAAY,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAM9C,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAgBhD;;;;;;;;;OASG;IACI,mBAAmB,IAAI,MAAM,EAAE;CAgBvC"}

package/lib/cjs/annotation/TextStyle.js

@@ -7,13 +7,31 @@
  * @module Annotation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextStyleSettings = exports.textAnnotationFrameShapes = void 0;
+exports.TextStyleSettings = exports.textAnnotationFrameShapes = exports.ListMarkerEnumerator = void 0;
 const ColorDef_1 = require("../ColorDef");
+const Fonts_1 = require("../Fonts");
+/** Predefined markers for list items in text annotations.
+ * These values control the appearance of list item markers (e.g., bullet, circle, square, dash, number) that denote the start of a list item in a list.
+ * @beta
+ */
+var ListMarkerEnumerator;
+(function (ListMarkerEnumerator) {
+    /** English Alphabet */
+    ListMarkerEnumerator["Letter"] = "A";
+    ListMarkerEnumerator["RomanNumeral"] = "I";
+    ListMarkerEnumerator["Number"] = "1";
+    ListMarkerEnumerator["Bullet"] = "\u2022";
+    ListMarkerEnumerator["Circle"] = "\u25CB";
+    ListMarkerEnumerator["Square"] = "\u25A0";
+    /** EM Dash */
+    ListMarkerEnumerator["Dash"] = "\u2013";
+})(ListMarkerEnumerator || (exports.ListMarkerEnumerator = ListMarkerEnumerator = {}));
 /** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
  * @beta
 */
 exports.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;
@@ -34,18 +52,22 @@ function deepFreeze(obj) {
 class TextStyleSettings {
     /** The color of the text. */
     color;
-    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
+    /** The 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 computed as lineHeight * [[subScriptScale]] and
-     * lineHeight * [[subScriptOffsetFactor]], respectively.
+    font;
+    /** The height of the text, in meters. Many other settings use the text height as the basis for computing their own values.
+     * For example, the height and offset from baseline of a subscript [[TextRun]]  are computed as textHeight * [[subScriptScale]] and
+     * textHeight * [[subScriptOffsetFactor]], respectively.
      */
-    lineHeight;
+    textHeight;
     /** Multiplier used to compute the vertical distance between two lines of text.
-     * The distance is computed in meters as lineSpacingFactor * [[lineHeight]].
+     * The distance is computed in meters as lineSpacingFactor * [[textHeight]] of the [[TextBlock]].
      */
     lineSpacingFactor;
+    /** Multiplier used to compute the vertical distance between two paragraphs of text.
+     * The distance is computed in meters as paragraphSpacingFactor * the [[TextBlock]]'s [[textHeight]].
+     */
+    paragraphSpacingFactor;
     /** Specifies whether the content of a [[TextRun]] should be rendered **bold**. */
     isBold;
     /** Specifies whether the content of a [[TextRun]] should be rendered in *italics*. */
@@ -53,45 +75,63 @@ class TextStyleSettings {
     /** Specifies whether the content of a [[TextRun]] should be underlined. */
     isUnderlined;
     /** Multiplier used to compute the height of both the numerator and denominator of a [[FractionRun]].
-     * The height is computed in meters as stackedFractionScale * [[lineHeight]].
+     * The height is computed in meters as stackedFractionScale * [[textHeight]].
      */
     stackedFractionScale;
     /** Specifies how to separate the numerator and denominator of a [[FractionRun]]. */
     stackedFractionType;
     /** Multiplier used to compute the vertical offset from the baseline for a subscript [[TextRun]].
-     * The offset is computed in meters as subScriptOffsetFactor * [[lineHeight]].
+     * The offset is computed in meters as subScriptOffsetFactor * [[textHeight]].
      */
     subScriptOffsetFactor;
     /** Multiplier used to compute the height of a subscript [[TextRun]].
-     * The height is computed as subScriptScale * [[lineHeight]].
+     * The height is computed as subScriptScale * [[textHeight]].
      */
     subScriptScale;
     /** Multiplier used to compute the vertical offset from the baseline for a super [[TextRun]].
-     * The offset is computed in meters as superScriptOffsetFactor * [[lineHeight]].
+     * The offset is computed in meters as superScriptOffsetFactor * [[textHeight]].
      */
     superScriptOffsetFactor;
     /** Multiplier used to compute the height of a superscript [[TextRun]].
-     * The height is computed as superScriptScale * [[lineHeight]].
+     * The height is computed as superScriptScale * [[textHeight]].
      */
     superScriptScale;
-    /** Multiplier used to compute the width of each glyph, relative to [[lineHeight]]. */
+    /** Multiplier used to compute the width of each glyph, relative to [[textHeight]]. */
     widthFactor;
     /** Properties describing appearance of leaders in a [[TextAnnotation]].
      * Used when producing geometry for [[TextAnnotation]].
      */
     leader;
     /** The size (in meters) used to calculate the tab stops in a run.
-     * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
+     * These are equally spaced from the left edge of the TextBlock.
+     * [[tabInterval]] is also used in lists to compute the offset of each child or [[Paragraph]].
+     * The [[listMarker]] is right justified on [[indentation]] + [[tabInterval]]*(depth - 1/2).
+     * [[Paragraph]]s will start at [[indentation]] + [[tabInterval]]*depth.
      */
     tabInterval;
+    /** The offset (in meters) from the left edge of the text block to the start of the line of text.
+     * In lists, the indentation is added to offset of list items.
+     * The [[listMarker]] is right justified on [[indentation]] + [[tabInterval]]*(depth - 1/2).
+     * [[Paragraph]]s will start at [[indentation]] + [[tabInterval]]*depth.
+     */
+    indentation;
+    /** The marker used to indicate the start of a list item.
+     * Default: [[ListMarkerEnumerator.Number]].
+     */
+    listMarker;
     /** The frame settings of the [[TextAnnotation]]. */
     frame;
-    /** A fully-populated JSON representation of the default settings. A real `fontName` must be provided before use. */
+    /** The margins to surround the document content. */
+    margins;
+    /** The alignment of the text content. */
+    justification;
+    /** A fully-populated JSON representation of the default settings. A real `font` must be provided before use. */
     static defaultProps = {
         color: "subcategory",
-        fontName: "",
-        lineHeight: 1,
+        font: { name: "", type: Fonts_1.FontType.TrueType },
+        textHeight: 1,
         lineSpacingFactor: 0.5,
+        paragraphSpacingFactor: 0.5,
         isBold: false,
         isItalic: false,
         isUnderlined: false,
@@ -110,12 +150,21 @@ class TextStyleSettings {
             terminatorWidthFactor: 1.0,
         },
         tabInterval: 4,
+        indentation: 0,
+        listMarker: { enumerator: "1", terminator: "period", case: "lower" },
         frame: {
             shape: "none",
-            fill: "none",
-            border: ColorDef_1.ColorDef.black.toJSON(),
+            fillColor: "none",
+            borderColor: ColorDef_1.ColorDef.black.toJSON(),
             borderWeight: 1,
         },
+        margins: {
+            left: 0,
+            right: 0,
+            top: 0,
+            bottom: 0
+        },
+        justification: "left",
     };
     /** Settings initialized to all default values. */
     static defaults = new TextStyleSettings({});
@@ -124,9 +173,14 @@ class TextStyleSettings {
             defaults = TextStyleSettings.defaultProps;
         }
         this.color = props.color ?? defaults.color;
-        this.fontName = props.fontName ?? defaults.fontName;
-        this.lineHeight = props.lineHeight ?? defaults.lineHeight;
+        const font = {
+            name: props.font?.name ?? defaults.font.name,
+            type: props.font?.type ?? defaults.font.type,
+        };
+        this.font = Object.freeze(font);
+        this.textHeight = props.textHeight ?? defaults.textHeight;
         this.lineSpacingFactor = props.lineSpacingFactor ?? defaults.lineSpacingFactor;
+        this.paragraphSpacingFactor = props.paragraphSpacingFactor ?? defaults.paragraphSpacingFactor;
         this.isBold = props.isBold ?? defaults.isBold;
         this.isItalic = props.isItalic ?? defaults.isItalic;
         this.isUnderlined = props.isUnderlined ?? defaults.isUnderlined;
@@ -146,36 +200,34 @@ class TextStyleSettings {
         };
         this.leader = Object.freeze(leader);
         this.tabInterval = props.tabInterval ?? defaults.tabInterval;
+        this.indentation = props.indentation ?? defaults.indentation;
+        this.listMarker = props.listMarker ?? defaults.listMarker;
         const frame = {
             shape: props.frame?.shape ?? defaults.frame.shape,
-            fill: props.frame?.fill ?? defaults.frame.fill,
-            border: props.frame?.border ?? defaults.frame.border,
+            fillColor: props.frame?.fillColor ?? defaults.frame.fillColor,
+            borderColor: props.frame?.borderColor ?? defaults.frame.borderColor,
             borderWeight: props.frame?.borderWeight ?? defaults.frame.borderWeight,
         };
         // Cast to indicate to TypeScript that the frame properties are all defined
         this.frame = Object.freeze(frame);
+        this.margins = Object.freeze({
+            left: props.margins?.left ?? defaults.margins.left,
+            right: props.margins?.right ?? defaults.margins.right,
+            top: props.margins?.top ?? defaults.margins.top,
+            bottom: props.margins?.bottom ?? defaults.margins.bottom,
+        });
+        this.justification = props.justification ?? defaults.justification;
     }
     /** 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;
     }
     toJSON() {
-        return { ...this };
+        return structuredClone(this);
     }
     /** Compare two [[TextLeaderStyleProps]] for equality.
      * @param other The other leader style properties to compare against.
@@ -188,20 +240,27 @@ class TextStyleSettings {
     }
     frameEquals(other) {
         return this.frame?.shape === other.shape
-            && this.frame?.fill === other.fill
-            && this.frame?.border === other.border
+            && this.frame?.fillColor === other.fillColor
+            && this.frame?.borderColor === other.borderColor
             && this.frame?.borderWeight === other.borderWeight;
     }
+    marginsEqual(other) {
+        return Object.entries(this.margins).every(([key, value]) => value === other[key]);
+    }
     equals(other) {
-        return this.color === other.color && this.fontName === other.fontName
-            && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor
+        return this.color === other.color && this.font.name === other.font.name && this.font.type === other.font.type
+            && this.textHeight === other.textHeight && this.widthFactor === other.widthFactor
+            && this.lineSpacingFactor === other.lineSpacingFactor && this.paragraphSpacingFactor === other.paragraphSpacingFactor
             && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined
             && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale
             && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale
             && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale
-            && this.tabInterval === other.tabInterval
+            && this.tabInterval === other.tabInterval && this.indentation === other.indentation
+            && this.listMarker.case === other.listMarker.case && this.listMarker.enumerator === other.listMarker.enumerator && this.listMarker.terminator === other.listMarker.terminator
+            && this.justification === other.justification
             && this.leaderEquals(other.leader)
-            && this.frameEquals(other.frame);
+            && this.frameEquals(other.frame)
+            && this.marginsEqual(other.margins);
     }
     /**
      * Returns a list of validation errors for this instance.
@@ -215,11 +274,11 @@ class TextStyleSettings {
      */
     getValidationErrors() {
         const errorMessages = [];
-        if (this.fontName.trim() === "") {
-            errorMessages.push("fontName must be provided");
+        if (this.font.name.trim() === "") {
+            errorMessages.push("font name must be provided");
         }
-        if (this.lineHeight <= 0) {
-            errorMessages.push("lineHeight must be greater than 0");
+        if (this.textHeight <= 0) {
+            errorMessages.push("textHeight must be greater than 0");
         }
         if (this.stackedFractionScale <= 0) {
             errorMessages.push("stackedFractionScale must be greater than 0");