@itwin/core-common 5.13.0-dev.9 → 5.14.0-dev.2

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;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;AAoCD;;;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;AAsSD;;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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Entities\r\n */\r\n\r\nimport { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  AngleProps, ClipVectorProps, LowAndHighXYProps, LowAndHighXYZProps, TransformProps, XYProps, XYZProps, YawPitchRollProps,\r\n} from \"@itwin/core-geometry\";\r\nimport { CodeProps } from \"./Code\";\r\nimport { EntityProps } from \"./EntityProps\";\r\nimport { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from \"./geometry/ElementGeometry\";\r\nimport { GeometryStreamProps } from \"./geometry/GeometryStream\";\r\nimport { IModelError } from \"./IModelError\";\r\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\r\n\r\n/** Properties of a NavigationProperty.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RelatedElementProps {\r\n  /** The Id of the element to which this element is related. */\r\n  id: Id64String;\r\n  /** The full className of the relationship class. */\r\n  relClassName?: string;\r\n}\r\n\r\n/** Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementProps extends EntityProps {\r\n  /** The Id of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element */\r\n  model: Id64String;\r\n  /** The [Code]($docs/bis/guide/fundamentals/codes.md) for this element */\r\n  code: CodeProps;\r\n  /** The Parent of this element, if defined. */\r\n  parent?: RelatedElementProps;\r\n  /** A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element.\r\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\r\n   * resultant element will have a `null` federationGuid. For update, `undefined` means \"don't change.\"\r\n   */\r\n  federationGuid?: GuidString;\r\n  /** A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. */\r\n  userLabel?: string;\r\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. */\r\n  jsonProperties?: any;\r\n}\r\n\r\n/** The Id and relationship class of an Element that is somehow related to another Element\r\n * @public @preview\r\n */\r\nexport class RelatedElement implements RelatedElementProps {\r\n  /** The Id of the element to which this element is related. */\r\n  public readonly id: Id64String;\r\n\r\n  /** The full className of the relationship class. */\r\n  public readonly relClassName?: string;\r\n\r\n  constructor(props: RelatedElementProps) {\r\n    this.id = Id64.fromJSON(props.id);\r\n    this.relClassName = props.relClassName;\r\n  }\r\n\r\n  public static fromJSON(json?: RelatedElementProps): RelatedElement | undefined {\r\n    return json ? new RelatedElement(json) : undefined;\r\n  }\r\n\r\n  /** Used to *null out* an existing navigation relationship. */\r\n  public static readonly none = new RelatedElement({ id: Id64.invalid });\r\n\r\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. */\r\n  public static idFromJson(json: any): Id64String {\r\n    if ((typeof json === \"object\") && (\"id\" in json)) {\r\n      const r = RelatedElement.fromJSON(json);\r\n      if (r === undefined)\r\n        throw new IModelError(IModelStatus.BadArg, \"Problem parsing Id64 from json\");\r\n      return r.id;\r\n    }\r\n    return Id64.fromJSON(json);\r\n  }\r\n\r\n  public toJSON(): RelatedElementProps {\r\n    return {\r\n      id: this.id,\r\n      relClassName: this.relClassName,\r\n    };\r\n  }\r\n}\r\n\r\n/** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.\r\n * @public @preview\r\n */\r\nexport class TypeDefinition extends RelatedElement {\r\n}\r\n\r\n/** Properties of a [GeometricElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometricElementProps extends ElementProps {\r\n  /** The id of the category for this geometric element. */\r\n  category: Id64String;\r\n  /** The geometry stream properties */\r\n  geom?: GeometryStreamProps;\r\n  /** Describes how to build the element's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\r\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent element.\r\n   */\r\n  elementGeometryBuilderParams?: ElementGeometryBuilderParams;\r\n  /** The placement properties */\r\n  placement?: PlacementProps;\r\n}\r\n\r\n/** Properties of a [[Placement3d]]\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface Placement3dProps {\r\n  origin: XYZProps;\r\n  angles: YawPitchRollProps;\r\n  bbox?: LowAndHighXYZProps;\r\n}\r\n\r\n/** Properties of a [[Placement2d]]\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface Placement2dProps {\r\n  origin: XYProps;\r\n  angle: AngleProps;\r\n  bbox?: LowAndHighXYProps;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport type PlacementProps = Placement2dProps | Placement3dProps;\r\n\r\n/** determine if this is Placement2dProps\r\n * @public @preview\r\n */\r\nexport function isPlacement2dProps(props: PlacementProps): props is Placement2dProps {\r\n  return (props as Placement2dProps).angle !== undefined;\r\n}\r\n\r\n/** determine if this is Placement3dProps\r\n * @public @preview\r\n */\r\nexport function isPlacement3dProps(props: PlacementProps): props is Placement3dProps {\r\n  return !isPlacement2dProps(props);\r\n}\r\n\r\n/** Properties that define a [GeometricElement3d]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometricElement3dProps extends GeometricElementProps {\r\n  placement?: Placement3dProps;\r\n  typeDefinition?: RelatedElementProps;\r\n}\r\n\r\n/** JSON representation of a [TextAnnotation3d]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface TextAnnotation3dProps extends GeometricElement3dProps {\r\n  /** The stringified versioned JSON representation of the text annotation.\r\n   * @see [[VersionedJSON]] for the JSON representation.\r\n   * @see [[TextAnnotationProps]] for the data model.\r\n   * @note Don't set this property directly - use [TextAnnotation3d.setAnnotation]($backend) instead.\r\n   */\r\n  textAnnotationData?: string;\r\n  /** The default [AnnotationTextStyle]($backend) element used by the text annotation.\r\n   * @beta\r\n   */\r\n  defaultTextStyle?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define a [PhysicalElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface PhysicalElementProps extends GeometricElement3dProps {\r\n  physicalMaterial?: RelatedElementProps;\r\n}\r\n\r\n/** An enumeration of the different types of [SectionDrawing]($backend)s.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport enum SectionType {\r\n  Section = 3,\r\n  Detail = 4,\r\n  Elevation = 5,\r\n  Plan = 6,\r\n}\r\n\r\n/** Properties that define a [Drawing]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface DrawingProps extends ElementProps {\r\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\r\n   * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).\r\n   * Default: 1.\r\n   * @note The scale factor **must** be greater than zero.\r\n   * @public @preview\r\n   */\r\n  scaleFactor?: number;\r\n}\r\n\r\n/** Properties that define a [SectionDrawing]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SectionDrawingProps extends DrawingProps {\r\n  /** The type of section used to generate the drawing. Default: Section. */\r\n  sectionType?: SectionType;\r\n  /** The spatial view from which the section was generated. */\r\n  spatialView?: RelatedElementProps;\r\n  jsonProperties?: {\r\n    /** A transform from the section drawing model's coordinates to spatial coordinates. */\r\n    drawingToSpatialTransform?: TransformProps;\r\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. */\r\n    sheetToSpatialTransform?: TransformProps;\r\n    /** If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), JSON representation of a [ClipVector]($geometry) to apply to\r\n     * the sheet graphics when drawn in the context of the spatial view.\r\n     * The ClipVector is in spatial coordinates.\r\n     */\r\n    drawingBoundaryClip?: ClipVectorProps;\r\n    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */\r\n    displaySpatialView?: true;\r\n  };\r\n}\r\n\r\n/** Properties that define a [SectionDrawingLocation]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SectionDrawingLocationProps extends GeometricElement3dProps {\r\n  /** The [ViewDefinition]($backend) to which this location refers. */\r\n  sectionView?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define a [GeometricElement2d]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometricElement2dProps extends GeometricElementProps {\r\n  placement?: Placement2dProps;\r\n  typeDefinition?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define a [TextAnnotation2d]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface TextAnnotation2dProps extends GeometricElement2dProps {\r\n  /** The stringified versioned JSON representation of the text annotation.\r\n   * @see [[VersionedJSON]] for the JSON representation.\r\n   * @see [[TextAnnotationProps]] for the data model.\r\n   * @note Don't set this property directly - use [TextAnnotation2d.setAnnotation]($backend) instead.\r\n   */\r\n  textAnnotationData?: string;\r\n  /** The default [AnnotationTextStyle]($backend) element used by the text annotation.\r\n   * @beta\r\n   */\r\n  defaultTextStyle?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [GeometryPart]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometryPartProps extends ElementProps {\r\n  geom?: GeometryStreamProps;\r\n  /** Describes how to build the part's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\r\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent part.\r\n   */\r\n  elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;\r\n  bbox?: LowAndHighXYZProps;\r\n}\r\n\r\n/** Properties for a [ViewAttachment]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ViewAttachmentProps extends GeometricElement2dProps {\r\n  view: RelatedElementProps;\r\n  jsonProperties?: {\r\n    /** Integer priority in [-500,500]. Where two attachments overlap, the one with the higher priority draws in front of the other. Default: 0. */\r\n    displayPriority?: number;\r\n    /** JSON representation of a [ClipVector]($core-geometry] in sheet coordinate space, used to clip the attachment's graphics on the sheet. */\r\n    clip?: ClipVectorProps;\r\n    /** Options for customizing how the view attachment is displayed on the sheet. */\r\n    displayOptions?: {\r\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. */\r\n      drawAsRaster?: boolean;\r\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\r\n       * sheet is used and any background pixels become transparent, allowing the contents of the sheet to show through. Default: false.\r\n       */\r\n      preserveBackground?: boolean;\r\n    };\r\n  };\r\n}\r\n\r\n/** Properties of a [Subject]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SubjectProps extends ElementProps {\r\n  description?: string;\r\n}\r\n\r\n/** Properties of a [SheetBorderTemplate]($backend)\r\n * @beta\r\n */\r\nexport interface SheetBorderTemplateProps extends ElementProps {\r\n  height?: number;\r\n  width?: number;\r\n}\r\n\r\n/** Properties of a [SheetTemplate]($backend)\r\n * @beta\r\n */\r\nexport interface SheetTemplateProps extends ElementProps {\r\n  height?: number;\r\n  width?: number;\r\n  border?: Id64String;\r\n}\r\n\r\n/** Properties of a [Sheet]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SheetProps extends ElementProps {\r\n  width?: number;\r\n  height?: number;\r\n  scale?: number;\r\n  sheetTemplate?: Id64String;\r\n  attachments?: Id64String[];\r\n}\r\n\r\n/** Properties of a [DefinitionElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface DefinitionElementProps extends ElementProps {\r\n  isPrivate?: boolean;\r\n}\r\n\r\n/** Properties of a [TypeDefinitionElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface TypeDefinitionElementProps extends DefinitionElementProps {\r\n  recipe?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [PhysicalType]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface PhysicalTypeProps extends TypeDefinitionElementProps {\r\n  /** The [PhysicalMaterial]($backend) that makes up this physical type. */\r\n  physicalMaterial?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [InformationPartitionElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface InformationPartitionElementProps extends ElementProps {\r\n  description?: string;\r\n}\r\n\r\n/** Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].\r\n * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface DisplayStyleLoadProps {\r\n  /** If true, the lists of element Ids in the display style's schedule script will be empty.\r\n   * The element Ids are not required on the frontend for display and can be quite large.\r\n   */\r\n  omitScheduleScriptElementIds?: boolean;\r\n  /** If true, [[DisplayStyleSettingsProps.excludedElements]] will be compressed into a single compact string; otherwise they will be expanded into an array of strings.\r\n   * The number of Ids may be quite large, so the compressed format is preferred, especially when communicating between the backend and frontend.\r\n   */\r\n  compressExcludedElementIds?: boolean;\r\n}\r\n\r\n/** Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].\r\n * @see [[ElementLoadOptions.renderTimeline]].\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RenderTimelineLoadProps {\r\n  /** If true, the lists of element Ids in the schedule script will be empty.\r\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).\r\n   */\r\n  omitScriptElementIds?: boolean;\r\n}\r\n\r\n/** Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like\r\n * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementLoadOptions {\r\n  /** if true, only load the members of [[ElementProps]], and no members from subclasses */\r\n  onlyBaseProperties?: boolean;\r\n  /** If true, include the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\r\n   * Geometry streams can consist of many megabytes worth of JSON, so they are omitted by default.\r\n   */\r\n  wantGeometry?: boolean;\r\n  /** When including a geometry stream containing brep entries, whether to return the raw brep data or proxy geometry, false when undefined */\r\n  /** If true, include [[BRepEntity.DataProps.data]] in the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\r\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.\r\n   */\r\n  wantBRepData?: boolean;\r\n  /** Options controlling which properties of [[DisplayStyleProps]] to include or exclude. */\r\n  displayStyle?: DisplayStyleLoadProps;\r\n  /** Options controlling which properties of [[RenderTimelineProps]] to include or exclude. */\r\n  renderTimeline?: RenderTimelineLoadProps;\r\n}\r\n\r\n/** Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementLoadProps extends ElementLoadOptions {\r\n  id?: Id64String;\r\n  /** The properties of the Code of the element to load.\r\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.\r\n   * TODO: change to Required<CodeProps> in Version 4.0\r\n   */\r\n  code?: CodeProps;\r\n  federationGuid?: GuidString;\r\n}\r\n\r\n/** Properties of an [ElementAspect]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementAspectProps extends EntityProps {\r\n  element: RelatedElementProps;\r\n}\r\n\r\n/** Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ExternalSourceAspectProps extends ElementAspectProps {\r\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\r\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\r\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\r\n   */\r\n  scope: RelatedElementProps;\r\n  /** The identifier of the object in the source repository. */\r\n  identifier: string;\r\n  /** The kind of object within the source repository. */\r\n  kind: string;\r\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\r\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.\r\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\r\n   */\r\n  version?: string;\r\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. */\r\n  checksum?: string;\r\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\r\n   * @note Warning: if defined, jsonProperties must be a *string*, specifically a valid JSON string.\r\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.\r\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\r\n  */\r\n  jsonProperties?: any;\r\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\r\n  source?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of an [ExternalSource]($backend)\r\n * @beta\r\n */\r\nexport interface ExternalSourceProps extends ElementProps {\r\n  repository?: RelatedElementProps;\r\n  connectorName?: string;\r\n  connectorVersion?: string;\r\n}\r\n\r\n/** The role that an attached [ExternalSource]($backend) plays.\r\n * @beta\r\n */\r\nexport enum ExternalSourceAttachmentRole {\r\n  /** The attached [ExternalSource]($backend) provides context. */\r\n  SpecifyContext = 0,\r\n  /** The attached [ExternalSource]($backend) models a part of the whole. */\r\n  SpecifyPart = 1,\r\n}\r\n\r\n/** Properties of an [ExternalSourceAttachment]($backend)\r\n * @beta\r\n */\r\nexport interface ExternalSourceAttachmentProps extends ElementProps {\r\n  attaches?: RelatedElementProps;\r\n  role?: ExternalSourceAttachmentRole;\r\n  translation?: XYZProps;\r\n  yaw?: number;\r\n  pitch?: number;\r\n  roll?: number;\r\n  scale?: XYZProps;\r\n}\r\n\r\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.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ChannelRootAspectProps extends ElementAspectProps {\r\n  /** The owner of the channel */\r\n  owner: string;\r\n}\r\n\r\n/** Properties of a [LineStyle]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface LineStyleProps extends DefinitionElementProps {\r\n  description?: string;\r\n  /** The JSON string line style definition element data [LineStyleDefinition.StyleProps]($backend) */\r\n  data: string;\r\n}\r\n\r\n/** Properties of a [LightLocation]($backend)\r\n * @internal\r\n */\r\nexport interface LightLocationProps extends GeometricElement3dProps {\r\n  enabled?: boolean;\r\n}\r\n\r\n/** The *rank* for a Category\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport enum Rank {\r\n  /** This category is predefined by the system */\r\n  System = 0,\r\n  /** This category is defined by a schema. Elements in this category are not recognized by system classes. */\r\n  Domain = 1,\r\n  /** This category is defined by an application. Elements in this category are not recognized by system and schema classes. */\r\n  Application = 2,\r\n  /** This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. */\r\n  User = 3,\r\n}\r\n\r\n/** Parameters of a [Category]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface CategoryProps extends DefinitionElementProps {\r\n  rank?: Rank;\r\n  description?: string;\r\n}\r\n\r\n/** Parameters of a [SubCategory]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SubCategoryProps extends DefinitionElementProps {\r\n  appearance?: SubCategoryAppearance.Props;\r\n  description?: string;\r\n}\r\n\r\n/** Parameters of a [UrlLink]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface UrlLinkProps extends ElementProps {\r\n  description?: string;\r\n  url?: string;\r\n}\r\n\r\n/** Parameters of a [RepositoryLink]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RepositoryLinkProps extends UrlLinkProps {\r\n  repositoryGuid?: GuidString;\r\n  format?: string;\r\n}\r\n\r\n/** The properties of a [SynchronizationConfigLink]($backend)\r\n * @beta\r\n */\r\nexport interface SynchronizationConfigLinkProps extends UrlLinkProps {\r\n  lastSuccessfulRun?: string;\r\n}\r\n\r\n/** Wire format describing a [RenderTimeline]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RenderTimelineProps extends ElementProps {\r\n  /** An optional human-readable description of the timeline. */\r\n  description?: string;\r\n  /** The stringified JSON representation of the instructions for visualizing change over time.\r\n   * @see [[RenderSchedule.ScriptProps]] for the JSON interface.\r\n   */\r\n  script: string;\r\n}\r\n\r\n/** Properties of a [SheetIndexEntry]($backend).\r\n * @beta\r\n*/\r\nexport interface SheetIndexEntryProps extends ElementProps {\r\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\r\n  entryPriority: number;\r\n}\r\n\r\n/** Properties of a [SheetIndexFolder]($backend)\r\n * @beta\r\n */\r\nexport type SheetIndexFolderProps = SheetIndexEntryProps;\r\n\r\n/** Properties of a [SheetIndexReference]($backend)\r\n * @beta\r\n */\r\nexport interface SheetIndexReferenceProps extends SheetIndexEntryProps {\r\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\r\n  sheetIndex?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [SheetReference]($backend)\r\n * @beta\r\n */\r\nexport interface SheetReferenceProps extends SheetIndexEntryProps {\r\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\r\n  sheet?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define an [AnnotationTextStyle]($backend).\r\n * @beta\r\n */\r\nexport interface AnnotationTextStyleProps extends DefinitionElementProps {\r\n  /** An optional human-readable description of the text style.*/\r\n  description?: string;\r\n  /** The stringified versioned JSON representation of the text style.\r\n   * @see [[VersionedJSON]] for the JSON representation.\r\n   * @see [[TextStyleSettingsProps]] for the data model.\r\n   */\r\n  settings?: string;\r\n}\r\n\r\n/** A string in the format `read.write.minor` where the semantics match those of [ECVersion]($ecschema-metadata).\r\n * @beta\r\n */\r\nexport type ECVersionString = `${string}.${string}.${string}`\r\n\r\n/** Wrapper for versioned JSON data.\r\n * @beta\r\n */\r\nexport interface VersionedJSON<T> {\r\n  /** The semver version of the JSON data.\r\n   * Uses the same semantics as [ECVersion]($ecschema-metadata).\r\n   */\r\n  version: ECVersionString;\r\n  /** The JSON data. */\r\n  data: T;\r\n}\r\n\r\n/** Project-level properties hosted by a [ProjectInformationRecord]($backend) element.\r\n * @beta\r\n */\r\nexport interface ProjectInformation {\r\n  /** A name that uniquely identifies this project within an organization. */\r\n  projectNumber?: string;\r\n  /** A human-readable display label for the project. Unlike [[projectNumber]], this needn't be unique. */\r\n  projectName?: string;\r\n  /** A human-readable description of the geographic location of the project - often, the name of a city or a street address. */\r\n  location?: string;\r\n}\r\n\r\n/** JSON representation of a [ProjectInformationRecord]($backend).\r\n * @beta\r\n */\r\nexport type ProjectInformationRecordProps = ElementProps & ProjectInformation;\r\n\r\n/** Captures basic metadata about a [Sheet]($backend). This information is typically included in the Sheet's graphical representation, often\r\n * as part of its title block.\r\n * This information is stored in a [SheetInformationAspect]($backend).\r\n * @beta\r\n */\r\nexport interface SheetInformation {\r\n  /** A user-supplied string describing who designed the sheet contents. */\r\n  designedBy?: string;\r\n  /** A user-supplied date describing when the sheet contents were designed. */\r\n  designedDate?: Date;\r\n  /** A user-supplied string describing who drew the sheet contents. */\r\n  drawnBy?: string;\r\n  /** A user-supplied string describing who verified the sheet contents. */\r\n  checkedBy?: string;\r\n}\r\n\r\n/** JSON representation of a [[SheetInformation]].\r\n * @beta\r\n */\r\nexport interface SheetInformationProps {\r\n  /** A user-supplied string describing who designed the sheet contents. */\r\n  designedBy?: string;\r\n  /** The [ISO string representation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) of a user-supplied date describing when the sheet contents were designed. */\r\n  designedDate?: string;\r\n  /** A user-supplied string describing who drew the sheet contents. */\r\n  drawnBy?: string;\r\n  /** A user-supplied string describing who verified the sheet contents. */\r\n  checkedBy?: string;\r\n}\r\n\r\n/** JSON representation of a [SheetInformationAspect]($backend).\r\n * @beta\r\n */\r\nexport type SheetInformationAspectProps = ElementAspectProps & SheetInformationProps;\r\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;AAoCD;;;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;AAsSD;;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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Entities\r\n */\r\n\r\nimport { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  AngleProps, ClipVectorProps, LowAndHighXYProps, LowAndHighXYZProps, TransformProps, XYProps, XYZProps, YawPitchRollProps,\r\n} from \"@itwin/core-geometry\";\r\nimport { CodeProps } from \"./Code\";\r\nimport { EntityProps } from \"./EntityProps\";\r\nimport { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from \"./geometry/ElementGeometry\";\r\nimport { GeometryStreamProps } from \"./geometry/GeometryStream\";\r\nimport { IModelError } from \"./IModelError\";\r\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\r\n\r\n/** Properties of a NavigationProperty.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RelatedElementProps {\r\n  /** The Id of the element to which this element is related. */\r\n  id: Id64String;\r\n  /** The full className of the relationship class. */\r\n  relClassName?: string;\r\n}\r\n\r\n/** Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementProps extends EntityProps {\r\n  /** The Id of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element */\r\n  model: Id64String;\r\n  /** The [Code]($docs/bis/guide/fundamentals/codes.md) for this element */\r\n  code: CodeProps;\r\n  /** The Parent of this element, if defined. */\r\n  parent?: RelatedElementProps;\r\n  /** A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element.\r\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\r\n   * resultant element will have a `null` federationGuid. For update, `undefined` means \"don't change.\"\r\n   */\r\n  federationGuid?: GuidString;\r\n  /** A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. */\r\n  userLabel?: string;\r\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. */\r\n  jsonProperties?: any;\r\n}\r\n\r\n/** The Id and relationship class of an Element that is somehow related to another Element\r\n * @public @preview\r\n */\r\nexport class RelatedElement implements RelatedElementProps {\r\n  /** The Id of the element to which this element is related. */\r\n  public readonly id: Id64String;\r\n\r\n  /** The full className of the relationship class. */\r\n  public readonly relClassName?: string;\r\n\r\n  constructor(props: RelatedElementProps) {\r\n    this.id = Id64.fromJSON(props.id);\r\n    this.relClassName = props.relClassName;\r\n  }\r\n\r\n  public static fromJSON(json?: RelatedElementProps): RelatedElement | undefined {\r\n    return json ? new RelatedElement(json) : undefined;\r\n  }\r\n\r\n  /** Used to *null out* an existing navigation relationship. */\r\n  public static readonly none = new RelatedElement({ id: Id64.invalid });\r\n\r\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. */\r\n  public static idFromJson(json: any): Id64String {\r\n    if ((typeof json === \"object\") && (\"id\" in json)) {\r\n      const r = RelatedElement.fromJSON(json);\r\n      if (r === undefined)\r\n        throw new IModelError(IModelStatus.BadArg, \"Problem parsing Id64 from json\");\r\n      return r.id;\r\n    }\r\n    return Id64.fromJSON(json);\r\n  }\r\n\r\n  public toJSON(): RelatedElementProps {\r\n    return {\r\n      id: this.id,\r\n      relClassName: this.relClassName,\r\n    };\r\n  }\r\n}\r\n\r\n/** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.\r\n * @public @preview\r\n */\r\nexport class TypeDefinition extends RelatedElement {\r\n}\r\n\r\n/** Properties of a [GeometricElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometricElementProps extends ElementProps {\r\n  /** The id of the category for this geometric element. */\r\n  category: Id64String;\r\n  /** The geometry stream properties */\r\n  geom?: GeometryStreamProps;\r\n  /** Describes how to build the element's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\r\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent element.\r\n   */\r\n  elementGeometryBuilderParams?: ElementGeometryBuilderParams;\r\n  /** The placement properties */\r\n  placement?: PlacementProps;\r\n}\r\n\r\n/** Properties of a [[Placement3d]]\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface Placement3dProps {\r\n  origin: XYZProps;\r\n  angles: YawPitchRollProps;\r\n  bbox?: LowAndHighXYZProps;\r\n}\r\n\r\n/** Properties of a [[Placement2d]]\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface Placement2dProps {\r\n  origin: XYProps;\r\n  angle: AngleProps;\r\n  bbox?: LowAndHighXYProps;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport type PlacementProps = Placement2dProps | Placement3dProps;\r\n\r\n/** determine if this is Placement2dProps\r\n * @public @preview\r\n */\r\nexport function isPlacement2dProps(props: PlacementProps): props is Placement2dProps {\r\n  return (props as Placement2dProps).angle !== undefined;\r\n}\r\n\r\n/** determine if this is Placement3dProps\r\n * @public @preview\r\n */\r\nexport function isPlacement3dProps(props: PlacementProps): props is Placement3dProps {\r\n  return !isPlacement2dProps(props);\r\n}\r\n\r\n/** Properties that define a [GeometricElement3d]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometricElement3dProps extends GeometricElementProps {\r\n  placement?: Placement3dProps;\r\n  typeDefinition?: RelatedElementProps;\r\n}\r\n\r\n/** JSON representation of a [TextAnnotation3d]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface TextAnnotation3dProps extends GeometricElement3dProps {\r\n  /** The stringified versioned JSON representation of the text annotation.\r\n   * @see [[VersionedJSON]] for the JSON representation.\r\n   * @see [[TextAnnotationProps]] for the data model.\r\n   * @note Don't set this property directly - use [TextAnnotation3d.setAnnotation]($backend) instead.\r\n   */\r\n  textAnnotationData?: string;\r\n  /** The default [AnnotationTextStyle]($backend) element used by the text annotation.\r\n   * @beta\r\n   */\r\n  defaultTextStyle?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define a [PhysicalElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface PhysicalElementProps extends GeometricElement3dProps {\r\n  physicalMaterial?: RelatedElementProps;\r\n}\r\n\r\n/** An enumeration of the different types of [SectionDrawing]($backend)s.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport enum SectionType {\r\n  Section = 3,\r\n  Detail = 4,\r\n  Elevation = 5,\r\n  Plan = 6,\r\n}\r\n\r\n/** Properties that define a [Drawing]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface DrawingProps extends ElementProps {\r\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\r\n   * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).\r\n   * Default: 1.\r\n   * @note The scale factor **must** be greater than zero.\r\n   * @public @preview\r\n   */\r\n  scaleFactor?: number;\r\n}\r\n\r\n/** Properties that define a [SectionDrawing]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SectionDrawingProps extends DrawingProps {\r\n  /** The type of section used to generate the drawing. Default: Section. */\r\n  sectionType?: SectionType;\r\n  /** The spatial view from which the section was generated. */\r\n  spatialView?: RelatedElementProps;\r\n  jsonProperties?: {\r\n    /** A transform from the section drawing model's coordinates to spatial coordinates. */\r\n    drawingToSpatialTransform?: TransformProps;\r\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. */\r\n    sheetToSpatialTransform?: TransformProps;\r\n    /** If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), JSON representation of a [ClipVector]($geometry) to apply to\r\n     * the sheet graphics when drawn in the context of the spatial view.\r\n     * The ClipVector is in spatial coordinates.\r\n     */\r\n    drawingBoundaryClip?: ClipVectorProps;\r\n    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */\r\n    displaySpatialView?: true;\r\n  };\r\n}\r\n\r\n/** Properties that define a [SectionDrawingLocation]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SectionDrawingLocationProps extends GeometricElement3dProps {\r\n  /** The [ViewDefinition]($backend) to which this location refers. */\r\n  sectionView?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define a [GeometricElement2d]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometricElement2dProps extends GeometricElementProps {\r\n  placement?: Placement2dProps;\r\n  typeDefinition?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define a [TextAnnotation2d]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface TextAnnotation2dProps extends GeometricElement2dProps {\r\n  /** The stringified versioned JSON representation of the text annotation.\r\n   * @see [[VersionedJSON]] for the JSON representation.\r\n   * @see [[TextAnnotationProps]] for the data model.\r\n   * @note Don't set this property directly - use [TextAnnotation2d.setAnnotation]($backend) instead.\r\n   */\r\n  textAnnotationData?: string;\r\n  /** The default [AnnotationTextStyle]($backend) element used by the text annotation.\r\n   * @beta\r\n   */\r\n  defaultTextStyle?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [GeometryPart]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface GeometryPartProps extends ElementProps {\r\n  geom?: GeometryStreamProps;\r\n  /** Describes how to build the part's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\r\n   * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent part.\r\n   */\r\n  elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;\r\n  bbox?: LowAndHighXYZProps;\r\n}\r\n\r\n/** Properties for a [ViewAttachment]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ViewAttachmentProps extends GeometricElement2dProps {\r\n  view: RelatedElementProps;\r\n  jsonProperties?: {\r\n    /** Integer priority in [-500,500]. Where two attachments overlap, the one with the higher priority draws in front of the other. Default: 0. */\r\n    displayPriority?: number;\r\n    /** JSON representation of a [ClipVector]($core-geometry] in sheet coordinate space, used to clip the attachment's graphics on the sheet. */\r\n    clip?: ClipVectorProps;\r\n    /** Options for customizing how the view attachment is displayed on the sheet. */\r\n    displayOptions?: {\r\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. */\r\n      drawAsRaster?: boolean;\r\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\r\n       * sheet is used and any background pixels become transparent, allowing the contents of the sheet to show through. Default: false.\r\n       */\r\n      preserveBackground?: boolean;\r\n    };\r\n  };\r\n}\r\n\r\n/** Properties of a [Subject]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SubjectProps extends ElementProps {\r\n  description?: string;\r\n}\r\n\r\n/** Properties of a [SheetBorderTemplate]($backend)\r\n * @beta\r\n */\r\nexport interface SheetBorderTemplateProps extends ElementProps {\r\n  height?: number;\r\n  width?: number;\r\n}\r\n\r\n/** Properties of a [SheetTemplate]($backend)\r\n * @beta\r\n */\r\nexport interface SheetTemplateProps extends ElementProps {\r\n  height?: number;\r\n  width?: number;\r\n  border?: Id64String;\r\n}\r\n\r\n/** Properties of a [Sheet]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SheetProps extends ElementProps {\r\n  width?: number;\r\n  height?: number;\r\n  scale?: number;\r\n  sheetTemplate?: Id64String;\r\n  attachments?: Id64String[];\r\n}\r\n\r\n/** Properties of a [DefinitionElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface DefinitionElementProps extends ElementProps {\r\n  isPrivate?: boolean;\r\n}\r\n\r\n/** Properties of a [TypeDefinitionElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface TypeDefinitionElementProps extends DefinitionElementProps {\r\n  recipe?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [PhysicalType]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface PhysicalTypeProps extends TypeDefinitionElementProps {\r\n  /** The [PhysicalMaterial]($backend) that makes up this physical type. */\r\n  physicalMaterial?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [InformationPartitionElement]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface InformationPartitionElementProps extends ElementProps {\r\n  description?: string;\r\n}\r\n\r\n/** Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].\r\n * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface DisplayStyleLoadProps {\r\n  /** If true, the lists of element Ids in the display style's schedule script will be empty.\r\n   * The element Ids are not required on the frontend for display and can be quite large.\r\n   */\r\n  omitScheduleScriptElementIds?: boolean;\r\n  /** If true, [[DisplayStyleSettingsProps.excludedElements]] will be compressed into a single compact string; otherwise they will be expanded into an array of strings.\r\n   * The number of Ids may be quite large, so the compressed format is preferred, especially when communicating between the backend and frontend.\r\n   */\r\n  compressExcludedElementIds?: boolean;\r\n}\r\n\r\n/** Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].\r\n * @see [[ElementLoadOptions.renderTimeline]].\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RenderTimelineLoadProps {\r\n  /** If true, the lists of element Ids in the schedule script will be empty.\r\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).\r\n   */\r\n  omitScriptElementIds?: boolean;\r\n}\r\n\r\n/** Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like\r\n * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementLoadOptions {\r\n  /** if true, only load the members of [[ElementProps]], and no members from subclasses */\r\n  onlyBaseProperties?: boolean;\r\n  /** If true, include the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\r\n   * Geometry streams can consist of many megabytes worth of JSON, so they are omitted by default.\r\n   */\r\n  wantGeometry?: boolean;\r\n  /** When including a geometry stream containing brep entries, whether to return the raw brep data or proxy geometry, false when undefined */\r\n  /** If true, include [[BRepEntity.DataProps.data]] in the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\r\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.\r\n   */\r\n  wantBRepData?: boolean;\r\n  /** Options controlling which properties of [[DisplayStyleProps]] to include or exclude. */\r\n  displayStyle?: DisplayStyleLoadProps;\r\n  /** Options controlling which properties of [[RenderTimelineProps]] to include or exclude. */\r\n  renderTimeline?: RenderTimelineLoadProps;\r\n}\r\n\r\n/** Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementLoadProps extends ElementLoadOptions {\r\n  id?: Id64String;\r\n  /** The properties of the Code of the element to load.\r\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.\r\n   * TODO: change to Required<CodeProps> in Version 4.0\r\n   */\r\n  code?: CodeProps;\r\n  federationGuid?: GuidString;\r\n}\r\n\r\n/** Properties of an [ElementAspect]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ElementAspectProps extends EntityProps {\r\n  element: RelatedElementProps;\r\n}\r\n\r\n/** Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ExternalSourceAspectProps extends ElementAspectProps {\r\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\r\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\r\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\r\n   */\r\n  scope: RelatedElementProps;\r\n  /** The identifier of the object in the source repository. */\r\n  identifier: string;\r\n  /** The kind of object within the source repository. */\r\n  kind: string;\r\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\r\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.\r\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\r\n   */\r\n  version?: string;\r\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. */\r\n  checksum?: string;\r\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\r\n   * @note Warning: if defined, jsonProperties must be a *string*, specifically a valid JSON string.\r\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.\r\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\r\n  */\r\n  jsonProperties?: any;\r\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\r\n  source?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of an [ExternalSource]($backend)\r\n * @beta\r\n */\r\nexport interface ExternalSourceProps extends ElementProps {\r\n  repository?: RelatedElementProps;\r\n  connectorName?: string;\r\n  connectorVersion?: string;\r\n}\r\n\r\n/** The role that an attached [ExternalSource]($backend) plays.\r\n * @beta\r\n */\r\nexport enum ExternalSourceAttachmentRole {\r\n  /** The attached [ExternalSource]($backend) provides context. */\r\n  SpecifyContext = 0,\r\n  /** The attached [ExternalSource]($backend) models a part of the whole. */\r\n  SpecifyPart = 1,\r\n}\r\n\r\n/** Properties of an [ExternalSourceAttachment]($backend)\r\n * @beta\r\n */\r\nexport interface ExternalSourceAttachmentProps extends ElementProps {\r\n  attaches?: RelatedElementProps;\r\n  role?: ExternalSourceAttachmentRole;\r\n  translation?: XYZProps;\r\n  yaw?: number;\r\n  pitch?: number;\r\n  roll?: number;\r\n  scale?: XYZProps;\r\n}\r\n\r\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.\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface ChannelRootAspectProps extends ElementAspectProps {\r\n  /** The owner of the channel */\r\n  owner: string;\r\n}\r\n\r\n/** Properties of a [LineStyle]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface LineStyleProps extends DefinitionElementProps {\r\n  description?: string;\r\n  /** The JSON string line style definition element data [LineStyleDefinition.StyleProps]($backend) */\r\n  data: string;\r\n}\r\n\r\n/** Properties of a [LightLocation]($backend)\r\n * @internal\r\n */\r\nexport interface LightLocationProps extends GeometricElement3dProps {\r\n  enabled?: boolean;\r\n}\r\n\r\n/** The *rank* for a [Category]($backend), [SubCategory]($backend), or [DefinitionSet]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport enum Rank {\r\n  /** This category is predefined by the system */\r\n  System = 0,\r\n  /** This category is defined by a schema. Elements in this category are not recognized by system classes. */\r\n  Domain = 1,\r\n  /** This category is defined by an application. Elements in this category are not recognized by system and schema classes. */\r\n  Application = 2,\r\n  /** This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. */\r\n  User = 3,\r\n}\r\n\r\n/** Parameters of a [DefinitionSet]($backend), unifying [DefinitionContainer]($backend) and [DefinitionGroup]($backend).\r\n * @beta\r\n */\r\nexport interface DefinitionSetProps extends DefinitionElementProps {\r\n  rank?: Rank;\r\n}\r\n\r\n/** Parameters of a [Category]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface CategoryProps extends DefinitionElementProps {\r\n  rank?: Rank;\r\n  description?: string;\r\n}\r\n\r\n/** Parameters of a [SubCategory]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface SubCategoryProps extends DefinitionElementProps {\r\n  appearance?: SubCategoryAppearance.Props;\r\n  description?: string;\r\n}\r\n\r\n/** Parameters of a [UrlLink]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface UrlLinkProps extends ElementProps {\r\n  description?: string;\r\n  url?: string;\r\n}\r\n\r\n/** Parameters of a [RepositoryLink]($backend)\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RepositoryLinkProps extends UrlLinkProps {\r\n  repositoryGuid?: GuidString;\r\n  format?: string;\r\n}\r\n\r\n/** The properties of a [SynchronizationConfigLink]($backend)\r\n * @beta\r\n */\r\nexport interface SynchronizationConfigLinkProps extends UrlLinkProps {\r\n  lastSuccessfulRun?: string;\r\n}\r\n\r\n/** Wire format describing a [RenderTimeline]($backend).\r\n * @public @preview\r\n * @extensions\r\n */\r\nexport interface RenderTimelineProps extends ElementProps {\r\n  /** An optional human-readable description of the timeline. */\r\n  description?: string;\r\n  /** The stringified JSON representation of the instructions for visualizing change over time.\r\n   * @see [[RenderSchedule.ScriptProps]] for the JSON interface.\r\n   */\r\n  script: string;\r\n}\r\n\r\n/** Properties of a [SheetIndexEntry]($backend).\r\n * @beta\r\n*/\r\nexport interface SheetIndexEntryProps extends ElementProps {\r\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\r\n  entryPriority: number;\r\n}\r\n\r\n/** Properties of a [SheetIndexFolder]($backend)\r\n * @beta\r\n */\r\nexport type SheetIndexFolderProps = SheetIndexEntryProps;\r\n\r\n/** Properties of a [SheetIndexReference]($backend)\r\n * @beta\r\n */\r\nexport interface SheetIndexReferenceProps extends SheetIndexEntryProps {\r\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\r\n  sheetIndex?: RelatedElementProps;\r\n}\r\n\r\n/** Properties of a [SheetReference]($backend)\r\n * @beta\r\n */\r\nexport interface SheetReferenceProps extends SheetIndexEntryProps {\r\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\r\n  sheet?: RelatedElementProps;\r\n}\r\n\r\n/** Properties that define an [AnnotationTextStyle]($backend).\r\n * @beta\r\n */\r\nexport interface AnnotationTextStyleProps extends DefinitionElementProps {\r\n  /** An optional human-readable description of the text style.*/\r\n  description?: string;\r\n  /** The stringified versioned JSON representation of the text style.\r\n   * @see [[VersionedJSON]] for the JSON representation.\r\n   * @see [[TextStyleSettingsProps]] for the data model.\r\n   */\r\n  settings?: string;\r\n}\r\n\r\n/** A string in the format `read.write.minor` where the semantics match those of [ECVersion]($ecschema-metadata).\r\n * @beta\r\n */\r\nexport type ECVersionString = `${string}.${string}.${string}`\r\n\r\n/** Wrapper for versioned JSON data.\r\n * @beta\r\n */\r\nexport interface VersionedJSON<T> {\r\n  /** The semver version of the JSON data.\r\n   * Uses the same semantics as [ECVersion]($ecschema-metadata).\r\n   */\r\n  version: ECVersionString;\r\n  /** The JSON data. */\r\n  data: T;\r\n}\r\n\r\n/** Project-level properties hosted by a [ProjectInformationRecord]($backend) element.\r\n * @beta\r\n */\r\nexport interface ProjectInformation {\r\n  /** A name that uniquely identifies this project within an organization. */\r\n  projectNumber?: string;\r\n  /** A human-readable display label for the project. Unlike [[projectNumber]], this needn't be unique. */\r\n  projectName?: string;\r\n  /** A human-readable description of the geographic location of the project - often, the name of a city or a street address. */\r\n  location?: string;\r\n}\r\n\r\n/** JSON representation of a [ProjectInformationRecord]($backend).\r\n * @beta\r\n */\r\nexport type ProjectInformationRecordProps = ElementProps & ProjectInformation;\r\n\r\n/** Captures basic metadata about a [Sheet]($backend). This information is typically included in the Sheet's graphical representation, often\r\n * as part of its title block.\r\n * This information is stored in a [SheetInformationAspect]($backend).\r\n * @beta\r\n */\r\nexport interface SheetInformation {\r\n  /** A user-supplied string describing who designed the sheet contents. */\r\n  designedBy?: string;\r\n  /** A user-supplied date describing when the sheet contents were designed. */\r\n  designedDate?: Date;\r\n  /** A user-supplied string describing who drew the sheet contents. */\r\n  drawnBy?: string;\r\n  /** A user-supplied string describing who verified the sheet contents. */\r\n  checkedBy?: string;\r\n}\r\n\r\n/** JSON representation of a [[SheetInformation]].\r\n * @beta\r\n */\r\nexport interface SheetInformationProps {\r\n  /** A user-supplied string describing who designed the sheet contents. */\r\n  designedBy?: string;\r\n  /** The [ISO string representation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) of a user-supplied date describing when the sheet contents were designed. */\r\n  designedDate?: string;\r\n  /** A user-supplied string describing who drew the sheet contents. */\r\n  drawnBy?: string;\r\n  /** A user-supplied string describing who verified the sheet contents. */\r\n  checkedBy?: string;\r\n}\r\n\r\n/** JSON representation of a [SheetInformationAspect]($backend).\r\n * @beta\r\n */\r\nexport type SheetInformationAspectProps = ElementAspectProps & SheetInformationProps;\r\n"]}

