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

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

@@ -0,0 +1,276 @@
+/** @packageDocumentation
+ * @module Annotation
+ */
+import { TextStyleSettingsProps } from "./TextStyle";
+/** Options supplied to [[TextBlockComponent.applyStyle]] to control how the style is applied to the component and its child components.
+ * @beta
+ */
+export interface ApplyTextStyleOptions {
+    /** Controls whether any deviations from the style's settings stored in [[TextBlockComponent.styleOverrides]] are retained.
+     * By default, all overrides are cleared.
+     */
+    preserveOverrides?: boolean;
+    /** Controls whether the style should be recursively applied to the [[Paragraph]]s belonging to a [[TextBlock]] and the [[Run]]s belonging to a [[Paragraph]].
+     * By default, the style change propagates to child components.
+     */
+    preventPropagation?: boolean;
+}
+/** The JSON representation of a [[TextBlockComponent]].
+ * @beta
+ */
+export interface TextBlockComponentProps {
+    /** The name of a [[TextStyle]] stored in a [Workspace]($backend) from which the base [[TextStyleSettings]] applied to the component originates. */
+    styleName: string;
+    /** Deviations from the base [[TextStyleSettings]] defined by the [[TextStyle]] applied to this component.
+     * This permits you to, e.g., create a [[TextRun]] using "Arial" font and override it to use "Comic Sans" instead.
+     */
+    styleOverrides?: TextStyleSettingsProps;
+}
+/** Options supplied to [[TextBlockComponent.stringify]] to control how the content is formatted.
+ * @beta
+ */
+export interface TextBlockStringifyOptions {
+    /** A string to insert in between each [[Paragraph]].
+     * Default: " " - a single space.
+     */
+    paragraphBreak?: string;
+    /** A string to insert for each [[LineBreakRun]].
+     * Default: " " - a single space.
+     */
+    lineBreak?: string;
+    /** A string to insert between the numerator and denominator of each [[FractionRun]].
+     * Default: "/"
+     */
+    fractionSeparator?: string;
+}
+/** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.
+ * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.
+ * @beta
+ */
+export declare abstract class TextBlockComponent {
+    private _styleName;
+    private _styleOverrides;
+    /** @internal */
+    protected constructor(props: TextBlockComponentProps);
+    /** The name of the [[TextStyle]] that provides the base formatting for the contents of this component.
+     * @note Assigning to this property is equivalent to calling [[applyStyle]] with default [[ApplyTextStyleOptions]], which propagates the style change to all of
+     * the components sub-components and clears any [[styleOverrides]].
+     */
+    get styleName(): string;
+    set styleName(styleName: string);
+    /** Deviations in individual properties of the [[TextStyle]] specified by [[styleName]].
+     * For example, if the style uses the "Arial" font, you can override that by settings `styleOverrides.fontName` to "Comic Sans".
+     * @see [[clearStyleOverrides]] to reset this to an empty object.
+     */
+    get styleOverrides(): TextStyleSettingsProps;
+    set styleOverrides(overrides: TextStyleSettingsProps);
+    /** Reset any [[styleOverrides]] applied to this component's [[TextStyle]]. */
+    clearStyleOverrides(): void;
+    /** Apply the [[TextStyle]] specified by `styleName` to this component, optionally preserving [[styleOverrides]] and/or preventing propagation to sub-components. */
+    applyStyle(styleName: string, options?: ApplyTextStyleOptions): void;
+    /** Returns true if [[styleOverrides]] specifies any deviations from this component's base [[TextStyle]]. */
+    get overridesStyle(): boolean;
+    /** Create a deep copy of this component. */
+    abstract clone(): TextBlockComponent;
+    /** Compute a string representation of the contents of this component and all of its sub-components. */
+    abstract stringify(options?: TextBlockStringifyOptions): string;
+    /** Convert this component to its JSON representation. */
+    toJSON(): TextBlockComponentProps;
+    /** Returns true if `this` is equivalent to `other`. */
+    equals(other: TextBlockComponent): boolean;
+}
+/**
+ * @beta
+ */
+export type Run = TextRun | FractionRun | LineBreakRun;
+/** The JSON representation of a [[Run]].
+ * Use the `type` field to discriminate between the different kinds of runs.
+ * @beta
+ */
+export type RunProps = TextRunProps | FractionRunProps | LineBreakRunProps;
+/** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span
+ * multiple lines, but it will never contain different styling.
+ * Use the `type` field to discriminate between the different kinds of runs.
+ * @beta
+ */
+export declare namespace Run {
+    /** Create a run from its JSON representation.
+     * @see [[TextRun.create]], [[FractionRun.create]], and [[LineBreakRun.create]] to create a run directly.
+     */
+    function fromJSON(props: RunProps): Run;
+}
+/** Describes whether the characters of a [[TextRun]] should be displayed normally, in subscript, or in superscript.
+ * [[TextStyleSettings.superScriptScale]], [[TextStyleSettings.subScriptScale]], [[TextStyleSettings.superScriptOffsetFactor]], and [[TextStyleSettings.subScriptOffsetFactor]]
+ * affect how the content is rendered.
+ * @beta
+ */
+export type BaselineShift = "subscript" | "superscript" | "none";
+/** JSON representation of a [[TextRun]].
+ * @beta
+ */
+export interface TextRunProps extends TextBlockComponentProps {
+    /** Discriminator field for the [[RunProps]] union. */
+    readonly type: "text";
+    /** The characters displayed by the run.
+     * Default: an empty string.
+     */
+    content?: string;
+    /** Whether to display [[content]] as a subscript, superscript, or normally.
+     * Default: "none"
+     */
+    baselineShift?: BaselineShift;
+}
+/** The most common type of [[Run]], containing a sequence of characters to be displayed using a single style.
+ * @beta
+ */
+export declare class TextRun extends TextBlockComponent {
+    /** Discriminator field for the [[Run]] union. */
+    readonly type = "text";
+    /** The sequence of characters to be displayed by the run. */
+    content: string;
+    /** Whether to display [[content]] as a subscript, superscript, or normally. */
+    baselineShift: BaselineShift;
+    private constructor();
+    clone(): TextRun;
+    toJSON(): TextRunProps;
+    static create(props: Omit<TextRunProps, "type">): TextRun;
+    /** Simply returns [[content]]. */
+    stringify(): string;
+    equals(other: TextBlockComponent): boolean;
+}
+/** JSON representation of a [[FractionRun]].
+ * @beta
+ */
+export interface FractionRunProps extends TextBlockComponentProps {
+    /** Discriminator field for the [[RunProps]] union. */
+    readonly type: "fraction";
+    /** The text displayed before or above the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */
+    numerator?: string;
+    /** The text displayed after or below the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */
+    denominator?: string;
+}
+/** A [[Run]] containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.
+ * @note The [[numerator]] and [[denominator]] are stored as strings. They are not technically required to contain a numeric representation.
+ * @beta
+ */
+export declare class FractionRun extends TextBlockComponent {
+    /** Discriminator field for the [[Run]] union. */
+    readonly type = "fraction";
+    /** The fraction's numerator. */
+    numerator: string;
+    /** The fraction's denominator. */
+    denominator: string;
+    private constructor();
+    toJSON(): FractionRunProps;
+    clone(): FractionRun;
+    static create(props: Omit<FractionRunProps, "type">): FractionRun;
+    /** Formats the fraction as a string with the [[numerator]] and [[denominator]] separated by [[TextBlockStringifyOptions.fractionSeparator]]. */
+    stringify(options?: TextBlockStringifyOptions): string;
+    equals(other: TextBlockComponent): boolean;
+}
+/** JSON representation of a [[LineBreakRun]].
+ * @beta
+ */
+export interface LineBreakRunProps extends TextBlockComponentProps {
+    /** Discriminator field for the [[RunProps]] union. */
+    readonly type: "linebreak";
+}
+/** A [[Run]] that represents the end of a line of text within a [[Paragraph]]. It contains no content of its own - it simply causes subsequent content to display on a new line.
+ * @beta
+ */
+export declare class LineBreakRun extends TextBlockComponent {
+    /** Discriminator field for the [[Run]] union. */
+    readonly type = "linebreak";
+    private constructor();
+    toJSON(): LineBreakRunProps;
+    static create(props: TextBlockComponentProps): LineBreakRun;
+    clone(): LineBreakRun;
+    /** Simply returns [[TextBlockStringifyOptions.lineBreak]]. */
+    stringify(options?: TextBlockStringifyOptions): string;
+    equals(other: TextBlockComponent): boolean;
+}
+/** JSON representation of a [[Paragraph]].
+ * @beta
+ */
+export interface ParagraphProps extends TextBlockComponentProps {
+    /** The collection of [[Run]]s within the paragraph.
+     * Default: an empty array.
+     */
+    runs?: RunProps[];
+}
+/** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.
+ * @beta
+ */
+export declare class Paragraph extends TextBlockComponent {
+    /** The runs within the paragraph. You can modify the contents of this array to change the content of the paragraph. */
+    readonly runs: Run[];
+    private constructor();
+    toJSON(): ParagraphProps;
+    /** Create a paragraph from its JSON representation. */
+    static create(props: ParagraphProps): Paragraph;
+    clone(): Paragraph;
+    /** Apply the specified style to this [[Paragraph]], and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[runs]]. */
+    applyStyle(styleName: string, options?: ApplyTextStyleOptions): void;
+    /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */
+    stringify(options?: TextBlockStringifyOptions): string;
+    equals(other: TextBlockComponent): boolean;
+}
+/** Describes the relative alignment of the content of a [[TextBlock]].
+ * @beta
+ */
+export type TextBlockJustification = "left" | "center" | "right";
+/** JSON representation of a [[TextBlock]].
+ * @beta
+ */
+export interface TextBlockProps extends TextBlockComponentProps {
+    /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line.
+     * A value less than or equal to zero indicates no wrapping is to be applied.
+     * Default: 0
+     */
+    width?: number;
+    /** The alignment of the document content. Default: "left". */
+    justification?: TextBlockJustification;
+    /** The paragraphs within the text block. Default: an empty array. */
+    paragraphs?: ParagraphProps[];
+}
+/** Represents a formatted text document consisting of a series of [[Paragraph]]s, each laid out on a separate line and containing their own content in the form of [[Run]]s.
+ * You can change the content of the document by directly modifying the contents of its [[paragraphs]], or via [[appendParagraph]] and [[appendRun]].
+ * No word-wrapping is applied to the document unless a [[width]] greater than zero is specified.
+ * @see [[TextAnnotation]] to position a text block as an annotation in 2d or 3d space.
+ * @beta
+ */
+export declare class TextBlock extends TextBlockComponent {
+    /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line.
+     * A value less than or equal to zero indicates no wrapping is to be applied.
+     * Default: 0
+     */
+    width: number;
+    /** The alignment of the document's content. */
+    justification: TextBlockJustification;
+    /** The ordered list of paragraphs within the document. */
+    readonly paragraphs: Paragraph[];
+    private constructor();
+    toJSON(): TextBlockProps;
+    /** Create a text block from its JSON representation. */
+    static create(props: TextBlockProps): TextBlock;
+    /** Create an empty text block containing no [[paragraphs]] and an empty [[styleName]]. */
+    static createEmpty(): TextBlock;
+    /** Returns true if every paragraph in this text block is empty. */
+    get isEmpty(): boolean;
+    clone(): TextBlock;
+    /** Apply the specified style to this block and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[paragraphs]]. */
+    applyStyle(styleName: string, options?: ApplyTextStyleOptions): void;
+    /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */
+    stringify(options?: TextBlockStringifyOptions): string;
+    /** Add and return a new paragraph.
+     * If [[paragraphs]] is not empty, the style and overrides of the last [[Paragraph]] in the block will be applied to the new paragraph; otherwise,
+     * the paragraph will inherit this block's style with no overrides.
+     */
+    appendParagraph(): Paragraph;
+    /** Append a run to the last [[Paragraph]] in this block.
+     * If the block contains no [[paragraphs]], a new one will first be created using [[appendParagraph]].
+     */
+    appendRun(run: Run): void;
+    equals(other: TextBlockComponent): boolean;
+}
+//# sourceMappingURL=TextBlock.d.ts.map

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

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

