@itwin/core-common 5.1.0-dev.61 → 5.1.0-dev.64

package/lib/cjs/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;;;AA+HH;;;;;GAKG;AACH,MAAa,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;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;QACd,MAAM,EAAE;YACN,KAAK,EAAE,aAAa;YACpB,SAAS,EAAE,KAAK;YAChB,WAAW,EAAE,GAAG;YAChB,sBAAsB,EAAE,GAAG;YAC3B,qBAAqB,EAAE,GAAG;SAC3B;QACD,WAAW,EAAE,CAAC;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;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;IACD;;;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,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;eAC9D,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAChD,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;;AAjJH,8CAkJC;AAED,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAY1C;;;;GAIG;AACH,MAAa,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;AA3BD,8BA2BC","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/** 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   * Default: \"subcategory\".\n   */\n  color?: TextStyleColor;\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 [[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 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\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 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\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    leader: {\n      color: \"subcategory\",\n      wantElbow: false,\n      elbowLength: 1.0,\n      terminatorHeightFactor: 1.0,\n      terminatorWidthFactor: 1.0,\n    },\n    tabInterval: 4,\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  }\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  /** 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 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\n      && this.superScriptScale === other.superScriptScale\n      && this.tabInterval === other.tabInterval && this.leaderEquals(other.leader);\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,0CAAsD;AAEtD;;EAEE;AACW,QAAA,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,MAAa,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,mBAAQ,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;;AAjNH,8CAkNC;AAED,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/ChangesetProps.d.ts

@@ -79,6 +79,8 @@ export interface ChangesetProps {
     userCreated: string;
     /** The size, in bytes, of this changeset */
     size: number;
+    /** The uncompressed size, in bytes, of this changeset */
+    uncompressedSize?: number;
 }
 /** Properties of a changeset file
  * @public
@@ -98,4 +100,30 @@ export interface ChangesetRange {
     /** index of last changeset. If undefined, all changesets after first are returned. */
     end?: ChangesetIndex;
 }
+/**
+ * Statistics for a single SQL statement executed during changeset application.
+ * @beta
+ */
+export interface PerStatementHealthStats {
+    sqlStatement: string;
+    dbOperation: string;
+    rowCount: number;
+    elapsedMs: number;
+    fullTableScans: number;
+}
+/**
+ * Aggregated health statistics for a changeset application.
+ * @beta
+ */
+export interface ChangesetHealthStats {
+    changesetId: string;
+    uncompressedSizeBytes: number;
+    sha1ValidationTimeMs: number;
+    insertedRows: number;
+    updatedRows: number;
+    deletedRows: number;
+    totalElapsedMs: number;
+    totalFullTableScans: number;
+    perStatementStats: [PerStatementHealthStats];
+}
 //# sourceMappingURL=ChangesetProps.d.ts.map

package/lib/esm/ChangesetProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChangesetProps.d.ts","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAIA;;;GAGG;AAEH,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,cAAc;AACd,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAAG,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEjG;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEnG;;;EAGE;AACF,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEtK;;;GAGG;AACH,oBAAY,aAAa;IACvB,mDAAmD;IACnD,OAAO,IAAI;IACX,+CAA+C;IAC/C,MAAM,IAAI;IACV,gEAAgE;IAChE,UAAU,KAAc;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4GAA4G;IAC5G,KAAK,EAAE,cAAc,CAAC;IACtB,sBAAsB;IACtB,EAAE,EAAE,WAAW,CAAC;IAChB,gEAAgE;IAChE,QAAQ,EAAE,WAAW,CAAC;IACtB,4BAA4B;IAC5B,WAAW,EAAE,aAAa,CAAC;IAC3B,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,kEAAkE;IAClE,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,KAAK,EAAE,cAAc,CAAC;IACtB,sFAAsF;IACtF,GAAG,CAAC,EAAE,cAAc,CAAC;CACtB"}
+{"version":3,"file":"ChangesetProps.d.ts","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAIA;;;GAGG;AAEH,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,cAAc;AACd,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAAG,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEjG;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEnG;;;EAGE;AACF,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEtK;;;GAGG;AACH,oBAAY,aAAa;IACvB,mDAAmD;IACnD,OAAO,IAAI;IACX,+CAA+C;IAC/C,MAAM,IAAI;IACV,gEAAgE;IAChE,UAAU,KAAc;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4GAA4G;IAC5G,KAAK,EAAE,cAAc,CAAC;IACtB,sBAAsB;IACtB,EAAE,EAAE,WAAW,CAAC;IAChB,gEAAgE;IAChE,QAAQ,EAAE,WAAW,CAAC;IACtB,4BAA4B;IAC5B,WAAW,EAAE,aAAa,CAAC;IAC3B,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,kEAAkE;IAClE,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,KAAK,EAAE,cAAc,CAAC;IACtB,sFAAsF;IACtF,GAAG,CAAC,EAAE,cAAc,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,CAAC,uBAAuB,CAAC,CAAC;CAC9C"}

package/lib/esm/ChangesetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangesetProps.js","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;;GAGG;AAuCH;;;GAGG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;IACV,gEAAgE;IAChE,8DAAwB,CAAA;AAC1B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB","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/**\n * @packageDocumentation\n * @module iModels\n */\n\n/** @public */\nexport type LocalFileName = string;\n/** @public */\nexport type LocalDirName = string;\n\n/** A string that identifies a changeset.\n * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.\n * @public\n * @extensions\n */\nexport type ChangesetId = string;\n\n/** The index of a changeset, assigned by iModelHub.\n * @note 0 means \"before the first changeset.\" Values less than 0 are invalid.\n * @public\n * @extensions\n */\nexport type ChangesetIndex = number;\n\n/** Both the index and Id of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIndexAndId { readonly index: ChangesetIndex, readonly id: ChangesetId }\n\n/** The Id and optionally the index of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIdWithIndex { readonly index?: ChangesetIndex, readonly id: ChangesetId }\n\n/** either changeset index, id, or both\n* @public\n * @extensions\n*/\nexport type ChangesetIndexOrId = ChangesetIndexAndId | { readonly index: ChangesetIndex, readonly id?: never } | { readonly id: ChangesetId, readonly index?: never };\n\n/** Value to indicate whether a changeset contains schema changes or not\n * @public\n * @extensions\n */\nexport enum ChangesetType {\n  /** changeset does *not* contain schema changes. */\n  Regular = 0,\n  /** changeset *does* contain schema changes. */\n  Schema = 1,\n  /** Schema changeset pushed by iModel with SchemaSync enabled */\n  SchemaSync = Schema | 64,\n}\n\n/** Properties of a changeset\n * @public\n */\nexport interface ChangesetProps {\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\n  index: ChangesetIndex;\n  /** the ChangesetId */\n  id: ChangesetId;\n  /** the ChangeSetId of the parent changeset of this changeset */\n  parentId: ChangesetId;\n  /** The type of changeset */\n  changesType: ChangesetType;\n  /** The user-supplied description of the work this changeset holds */\n  description: string;\n  /** The BriefcaseId of the briefcase that created this changeset */\n  briefcaseId: number;\n  /** The date this changeset was uploaded to the hub */\n  pushDate: string;\n  /** The identity of the user that created this changeset */\n  userCreated: string;\n  /** The size, in bytes, of this changeset */\n  size: number;\n}\n\n/** Properties of a changeset file\n * @public\n */\nexport interface ChangesetFileProps extends ChangesetProps {\n  /** The full pathname of the local file holding this changeset. */\n  pathname: LocalFileName;\n}\n\n/**\n * A range of changesets\n * @public\n * @extensions\n */\nexport interface ChangesetRange {\n  /** index of the first changeset */\n  first: ChangesetIndex;\n  /** index of last changeset. If undefined, all changesets after first are returned. */\n  end?: ChangesetIndex;\n}\n"]}
+{"version":3,"file":"ChangesetProps.js","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;;GAGG;AAuCH;;;GAGG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;IACV,gEAAgE;IAChE,8DAAwB,CAAA;AAC1B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB","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/**\n * @packageDocumentation\n * @module iModels\n */\n\n/** @public */\nexport type LocalFileName = string;\n/** @public */\nexport type LocalDirName = string;\n\n/** A string that identifies a changeset.\n * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.\n * @public\n * @extensions\n */\nexport type ChangesetId = string;\n\n/** The index of a changeset, assigned by iModelHub.\n * @note 0 means \"before the first changeset.\" Values less than 0 are invalid.\n * @public\n * @extensions\n */\nexport type ChangesetIndex = number;\n\n/** Both the index and Id of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIndexAndId { readonly index: ChangesetIndex, readonly id: ChangesetId }\n\n/** The Id and optionally the index of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIdWithIndex { readonly index?: ChangesetIndex, readonly id: ChangesetId }\n\n/** either changeset index, id, or both\n* @public\n * @extensions\n*/\nexport type ChangesetIndexOrId = ChangesetIndexAndId | { readonly index: ChangesetIndex, readonly id?: never } | { readonly id: ChangesetId, readonly index?: never };\n\n/** Value to indicate whether a changeset contains schema changes or not\n * @public\n * @extensions\n */\nexport enum ChangesetType {\n  /** changeset does *not* contain schema changes. */\n  Regular = 0,\n  /** changeset *does* contain schema changes. */\n  Schema = 1,\n  /** Schema changeset pushed by iModel with SchemaSync enabled */\n  SchemaSync = Schema | 64,\n}\n\n/** Properties of a changeset\n * @public\n */\nexport interface ChangesetProps {\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\n  index: ChangesetIndex;\n  /** the ChangesetId */\n  id: ChangesetId;\n  /** the ChangeSetId of the parent changeset of this changeset */\n  parentId: ChangesetId;\n  /** The type of changeset */\n  changesType: ChangesetType;\n  /** The user-supplied description of the work this changeset holds */\n  description: string;\n  /** The BriefcaseId of the briefcase that created this changeset */\n  briefcaseId: number;\n  /** The date this changeset was uploaded to the hub */\n  pushDate: string;\n  /** The identity of the user that created this changeset */\n  userCreated: string;\n  /** The size, in bytes, of this changeset */\n  size: number;\n  /** The uncompressed size, in bytes, of this changeset */\n  uncompressedSize?: number;\n}\n\n/** Properties of a changeset file\n * @public\n */\nexport interface ChangesetFileProps extends ChangesetProps {\n  /** The full pathname of the local file holding this changeset. */\n  pathname: LocalFileName;\n}\n\n/**\n * A range of changesets\n * @public\n * @extensions\n */\nexport interface ChangesetRange {\n  /** index of the first changeset */\n  first: ChangesetIndex;\n  /** index of last changeset. If undefined, all changesets after first are returned. */\n  end?: ChangesetIndex;\n}\n\n/**\n * Statistics for a single SQL statement executed during changeset application.\n * @beta\n */\nexport interface PerStatementHealthStats {\n  sqlStatement: string;\n  dbOperation: string;\n  rowCount: number;\n  elapsedMs: number;\n  fullTableScans: number;\n}\n\n/**\n * Aggregated health statistics for a changeset application.\n * @beta\n */\nexport interface ChangesetHealthStats {\n  changesetId: string;\n  uncompressedSizeBytes: number;\n  sha1ValidationTimeMs: number;\n  insertedRows: number;\n  updatedRows: number;\n  deletedRows: number;\n  totalElapsedMs: number;\n  totalFullTableScans: number;\n  perStatementStats: [PerStatementHealthStats];\n}\n"]}

package/lib/esm/ElementProps.d.ts

@@ -8,7 +8,6 @@ import { EntityProps } from "./EntityProps";
 import { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from "./geometry/ElementGeometry";
 import { GeometryStreamProps } from "./geometry/GeometryStream";
 import { SubCategoryAppearance } from "./SubCategoryAppearance";
-import { TextAnnotationProps } from "./annotation/TextAnnotation";
 /** Properties of a NavigationProperty.
  * @public @preview
  * @extensions
@@ -121,11 +120,11 @@ export interface GeometricElement3dProps extends GeometricElementProps {
  * @extensions
  */
 export interface TextAnnotation3dProps extends GeometricElement3dProps {
-    jsonProperties?: {
-        [key: string]: any;
-        /** @beta */
-        annotation?: TextAnnotationProps;
-    };
+    /** The stringified JSON representation of the text annotation.
+     * @see [[TextAnnotationProps]] for the JSON representation.
+     * @note Don't set this property directly - use [TextAnnotation3d.setAnnotation]($backend) instead.
+     */
+    textAnnotationData?: string;
 }
 /** Properties that define a [PhysicalElement]($backend)
  * @public @preview
@@ -196,16 +195,16 @@ export interface GeometricElement2dProps extends GeometricElementProps {
     placement?: Placement2dProps;
     typeDefinition?: RelatedElementProps;
 }
-/** JSON representation of a [TextAnnotation2d]($backend).
+/** Properties that define a [TextAnnotation2d]($backend).
  * @public @preview
  * @extensions
  */
 export interface TextAnnotation2dProps extends GeometricElement2dProps {
-    jsonProperties?: {
-        [key: string]: any;
-        /** @beta */
-        annotation?: TextAnnotationProps;
-    };
+    /** The stringified JSON representation of the text annotation.
+     * @see [[TextAnnotationProps]] for the JSON representation.
+     * @note Don't set this property directly - use [TextAnnotation2d.setAnnotation]($backend) instead.
+     */
+    textAnnotationData?: string;
 }
 /** Properties of a [GeometryPart]($backend)
  * @public @preview
@@ -542,4 +541,15 @@ export interface SheetReferenceProps extends SheetIndexEntryProps {
     /** The bis:Sheet that this bis:SheetReference is pointing to. */
     sheet?: RelatedElementProps;
 }
+/** Properties that define an [AnnotationTextStyle]($backend).
+ * @beta
+ */
+export interface AnnotationTextStyleProps extends DefinitionElementProps {
+    /** An optional human-readable description of the text style.*/
+    description?: string;
+    /** The stringified JSON representation of the text style.
+     * @see [[TextStyleSettingsProps]]
+     */
+    settings?: string;
+}
 //# sourceMappingURL=ElementProps.d.ts.map

package/lib/esm/ElementProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ElementProps.d.ts","sourceRoot":"","sources":["../../src/ElementProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAQ,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AACjF,OAAO,EACL,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EACzH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,4BAA4B,EAAE,mCAAmC,EAAE,MAAM,4BAA4B,CAAC;AAC/G,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,8DAA8D;IAC9D,EAAE,EAAE,UAAU,CAAC;IACf,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,wGAAwG;IACxG,KAAK,EAAE,UAAU,CAAC;IAClB,yEAAyE;IACzE,IAAI,EAAE,SAAS,CAAC;IAChB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,gHAAgH;IAChH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uHAAuH;IACvH,cAAc,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,8DAA8D;IAC9D,SAAgB,EAAE,EAAE,UAAU,CAAC;IAE/B,oDAAoD;IACpD,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAE1B,KAAK,EAAE,mBAAmB;WAKxB,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,cAAc,GAAG,SAAS;IAI9E,8DAA8D;IAC9D,gBAAuB,IAAI,iBAA4C;IAEvE,mJAAmJ;WACrI,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,UAAU;IAUxC,MAAM,IAAI,mBAAmB;CAMrC;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,cAAc;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,yDAAyD;IACzD,QAAQ,EAAE,UAAU,CAAC;IACrB,qCAAqC;IACrC,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B;;OAEG;IACH,4BAA4B,CAAC,EAAE,4BAA4B,CAAC;IAC5D,+BAA+B;IAC/B,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,UAAU,CAAC;IAClB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEjE;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,gBAAgB,CAEnF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,gBAAgB,CAEnF;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,cAAc,CAAC,EAAE,mBAAmB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE,cAAc,CAAC,EAAE;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;QACnB,YAAY;QACZ,UAAU,CAAC,EAAE,mBAAmB,CAAC;KAClC,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;CACxC;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,OAAO,IAAI;IACX,MAAM,IAAI;IACV,SAAS,IAAI;IACb,IAAI,IAAI;CACT;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,0EAA0E;IAC1E,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,6DAA6D;IAC7D,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,cAAc,CAAC,EAAE;QACf,uFAAuF;QACvF,yBAAyB,CAAC,EAAE,cAAc,CAAC;QAC3C,mKAAmK;QACnK,uBAAuB,CAAC,EAAE,cAAc,CAAC;QACzC;;;WAGG;QACH,mBAAmB,CAAC,EAAE,eAAe,CAAC;QACtC,mIAAmI;QACnI,kBAAkB,CAAC,EAAE,IAAI,CAAC;KAC3B,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,oEAAoE;IACpE,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,cAAc,CAAC,EAAE,mBAAmB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE,cAAc,CAAC,EAAE;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;QACnB,YAAY;QACZ,UAAU,CAAC,EAAE,mBAAmB,CAAC;KAClC,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B;;OAEG;IACH,4BAA4B,CAAC,EAAE,mCAAmC,CAAC;IACnE,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,IAAI,EAAE,mBAAmB,CAAC;IAC1B,cAAc,CAAC,EAAE;QACf,+IAA+I;QAC/I,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,4IAA4I;QAC5I,IAAI,CAAC,EAAE,eAAe,CAAC;QACvB,iFAAiF;QACjF,cAAc,CAAC,EAAE;YACf,wKAAwK;YACxK,YAAY,CAAC,EAAE,OAAO,CAAC;YACvB;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAC9B,CAAC;KACH,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,0BAA0B;IACnE,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,YAAY;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,4IAA4I;IAC5I;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2FAA2F;IAC3F,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACrC,6FAA6F;IAC7F,cAAc,CAAC,EAAE,uBAAuB,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACnE;;;OAGG;IACH,KAAK,EAAE,mBAAmB,CAAC;IAC3B,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4KAA4K;IAC5K,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;MAIE;IACF,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iHAAiH;IACjH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,4BAA4B;IACtC,gEAAgE;IAChE,cAAc,IAAI;IAClB,0EAA0E;IAC1E,WAAW,IAAI;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IACjE,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,IAAI,CAAC,EAAE,4BAA4B,CAAC;IACpC,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,sBAAsB;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,IAAI;IACd,gDAAgD;IAChD,MAAM,IAAI;IACV,4GAA4G;IAC5G,MAAM,IAAI;IACV,6HAA6H;IAC7H,WAAW,IAAI;IACf,mIAAmI;IACnI,IAAI,IAAI;CACT;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,sBAAsB;IAC3D,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,sBAAsB;IAC9D,UAAU,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,YAAY;IAClE,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;EAEE;AACF,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,2EAA2E;IAC3E,UAAU,CAAC,EAAE,mBAAmB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,iEAAiE;IACjE,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B"}
+{"version":3,"file":"ElementProps.d.ts","sourceRoot":"","sources":["../../src/ElementProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAQ,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AACjF,OAAO,EACL,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EACzH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,4BAA4B,EAAE,mCAAmC,EAAE,MAAM,4BAA4B,CAAC;AAC/G,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,8DAA8D;IAC9D,EAAE,EAAE,UAAU,CAAC;IACf,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,wGAAwG;IACxG,KAAK,EAAE,UAAU,CAAC;IAClB,yEAAyE;IACzE,IAAI,EAAE,SAAS,CAAC;IAChB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,gHAAgH;IAChH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uHAAuH;IACvH,cAAc,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,8DAA8D;IAC9D,SAAgB,EAAE,EAAE,UAAU,CAAC;IAE/B,oDAAoD;IACpD,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAE1B,KAAK,EAAE,mBAAmB;WAKxB,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,cAAc,GAAG,SAAS;IAI9E,8DAA8D;IAC9D,gBAAuB,IAAI,iBAA4C;IAEvE,mJAAmJ;WACrI,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,UAAU;IAUxC,MAAM,IAAI,mBAAmB;CAMrC;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,cAAc;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,yDAAyD;IACzD,QAAQ,EAAE,UAAU,CAAC;IACrB,qCAAqC;IACrC,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B;;OAEG;IACH,4BAA4B,CAAC,EAAE,4BAA4B,CAAC;IAC5D,+BAA+B;IAC/B,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,UAAU,CAAC;IAClB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEjE;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,gBAAgB,CAEnF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,gBAAgB,CAEnF;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,cAAc,CAAC,EAAE,mBAAmB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;CACxC;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,OAAO,IAAI;IACX,MAAM,IAAI;IACV,SAAS,IAAI;IACb,IAAI,IAAI;CACT;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,0EAA0E;IAC1E,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,6DAA6D;IAC7D,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,cAAc,CAAC,EAAE;QACf,uFAAuF;QACvF,yBAAyB,CAAC,EAAE,cAAc,CAAC;QAC3C,mKAAmK;QACnK,uBAAuB,CAAC,EAAE,cAAc,CAAC;QACzC;;;WAGG;QACH,mBAAmB,CAAC,EAAE,eAAe,CAAC;QACtC,mIAAmI;QACnI,kBAAkB,CAAC,EAAE,IAAI,CAAC;KAC3B,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,oEAAoE;IACpE,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,cAAc,CAAC,EAAE,mBAAmB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B;;OAEG;IACH,4BAA4B,CAAC,EAAE,mCAAmC,CAAC;IACnE,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,IAAI,EAAE,mBAAmB,CAAC;IAC1B,cAAc,CAAC,EAAE;QACf,+IAA+I;QAC/I,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,4IAA4I;QAC5I,IAAI,CAAC,EAAE,eAAe,CAAC;QACvB,iFAAiF;QACjF,cAAc,CAAC,EAAE;YACf,wKAAwK;YACxK,YAAY,CAAC,EAAE,OAAO,CAAC;YACvB;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAC9B,CAAC;KACH,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,0BAA0B;IACnE,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,YAAY;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,4IAA4I;IAC5I;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2FAA2F;IAC3F,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACrC,6FAA6F;IAC7F,cAAc,CAAC,EAAE,uBAAuB,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACnE;;;OAGG;IACH,KAAK,EAAE,mBAAmB,CAAC;IAC3B,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4KAA4K;IAC5K,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;MAIE;IACF,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iHAAiH;IACjH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,4BAA4B;IACtC,gEAAgE;IAChE,cAAc,IAAI;IAClB,0EAA0E;IAC1E,WAAW,IAAI;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IACjE,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,IAAI,CAAC,EAAE,4BAA4B,CAAC;IACpC,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,sBAAsB;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,IAAI;IACd,gDAAgD;IAChD,MAAM,IAAI;IACV,4GAA4G;IAC5G,MAAM,IAAI;IACV,6HAA6H;IAC7H,WAAW,IAAI;IACf,mIAAmI;IACnI,IAAI,IAAI;CACT;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,sBAAsB;IAC3D,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,sBAAsB;IAC9D,UAAU,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,YAAY;IAClE,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;EAEE;AACF,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,2EAA2E;IAC3E,UAAU,CAAC,EAAE,mBAAmB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,iEAAiE;IACjE,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/lib/esm/ElementProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElementProps.js","sourceRoot":"","sources":["../../src/ElementProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,IAAI,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAQjF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAqC5C;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB,8DAA8D;IAC9C,EAAE,CAAa;IAE/B,oDAAoD;IACpC,YAAY,CAAU;IAEtC,YAAY,KAA0B;QACpC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAU,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAEvE,mJAAmJ;IAC5I,MAAM,CAAC,UAAU,CAAC,IAAS;QAChC,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,SAAS;gBACjB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;YAC/E,OAAO,CAAC,CAAC,EAAE,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAEM,MAAM;QACX,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,cAAc;CACjD;AA6CD;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAqB;IACtD,OAAQ,KAA0B,CAAC,KAAK,KAAK,SAAS,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAqB;IACtD,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AA+BD;;;GAGG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,iDAAU,CAAA;IACV,uDAAa,CAAA;IACb,6CAAQ,CAAA;AACV,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAiSD;;GAEG;AACH,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,gEAAgE;IAChE,mGAAkB,CAAA;IAClB,0EAA0E;IAC1E,6FAAe,CAAA;AACjB,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC;AAyCD;;;GAGG;AACH,MAAM,CAAN,IAAY,IASX;AATD,WAAY,IAAI;IACd,gDAAgD;IAChD,mCAAU,CAAA;IACV,4GAA4G;IAC5G,mCAAU,CAAA;IACV,6HAA6H;IAC7H,6CAAe,CAAA;IACf,mIAAmI;IACnI,+BAAQ,CAAA;AACV,CAAC,EATW,IAAI,KAAJ,IAAI,QASf","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 Entities\n */\n\nimport { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport {\n  AngleProps, ClipVectorProps, LowAndHighXYProps, LowAndHighXYZProps, TransformProps, XYProps, XYZProps, YawPitchRollProps,\n} from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { EntityProps } from \"./EntityProps\";\nimport { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from \"./geometry/ElementGeometry\";\nimport { GeometryStreamProps } from \"./geometry/GeometryStream\";\nimport { IModelError } from \"./IModelError\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\nimport { TextAnnotationProps } from \"./annotation/TextAnnotation\";\n\n/** Properties of a NavigationProperty.\n * @public @preview\n * @extensions\n */\nexport interface RelatedElementProps {\n  /** The Id of the element to which this element is related. */\n  id: Id64String;\n  /** The full className of the relationship class. */\n  relClassName?: string;\n}\n\n/** Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)\n * @public @preview\n * @extensions\n */\nexport interface ElementProps extends EntityProps {\n  /** The Id of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element */\n  model: Id64String;\n  /** The [Code]($docs/bis/guide/fundamentals/codes.md) for this element */\n  code: CodeProps;\n  /** The Parent of this element, if defined. */\n  parent?: RelatedElementProps;\n  /** A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element.\n   * @note  On insert, if this is a valid Guid, the value is preserved. If it is `undefined`, a new Guid is created. If it is an invalid Guid (e.g. Guid.empty), the\n   * resultant element will have a `null` federationGuid. For update, `undefined` means \"don't change.\"\n   */\n  federationGuid?: GuidString;\n  /** A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. */\n  userLabel?: string;\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. */\n  jsonProperties?: any;\n}\n\n/** The Id and relationship class of an Element that is somehow related to another Element\n * @public @preview\n */\nexport class RelatedElement implements RelatedElementProps {\n  /** The Id of the element to which this element is related. */\n  public readonly id: Id64String;\n\n  /** The full className of the relationship class. */\n  public readonly relClassName?: string;\n\n  constructor(props: RelatedElementProps) {\n    this.id = Id64.fromJSON(props.id);\n    this.relClassName = props.relClassName;\n  }\n\n  public static fromJSON(json?: RelatedElementProps): RelatedElement | undefined {\n    return json ? new RelatedElement(json) : undefined;\n  }\n\n  /** Used to *null out* an existing navigation relationship. */\n  public static readonly none = new RelatedElement({ id: Id64.invalid });\n\n  /** Accept the value of a navigation property that might be in the shortened format of just an id or might be in the full RelatedElement format. */\n  public static idFromJson(json: any): Id64String {\n    if ((typeof json === \"object\") && (\"id\" in json)) {\n      const r = RelatedElement.fromJSON(json);\n      if (r === undefined)\n        throw new IModelError(IModelStatus.BadArg, \"Problem parsing Id64 from json\");\n      return r.id;\n    }\n    return Id64.fromJSON(json);\n  }\n\n  public toJSON(): RelatedElementProps {\n    return {\n      id: this.id,\n      relClassName: this.relClassName,\n    };\n  }\n}\n\n/** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.\n * @public @preview\n */\nexport class TypeDefinition extends RelatedElement {\n}\n\n/** Properties of a [GeometricElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometricElementProps extends ElementProps {\n  /** The id of the category for this geometric element. */\n  category: Id64String;\n  /** The geometry stream properties */\n  geom?: GeometryStreamProps;\n  /** Describes how to build the element's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent element.\n   */\n  elementGeometryBuilderParams?: ElementGeometryBuilderParams;\n  /** The placement properties */\n  placement?: PlacementProps;\n}\n\n/** Properties of a [[Placement3d]]\n * @public @preview\n * @extensions\n */\nexport interface Placement3dProps {\n  origin: XYZProps;\n  angles: YawPitchRollProps;\n  bbox?: LowAndHighXYZProps;\n}\n\n/** Properties of a [[Placement2d]]\n * @public @preview\n * @extensions\n */\nexport interface Placement2dProps {\n  origin: XYProps;\n  angle: AngleProps;\n  bbox?: LowAndHighXYProps;\n}\n\n/**\n * @public @preview\n * @extensions\n */\nexport type PlacementProps = Placement2dProps | Placement3dProps;\n\n/** determine if this is Placement2dProps\n * @public @preview\n */\nexport function isPlacement2dProps(props: PlacementProps): props is Placement2dProps {\n  return (props as Placement2dProps).angle !== undefined;\n}\n\n/** determine if this is Placement3dProps\n * @public @preview\n */\nexport function isPlacement3dProps(props: PlacementProps): props is Placement3dProps {\n  return !isPlacement2dProps(props);\n}\n\n/** Properties that define a [GeometricElement3d]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometricElement3dProps extends GeometricElementProps {\n  placement?: Placement3dProps;\n  typeDefinition?: RelatedElementProps;\n}\n\n/** JSON representation of a [TextAnnotation3d]($backend).\n * @public @preview\n * @extensions\n */\nexport interface TextAnnotation3dProps extends GeometricElement3dProps {\n  jsonProperties?: {\n    [key: string]: any;\n    /** @beta */\n    annotation?: TextAnnotationProps;\n  };\n}\n\n/** Properties that define a [PhysicalElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface PhysicalElementProps extends GeometricElement3dProps {\n  physicalMaterial?: RelatedElementProps;\n}\n\n/** An enumeration of the different types of [SectionDrawing]($backend)s.\n * @public @preview\n * @extensions\n */\nexport enum SectionType {\n  Section = 3,\n  Detail = 4,\n  Elevation = 5,\n  Plan = 6,\n}\n\n/** Properties that define a [Drawing]($backend).\n * @public @preview\n * @extensions\n */\nexport interface DrawingProps extends ElementProps {\n  /** A factor used by tools to adjust the size of text in [GeometricElement2d]($backend)s in the associated [DrawingModel]($backend) and to compute the\n   * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).\n   * Default: 1.\n   * @note The scale factor **must** be greater than zero.\n   * @public @preview\n   */\n  scaleFactor?: number;\n}\n\n/** Properties that define a [SectionDrawing]($backend).\n * @public @preview\n * @extensions\n */\nexport interface SectionDrawingProps extends DrawingProps {\n  /** The type of section used to generate the drawing. Default: Section. */\n  sectionType?: SectionType;\n  /** The spatial view from which the section was generated. */\n  spatialView?: RelatedElementProps;\n  jsonProperties?: {\n    /** A transform from the section drawing model's coordinates to spatial coordinates. */\n    drawingToSpatialTransform?: TransformProps;\n    /** If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), a transform from the sheet's coordinates to spatial coordinates. */\n    sheetToSpatialTransform?: TransformProps;\n    /** If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), JSON representation of a [ClipVector]($geometry) to apply to\n     * the sheet graphics when drawn in the context of the spatial view.\n     * The ClipVector is in spatial coordinates.\n     */\n    drawingBoundaryClip?: ClipVectorProps;\n    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */\n    displaySpatialView?: true;\n  };\n}\n\n/** Properties that define a [SectionDrawingLocation]($backend)\n * @public @preview\n * @extensions\n */\nexport interface SectionDrawingLocationProps extends GeometricElement3dProps {\n  /** The [ViewDefinition]($backend) to which this location refers. */\n  sectionView?: RelatedElementProps;\n}\n\n/** Properties that define a [GeometricElement2d]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometricElement2dProps extends GeometricElementProps {\n  placement?: Placement2dProps;\n  typeDefinition?: RelatedElementProps;\n}\n\n/** JSON representation of a [TextAnnotation2d]($backend).\n * @public @preview\n * @extensions\n */\nexport interface TextAnnotation2dProps extends GeometricElement2dProps {\n  jsonProperties?: {\n    [key: string]: any;\n    /** @beta */\n    annotation?: TextAnnotationProps;\n  };\n}\n\n/** Properties of a [GeometryPart]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometryPartProps extends ElementProps {\n  geom?: GeometryStreamProps;\n  /** Describes how to build the part's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent part.\n   */\n  elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;\n  bbox?: LowAndHighXYZProps;\n}\n\n/** Properties for a [ViewAttachment]($backend)\n * @public @preview\n * @extensions\n */\nexport interface ViewAttachmentProps extends GeometricElement2dProps {\n  view: RelatedElementProps;\n  jsonProperties?: {\n    /** Integer priority in [-500,500]. Where two attachments overlap, the one with the higher priority draws in front of the other. Default: 0. */\n    displayPriority?: number;\n    /** JSON representation of a [ClipVector]($core-geometry] in sheet coordinate space, used to clip the attachment's graphics on the sheet. */\n    clip?: ClipVectorProps;\n    /** Options for customizing how the view attachment is displayed on the sheet. */\n    displayOptions?: {\n      /** If true, the view attachment is always drawn as a raster image. By default, only 3d perspective views are drawn this way (they always *must* be). Default: false. */\n      drawAsRaster?: boolean;\n      /** If true, and the view attachment is drawn as a raster image, the background color of the view will be preserved. By default the background color of the\n       * sheet is used and any background pixels become transparent, allowing the contents of the sheet to show through. Default: false.\n       */\n      preserveBackground?: boolean;\n    };\n  };\n}\n\n/** Properties of a [Subject]($backend)\n * @public @preview\n * @extensions\n */\nexport interface SubjectProps extends ElementProps {\n  description?: string;\n}\n\n/** Properties of a [SheetBorderTemplate]($backend)\n * @beta\n */\nexport interface SheetBorderTemplateProps extends ElementProps {\n  height?: number;\n  width?: number;\n}\n\n/** Properties of a [SheetTemplate]($backend)\n * @beta\n */\nexport interface SheetTemplateProps extends ElementProps {\n  height?: number;\n  width?: number;\n  border?: Id64String;\n}\n\n/** Properties of a [Sheet]($backend).\n * @public @preview\n * @extensions\n */\nexport interface SheetProps extends ElementProps {\n  width?: number;\n  height?: number;\n  scale?: number;\n  sheetTemplate?: Id64String;\n  attachments?: Id64String[];\n}\n\n/** Properties of a [DefinitionElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface DefinitionElementProps extends ElementProps {\n  isPrivate?: boolean;\n}\n\n/** Properties of a [TypeDefinitionElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface TypeDefinitionElementProps extends DefinitionElementProps {\n  recipe?: RelatedElementProps;\n}\n\n/** Properties of a [PhysicalType]($backend)\n * @public @preview\n * @extensions\n */\nexport interface PhysicalTypeProps extends TypeDefinitionElementProps {\n  /** The [PhysicalMaterial]($backend) that makes up this physical type. */\n  physicalMaterial?: RelatedElementProps;\n}\n\n/** Properties of a [InformationPartitionElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface InformationPartitionElementProps extends ElementProps {\n  description?: string;\n}\n\n/** Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].\n * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].\n * @public @preview\n * @extensions\n */\nexport interface DisplayStyleLoadProps {\n  /** If true, the lists of element Ids in the display style's schedule script will be empty.\n   * The element Ids are not required on the frontend for display and can be quite large.\n   */\n  omitScheduleScriptElementIds?: boolean;\n  /** If true, [[DisplayStyleSettingsProps.excludedElements]] will be compressed into a single compact string; otherwise they will be expanded into an array of strings.\n   * The number of Ids may be quite large, so the compressed format is preferred, especially when communicating between the backend and frontend.\n   */\n  compressExcludedElementIds?: boolean;\n}\n\n/** Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].\n * @see [[ElementLoadOptions.renderTimeline]].\n * @public @preview\n * @extensions\n */\nexport interface RenderTimelineLoadProps {\n  /** If true, the lists of element Ids in the schedule script will be empty.\n   * The element Ids can be extremely numerous and are not required on the frontend for display, so they are omitted by default by [DisplayStyleState.load]($frontend).\n   */\n  omitScriptElementIds?: boolean;\n}\n\n/** Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like\n * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).\n * @public @preview\n * @extensions\n */\nexport interface ElementLoadOptions {\n  /** if true, only load the members of [[ElementProps]], and no members from subclasses */\n  onlyBaseProperties?: boolean;\n  /** If true, include the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n   * Geometry streams can consist of many megabytes worth of JSON, so they are omitted by default.\n   */\n  wantGeometry?: boolean;\n  /** When including a geometry stream containing brep entries, whether to return the raw brep data or proxy geometry, false when undefined */\n  /** If true, include [[BRepEntity.DataProps.data]] in the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n   * The data is a potentially large base-64-encoded opaque binary blob that cannot be directly inspected or manipulated on the frontend, so it is omitted by default.\n   */\n  wantBRepData?: boolean;\n  /** Options controlling which properties of [[DisplayStyleProps]] to include or exclude. */\n  displayStyle?: DisplayStyleLoadProps;\n  /** Options controlling which properties of [[RenderTimelineProps]] to include or exclude. */\n  renderTimeline?: RenderTimelineLoadProps;\n}\n\n/** Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).\n * @public @preview\n * @extensions\n */\nexport interface ElementLoadProps extends ElementLoadOptions {\n  id?: Id64String;\n  /** The properties of the Code of the element to load.\n   * @note the Value member is required even though it is not declared so here. If no value is supplied, no element will ever be loaded.\n   * TODO: change to Required<CodeProps> in Version 4.0\n   */\n  code?: CodeProps;\n  federationGuid?: GuidString;\n}\n\n/** Properties of an [ElementAspect]($backend)\n * @public @preview\n * @extensions\n */\nexport interface ElementAspectProps extends EntityProps {\n  element: RelatedElementProps;\n}\n\n/** Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.\n * @public @preview\n * @extensions\n */\nexport interface ExternalSourceAspectProps extends ElementAspectProps {\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\n   */\n  scope: RelatedElementProps;\n  /** The identifier of the object in the source repository. */\n  identifier: string;\n  /** The kind of object within the source repository. */\n  kind: string;\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\n   * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\n   */\n  version?: string;\n  /** The optional cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. */\n  checksum?: string;\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\n   * @note Warning: if defined, jsonProperties must be a *string*, specifically a valid JSON string.\n   * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\n  */\n  jsonProperties?: any;\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\n  source?: RelatedElementProps;\n}\n\n/** Properties of an [ExternalSource]($backend)\n * @beta\n */\nexport interface ExternalSourceProps extends ElementProps {\n  repository?: RelatedElementProps;\n  connectorName?: string;\n  connectorVersion?: string;\n}\n\n/** The role that an attached [ExternalSource]($backend) plays.\n * @beta\n */\nexport enum ExternalSourceAttachmentRole {\n  /** The attached [ExternalSource]($backend) provides context. */\n  SpecifyContext = 0,\n  /** The attached [ExternalSource]($backend) models a part of the whole. */\n  SpecifyPart = 1,\n}\n\n/** Properties of an [ExternalSourceAttachment]($backend)\n * @beta\n */\nexport interface ExternalSourceAttachmentProps extends ElementProps {\n  attaches?: RelatedElementProps;\n  role?: ExternalSourceAttachmentRole;\n  translation?: XYZProps;\n  yaw?: number;\n  pitch?: number;\n  roll?: number;\n  scale?: XYZProps;\n}\n\n/** Properties of an [ChannelRootAspect]($backend) that identifies an Element as the root of a *channel* which is a subset of the overall iModel hierarchy that is independently maintained.\n * @public @preview\n * @extensions\n */\nexport interface ChannelRootAspectProps extends ElementAspectProps {\n  /** The owner of the channel */\n  owner: string;\n}\n\n/** Properties of a [LineStyle]($backend)\n * @public @preview\n * @extensions\n */\nexport interface LineStyleProps extends DefinitionElementProps {\n  description?: string;\n  /** The JSON string line style definition element data [LineStyleDefinition.StyleProps]($backend) */\n  data: string;\n}\n\n/** Properties of a [LightLocation]($backend)\n * @internal\n */\nexport interface LightLocationProps extends GeometricElement3dProps {\n  enabled?: boolean;\n}\n\n/** The *rank* for a Category\n * @public @preview\n * @extensions\n */\nexport enum Rank {\n  /** This category is predefined by the system */\n  System = 0,\n  /** This category is defined by a schema. Elements in this category are not recognized by system classes. */\n  Domain = 1,\n  /** This category is defined by an application. Elements in this category are not recognized by system and schema classes. */\n  Application = 2,\n  /** This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. */\n  User = 3,\n}\n\n/** Parameters of a [Category]($backend)\n * @public @preview\n * @extensions\n */\nexport interface CategoryProps extends DefinitionElementProps {\n  rank?: Rank;\n  description?: string;\n}\n\n/** Parameters of a [SubCategory]($backend)\n * @public @preview\n * @extensions\n */\nexport interface SubCategoryProps extends DefinitionElementProps {\n  appearance?: SubCategoryAppearance.Props;\n  description?: string;\n}\n\n/** Parameters of a [UrlLink]($backend)\n * @public @preview\n * @extensions\n */\nexport interface UrlLinkProps extends ElementProps {\n  description?: string;\n  url?: string;\n}\n\n/** Parameters of a [RepositoryLink]($backend)\n * @public @preview\n * @extensions\n */\nexport interface RepositoryLinkProps extends UrlLinkProps {\n  repositoryGuid?: GuidString;\n  format?: string;\n}\n\n/** The properties of a [SynchronizationConfigLink]($backend)\n * @beta\n */\nexport interface SynchronizationConfigLinkProps extends UrlLinkProps {\n  lastSuccessfulRun?: string;\n}\n\n/** Wire format describing a [RenderTimeline]($backend).\n * @public @preview\n * @extensions\n */\nexport interface RenderTimelineProps extends ElementProps {\n  /** An optional human-readable description of the timeline. */\n  description?: string;\n  /** The stringified JSON representation of the instructions for visualizing change over time.\n   * @see [[RenderSchedule.ScriptProps]] for the JSON interface.\n   */\n  script: string;\n}\n\n/** Properties of a [SheetIndexEntry]($backend).\n * @beta\n*/\nexport interface SheetIndexEntryProps extends ElementProps {\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\n  entryPriority: number;\n}\n\n/** Properties of a [SheetIndexFolder]($backend)\n * @beta\n */\nexport type SheetIndexFolderProps = SheetIndexEntryProps;\n\n/** Properties of a [SheetIndexReference]($backend)\n * @beta\n */\nexport interface SheetIndexReferenceProps extends SheetIndexEntryProps {\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\n  sheetIndex?: RelatedElementProps;\n}\n\n/** Properties of a [SheetReference]($backend)\n * @beta\n */\nexport interface SheetReferenceProps extends SheetIndexEntryProps {\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\n  sheet?: RelatedElementProps;\n}\n"]}
+{"version":3,"file":"ElementProps.js","sourceRoot":"","sources":["../../src/ElementProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,IAAI,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAQjF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAoC5C;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB,8DAA8D;IAC9C,EAAE,CAAa;IAE/B,oDAAoD;IACpC,YAAY,CAAU;IAEtC,YAAY,KAA0B;QACpC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAU,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAEvE,mJAAmJ;IAC5I,MAAM,CAAC,UAAU,CAAC,IAAS;QAChC,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,SAAS;gBACjB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;YAC/E,OAAO,CAAC,CAAC,EAAE,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAEM,MAAM;QACX,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,cAAc;CACjD;AA6CD;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAqB;IACtD,OAAQ,KAA0B,CAAC,KAAK,KAAK,SAAS,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAqB;IACtD,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AA+BD;;;GAGG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,iDAAU,CAAA;IACV,uDAAa,CAAA;IACb,6CAAQ,CAAA;AACV,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAiSD;;GAEG;AACH,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,gEAAgE;IAChE,mGAAkB,CAAA;IAClB,0EAA0E;IAC1E,6FAAe,CAAA;AACjB,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC;AAyCD;;;GAGG;AACH,MAAM,CAAN,IAAY,IASX;AATD,WAAY,IAAI;IACd,gDAAgD;IAChD,mCAAU,CAAA;IACV,4GAA4G;IAC5G,mCAAU,CAAA;IACV,6HAA6H;IAC7H,6CAAe,CAAA;IACf,mIAAmI;IACnI,+BAAQ,CAAA;AACV,CAAC,EATW,IAAI,KAAJ,IAAI,QASf","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 Entities\n */\n\nimport { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport {\n  AngleProps, ClipVectorProps, LowAndHighXYProps, LowAndHighXYZProps, TransformProps, XYProps, XYZProps, YawPitchRollProps,\n} from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { EntityProps } from \"./EntityProps\";\nimport { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from \"./geometry/ElementGeometry\";\nimport { GeometryStreamProps } from \"./geometry/GeometryStream\";\nimport { IModelError } from \"./IModelError\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\n\n/** Properties of a NavigationProperty.\n * @public @preview\n * @extensions\n */\nexport interface RelatedElementProps {\n  /** The Id of the element to which this element is related. */\n  id: Id64String;\n  /** The full className of the relationship class. */\n  relClassName?: string;\n}\n\n/** Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)\n * @public @preview\n * @extensions\n */\nexport interface ElementProps extends EntityProps {\n  /** The Id of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element */\n  model: Id64String;\n  /** The [Code]($docs/bis/guide/fundamentals/codes.md) for this element */\n  code: CodeProps;\n  /** The Parent of this element, if defined. */\n  parent?: RelatedElementProps;\n  /** A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element.\n   * @note  On insert, if this is a valid Guid, the value is preserved. If it is `undefined`, a new Guid is created. If it is an invalid Guid (e.g. Guid.empty), the\n   * resultant element will have a `null` federationGuid. For update, `undefined` means \"don't change.\"\n   */\n  federationGuid?: GuidString;\n  /** A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. */\n  userLabel?: string;\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. */\n  jsonProperties?: any;\n}\n\n/** The Id and relationship class of an Element that is somehow related to another Element\n * @public @preview\n */\nexport class RelatedElement implements RelatedElementProps {\n  /** The Id of the element to which this element is related. */\n  public readonly id: Id64String;\n\n  /** The full className of the relationship class. */\n  public readonly relClassName?: string;\n\n  constructor(props: RelatedElementProps) {\n    this.id = Id64.fromJSON(props.id);\n    this.relClassName = props.relClassName;\n  }\n\n  public static fromJSON(json?: RelatedElementProps): RelatedElement | undefined {\n    return json ? new RelatedElement(json) : undefined;\n  }\n\n  /** Used to *null out* an existing navigation relationship. */\n  public static readonly none = new RelatedElement({ id: Id64.invalid });\n\n  /** Accept the value of a navigation property that might be in the shortened format of just an id or might be in the full RelatedElement format. */\n  public static idFromJson(json: any): Id64String {\n    if ((typeof json === \"object\") && (\"id\" in json)) {\n      const r = RelatedElement.fromJSON(json);\n      if (r === undefined)\n        throw new IModelError(IModelStatus.BadArg, \"Problem parsing Id64 from json\");\n      return r.id;\n    }\n    return Id64.fromJSON(json);\n  }\n\n  public toJSON(): RelatedElementProps {\n    return {\n      id: this.id,\n      relClassName: this.relClassName,\n    };\n  }\n}\n\n/** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.\n * @public @preview\n */\nexport class TypeDefinition extends RelatedElement {\n}\n\n/** Properties of a [GeometricElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometricElementProps extends ElementProps {\n  /** The id of the category for this geometric element. */\n  category: Id64String;\n  /** The geometry stream properties */\n  geom?: GeometryStreamProps;\n  /** Describes how to build the element's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent element.\n   */\n  elementGeometryBuilderParams?: ElementGeometryBuilderParams;\n  /** The placement properties */\n  placement?: PlacementProps;\n}\n\n/** Properties of a [[Placement3d]]\n * @public @preview\n * @extensions\n */\nexport interface Placement3dProps {\n  origin: XYZProps;\n  angles: YawPitchRollProps;\n  bbox?: LowAndHighXYZProps;\n}\n\n/** Properties of a [[Placement2d]]\n * @public @preview\n * @extensions\n */\nexport interface Placement2dProps {\n  origin: XYProps;\n  angle: AngleProps;\n  bbox?: LowAndHighXYProps;\n}\n\n/**\n * @public @preview\n * @extensions\n */\nexport type PlacementProps = Placement2dProps | Placement3dProps;\n\n/** determine if this is Placement2dProps\n * @public @preview\n */\nexport function isPlacement2dProps(props: PlacementProps): props is Placement2dProps {\n  return (props as Placement2dProps).angle !== undefined;\n}\n\n/** determine if this is Placement3dProps\n * @public @preview\n */\nexport function isPlacement3dProps(props: PlacementProps): props is Placement3dProps {\n  return !isPlacement2dProps(props);\n}\n\n/** Properties that define a [GeometricElement3d]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometricElement3dProps extends GeometricElementProps {\n  placement?: Placement3dProps;\n  typeDefinition?: RelatedElementProps;\n}\n\n/** JSON representation of a [TextAnnotation3d]($backend).\n * @public @preview\n * @extensions\n */\nexport interface TextAnnotation3dProps extends GeometricElement3dProps {\n  /** The stringified JSON representation of the text annotation.\n   * @see [[TextAnnotationProps]] for the JSON representation.\n   * @note Don't set this property directly - use [TextAnnotation3d.setAnnotation]($backend) instead.\n   */\n  textAnnotationData?: string;\n}\n\n/** Properties that define a [PhysicalElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface PhysicalElementProps extends GeometricElement3dProps {\n  physicalMaterial?: RelatedElementProps;\n}\n\n/** An enumeration of the different types of [SectionDrawing]($backend)s.\n * @public @preview\n * @extensions\n */\nexport enum SectionType {\n  Section = 3,\n  Detail = 4,\n  Elevation = 5,\n  Plan = 6,\n}\n\n/** Properties that define a [Drawing]($backend).\n * @public @preview\n * @extensions\n */\nexport interface DrawingProps extends ElementProps {\n  /** A factor used by tools to adjust the size of text in [GeometricElement2d]($backend)s in the associated [DrawingModel]($backend) and to compute the\n   * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).\n   * Default: 1.\n   * @note The scale factor **must** be greater than zero.\n   * @public @preview\n   */\n  scaleFactor?: number;\n}\n\n/** Properties that define a [SectionDrawing]($backend).\n * @public @preview\n * @extensions\n */\nexport interface SectionDrawingProps extends DrawingProps {\n  /** The type of section used to generate the drawing. Default: Section. */\n  sectionType?: SectionType;\n  /** The spatial view from which the section was generated. */\n  spatialView?: RelatedElementProps;\n  jsonProperties?: {\n    /** A transform from the section drawing model's coordinates to spatial coordinates. */\n    drawingToSpatialTransform?: TransformProps;\n    /** If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), a transform from the sheet's coordinates to spatial coordinates. */\n    sheetToSpatialTransform?: TransformProps;\n    /** If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), JSON representation of a [ClipVector]($geometry) to apply to\n     * the sheet graphics when drawn in the context of the spatial view.\n     * The ClipVector is in spatial coordinates.\n     */\n    drawingBoundaryClip?: ClipVectorProps;\n    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */\n    displaySpatialView?: true;\n  };\n}\n\n/** Properties that define a [SectionDrawingLocation]($backend)\n * @public @preview\n * @extensions\n */\nexport interface SectionDrawingLocationProps extends GeometricElement3dProps {\n  /** The [ViewDefinition]($backend) to which this location refers. */\n  sectionView?: RelatedElementProps;\n}\n\n/** Properties that define a [GeometricElement2d]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometricElement2dProps extends GeometricElementProps {\n  placement?: Placement2dProps;\n  typeDefinition?: RelatedElementProps;\n}\n\n/** Properties that define a [TextAnnotation2d]($backend).\n * @public @preview\n * @extensions\n */\nexport interface TextAnnotation2dProps extends GeometricElement2dProps {\n  /** The stringified JSON representation of the text annotation.\n   * @see [[TextAnnotationProps]] for the JSON representation.\n   * @note Don't set this property directly - use [TextAnnotation2d.setAnnotation]($backend) instead.\n   */\n  textAnnotationData?: string;\n}\n\n/** Properties of a [GeometryPart]($backend)\n * @public @preview\n * @extensions\n */\nexport interface GeometryPartProps extends ElementProps {\n  geom?: GeometryStreamProps;\n  /** Describes how to build the part's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent part.\n   */\n  elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;\n  bbox?: LowAndHighXYZProps;\n}\n\n/** Properties for a [ViewAttachment]($backend)\n * @public @preview\n * @extensions\n */\nexport interface ViewAttachmentProps extends GeometricElement2dProps {\n  view: RelatedElementProps;\n  jsonProperties?: {\n    /** Integer priority in [-500,500]. Where two attachments overlap, the one with the higher priority draws in front of the other. Default: 0. */\n    displayPriority?: number;\n    /** JSON representation of a [ClipVector]($core-geometry] in sheet coordinate space, used to clip the attachment's graphics on the sheet. */\n    clip?: ClipVectorProps;\n    /** Options for customizing how the view attachment is displayed on the sheet. */\n    displayOptions?: {\n      /** If true, the view attachment is always drawn as a raster image. By default, only 3d perspective views are drawn this way (they always *must* be). Default: false. */\n      drawAsRaster?: boolean;\n      /** If true, and the view attachment is drawn as a raster image, the background color of the view will be preserved. By default the background color of the\n       * sheet is used and any background pixels become transparent, allowing the contents of the sheet to show through. Default: false.\n       */\n      preserveBackground?: boolean;\n    };\n  };\n}\n\n/** Properties of a [Subject]($backend)\n * @public @preview\n * @extensions\n */\nexport interface SubjectProps extends ElementProps {\n  description?: string;\n}\n\n/** Properties of a [SheetBorderTemplate]($backend)\n * @beta\n */\nexport interface SheetBorderTemplateProps extends ElementProps {\n  height?: number;\n  width?: number;\n}\n\n/** Properties of a [SheetTemplate]($backend)\n * @beta\n */\nexport interface SheetTemplateProps extends ElementProps {\n  height?: number;\n  width?: number;\n  border?: Id64String;\n}\n\n/** Properties of a [Sheet]($backend).\n * @public @preview\n * @extensions\n */\nexport interface SheetProps extends ElementProps {\n  width?: number;\n  height?: number;\n  scale?: number;\n  sheetTemplate?: Id64String;\n  attachments?: Id64String[];\n}\n\n/** Properties of a [DefinitionElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface DefinitionElementProps extends ElementProps {\n  isPrivate?: boolean;\n}\n\n/** Properties of a [TypeDefinitionElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface TypeDefinitionElementProps extends DefinitionElementProps {\n  recipe?: RelatedElementProps;\n}\n\n/** Properties of a [PhysicalType]($backend)\n * @public @preview\n * @extensions\n */\nexport interface PhysicalTypeProps extends TypeDefinitionElementProps {\n  /** The [PhysicalMaterial]($backend) that makes up this physical type. */\n  physicalMaterial?: RelatedElementProps;\n}\n\n/** Properties of a [InformationPartitionElement]($backend)\n * @public @preview\n * @extensions\n */\nexport interface InformationPartitionElementProps extends ElementProps {\n  description?: string;\n}\n\n/** Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].\n * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].\n * @public @preview\n * @extensions\n */\nexport interface DisplayStyleLoadProps {\n  /** If true, the lists of element Ids in the display style's schedule script will be empty.\n   * The element Ids are not required on the frontend for display and can be quite large.\n   */\n  omitScheduleScriptElementIds?: boolean;\n  /** If true, [[DisplayStyleSettingsProps.excludedElements]] will be compressed into a single compact string; otherwise they will be expanded into an array of strings.\n   * The number of Ids may be quite large, so the compressed format is preferred, especially when communicating between the backend and frontend.\n   */\n  compressExcludedElementIds?: boolean;\n}\n\n/** Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].\n * @see [[ElementLoadOptions.renderTimeline]].\n * @public @preview\n * @extensions\n */\nexport interface RenderTimelineLoadProps {\n  /** If true, the lists of element Ids in the schedule script will be empty.\n   * The element Ids can be extremely numerous and are not required on the frontend for display, so they are omitted by default by [DisplayStyleState.load]($frontend).\n   */\n  omitScriptElementIds?: boolean;\n}\n\n/** Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like\n * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).\n * @public @preview\n * @extensions\n */\nexport interface ElementLoadOptions {\n  /** if true, only load the members of [[ElementProps]], and no members from subclasses */\n  onlyBaseProperties?: boolean;\n  /** If true, include the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n   * Geometry streams can consist of many megabytes worth of JSON, so they are omitted by default.\n   */\n  wantGeometry?: boolean;\n  /** When including a geometry stream containing brep entries, whether to return the raw brep data or proxy geometry, false when undefined */\n  /** If true, include [[BRepEntity.DataProps.data]] in the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n   * The data is a potentially large base-64-encoded opaque binary blob that cannot be directly inspected or manipulated on the frontend, so it is omitted by default.\n   */\n  wantBRepData?: boolean;\n  /** Options controlling which properties of [[DisplayStyleProps]] to include or exclude. */\n  displayStyle?: DisplayStyleLoadProps;\n  /** Options controlling which properties of [[RenderTimelineProps]] to include or exclude. */\n  renderTimeline?: RenderTimelineLoadProps;\n}\n\n/** Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).\n * @public @preview\n * @extensions\n */\nexport interface ElementLoadProps extends ElementLoadOptions {\n  id?: Id64String;\n  /** The properties of the Code of the element to load.\n   * @note the Value member is required even though it is not declared so here. If no value is supplied, no element will ever be loaded.\n   * TODO: change to Required<CodeProps> in Version 4.0\n   */\n  code?: CodeProps;\n  federationGuid?: GuidString;\n}\n\n/** Properties of an [ElementAspect]($backend)\n * @public @preview\n * @extensions\n */\nexport interface ElementAspectProps extends EntityProps {\n  element: RelatedElementProps;\n}\n\n/** Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.\n * @public @preview\n * @extensions\n */\nexport interface ExternalSourceAspectProps extends ElementAspectProps {\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\n   */\n  scope: RelatedElementProps;\n  /** The identifier of the object in the source repository. */\n  identifier: string;\n  /** The kind of object within the source repository. */\n  kind: string;\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\n   * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\n   */\n  version?: string;\n  /** The optional cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. */\n  checksum?: string;\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\n   * @note Warning: if defined, jsonProperties must be a *string*, specifically a valid JSON string.\n   * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\n  */\n  jsonProperties?: any;\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\n  source?: RelatedElementProps;\n}\n\n/** Properties of an [ExternalSource]($backend)\n * @beta\n */\nexport interface ExternalSourceProps extends ElementProps {\n  repository?: RelatedElementProps;\n  connectorName?: string;\n  connectorVersion?: string;\n}\n\n/** The role that an attached [ExternalSource]($backend) plays.\n * @beta\n */\nexport enum ExternalSourceAttachmentRole {\n  /** The attached [ExternalSource]($backend) provides context. */\n  SpecifyContext = 0,\n  /** The attached [ExternalSource]($backend) models a part of the whole. */\n  SpecifyPart = 1,\n}\n\n/** Properties of an [ExternalSourceAttachment]($backend)\n * @beta\n */\nexport interface ExternalSourceAttachmentProps extends ElementProps {\n  attaches?: RelatedElementProps;\n  role?: ExternalSourceAttachmentRole;\n  translation?: XYZProps;\n  yaw?: number;\n  pitch?: number;\n  roll?: number;\n  scale?: XYZProps;\n}\n\n/** Properties of an [ChannelRootAspect]($backend) that identifies an Element as the root of a *channel* which is a subset of the overall iModel hierarchy that is independently maintained.\n * @public @preview\n * @extensions\n */\nexport interface ChannelRootAspectProps extends ElementAspectProps {\n  /** The owner of the channel */\n  owner: string;\n}\n\n/** Properties of a [LineStyle]($backend)\n * @public @preview\n * @extensions\n */\nexport interface LineStyleProps extends DefinitionElementProps {\n  description?: string;\n  /** The JSON string line style definition element data [LineStyleDefinition.StyleProps]($backend) */\n  data: string;\n}\n\n/** Properties of a [LightLocation]($backend)\n * @internal\n */\nexport interface LightLocationProps extends GeometricElement3dProps {\n  enabled?: boolean;\n}\n\n/** The *rank* for a Category\n * @public @preview\n * @extensions\n */\nexport enum Rank {\n  /** This category is predefined by the system */\n  System = 0,\n  /** This category is defined by a schema. Elements in this category are not recognized by system classes. */\n  Domain = 1,\n  /** This category is defined by an application. Elements in this category are not recognized by system and schema classes. */\n  Application = 2,\n  /** This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. */\n  User = 3,\n}\n\n/** Parameters of a [Category]($backend)\n * @public @preview\n * @extensions\n */\nexport interface CategoryProps extends DefinitionElementProps {\n  rank?: Rank;\n  description?: string;\n}\n\n/** Parameters of a [SubCategory]($backend)\n * @public @preview\n * @extensions\n */\nexport interface SubCategoryProps extends DefinitionElementProps {\n  appearance?: SubCategoryAppearance.Props;\n  description?: string;\n}\n\n/** Parameters of a [UrlLink]($backend)\n * @public @preview\n * @extensions\n */\nexport interface UrlLinkProps extends ElementProps {\n  description?: string;\n  url?: string;\n}\n\n/** Parameters of a [RepositoryLink]($backend)\n * @public @preview\n * @extensions\n */\nexport interface RepositoryLinkProps extends UrlLinkProps {\n  repositoryGuid?: GuidString;\n  format?: string;\n}\n\n/** The properties of a [SynchronizationConfigLink]($backend)\n * @beta\n */\nexport interface SynchronizationConfigLinkProps extends UrlLinkProps {\n  lastSuccessfulRun?: string;\n}\n\n/** Wire format describing a [RenderTimeline]($backend).\n * @public @preview\n * @extensions\n */\nexport interface RenderTimelineProps extends ElementProps {\n  /** An optional human-readable description of the timeline. */\n  description?: string;\n  /** The stringified JSON representation of the instructions for visualizing change over time.\n   * @see [[RenderSchedule.ScriptProps]] for the JSON interface.\n   */\n  script: string;\n}\n\n/** Properties of a [SheetIndexEntry]($backend).\n * @beta\n*/\nexport interface SheetIndexEntryProps extends ElementProps {\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\n  entryPriority: number;\n}\n\n/** Properties of a [SheetIndexFolder]($backend)\n * @beta\n */\nexport type SheetIndexFolderProps = SheetIndexEntryProps;\n\n/** Properties of a [SheetIndexReference]($backend)\n * @beta\n */\nexport interface SheetIndexReferenceProps extends SheetIndexEntryProps {\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\n  sheetIndex?: RelatedElementProps;\n}\n\n/** Properties of a [SheetReference]($backend)\n * @beta\n */\nexport interface SheetReferenceProps extends SheetIndexEntryProps {\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\n  sheet?: RelatedElementProps;\n}\n\n/** Properties that define an [AnnotationTextStyle]($backend).\n * @beta\n */\nexport interface AnnotationTextStyleProps extends DefinitionElementProps {\n  /** An optional human-readable description of the text style.*/\n  description?: string;\n  /** The stringified JSON representation of the text style.\n   * @see [[TextStyleSettingsProps]]\n   */\n  settings?: string;\n}"]}

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

@@ -3,7 +3,7 @@
  */
 import { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
 import { TextBlock, TextBlockProps } from "./TextBlock";
-import { TextStyleColor, TextStyleSettingsProps } from "./TextStyle";
+import { TextStyleSettingsProps } from "./TextStyle";
 /** Describes how to compute the "anchor point" for a [[TextAnnotation]].
  * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].
  * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point
@@ -28,35 +28,6 @@ export interface TextAnnotationAnchor {
      */
     horizontal: "left" | "center" | "right";
 }
-/** 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`.
- * @beta
- */
-export type TextAnnotationFillColor = TextStyleColor | "background";
-/**
- * Describes how to draw the frame around a [[TextBlock]].
- * The frame can be a simple line, a filled shape, or both.
- * @beta
- */
-export interface TextFrameStyleProps {
-    /** Shape of the frame. Default: "rectangle" */
-    shape?: TextAnnotationFrameShape;
-    /** The color to fill the shape of the text frame. This fill will is applied using [[FillDisplay.Blanking]]. Default: no fill */
-    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;
-}
 /**
  * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].
  * Leader can be attached using one of the three modes:
@@ -122,8 +93,6 @@ export interface TextAnnotationLeaderProps {
     /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */
     styleOverrides?: TextStyleSettingsProps;
 }
-/**
-
 /**
  * JSON representation of a [[TextAnnotation]].
  * @beta
@@ -137,8 +106,6 @@ export interface TextAnnotationProps {
     textBlock?: TextBlockProps;
     /** See [[TextAnnotation.anchor]]. Default: top-left. */
     anchor?: TextAnnotationAnchor;
-    /** See [[TextAnnotation.frame]]. Default: no frame */
-    frame?: TextFrameStyleProps;
     /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
     leaders?: TextAnnotationLeaderProps[];
 }