package/lib/esm/ITwinCoreErrors.d.ts

@@ -193,4 +193,35 @@ export declare namespace ElementError {
     /** Determine whether an error object is an ElementError */
     function isError(error: unknown, key?: Key): error is ITwinError;
 }
+/** An error originating from the shared element reservation APIs (see [SynchronousChannel.Reservations]($backend)),
+ * used to coordinate simultaneous creation of elements with shared identities across briefcases.
+ * @beta
+ */
+export interface ElementReservationError extends ITwinError {
+    /** The federationGuid of the element involved in the error, when known. */
+    readonly federationGuid?: GuidString;
+}
+/** @beta */
+export declare namespace ElementReservationError {
+    /** the ITwinError scope for `ElementReservationError`s. */
+    const scope = "itwin-ElementReservation";
+    /** Keys that identify `ElementReservationError`s */
+    type Key = 
+    /** A proposed or inserted reservation is invalid: e.g. a malformed federationGuid, an invalid code, an unknown class, or a missing federationGuid. */
+    "invalid-reservation" | 
+    /** The requested reservation conflicts with an existing reservation (a different class or code). */
+    "reservation-conflict" | 
+    /** No reservation exists for the element being inserted; it must be reserved first. */
+    "reservation-not-found" | 
+    /** The element cannot be inserted because the SchemaSync container has un-pushed local changes. */
+    "container-has-local-changes" | 
+    /** The pool of element ids available for reservations has been exhausted. */
+    "id-sequence-exhausted" | 
+    /** The persisted reservation bookkeeping data is corrupt. */
+    "corrupt-reservation-data";
+    /** Instantiate and throw an ElementReservationError */
+    function throwError<T extends ElementReservationError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+    /** Determine whether an error object is an ElementReservationError */
+    function isError(error: unknown, key?: Key): error is ElementReservationError;
+}
 //# sourceMappingURL=ITwinCoreErrors.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,KAAK,mBAAmB,CAAC;IACtC,KAAY,GAAG,GACb,kCAAkC,GAClC,2BAA2B,GAC3B,oCAAoC,GACpC,oBAAoB,GACpB,0BAA0B,GAC1B,kBAAkB,GAClB,iBAAiB,CAAC;IAEpB,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,kBAAkB,CAE9E;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE7G;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,gDAAgD;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,gEAAgE;IAChE,gBAAgB;IAChB,8GAA8G;IAC9G,+BAA+B;IAC/B,8EAA8E;IAC9E,iBAAiB;IACjB,6FAA6F;IAC7F,YAAY;IACZ,yDAAyD;IACzD,cAAc,CAAC;IAEjB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAErG;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAExE;CACF;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IAClD,MAAM,KAAK,2BAA2B,CAAC;IAE9C,kDAAkD;IAClD,KAAY,GAAG;IACb,6CAA6C;IAC7C,qBAAqB;IACrB,4EAA4E;IAC5E,uBAAuB;IACvB,0DAA0D;IAC1D,kBAAkB;IAClB,0EAA0E;IAC1E,kBAAkB,CAAC;IAErB,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF;AAED;;;GAGG;AACH,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,wFAAwF;IACxF,qBAAqB;IACrB,8DAA8D;IAC9D,mBAAmB,CAAC;IAEtB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF"}