package/lib/cjs/annotation/TextBlock.js

@@ -0,0 +1,324 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Annotation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextBlock = exports.Paragraph = exports.LineBreakRun = exports.FractionRun = exports.TextRun = exports.Run = exports.TextBlockComponent = void 0;
+/** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.
+ * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.
+ * @beta
+ */
+class TextBlockComponent {
+    /** @internal */
+    constructor(props) {
+        this._styleName = props.styleName;
+        this._styleOverrides = { ...props.styleOverrides };
+    }
+    /** The name of the [[TextStyle]] that provides the base formatting for the contents of this component.
+     * @note Assigning to this property is equivalent to calling [[applyStyle]] with default [[ApplyTextStyleOptions]], which propagates the style change to all of
+     * the components sub-components and clears any [[styleOverrides]].
+     */
+    get styleName() {
+        return this._styleName;
+    }
+    set styleName(styleName) {
+        this.applyStyle(styleName);
+    }
+    /** Deviations in individual properties of the [[TextStyle]] specified by [[styleName]].
+     * For example, if the style uses the "Arial" font, you can override that by settings `styleOverrides.fontName` to "Comic Sans".
+     * @see [[clearStyleOverrides]] to reset this to an empty object.
+     */
+    get styleOverrides() {
+        return this._styleOverrides;
+    }
+    set styleOverrides(overrides) {
+        this._styleOverrides = { ...overrides };
+    }
+    /** Reset any [[styleOverrides]] applied to this component's [[TextStyle]]. */
+    clearStyleOverrides() {
+        this.styleOverrides = {};
+    }
+    /** Apply the [[TextStyle]] specified by `styleName` to this component, optionally preserving [[styleOverrides]] and/or preventing propagation to sub-components. */
+    applyStyle(styleName, options) {
+        this._styleName = styleName;
+        if (!(options?.preserveOverrides)) {
+            this.clearStyleOverrides();
+        }
+    }
+    /** Returns true if [[styleOverrides]] specifies any deviations from this component's base [[TextStyle]]. */
+    get overridesStyle() {
+        return Object.keys(this.styleOverrides).length > 0;
+    }
+    /** Convert this component to its JSON representation. */
+    toJSON() {
+        return {
+            styleName: this.styleName,
+            styleOverrides: { ...this.styleOverrides },
+        };
+    }
+    /** Returns true if `this` is equivalent to `other`. */
+    equals(other) {
+        const myKeys = Object.keys(this.styleOverrides);
+        const yrKeys = Object.keys(other._styleOverrides);
+        if (this.styleName !== other.styleName || myKeys.length !== yrKeys.length) {
+            return false;
+        }
+        for (const name of myKeys) {
+            const key = name;
+            if (this.styleOverrides[key] !== other.styleOverrides[key]) {
+                return false;
+            }
+        }
+        return true;
+    }
+}
+exports.TextBlockComponent = TextBlockComponent;
+/** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span
+ * multiple lines, but it will never contain different styling.
+ * Use the `type` field to discriminate between the different kinds of runs.
+ * @beta
+ */
+var Run;
+(function (Run) {
+    /** Create a run from its JSON representation.
+     * @see [[TextRun.create]], [[FractionRun.create]], and [[LineBreakRun.create]] to create a run directly.
+     */
+    function fromJSON(props) {
+        switch (props.type) {
+            case "text": return TextRun.create(props);
+            case "fraction": return FractionRun.create(props);
+            case "linebreak": return LineBreakRun.create(props);
+        }
+    }
+    Run.fromJSON = fromJSON;
+})(Run || (exports.Run = Run = {}));
+/** The most common type of [[Run]], containing a sequence of characters to be displayed using a single style.
+ * @beta
+ */
+class TextRun extends TextBlockComponent {
+    constructor(props) {
+        super(props);
+        /** Discriminator field for the [[Run]] union. */
+        this.type = "text";
+        this.content = props.content ?? "";
+        this.baselineShift = props.baselineShift ?? "none";
+    }
+    clone() {
+        return new TextRun(this.toJSON());
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            type: "text",
+            content: this.content,
+            baselineShift: this.baselineShift,
+        };
+    }
+    static create(props) {
+        return new TextRun(props);
+    }
+    /** Simply returns [[content]]. */
+    stringify() {
+        return this.content;
+    }
+    equals(other) {
+        return other instanceof TextRun && this.content === other.content && this.baselineShift === other.baselineShift && super.equals(other);
+    }
+}
+exports.TextRun = TextRun;
+/** A [[Run]] containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.
+ * @note The [[numerator]] and [[denominator]] are stored as strings. They are not technically required to contain a numeric representation.
+ * @beta
+ */
+class FractionRun extends TextBlockComponent {
+    constructor(props) {
+        super(props);
+        /** Discriminator field for the [[Run]] union. */
+        this.type = "fraction";
+        this.numerator = props.numerator ?? "";
+        this.denominator = props.denominator ?? "";
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            type: "fraction",
+            numerator: this.numerator,
+            denominator: this.denominator,
+        };
+    }
+    clone() {
+        return new FractionRun(this.toJSON());
+    }
+    static create(props) {
+        return new FractionRun(props);
+    }
+    /** Formats the fraction as a string with the [[numerator]] and [[denominator]] separated by [[TextBlockStringifyOptions.fractionSeparator]]. */
+    stringify(options) {
+        const sep = options?.fractionSeparator ?? "/";
+        return `${this.numerator}${sep}${this.denominator}`;
+    }
+    equals(other) {
+        return other instanceof FractionRun && this.numerator === other.numerator && this.denominator === other.denominator && super.equals(other);
+    }
+}
+exports.FractionRun = FractionRun;
+/** A [[Run]] that represents the end of a line of text within a [[Paragraph]]. It contains no content of its own - it simply causes subsequent content to display on a new line.
+ * @beta
+ */
+class LineBreakRun extends TextBlockComponent {
+    constructor(props) {
+        super(props);
+        /** Discriminator field for the [[Run]] union. */
+        this.type = "linebreak";
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            type: "linebreak",
+        };
+    }
+    static create(props) {
+        return new LineBreakRun(props);
+    }
+    clone() {
+        return new LineBreakRun(this.toJSON());
+    }
+    /** Simply returns [[TextBlockStringifyOptions.lineBreak]]. */
+    stringify(options) {
+        return options?.lineBreak ?? " ";
+    }
+    equals(other) {
+        return other instanceof LineBreakRun && super.equals(other);
+    }
+}
+exports.LineBreakRun = LineBreakRun;
+/** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.
+ * @beta
+ */
+class Paragraph extends TextBlockComponent {
+    constructor(props) {
+        super(props);
+        this.runs = props.runs?.map((run) => Run.fromJSON(run)) ?? [];
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            runs: this.runs.map((run) => run.toJSON()),
+        };
+    }
+    /** Create a paragraph from its JSON representation. */
+    static create(props) {
+        return new Paragraph(props);
+    }
+    clone() {
+        return new Paragraph(this.toJSON());
+    }
+    /** Apply the specified style to this [[Paragraph]], and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[runs]]. */
+    applyStyle(styleName, options) {
+        super.applyStyle(styleName, options);
+        if (!(options?.preventPropagation)) {
+            for (const run of this.runs) {
+                run.applyStyle(styleName, options);
+            }
+        }
+    }
+    /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */
+    stringify(options) {
+        return this.runs.map((x) => x.stringify(options)).join("");
+    }
+    equals(other) {
+        if (!(other instanceof Paragraph)) {
+            return false;
+        }
+        if (this.runs.length !== other.runs.length || !super.equals(other)) {
+            return false;
+        }
+        return this.runs.every((run, index) => run.equals(other.runs[index]));
+    }
+}
+exports.Paragraph = Paragraph;
+/** Represents a formatted text document consisting of a series of [[Paragraph]]s, each laid out on a separate line and containing their own content in the form of [[Run]]s.
+ * You can change the content of the document by directly modifying the contents of its [[paragraphs]], or via [[appendParagraph]] and [[appendRun]].
+ * No word-wrapping is applied to the document unless a [[width]] greater than zero is specified.
+ * @see [[TextAnnotation]] to position a text block as an annotation in 2d or 3d space.
+ * @beta
+ */
+class TextBlock extends TextBlockComponent {
+    constructor(props) {
+        super(props);
+        this.width = props.width ?? 0;
+        this.justification = props.justification ?? "left";
+        this.paragraphs = props.paragraphs?.map((x) => Paragraph.create(x)) ?? [];
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            width: this.width,
+            justification: this.justification,
+            paragraphs: this.paragraphs.map((x) => x.toJSON()),
+        };
+    }
+    /** Create a text block from its JSON representation. */
+    static create(props) {
+        return new TextBlock(props);
+    }
+    /** Create an empty text block containing no [[paragraphs]] and an empty [[styleName]]. */
+    static createEmpty() {
+        return TextBlock.create({ styleName: "" });
+    }
+    /** Returns true if every paragraph in this text block is empty. */
+    get isEmpty() {
+        return this.paragraphs.every((p) => p.runs.length === 0);
+    }
+    clone() {
+        return new TextBlock(this.toJSON());
+    }
+    /** Apply the specified style to this block and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[paragraphs]]. */
+    applyStyle(styleName, options) {
+        super.applyStyle(styleName, options);
+        if (!(options?.preventPropagation)) {
+            for (const paragraph of this.paragraphs) {
+                paragraph.applyStyle(styleName, options);
+            }
+        }
+    }
+    /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */
+    stringify(options) {
+        return this.paragraphs.map((x) => x.stringify(options)).join(options?.paragraphBreak ?? " ");
+    }
+    /** Add and return a new paragraph.
+     * If [[paragraphs]] is not empty, the style and overrides of the last [[Paragraph]] in the block will be applied to the new paragraph; otherwise,
+     * the paragraph will inherit this block's style with no overrides.
+     */
+    appendParagraph() {
+        const seed = this.paragraphs[0];
+        const paragraph = Paragraph.create({
+            styleName: seed?.styleName ?? this.styleName,
+            styleOverrides: seed?.styleOverrides ?? undefined,
+        });
+        this.paragraphs.push(paragraph);
+        return paragraph;
+    }
+    /** Append a run to the last [[Paragraph]] in this block.
+     * If the block contains no [[paragraphs]], a new one will first be created using [[appendParagraph]].
+     */
+    appendRun(run) {
+        const paragraph = this.paragraphs[this.paragraphs.length - 1] ?? this.appendParagraph();
+        paragraph.runs.push(run);
+    }
+    equals(other) {
+        if (!(other instanceof TextBlock)) {
+            return false;
+        }
+        if (this.width !== other.width || this.justification !== other.justification || this.paragraphs.length !== other.paragraphs.length) {
+            return false;
+        }
+        return this.paragraphs.every((paragraph, index) => paragraph.equals(other.paragraphs[index]));
+    }
+}
+exports.TextBlock = TextBlock;
+//# sourceMappingURL=TextBlock.js.map