@@ -154,8 +121,6 @@ export interface TextAnnotationCreateArgs {
     textBlock?: TextBlock;
     /** See [[TextAnnotation.anchor]]. Default: top-left. */
     anchor?: TextAnnotationAnchor;
-    /** See [[TextAnnotation.frame]]. Default: no frame */
-    frame?: TextFrameStyleProps;
     /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
     leaders?: TextAnnotationLeader[];
 }
@@ -183,8 +148,6 @@ export declare class TextAnnotation {
     anchor: TextAnnotationAnchor;
     /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */
     offset: Point3d;
-    /** The frame settings of the text annotation. */
-    frame?: TextFrameStyleProps;
     /** The leaders of the text annotation. */
     leaders?: TextAnnotationLeader[];
     private constructor();
@@ -203,11 +166,13 @@ export declare class TextAnnotation {
      * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.
      * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].
      * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.
+     * If a scale factor is specified, the transform will also scale the annotation by that factor. Usually, this should come from the [[Drawing]] containing the annotation.
      * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.
+     * @param scaleFactor A factor by which to scale the annotation. Default: 1 (no scaling).
      * @see [[computeAnchorPoint]] to compute the transform's anchor point.
      * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.
      */
-    computeTransform(boundingBox: Range2d): Transform;
+    computeTransform(boundingBox: Range2d, scaleFactor?: number): Transform;
     /** Compute the anchor point of this annotation as specified by [[anchor]].
      * @param boundingBox A box fully containing the [[textBlock]].
      * @see [[computeTransform]] to compute the transform relative to the anchor point.

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

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,gIAAgI;IAChI,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,aAAa,CAAA;AAE1F;;;;;;;EAOE;AACF,MAAM,WAAW,oBAAoB;IACnC;yEACqE;IACrE,UAAU,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,UAAU,EAAE,gBAAgB,CAAC;IAC7B;;+LAE2L;IAC3L,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,QAAQ,CAAC;IACrB,+CAA+C;IAC/C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChC,gFAAgF;IAChF,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,iDAAiD;IAC1C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IACnC,0CAA0C;IACnC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExC,OAAO;IASP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IAYrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAgB9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAgCpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0FAA0F;IAC1F,OAAO,CAAC,eAAe;IAsBvB,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAmB9C"}
+{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,aAAa,CAAA;AAE1F;;;;;;;EAOE;AACF,MAAM,WAAW,oBAAoB;IACnC;yEACqE;IACrE,UAAU,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,UAAU,EAAE,gBAAgB,CAAC;IAC7B;;+LAE2L;IAC3L,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,QAAQ,CAAC;IACrB,+CAA+C;IAC/C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChC,gFAAgF;IAChF,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,qEAAqE;IACrE,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,qEAAqE;IACrE,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,0CAA0C;IACnC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExC,OAAO;IAQP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IASrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAe9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IA6BpC;;;;;;;;;;OAUG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,GAAE,MAAU,GAAG,SAAS;IAcjF;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0FAA0F;IAC1F,OAAO,CAAC,eAAe;IAsBvB,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAW9C"}