+{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,KAAK,mBAAmB,CAAC;IACtC,KAAY,GAAG,GACb,kCAAkC,GAClC,2BAA2B,GAC3B,oCAAoC,GACpC,oBAAoB,GACpB,0BAA0B,GAC1B,kBAAkB,GAClB,iBAAiB,CAAC;IAEpB,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,kBAAkB,CAE9E;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE7G;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,gDAAgD;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,gEAAgE;IAChE,gBAAgB;IAChB,8GAA8G;IAC9G,+BAA+B;IAC/B,8EAA8E;IAC9E,iBAAiB;IACjB,6FAA6F;IAC7F,YAAY;IACZ,yDAAyD;IACzD,cAAc,CAAC;IAEjB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAErG;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAExE;CACF;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IAClD,MAAM,KAAK,2BAA2B,CAAC;IAE9C,kDAAkD;IAClD,KAAY,GAAG;IACb,6CAA6C;IAC7C,qBAAqB;IACrB,4EAA4E;IAC5E,uBAAuB;IACvB,0DAA0D;IAC1D,kBAAkB;IAClB,0EAA0E;IAC1E,kBAAkB,CAAC;IAErB,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF;AAED;;;GAGG;AACH,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,wFAAwF;IACxF,qBAAqB;IACrB,8DAA8D;IAC9D,mBAAmB,CAAC;IAEtB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,2EAA2E;IAC3E,QAAQ,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC;CACtC;AAED,YAAY;AACZ,yBAAiB,uBAAuB,CAAC;IACvC,2DAA2D;IACpD,MAAM,KAAK,6BAA6B,CAAC;IAEhD,oDAAoD;IACpD,KAAY,GAAG;IACb,sJAAsJ;IACtJ,qBAAqB;IACrB,oGAAoG;IACpG,sBAAsB;IACtB,uFAAuF;IACvF,uBAAuB;IACvB,mGAAmG;IACnG,6BAA6B;IAC7B,6EAA6E;IAC7E,uBAAuB;IACvB,6DAA6D;IAC7D,0BAA0B,CAAC;IAE7B,uDAAuD;IACvD,SAAgB,UAAU,CAAC,CAAC,SAAS,uBAAuB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAElH;IAED,sEAAsE;IACtE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,uBAAuB,CAEnF;CACF"}

package/lib/esm/ITwinCoreErrors.js

@@ -152,4 +152,20 @@ export var ElementError;
     }
     ElementError.isError = isError;
 })(ElementError || (ElementError = {}));
+/** @beta */
+export var ElementReservationError;
+(function (ElementReservationError) {
+    /** the ITwinError scope for `ElementReservationError`s. */
+    ElementReservationError.scope = "itwin-ElementReservation";
+    /** Instantiate and throw an ElementReservationError */
+    function throwError(key, e) {
+        ITwinError.throwError({ ...e, iTwinErrorId: { scope: ElementReservationError.scope, key } });
+    }
+    ElementReservationError.throwError = throwError;
+    /** Determine whether an error object is an ElementReservationError */
+    function isError(error, key) {
+        return ITwinError.isError(error, ElementReservationError.scope, key);
+    }
+    ElementReservationError.isError = isError;
+})(ElementReservationError || (ElementReservationError = {}));
 //# sourceMappingURL=ITwinCoreErrors.js.map

package/lib/esm/ITwinCoreErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAW7D,YAAY;AACZ,MAAM,KAAW,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,UAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,KAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,UAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,KAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,MAAM,KAAW,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,UAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,KAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,MAAM,KAAW,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,UAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,KAAd,cAAc,QAsB9B;AAaD,YAAY;AACZ,MAAM,KAAW,kBAAkB,CAoBlC;AApBD,WAAiB,kBAAkB;IACpB,wBAAK,GAAG,gBAAgB,CAAC;IAUtC,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAqB,KAAK,EAAE,mBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAFe,0BAAO,UAEtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAA+B,GAAQ,EAAE,CAAmC;QACpG,UAAU,CAAC,UAAU,CAAqB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,mBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAFe,6BAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,kBAAkB,KAAlB,kBAAkB,QAoBlC;AAWD,YAAY;AACZ,MAAM,KAAW,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,UAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,KAAnB,mBAAmB,QAqBnC;AAaD,YAAY;AACZ,MAAM,KAAW,YAAY,CA0B5B;AA1BD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IAerC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,SAAkB,EAAE,WAAoB;QAC5F,UAAU,CAAC,UAAU,CAAe,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IACzG,CAAC;IAFe,uBAAU,aAEzB,CAAA;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAe,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EA1BgB,YAAY,KAAZ,YAAY,QA0B5B;AAED;;GAEG;AACH,MAAM,KAAW,qBAAqB,CAuBrC;AAvBD,WAAiB,qBAAqB;IACpC,yDAAyD;IAC5C,2BAAK,GAAG,wBAAwB,CAAC;IAa9C,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,UAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,sBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,gCAAU,aAEzB,CAAA;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,sBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,6BAAO,UAEtB,CAAA;AACH,CAAC,EAvBgB,qBAAqB,KAArB,qBAAqB,QAuBrC;AAED;;;GAGG;AACH,MAAM,KAAW,YAAY,CAmB5B;AAnBD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IASrC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,UAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,uBAAU,aAEzB,CAAA;IACD,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EAnBgB,YAAY,KAAZ,YAAY,QAmB5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { GuidString, ITwinError } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * An error originating from the [SQLiteDb]($backend) API.\r\n * @beta\r\n */\r\nexport interface SqliteError extends ITwinError {\r\n  /** The name of the database for this problem. */\r\n  dbName: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace SqliteError {\r\n  export const scope = \"itwin-Sqlite\";\r\n  export type Key =\r\n    \"already-open\" |\r\n    \"incompatible-version\" |\r\n    \"invalid-versions-property\" |\r\n    \"readonly\";\r\n\r\n  /** Determine whether an error object is a SqliteError */\r\n  export function isError(error: unknown, key?: Key): error is SqliteError {\r\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\r\n  }\r\n\r\n  /** Instantiate and throw a SqliteError */\r\n  export function throwError(key: Key, message: string, dbName: string): never {\r\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\r\n  }\r\n}\r\n\r\n/**\r\n * An error originating from the [CloudSqlite]($backend) API.\r\n * @beta\r\n */\r\nexport interface CloudSqliteError extends ITwinError {\r\n  /** The name of the database that generated the error */\r\n  readonly dbName?: string;\r\n  /** The name of the container associated with the error */\r\n  readonly containerId?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace CloudSqliteError {\r\n  export const scope = \"itwin-CloudSqlite\";\r\n  export type Key =\r\n    \"already-published\" |\r\n    \"copy-error\" |\r\n    \"invalid-name\" |\r\n    \"no-version-available\" |\r\n    \"not-a-function\" |\r\n    \"service-not-available\" |\r\n    /** The write lock cannot be acquired because it is currently held by somebody else.\r\n     * @see WriteLockHeld for details\r\n     */\r\n    \"write-lock-held\" |\r\n    /** The write lock on a container is not held, but is required for this operation */\r\n    \"write-lock-not-held\";\r\n\r\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\r\n  export interface WriteLockHeld extends CloudSqliteError {\r\n    /** @internal */\r\n    errorNumber: number;\r\n    /** moniker of user currently holding container's lock */\r\n    lockedBy: string;\r\n    /** time the lock expires */\r\n    expires: string;\r\n  }\r\n\r\n  /** Determine whether an error object is a CloudSqliteError */\r\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw a CloudSqliteError */\r\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n/** Errors thrown by the [ViewStore]($backend) API.\r\n * @beta\r\n */\r\nexport interface ViewStoreError extends ITwinError {\r\n  /** The name of the ViewStore that generated the error */\r\n  viewStoreName?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ViewStoreError {\r\n  export const scope = \"itwin-ViewStore\";\r\n  export type Key =\r\n    \"invalid-value\" |\r\n    \"invalid-member\" |\r\n    \"no-owner\" |\r\n    \"not-found\" |\r\n    \"not-unique\" |\r\n    \"no-viewstore\" |\r\n    \"group-error\";\r\n\r\n  /** Determine whether an error object is a ViewStoreError */\r\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw a ViewStoreError */\r\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n/**\r\n * Errors thrown by the [Workspace]($backend) APIs.\r\n * @beta\r\n */\r\nexport namespace WorkspaceError {\r\n  export const scope = \"itwin-Workspace\";\r\n  export type Key =\r\n    \"already-exists\" |\r\n    \"container-exists\" |\r\n    \"does-not-exist\" |\r\n    \"invalid-name\" |\r\n    \"no-cloud-container\" |\r\n    \"load-error\" |\r\n    \"load-errors\" |\r\n    \"resource-exists\" |\r\n    \"too-large\" |\r\n    \"write-error\";\r\n\r\n  /** Determine whether an error object is a WorkspaceError */\r\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\r\n  }\r\n}\r\n\r\n/**\r\n * Errors thrown by iTwin settings container APIs.\r\n * @beta\r\n */\r\nexport interface ITwinSettingsError extends ITwinError {\r\n  /** The iTwin associated with this settings error, when available. */\r\n  readonly iTwinId?: GuidString;\r\n  /** The priority associated with this settings error, when available. */\r\n  readonly priority?: number;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ITwinSettingsError {\r\n  export const scope = \"itwin-settings\";\r\n  export type Key =\r\n    \"failed-to-obtain-container-token\" |\r\n    \"missing-container-itwinid\" |\r\n    \"multiple-itwin-settings-containers\" |\r\n    \"no-cloud-container\" |\r\n    \"blob-service-unavailable\" |\r\n    \"invalid-priority\" |\r\n    \"unknown-setting\";\r\n\r\n  /** Determine whether an error object is an ITwinSettingsError. */\r\n  export function isError(error: unknown, key?: Key): error is ITwinSettingsError {\r\n    return ITwinError.isError<ITwinSettingsError>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw an ITwinSettingsError. */\r\n  export function throwError<T extends ITwinSettingsError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ITwinSettingsError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n\r\n/** Errors originating from the [ChannelControl]($backend) interface.\r\n * @beta\r\n */\r\nexport interface ChannelControlError extends ITwinError {\r\n  /** The channel key that caused the error. */\r\n  readonly channelKey: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ChannelControlError {\r\n  /** the ITwinError scope for `ChannelControlError`s. */\r\n  export const scope = \"itwin-ChannelControl\";\r\n\r\n  /** Keys that identify `ChannelControlError`s */\r\n  export type Key =\r\n    /** an attempt to create a channel within an existing channel */\r\n    \"may-not-nest\" |\r\n    /** an attempt to use a channel that was not \"allowed\" */\r\n    \"not-allowed\" |\r\n    /** the root channel already exists */\r\n    \"root-exists\";\r\n\r\n  /** Instantiate and throw a ChannelControlError */\r\n  export function throwError(key: Key, message: string, channelKey: string): never {\r\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\r\n  }\r\n  /** Determine whether an error object is a ChannelControlError */\r\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\r\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\r\n  }\r\n}\r\n\r\n/**\r\n * An error originating from the [EditTxn]($backend) API.\r\n * @beta\r\n */\r\nexport interface EditTxnError extends ITwinError {\r\n  /** The iModel key associated with the error. */\r\n  readonly iModelKey?: string;\r\n  /** The description of the EditTxn that caused the error, if applicable. */\r\n  readonly description?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace EditTxnError {\r\n  /** the ITwinError scope for `EditTxnError`s. */\r\n  export const scope = \"itwin-EditTxn\";\r\n\r\n  /** Keys that identify `EditTxnError`s */\r\n  export type Key =\r\n    /** an attempt to start an EditTxn when one is already active */\r\n    \"already-active\" |\r\n    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */\r\n    \"implicit-txn-write-disallowed\" |\r\n    /** an attempt to start an EditTxn when unsaved changes are already present */\r\n    \"unsaved-changes\" |\r\n    /** an attempt to perform an operation that requires an active EditTxn when none is active */\r\n    \"not-active\" |\r\n    /** an attempt to use an EditTxn with the wrong iModel */\r\n    \"wrong-imodel\";\r\n\r\n  /** Instantiate and throw an EditTxnError */\r\n  export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never {\r\n    ITwinError.throwError<EditTxnError>({ iTwinErrorId: { scope, key }, message, iModelKey, description });\r\n  }\r\n\r\n  /** Determine whether an error object is an EditTxnError */\r\n  export function isError(error: unknown, key?: Key): error is EditTxnError {\r\n    return ITwinError.isError<EditTxnError>(error, scope, key);\r\n  }\r\n}\r\n\r\n/** Errors originating from the server-based implementation of the [LockControl]($backend) interface.\r\n * @beta\r\n */\r\nexport namespace ServerBasedLocksError {\r\n  /** the ITwinError scope for `ServerBasedLocksError`s. */\r\n  export const scope = \"itwin-ServerBasedLocks\";\r\n\r\n  /** Keys that identify `ServerBasedLocksError`s */\r\n  export type Key =\r\n    /** The briefcase contains unsaved changes */\r\n    \"has-unsaved-changes\" |\r\n    /** A SQLite error occurred while reading or writing the \"locks\" database */\r\n    \"lock-database-problem\" |\r\n    /** The specified Txn ID is not known to the TxnManager */\r\n    \"txn-id-not-found\" |\r\n    /** Attempted to abandon locks for a Txn that has not yet been reversed */\r\n    \"txn-not-reversed\";\r\n\r\n  /** Instantiate and throw a ServerBasedLocksError */\r\n  export function throwError(key: Key, message: string): never {\r\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\r\n  }\r\n  /** Determine whether an error object is a ServerBasedLocksError */\r\n  export function isError(error: unknown, key?: Key): error is ITwinError {\r\n    return ITwinError.isError<ITwinError>(error, scope, key);\r\n  }\r\n}\r\n\r\n/** Errors originating from element operations such as [EditTxn.changeElementParent]($backend) and\r\n * [EditTxn.changeElementModel]($backend).\r\n * @beta\r\n */\r\nexport namespace ElementError {\r\n  /** the ITwinError scope for `ElementError`s. */\r\n  export const scope = \"itwin-Element\";\r\n\r\n  /** Keys that identify `ElementError`s */\r\n  export type Key =\r\n    /** The element's model type does not match the expected model type for the operation */\r\n    \"model-type-mismatch\" |\r\n    /** Invalid arguments were provided to an element operation */\r\n    \"invalid-arguments\";\r\n\r\n  /** Instantiate and throw an ElementError */\r\n  export function throwError(key: Key, message: string): never {\r\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\r\n  }\r\n  /** Determine whether an error object is an ElementError */\r\n  export function isError(error: unknown, key?: Key): error is ITwinError {\r\n    return ITwinError.isError<ITwinError>(error, scope, key);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAW7D,YAAY;AACZ,MAAM,KAAW,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,UAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,KAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,UAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,KAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,MAAM,KAAW,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,UAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,KAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,MAAM,KAAW,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,UAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,KAAd,cAAc,QAsB9B;AAaD,YAAY;AACZ,MAAM,KAAW,kBAAkB,CAoBlC;AApBD,WAAiB,kBAAkB;IACpB,wBAAK,GAAG,gBAAgB,CAAC;IAUtC,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAqB,KAAK,EAAE,mBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAFe,0BAAO,UAEtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAA+B,GAAQ,EAAE,CAAmC;QACpG,UAAU,CAAC,UAAU,CAAqB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,mBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAFe,6BAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,kBAAkB,KAAlB,kBAAkB,QAoBlC;AAWD,YAAY;AACZ,MAAM,KAAW,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,UAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,KAAnB,mBAAmB,QAqBnC;AAaD,YAAY;AACZ,MAAM,KAAW,YAAY,CA0B5B;AA1BD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IAerC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,SAAkB,EAAE,WAAoB;QAC5F,UAAU,CAAC,UAAU,CAAe,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IACzG,CAAC;IAFe,uBAAU,aAEzB,CAAA;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAe,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EA1BgB,YAAY,KAAZ,YAAY,QA0B5B;AAED;;GAEG;AACH,MAAM,KAAW,qBAAqB,CAuBrC;AAvBD,WAAiB,qBAAqB;IACpC,yDAAyD;IAC5C,2BAAK,GAAG,wBAAwB,CAAC;IAa9C,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,UAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,sBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,gCAAU,aAEzB,CAAA;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,sBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,6BAAO,UAEtB,CAAA;AACH,CAAC,EAvBgB,qBAAqB,KAArB,qBAAqB,QAuBrC;AAED;;;GAGG;AACH,MAAM,KAAW,YAAY,CAmB5B;AAnBD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IASrC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,UAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,uBAAU,aAEzB,CAAA;IACD,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EAnBgB,YAAY,KAAZ,YAAY,QAmB5B;AAWD,YAAY;AACZ,MAAM,KAAW,uBAAuB,CA4BvC;AA5BD,WAAiB,uBAAuB;IACtC,2DAA2D;IAC9C,6BAAK,GAAG,0BAA0B,CAAC;IAiBhD,uDAAuD;IACvD,SAAgB,UAAU,CAAoC,GAAQ,EAAE,CAAmC;QACzG,UAAU,CAAC,UAAU,CAA0B,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,wBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACzF,CAAC;IAFe,kCAAU,aAEzB,CAAA;IAED,sEAAsE;IACtE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAA0B,KAAK,EAAE,wBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACxE,CAAC;IAFe,+BAAO,UAEtB,CAAA;AACH,CAAC,EA5BgB,uBAAuB,KAAvB,uBAAuB,QA4BvC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { GuidString, ITwinError } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * An error originating from the [SQLiteDb]($backend) API.\r\n * @beta\r\n */\r\nexport interface SqliteError extends ITwinError {\r\n  /** The name of the database for this problem. */\r\n  dbName: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace SqliteError {\r\n  export const scope = \"itwin-Sqlite\";\r\n  export type Key =\r\n    \"already-open\" |\r\n    \"incompatible-version\" |\r\n    \"invalid-versions-property\" |\r\n    \"readonly\";\r\n\r\n  /** Determine whether an error object is a SqliteError */\r\n  export function isError(error: unknown, key?: Key): error is SqliteError {\r\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\r\n  }\r\n\r\n  /** Instantiate and throw a SqliteError */\r\n  export function throwError(key: Key, message: string, dbName: string): never {\r\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\r\n  }\r\n}\r\n\r\n/**\r\n * An error originating from the [CloudSqlite]($backend) API.\r\n * @beta\r\n */\r\nexport interface CloudSqliteError extends ITwinError {\r\n  /** The name of the database that generated the error */\r\n  readonly dbName?: string;\r\n  /** The name of the container associated with the error */\r\n  readonly containerId?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace CloudSqliteError {\r\n  export const scope = \"itwin-CloudSqlite\";\r\n  export type Key =\r\n    \"already-published\" |\r\n    \"copy-error\" |\r\n    \"invalid-name\" |\r\n    \"no-version-available\" |\r\n    \"not-a-function\" |\r\n    \"service-not-available\" |\r\n    /** The write lock cannot be acquired because it is currently held by somebody else.\r\n     * @see WriteLockHeld for details\r\n     */\r\n    \"write-lock-held\" |\r\n    /** The write lock on a container is not held, but is required for this operation */\r\n    \"write-lock-not-held\";\r\n\r\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\r\n  export interface WriteLockHeld extends CloudSqliteError {\r\n    /** @internal */\r\n    errorNumber: number;\r\n    /** moniker of user currently holding container's lock */\r\n    lockedBy: string;\r\n    /** time the lock expires */\r\n    expires: string;\r\n  }\r\n\r\n  /** Determine whether an error object is a CloudSqliteError */\r\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw a CloudSqliteError */\r\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n/** Errors thrown by the [ViewStore]($backend) API.\r\n * @beta\r\n */\r\nexport interface ViewStoreError extends ITwinError {\r\n  /** The name of the ViewStore that generated the error */\r\n  viewStoreName?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ViewStoreError {\r\n  export const scope = \"itwin-ViewStore\";\r\n  export type Key =\r\n    \"invalid-value\" |\r\n    \"invalid-member\" |\r\n    \"no-owner\" |\r\n    \"not-found\" |\r\n    \"not-unique\" |\r\n    \"no-viewstore\" |\r\n    \"group-error\";\r\n\r\n  /** Determine whether an error object is a ViewStoreError */\r\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw a ViewStoreError */\r\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n/**\r\n * Errors thrown by the [Workspace]($backend) APIs.\r\n * @beta\r\n */\r\nexport namespace WorkspaceError {\r\n  export const scope = \"itwin-Workspace\";\r\n  export type Key =\r\n    \"already-exists\" |\r\n    \"container-exists\" |\r\n    \"does-not-exist\" |\r\n    \"invalid-name\" |\r\n    \"no-cloud-container\" |\r\n    \"load-error\" |\r\n    \"load-errors\" |\r\n    \"resource-exists\" |\r\n    \"too-large\" |\r\n    \"write-error\";\r\n\r\n  /** Determine whether an error object is a WorkspaceError */\r\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\r\n  }\r\n}\r\n\r\n/**\r\n * Errors thrown by iTwin settings container APIs.\r\n * @beta\r\n */\r\nexport interface ITwinSettingsError extends ITwinError {\r\n  /** The iTwin associated with this settings error, when available. */\r\n  readonly iTwinId?: GuidString;\r\n  /** The priority associated with this settings error, when available. */\r\n  readonly priority?: number;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ITwinSettingsError {\r\n  export const scope = \"itwin-settings\";\r\n  export type Key =\r\n    \"failed-to-obtain-container-token\" |\r\n    \"missing-container-itwinid\" |\r\n    \"multiple-itwin-settings-containers\" |\r\n    \"no-cloud-container\" |\r\n    \"blob-service-unavailable\" |\r\n    \"invalid-priority\" |\r\n    \"unknown-setting\";\r\n\r\n  /** Determine whether an error object is an ITwinSettingsError. */\r\n  export function isError(error: unknown, key?: Key): error is ITwinSettingsError {\r\n    return ITwinError.isError<ITwinSettingsError>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw an ITwinSettingsError. */\r\n  export function throwError<T extends ITwinSettingsError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ITwinSettingsError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n\r\n/** Errors originating from the [ChannelControl]($backend) interface.\r\n * @beta\r\n */\r\nexport interface ChannelControlError extends ITwinError {\r\n  /** The channel key that caused the error. */\r\n  readonly channelKey: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ChannelControlError {\r\n  /** the ITwinError scope for `ChannelControlError`s. */\r\n  export const scope = \"itwin-ChannelControl\";\r\n\r\n  /** Keys that identify `ChannelControlError`s */\r\n  export type Key =\r\n    /** an attempt to create a channel within an existing channel */\r\n    \"may-not-nest\" |\r\n    /** an attempt to use a channel that was not \"allowed\" */\r\n    \"not-allowed\" |\r\n    /** the root channel already exists */\r\n    \"root-exists\";\r\n\r\n  /** Instantiate and throw a ChannelControlError */\r\n  export function throwError(key: Key, message: string, channelKey: string): never {\r\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\r\n  }\r\n  /** Determine whether an error object is a ChannelControlError */\r\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\r\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\r\n  }\r\n}\r\n\r\n/**\r\n * An error originating from the [EditTxn]($backend) API.\r\n * @beta\r\n */\r\nexport interface EditTxnError extends ITwinError {\r\n  /** The iModel key associated with the error. */\r\n  readonly iModelKey?: string;\r\n  /** The description of the EditTxn that caused the error, if applicable. */\r\n  readonly description?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace EditTxnError {\r\n  /** the ITwinError scope for `EditTxnError`s. */\r\n  export const scope = \"itwin-EditTxn\";\r\n\r\n  /** Keys that identify `EditTxnError`s */\r\n  export type Key =\r\n    /** an attempt to start an EditTxn when one is already active */\r\n    \"already-active\" |\r\n    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */\r\n    \"implicit-txn-write-disallowed\" |\r\n    /** an attempt to start an EditTxn when unsaved changes are already present */\r\n    \"unsaved-changes\" |\r\n    /** an attempt to perform an operation that requires an active EditTxn when none is active */\r\n    \"not-active\" |\r\n    /** an attempt to use an EditTxn with the wrong iModel */\r\n    \"wrong-imodel\";\r\n\r\n  /** Instantiate and throw an EditTxnError */\r\n  export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never {\r\n    ITwinError.throwError<EditTxnError>({ iTwinErrorId: { scope, key }, message, iModelKey, description });\r\n  }\r\n\r\n  /** Determine whether an error object is an EditTxnError */\r\n  export function isError(error: unknown, key?: Key): error is EditTxnError {\r\n    return ITwinError.isError<EditTxnError>(error, scope, key);\r\n  }\r\n}\r\n\r\n/** Errors originating from the server-based implementation of the [LockControl]($backend) interface.\r\n * @beta\r\n */\r\nexport namespace ServerBasedLocksError {\r\n  /** the ITwinError scope for `ServerBasedLocksError`s. */\r\n  export const scope = \"itwin-ServerBasedLocks\";\r\n\r\n  /** Keys that identify `ServerBasedLocksError`s */\r\n  export type Key =\r\n    /** The briefcase contains unsaved changes */\r\n    \"has-unsaved-changes\" |\r\n    /** A SQLite error occurred while reading or writing the \"locks\" database */\r\n    \"lock-database-problem\" |\r\n    /** The specified Txn ID is not known to the TxnManager */\r\n    \"txn-id-not-found\" |\r\n    /** Attempted to abandon locks for a Txn that has not yet been reversed */\r\n    \"txn-not-reversed\";\r\n\r\n  /** Instantiate and throw a ServerBasedLocksError */\r\n  export function throwError(key: Key, message: string): never {\r\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\r\n  }\r\n  /** Determine whether an error object is a ServerBasedLocksError */\r\n  export function isError(error: unknown, key?: Key): error is ITwinError {\r\n    return ITwinError.isError<ITwinError>(error, scope, key);\r\n  }\r\n}\r\n\r\n/** Errors originating from element operations such as [EditTxn.changeElementParent]($backend) and\r\n * [EditTxn.changeElementModel]($backend).\r\n * @beta\r\n */\r\nexport namespace ElementError {\r\n  /** the ITwinError scope for `ElementError`s. */\r\n  export const scope = \"itwin-Element\";\r\n\r\n  /** Keys that identify `ElementError`s */\r\n  export type Key =\r\n    /** The element's model type does not match the expected model type for the operation */\r\n    \"model-type-mismatch\" |\r\n    /** Invalid arguments were provided to an element operation */\r\n    \"invalid-arguments\";\r\n\r\n  /** Instantiate and throw an ElementError */\r\n  export function throwError(key: Key, message: string): never {\r\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\r\n  }\r\n  /** Determine whether an error object is an ElementError */\r\n  export function isError(error: unknown, key?: Key): error is ITwinError {\r\n    return ITwinError.isError<ITwinError>(error, scope, key);\r\n  }\r\n}\r\n\r\n/** An error originating from the shared element reservation APIs (see [SynchronousChannel.Reservations]($backend)),\r\n * used to coordinate simultaneous creation of elements with shared identities across briefcases.\r\n * @beta\r\n */\r\nexport interface ElementReservationError extends ITwinError {\r\n  /** The federationGuid of the element involved in the error, when known. */\r\n  readonly federationGuid?: GuidString;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ElementReservationError {\r\n  /** the ITwinError scope for `ElementReservationError`s. */\r\n  export const scope = \"itwin-ElementReservation\";\r\n\r\n  /** Keys that identify `ElementReservationError`s */\r\n  export type Key =\r\n    /** A proposed or inserted reservation is invalid: e.g. a malformed federationGuid, an invalid code, an unknown class, or a missing federationGuid. */\r\n    \"invalid-reservation\" |\r\n    /** The requested reservation conflicts with an existing reservation (a different class or code). */\r\n    \"reservation-conflict\" |\r\n    /** No reservation exists for the element being inserted; it must be reserved first. */\r\n    \"reservation-not-found\" |\r\n    /** The element cannot be inserted because the SchemaSync container has un-pushed local changes. */\r\n    \"container-has-local-changes\" |\r\n    /** The pool of element ids available for reservations has been exhausted. */\r\n    \"id-sequence-exhausted\" |\r\n    /** The persisted reservation bookkeeping data is corrupt. */\r\n    \"corrupt-reservation-data\";\r\n\r\n  /** Instantiate and throw an ElementReservationError */\r\n  export function throwError<T extends ElementReservationError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ElementReservationError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n\r\n  /** Determine whether an error object is an ElementReservationError */\r\n  export function isError(error: unknown, key?: Key): error is ElementReservationError {\r\n    return ITwinError.isError<ElementReservationError>(error, scope, key);\r\n  }\r\n}\r\n"]}

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

@@ -46,6 +46,16 @@ export declare const terminatorShapes: readonly ["openArrow", "closedArrow", "cl
  * @beta
 */
 export type TerminatorShape = typeof terminatorShapes[number];
+/**
+ * Predefined shapes that can be used to indicate the target point of a leader in a [[TextAnnotation]].
+ * @beta
+ */
+export declare const targetPointShapes: readonly ["cross", "plus", "circle", "square", "rectangle"];
+/**
+ * Describes a predefined shape that can be used to indicate the target point of a leader in a [[TextAnnotation]].
+ * @beta
+ */
+export type TargetPointShape = typeof targetPointShapes[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`.
@@ -132,6 +142,26 @@ export interface TextLeaderStyleProps {
      * Default: 1.0
      */
     terminatorWidthFactor?: number;
+    /**
+     * Whether to show the leaders in a [[TextAnnotation]].
+     */
+    showLeaders?: boolean;
+    /**
+     * Whether to show the leader terminator in a [[TextAnnotation]].
+     */
+    showTerminators?: boolean;
+    /**
+     * Whether to show the target point in a [[TextAnnotation]].
+     */
+    showTargetPoint?: boolean;
+    /**
+     * The shape of the target point in a [[TextAnnotation]].
+     */
+    targetPointShape?: TargetPointShape;
+    /**
+     * Multiplier used to compute the offset distance between the target point (at the leader start point) and the start of the leader line, measured along the first leader segment.
+     */
+    targetPointOffsetFactor?: number;
 }
 /** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [AnnotationTextStyle]($backend)'s properties.
  * @beta
@@ -207,7 +237,7 @@ export interface TextStyleSettingsProps {
     widthFactor?: number;
     /** Properties describing appearance of leaders in a [[TextAnnotation]]
      * Used when producing geometry for [[TextAnnotation]]
-     * Default: {color:"subcategory", wantElbow:"false",elbowLength:1, terminatorShape:"openArrow",terminatorWidthFactor:1, terminatorHeightFactor:1}.
+     * Default: {color:"inherit", wantElbow:"false",elbowLength:1, terminatorShape:"openArrow",terminatorWidthFactor:1, terminatorHeightFactor:1, showTargetPoint: false, targetPointShape:"cross", showLeaders:true, showTerminators:true, targetPointOffsetFactor:0}.
      */
     leader?: TextLeaderStyleProps;
     /** The size (in meters) used to calculate the tab stops in a run.

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

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAY,aAAa,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAY,MAAM,UAAU,CAAC;AAExD;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,uBAAuB;IACvB,MAAM,MAAM;IACZ,YAAY,MAAM;IAClB,MAAM,MAAM;IACZ,MAAM,WAAM;IACZ,MAAM,WAAM;IACZ,MAAM,WAAM;IACZ,cAAc;IACd,IAAI,WAAM;CACX;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6GAA6G;IAC7G,UAAU,EAAE,oBAAoB,GAAG,MAAM,CAAC;IAC1C,gDAAgD;IAChD,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IACtC,oJAAoJ;IACpJ,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC1B;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;EAEE;AACF,eAAO,MAAM,gBAAgB,uGAAwG,CAAC;AAEtI;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,GAAG,MAAM,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iGAAiG;IACjG,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oGAAoG;IACpG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;EAEE;AACF,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,0HAA0H;IAC1H,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;;yCAEqC;IACrC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;0BACsB;IACtB,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AAcD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC7D;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,sBAAsB,EAAE,MAAM,CAAC;IAC/C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;;;;OAKG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,oDAAoD;IACpD,SAAgB,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/D,iFAAiF;IACjF,SAAgB,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9D,yCAAyC;IACzC,SAAgB,aAAa,EAAE,iBAAiB,CAAC;IAEjD,gHAAgH;IAChH,OAAc,YAAY,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAwCxF;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IAqDP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,WAAW,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAOhD,YAAY,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAM9C,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAgBhD;;;;;;;;;OASG;IACI,mBAAmB,IAAI,MAAM,EAAE;CAgBvC"}
+{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAY,aAAa,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAY,MAAM,UAAU,CAAC;AAExD;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,uBAAuB;IACvB,MAAM,MAAM;IACZ,YAAY,MAAM;IAClB,MAAM,MAAM;IACZ,MAAM,WAAM;IACZ,MAAM,WAAM;IACZ,MAAM,WAAM;IACZ,cAAc;IACd,IAAI,WAAM;CACX;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6GAA6G;IAC7G,UAAU,EAAE,oBAAoB,GAAG,MAAM,CAAC;IAC1C,gDAAgD;IAChD,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IACtC,oJAAoJ;IACpJ,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC1B;AAED;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;EAEE;AACF,eAAO,MAAM,gBAAgB,uGAAwG,CAAC;AAEtI;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,6DAA8D,CAAC;AAC7F;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAGhE;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,GAAG,MAAM,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iGAAiG;IACjG,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oGAAoG;IACpG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;EAEE;AACF,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,0HAA0H;IAC1H,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;;yCAEqC;IACrC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;0BACsB;IACtB,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AAcD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC7D;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,sBAAsB,EAAE,MAAM,CAAC;IAC/C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;;;;OAKG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,oDAAoD;IACpD,SAAgB,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/D,iFAAiF;IACjF,SAAgB,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9D,yCAAyC;IACzC,SAAgB,aAAa,EAAE,iBAAiB,CAAC;IAEjD,gHAAgH;IAChH,OAAc,YAAY,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CA6CxF;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IA0DP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAclD,WAAW,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAOhD,YAAY,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAM9C,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAgBhD;;;;;;;;;OASG;IACI,mBAAmB,IAAI,MAAM,EAAE;CAgBvC"}

package/lib/esm/annotation/TextStyle.js

@@ -31,6 +31,11 @@ export const textAnnotationFrameShapes = ["none", "line", "rectangle", "circle",
  * @beta
 */
 export const terminatorShapes = ["openArrow", "closedArrow", "closedArrowFilled", "circle", "circleFilled", "slash", "none"];
+/**
+ * Predefined shapes that can be used to indicate the target point of a leader in a [[TextAnnotation]].
+ * @beta
+ */
+export const targetPointShapes = ["cross", "plus", "circle", "square", "rectangle"];
 ;
 ;
 function deepFreeze(obj) {
@@ -150,6 +155,11 @@ export class TextStyleSettings {
             terminatorShape: terminatorShapes[0],
             terminatorHeightFactor: 1.0,
             terminatorWidthFactor: 1.0,
+            showLeaders: true,
+            showTerminators: true,
+            showTargetPoint: false,
+            targetPointShape: targetPointShapes[0],
+            targetPointOffsetFactor: 0,
         },
         tabInterval: 4,
         indentation: 0,
@@ -200,6 +210,11 @@ export class TextStyleSettings {
             terminatorShape: props.leader?.terminatorShape ?? defaults.leader.terminatorShape,
             terminatorHeightFactor: props.leader?.terminatorHeightFactor ?? defaults.leader.terminatorHeightFactor,
             terminatorWidthFactor: props.leader?.terminatorWidthFactor ?? defaults.leader.terminatorWidthFactor,
+            showLeaders: props.leader?.showLeaders ?? defaults.leader.showLeaders,
+            showTerminators: props.leader?.showTerminators ?? defaults.leader.showTerminators,
+            showTargetPoint: props.leader?.showTargetPoint ?? defaults.leader.showTargetPoint,
+            targetPointShape: props.leader?.targetPointShape ?? defaults.leader.targetPointShape,
+            targetPointOffsetFactor: props.leader?.targetPointOffsetFactor ?? defaults.leader.targetPointOffsetFactor,
         };
         this.leader = Object.freeze(leader);
         this.tabInterval = props.tabInterval ?? defaults.tabInterval;
@@ -237,9 +252,17 @@ export class TextStyleSettings {
      * @returns true if the two leader styles are equal, false otherwise.
      */
     leaderEquals(other) {
-        return this.leader.color === other.color && this.leader.wantElbow === other.wantElbow
-            && this.leader.elbowLength === other.elbowLength && this.leader.terminatorShape === other.terminatorShape && this.leader.terminatorHeightFactor === other.terminatorHeightFactor
-            && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;
+        return this.leader.color === other.color
+            && this.leader.wantElbow === other.wantElbow
+            && this.leader.elbowLength === other.elbowLength
+            && this.leader.terminatorShape === other.terminatorShape
+            && this.leader.terminatorHeightFactor === other.terminatorHeightFactor
+            && this.leader.terminatorWidthFactor === other.terminatorWidthFactor
+            && this.leader.showLeaders === other.showLeaders
+            && this.leader.showTerminators === other.showTerminators
+            && this.leader.showTargetPoint === other.showTargetPoint
+            && this.leader.targetPointShape === other.targetPointShape
+            && this.leader.targetPointOffsetFactor === other.targetPointOffsetFactor;
     }
     frameEquals(other) {
         return this.frame?.shape === other.shape