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

package/lib/esm/EntityProps.d.ts

@@ -6,7 +6,7 @@ import { Id64String } from "@itwin/core-bentley";
  * between the backend and frontend.
  * EntityProps and all of its sub-types like [[ElementProps]] are "plain old Javascript objects" - that is, objects containing
  * no methods and no properties of `class` type.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface EntityProps {
@@ -24,7 +24,7 @@ export interface EntityProps {
     };
 }
 /** Specifies the source and target elements of a [[Relationship]] instance.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SourceAndTarget {
@@ -32,13 +32,13 @@ export interface SourceAndTarget {
     targetId: Id64String;
 }
 /** Properties that are common to all types of link table ECRelationships
- * @public
+ * @public @preview
  * @extensions
  */
 export interface RelationshipProps extends EntityProps, SourceAndTarget {
 }
 /** Parameters for performing a query on [Entity]($backend) classes.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface EntityQueryParams {
@@ -77,7 +77,7 @@ export declare enum PrimitiveTypeCode {
 }
 /** A callback function to process properties of an Entity
  * @beta
- * @deprecated in 5.0. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.
  *
  * @example
  * ```typescript
@@ -95,7 +95,7 @@ export declare enum PrimitiveTypeCode {
 export type PropertyCallback = (name: string, meta: PropertyMetaData) => void;
 /** A custom attribute instance
  * @beta
- * @deprecated in 5.0. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.
  */
 export interface CustomAttribute {
     /** The class of the CustomAttribute */
@@ -107,7 +107,7 @@ export interface CustomAttribute {
 }
 /**
  * @beta
- * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `@itwin/ecschema-metadata` instead.
  */
 export interface PropertyMetaDataProps {
     primitiveType?: number;
@@ -131,7 +131,7 @@ export interface PropertyMetaDataProps {
 }
 /** Metadata for a property.
  * @beta
- * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the `Property` class from @itwin/ecschema-metadata` instead.
  */
 export declare class PropertyMetaData implements PropertyMetaDataProps {
     primitiveType?: PrimitiveTypeCode;
@@ -162,7 +162,7 @@ export declare class PropertyMetaData implements PropertyMetaDataProps {
 }
 /**
  * @beta
- * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `@itwin/ecschema-metadata` instead.
  */
 export interface EntityMetaDataProps {
     classId: Id64String;
@@ -181,7 +181,7 @@ export interface EntityMetaDataProps {
 }
 /** Metadata for an Entity.
  * @beta
- * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.
  */
 export declare class EntityMetaData implements EntityMetaDataProps {
     /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */

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

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.d.ts","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACpC,mIAAmI;IACnI,aAAa,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,sHAAsH;IACtH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe;CACtE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ,CAAE,mDAAmD;IACpE,OAAO,OAAQ,CAAE,mDAAmD;IACpE,MAAM,OAAQ;IACd,SAAS,OAAQ;CAClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAID;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,qBAAqB;IACrD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAGzB,OAAO,EAAE,qBAAqB;IA2BjD,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAS1B,kFAAkF;IAC3E,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyBxC,8DAA8D;IAC9D,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gKAAgK;IAChK,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,2CAA2C;IAE3C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,qFAAqF;IAErF,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACtD;AAED;;;GAGG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,oFAAoF;IACpF,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,sBAAsB;IACtB,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,uIAAuI;IACvI,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAE3C,SAAgB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrD,qFAAqF;IAErF,SAAgB,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;gBAGlD,OAAO,EAAE,mBAAmB;CAehD"}
+{"version":3,"file":"EntityProps.d.ts","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACpC,mIAAmI;IACnI,aAAa,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,sHAAsH;IACtH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe;CACtE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ,CAAE,mDAAmD;IACpE,OAAO,OAAQ,CAAE,mDAAmD;IACpE,MAAM,OAAQ;IACd,SAAS,OAAQ;CAClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAID;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;;GAGG;AAEH,qBAAa,gBAAiB,YAAW,qBAAqB;IACrD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAGzB,OAAO,EAAE,qBAAqB;IA2BjD,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAS1B,kFAAkF;IAC3E,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyBxC,8DAA8D;IAC9D,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gKAAgK;IAChK,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,2CAA2C;IAE3C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,qFAAqF;IAErF,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACtD;AAED;;;GAGG;AAEH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,oFAAoF;IACpF,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,sBAAsB;IACtB,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,uIAAuI;IACvI,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAE3C,SAAgB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrD,qFAAqF;IAErF,SAAgB,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;gBAGlD,OAAO,EAAE,mBAAmB;CAehD"}

package/lib/esm/EntityProps.js

@@ -27,8 +27,9 @@ export var PrimitiveTypeCode;
 })(PrimitiveTypeCode || (PrimitiveTypeCode = {}));
 /** Metadata for a property.
  * @beta
- * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the `Property` class from @itwin/ecschema-metadata` instead.
  */
+// eslint-disable-next-line @typescript-eslint/no-deprecated
 export class PropertyMetaData {
     primitiveType;
     structName;
@@ -112,8 +113,9 @@ export class PropertyMetaData {
 }
 /** Metadata for an Entity.
  * @beta
- * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.
  */
+// eslint-disable-next-line @typescript-eslint/no-deprecated
 export class EntityMetaData {
     /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */
     classId;

package/lib/esm/EntityProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA6DhD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B;AA4DD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IACpB,aAAa,CAAqB;IAClC,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,WAAW,CAAU;IACrB,YAAY,CAAU;IACtB,YAAY,CAAO;IACnB,YAAY,CAAO;IACnB,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,QAAQ,CAAW;IACnB,cAAc,CAAU;IACxB,eAAe,CAAW;IAC1B,qBAAqB,CAAW;IAChC,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,iBAAiB,CAAU;IAClC,4DAA4D;IACrD,gBAAgB,CAAqB;IAE5C,4DAA4D;IAC5D,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBAE1E,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAsBD;;;GAGG;AACH,MAAM,OAAO,cAAc;IACzB,oFAAoF;IACpE,OAAO,CAAa;IACpC,sBAAsB;IACN,OAAO,CAAS;IAChB,WAAW,CAAU;IACrB,QAAQ,CAAU;IAClB,YAAY,CAAU;IACtC,uIAAuI;IACvH,WAAW,CAAW;IACtC,2CAA2C;IAC3C,4DAA4D;IAC5C,gBAAgB,CAAqB;IACrD,qFAAqF;IACrF,4DAA4D;IAC5C,UAAU,CAA2C;IAErE,4DAA4D;IAC5D,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,mCAAmC;YAC9E,4DAA4D;YAC5D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Entities\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\nimport { RelatedElement } from \"./ElementProps\";\n\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\n * between the backend and frontend.\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\n * no methods and no properties of `class` type.\n * @public\n * @extensions\n */\nexport interface EntityProps {\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\n   * @see [Entity.isInstanceOfEntity]($backend).\n   */\n  readonly isInstanceOfEntity?: never;\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\n  classFullName: string;\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\n  id?: Id64String;\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\n  jsonProperties?: { [key: string]: any };\n}\n\n/** Specifies the source and target elements of a [[Relationship]] instance.\n * @public\n * @extensions\n */\nexport interface SourceAndTarget {\n  sourceId: Id64String;\n  targetId: Id64String;\n}\n\n/** Properties that are common to all types of link table ECRelationships\n * @public\n * @extensions\n */\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\n}\n\n/** Parameters for performing a query on [Entity]($backend) classes.\n * @public\n * @extensions\n */\nexport interface EntityQueryParams {\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\n  from?: string;\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\n  only?: boolean;\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\n  where?: string;\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\n  orderBy?: string;\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\n  limit?: number;\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\n  offset?: number;\n  /** Bindings for parameterized values.\n   * @see [[ECSqlStatement.bindValues]]\n   */\n  bindings?: any[] | object;\n}\n\n/** The primitive types of an Entity property.\n * @beta\n */\nexport enum PrimitiveTypeCode {\n  Uninitialized = 0x00,\n  Binary = 0x101,\n  Boolean = 0x201,\n  DateTime = 0x301,\n  Double = 0x401,\n  Integer = 0x501,\n  Long = 0x601,\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\n  String = 0x901,\n  IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\n}\n\n/** A callback function to process properties of an Entity\n * @beta\n * @deprecated in 5.0. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.\n *\n * @example\n * ```typescript\n * // Current usage:\n * const callback: PropertyCallback = (name: string, propMetaData: PropertyMetaData) => {\n *  console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n * };\n *\n * // Replacement:\n * const callback: PropertyHandler = (propName: string, property: Property) => {\n *  console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);\n * };\n * ```\n */\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/** A custom attribute instance\n * @beta\n * @deprecated in 5.0. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.\n */\nexport interface CustomAttribute {\n  /** The class of the CustomAttribute */\n  ecclass: string;\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\n  properties: { [propName: string]: any };\n}\n\ntype FactoryFunc = (jsonObj: any) => any;\n\n/**\n * @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n */\nexport interface PropertyMetaDataProps {\n  primitiveType?: number;\n  structName?: string;\n  extendedType?: string;\n  description?: string;\n  displayLabel?: string;\n  minimumValue?: any;\n  maximumValue?: any;\n  minimumLength?: number;\n  maximumLength?: number;\n  readOnly?: boolean;\n  kindOfQuantity?: string;\n  isCustomHandled?: boolean;\n  isCustomHandledOrphan?: boolean;\n  minOccurs?: number;\n  maxOccurs?: number;\n  direction?: string;\n  relationshipClass?: string;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  customAttributes?: CustomAttribute[];\n}\n\n/** Metadata for a property.\n * @beta\n * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.\n */\nexport class PropertyMetaData implements PropertyMetaDataProps {\n  public primitiveType?: PrimitiveTypeCode;\n  public structName?: string;\n  public extendedType?: string;\n  public description?: string;\n  public displayLabel?: string;\n  public minimumValue?: any;\n  public maximumValue?: any;\n  public minimumLength?: number;\n  public maximumLength?: number;\n  public readOnly?: boolean;\n  public kindOfQuantity?: string;\n  public isCustomHandled?: boolean;\n  public isCustomHandledOrphan?: boolean;\n  public minOccurs?: number;\n  public maxOccurs?: number;\n  public direction?: string;\n  public relationshipClass?: string;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public customAttributes?: CustomAttribute[];\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public constructor(jsonObj: PropertyMetaDataProps) {\n    this.primitiveType = jsonObj.primitiveType;\n    if (jsonObj.structName)\n      this.structName = jsonObj.structName;\n    this.extendedType = jsonObj.extendedType;\n    this.description = jsonObj.description;\n    this.displayLabel = jsonObj.displayLabel;\n    if (undefined !== jsonObj.minimumValue)\n      this.minimumValue = jsonObj.minimumValue;\n    if (undefined !== jsonObj.maximumValue)\n      this.maximumValue = jsonObj.maximumValue;\n    if (undefined !== jsonObj.minimumLength)\n      this.minimumLength = jsonObj.minimumLength;\n    if (undefined !== jsonObj.maximumLength)\n      this.maximumLength = jsonObj.maximumLength;\n    this.readOnly = jsonObj.readOnly;\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\n    this.isCustomHandled = jsonObj.isCustomHandled;\n    if (undefined !== jsonObj.minOccurs)\n      this.minOccurs = jsonObj.minOccurs;\n    if (undefined !== jsonObj.maxOccurs)\n      this.maxOccurs = jsonObj.maxOccurs;\n    this.direction = jsonObj.direction;\n    this.relationshipClass = jsonObj.relationshipClass;\n    this.customAttributes = jsonObj.customAttributes;\n  }\n\n  /** Create a typed value, or array of values, from a factory and an input object */\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\n    if (undefined === this.minOccurs)\n      return func(jsonObj); // not an array\n\n    const val: any = [];\n    jsonObj.forEach((element: any) => val.push(func(element)));\n    return val;\n  }\n\n  /** construct a single property from an input object according to this metadata */\n  public createProperty(jsonObj: any): any {\n    if (jsonObj === undefined)\n      return undefined;\n\n    if (undefined !== this.primitiveType) {\n      switch (this.primitiveType) {\n        case PrimitiveTypeCode.Boolean:\n        case PrimitiveTypeCode.Double:\n        case PrimitiveTypeCode.Integer:\n        case PrimitiveTypeCode.String:\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\n\n        case PrimitiveTypeCode.Point2d:\n          return this.createValueOrArray((obj) => Point2d.fromJSON(obj), jsonObj);\n\n        case PrimitiveTypeCode.Point3d:\n          return this.createValueOrArray((obj) => Point3d.fromJSON(obj), jsonObj);\n      }\n    }\n    if (this.isNavigation)\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\n\n    return jsonObj;\n  }\n\n  /** Return `true` if this property is a NavigationProperty. */\n  public get isNavigation(): boolean {\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\n  }\n}\n\n/**\n * @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n */\nexport interface EntityMetaDataProps {\n  classId: Id64String;\n  ecclass: string;\n  description?: string;\n  modifier?: string;\n  displayLabel?: string;\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\n  baseClasses: string[];\n  /** The Custom Attributes for this class */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  properties: { [propName: string]: PropertyMetaData };\n}\n\n/** Metadata for an Entity.\n * @beta\n * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.\n */\nexport class EntityMetaData implements EntityMetaDataProps {\n  /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */\n  public readonly classId: Id64String;\n  /** The Entity name */\n  public readonly ecclass: string;\n  public readonly description?: string;\n  public readonly modifier?: string;\n  public readonly displayLabel?: string;\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\n  public readonly baseClasses: string[];\n  /** The Custom Attributes for this class */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public readonly customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public readonly properties: { [propName: string]: PropertyMetaData };\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public constructor(jsonObj: EntityMetaDataProps) {\n    this.classId = jsonObj.classId;\n    this.ecclass = jsonObj.ecclass;\n    this.description = jsonObj.description;\n    this.modifier = jsonObj.modifier;\n    this.displayLabel = jsonObj.displayLabel;\n    this.baseClasses = jsonObj.baseClasses;\n    this.customAttributes = jsonObj.customAttributes;\n    this.properties = {};\n\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n    }\n  }\n}\n"]}
+{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA6DhD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B;AA4DD;;;GAGG;AACH,4DAA4D;AAC5D,MAAM,OAAO,gBAAgB;IACpB,aAAa,CAAqB;IAClC,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,WAAW,CAAU;IACrB,YAAY,CAAU;IACtB,YAAY,CAAO;IACnB,YAAY,CAAO;IACnB,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,QAAQ,CAAW;IACnB,cAAc,CAAU;IACxB,eAAe,CAAW;IAC1B,qBAAqB,CAAW;IAChC,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,iBAAiB,CAAU;IAClC,4DAA4D;IACrD,gBAAgB,CAAqB;IAE5C,4DAA4D;IAC5D,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBAE1E,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAsBD;;;GAGG;AACH,4DAA4D;AAC5D,MAAM,OAAO,cAAc;IACzB,oFAAoF;IACpE,OAAO,CAAa;IACpC,sBAAsB;IACN,OAAO,CAAS;IAChB,WAAW,CAAU;IACrB,QAAQ,CAAU;IAClB,YAAY,CAAU;IACtC,uIAAuI;IACvH,WAAW,CAAW;IACtC,2CAA2C;IAC3C,4DAA4D;IAC5C,gBAAgB,CAAqB;IACrD,qFAAqF;IACrF,4DAA4D;IAC5C,UAAU,CAA2C;IAErE,4DAA4D;IAC5D,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,mCAAmC;YAC9E,4DAA4D;YAC5D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Entities\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\nimport { RelatedElement } from \"./ElementProps\";\n\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\n * between the backend and frontend.\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\n * no methods and no properties of `class` type.\n * @public @preview\n * @extensions\n */\nexport interface EntityProps {\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\n   * @see [Entity.isInstanceOfEntity]($backend).\n   */\n  readonly isInstanceOfEntity?: never;\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\n  classFullName: string;\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\n  id?: Id64String;\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\n  jsonProperties?: { [key: string]: any };\n}\n\n/** Specifies the source and target elements of a [[Relationship]] instance.\n * @public @preview\n * @extensions\n */\nexport interface SourceAndTarget {\n  sourceId: Id64String;\n  targetId: Id64String;\n}\n\n/** Properties that are common to all types of link table ECRelationships\n * @public @preview\n * @extensions\n */\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\n}\n\n/** Parameters for performing a query on [Entity]($backend) classes.\n * @public @preview\n * @extensions\n */\nexport interface EntityQueryParams {\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\n  from?: string;\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\n  only?: boolean;\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\n  where?: string;\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\n  orderBy?: string;\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\n  limit?: number;\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\n  offset?: number;\n  /** Bindings for parameterized values.\n   * @see [[ECSqlStatement.bindValues]]\n   */\n  bindings?: any[] | object;\n}\n\n/** The primitive types of an Entity property.\n * @beta\n */\nexport enum PrimitiveTypeCode {\n  Uninitialized = 0x00,\n  Binary = 0x101,\n  Boolean = 0x201,\n  DateTime = 0x301,\n  Double = 0x401,\n  Integer = 0x501,\n  Long = 0x601,\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\n  String = 0x901,\n  IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\n}\n\n/** A callback function to process properties of an Entity\n * @beta\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.\n *\n * @example\n * ```typescript\n * // Current usage:\n * const callback: PropertyCallback = (name: string, propMetaData: PropertyMetaData) => {\n *  console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n * };\n *\n * // Replacement:\n * const callback: PropertyHandler = (propName: string, property: Property) => {\n *  console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);\n * };\n * ```\n */\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/** A custom attribute instance\n * @beta\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.\n */\nexport interface CustomAttribute {\n  /** The class of the CustomAttribute */\n  ecclass: string;\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\n  properties: { [propName: string]: any };\n}\n\ntype FactoryFunc = (jsonObj: any) => any;\n\n/**\n * @beta\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `@itwin/ecschema-metadata` instead.\n */\nexport interface PropertyMetaDataProps {\n  primitiveType?: number;\n  structName?: string;\n  extendedType?: string;\n  description?: string;\n  displayLabel?: string;\n  minimumValue?: any;\n  maximumValue?: any;\n  minimumLength?: number;\n  maximumLength?: number;\n  readOnly?: boolean;\n  kindOfQuantity?: string;\n  isCustomHandled?: boolean;\n  isCustomHandledOrphan?: boolean;\n  minOccurs?: number;\n  maxOccurs?: number;\n  direction?: string;\n  relationshipClass?: string;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  customAttributes?: CustomAttribute[];\n}\n\n/** Metadata for a property.\n * @beta\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the `Property` class from @itwin/ecschema-metadata` instead.\n */\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport class PropertyMetaData implements PropertyMetaDataProps {\n  public primitiveType?: PrimitiveTypeCode;\n  public structName?: string;\n  public extendedType?: string;\n  public description?: string;\n  public displayLabel?: string;\n  public minimumValue?: any;\n  public maximumValue?: any;\n  public minimumLength?: number;\n  public maximumLength?: number;\n  public readOnly?: boolean;\n  public kindOfQuantity?: string;\n  public isCustomHandled?: boolean;\n  public isCustomHandledOrphan?: boolean;\n  public minOccurs?: number;\n  public maxOccurs?: number;\n  public direction?: string;\n  public relationshipClass?: string;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public customAttributes?: CustomAttribute[];\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public constructor(jsonObj: PropertyMetaDataProps) {\n    this.primitiveType = jsonObj.primitiveType;\n    if (jsonObj.structName)\n      this.structName = jsonObj.structName;\n    this.extendedType = jsonObj.extendedType;\n    this.description = jsonObj.description;\n    this.displayLabel = jsonObj.displayLabel;\n    if (undefined !== jsonObj.minimumValue)\n      this.minimumValue = jsonObj.minimumValue;\n    if (undefined !== jsonObj.maximumValue)\n      this.maximumValue = jsonObj.maximumValue;\n    if (undefined !== jsonObj.minimumLength)\n      this.minimumLength = jsonObj.minimumLength;\n    if (undefined !== jsonObj.maximumLength)\n      this.maximumLength = jsonObj.maximumLength;\n    this.readOnly = jsonObj.readOnly;\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\n    this.isCustomHandled = jsonObj.isCustomHandled;\n    if (undefined !== jsonObj.minOccurs)\n      this.minOccurs = jsonObj.minOccurs;\n    if (undefined !== jsonObj.maxOccurs)\n      this.maxOccurs = jsonObj.maxOccurs;\n    this.direction = jsonObj.direction;\n    this.relationshipClass = jsonObj.relationshipClass;\n    this.customAttributes = jsonObj.customAttributes;\n  }\n\n  /** Create a typed value, or array of values, from a factory and an input object */\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\n    if (undefined === this.minOccurs)\n      return func(jsonObj); // not an array\n\n    const val: any = [];\n    jsonObj.forEach((element: any) => val.push(func(element)));\n    return val;\n  }\n\n  /** construct a single property from an input object according to this metadata */\n  public createProperty(jsonObj: any): any {\n    if (jsonObj === undefined)\n      return undefined;\n\n    if (undefined !== this.primitiveType) {\n      switch (this.primitiveType) {\n        case PrimitiveTypeCode.Boolean:\n        case PrimitiveTypeCode.Double:\n        case PrimitiveTypeCode.Integer:\n        case PrimitiveTypeCode.String:\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\n\n        case PrimitiveTypeCode.Point2d:\n          return this.createValueOrArray((obj) => Point2d.fromJSON(obj), jsonObj);\n\n        case PrimitiveTypeCode.Point3d:\n          return this.createValueOrArray((obj) => Point3d.fromJSON(obj), jsonObj);\n      }\n    }\n    if (this.isNavigation)\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\n\n    return jsonObj;\n  }\n\n  /** Return `true` if this property is a NavigationProperty. */\n  public get isNavigation(): boolean {\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\n  }\n}\n\n/**\n * @beta\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `@itwin/ecschema-metadata` instead.\n */\nexport interface EntityMetaDataProps {\n  classId: Id64String;\n  ecclass: string;\n  description?: string;\n  modifier?: string;\n  displayLabel?: string;\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\n  baseClasses: string[];\n  /** The Custom Attributes for this class */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  properties: { [propName: string]: PropertyMetaData };\n}\n\n/** Metadata for an Entity.\n * @beta\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.\n */\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport class EntityMetaData implements EntityMetaDataProps {\n  /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */\n  public readonly classId: Id64String;\n  /** The Entity name */\n  public readonly ecclass: string;\n  public readonly description?: string;\n  public readonly modifier?: string;\n  public readonly displayLabel?: string;\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\n  public readonly baseClasses: string[];\n  /** The Custom Attributes for this class */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public readonly customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public readonly properties: { [propName: string]: PropertyMetaData };\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public constructor(jsonObj: EntityMetaDataProps) {\n    this.classId = jsonObj.classId;\n    this.ecclass = jsonObj.ecclass;\n    this.description = jsonObj.description;\n    this.modifier = jsonObj.modifier;\n    this.displayLabel = jsonObj.displayLabel;\n    this.baseClasses = jsonObj.baseClasses;\n    this.customAttributes = jsonObj.customAttributes;\n    this.properties = {};\n\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n    }\n  }\n}\n"]}

package/lib/esm/Fonts.d.ts

@@ -86,7 +86,7 @@ export interface RscFontEncodingProps {
 /** The properties of a FontMap
  * @public
  * @extensions
- * @deprecated in 5.0.0. Use [IModelDb.fonts]($backend)
+ * @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [IModelDb.fonts]($backend)
  */
 export interface FontMapProps {
     fonts: FontProps[];
@@ -97,7 +97,7 @@ export interface FontMapProps {
  * This class maps FontIds to FontProps.
  * @note This API has never worked properly. Don't use it. Use [IModelDb.fonts]($backend) instead.
  * @public
- * @deprecated in 5.0.0. Use [IModelDb.fonts]($backend) instead.
+ * @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [IModelDb.fonts]($backend) instead.
  */
 export declare class FontMap {
     readonly fonts: Map<number, FontProps>;

package/lib/esm/Fonts.js

@@ -36,7 +36,7 @@ export var FontType;
  * This class maps FontIds to FontProps.
  * @note This API has never worked properly. Don't use it. Use [IModelDb.fonts]($backend) instead.
  * @public
- * @deprecated in 5.0.0. Use [IModelDb.fonts]($backend) instead.
+ * @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [IModelDb.fonts]($backend) instead.
  */
 export class FontMap {
     fonts = new Map();

package/lib/esm/Fonts.js.map

@@ -1 +1 @@
-{"version":3,"file":"Fonts.js","sourceRoot":"","sources":["../../src/Fonts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,QAkBX;AAlBD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,+CAAY,CAAA;IACZ;;;;OAIG;IACH,qCAAO,CAAA;IACP;;;OAGG;IACH,qCAAO,CAAA;AACT,CAAC,EAlBW,QAAQ,KAAR,QAAQ,QAkBnB;AAyED;;;;;;;GAOG;AACH,MAAM,OAAO,OAAO;IACF,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IACrD,YAAY,KAAoB;QAC9B,IAAI,SAAS,KAAK,KAAK;YACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACM,QAAQ,CAAC,KAAkB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACzD,CAAC;IACM,MAAM;QACX,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IACD,iFAAiF;IAC1E,OAAO,CAAC,GAAoB;QACjC,IAAI,OAAO,GAAG,KAAK,QAAQ;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE7B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACpC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE;gBAC/C,OAAO,IAAI,CAAC;QAEhB,OAAO,SAAS,CAAC;IACnB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\n/** The [FontFile]($backend) encodings understood by iTwin.js.\n * @see [this article]($docs/learning/backend/Fonts.md) to learn more about fonts in iModels.\n * @public\n * @extensions\n */\nexport enum FontType {\n  /** [OpenType](https://en.wikipedia.org/wiki/OpenType) format, derived from and compatible with the earlier [TrueType](https://en.wikipedia.org/wiki/TrueType) format.\n   * The vast majority of modern, scalable, aesthetically-pleasing fonts are delivered in this format.\n   * OpenType files typically use one of the following suffixes: .ttf, .ttc, .otf, and .otc.\n   * @see [FontFile.createFromTrueTypeFileName]($backend) to work with font files in this format.\n   */\n  TrueType = 1,\n  /** [RSC](https://docs.bentley.com/LiveContent/web/MicroStation%20Help-v27/en/GUID-FC78484C-E42F-30BF-BF68-2B2C025AE040.html) is a simple font format\n   * originating in [MicroStation](https://en.wikipedia.org/wiki/MicroStation). In MicroStation, they are defined in \"resource files\" with a \".rsc\" suffix.\n   * In iModels, they are encoded in a binary format. Currently, no APIs exist to convert to this binary format, but some [connectors]($docs/learning/imodel-connectors.md) can\n   * perform the conversion.\n   */\n  Rsc = 2,\n  /** [SHX](https://help.autodesk.com/view/OARX/2024/ENU/?guid=GUID-DE941DB5-7044-433C-AA68-2A9AE98A5713) is a simple font format originating in\n   * [AutoCAD](https://en.wikipedia.org/wiki/AutoCAD). SHX fonts are generally distributed as files with a \".shx\" suffix.\n   * @see [FontFile.createFromShxFontBlob]($backend) to work with font files in this format.\n   */\n  Shx = 3,\n}\n\n/** An unsigned integer uniquely identifying a [font family]($docs/learning/backend/Fonts.md) in the context of an [[IModel]].\n * The iModel stores a mapping between `FontId`s and [[FontFamilyDescriptor]]s.\n * [[TextString]]s refer to fonts by the their `FontId`s.\n * A font Id of zero represents an invalid/non-existent font.\n * @see [IModelDbFonts]($backend) to work with font Ids.\n * @public\n * @extensions\n */\nexport type FontId = number;\n\n/** Uniquely describes one or more [[FontFace]]s sharing the same name and type comprising a single [font family]($docs/learning/backend/Fonts.md).\n * @public\n */\nexport interface FontFamilyDescriptor {\n  /** The encoding in which the font family's faces are stored. */\n  type: FontType;\n  /** The name of the family. */\n  name: string;\n}\n\n/** A [[FontFamilyDescriptor]] in which the [[FontType]] is optional, used when querying [[FontId]]s via [IModelDbFonts.findId]($backend).\n * If a font type is provided, this selector exactly identifies a unique font family, just like [[FontFamilyDescriptor]] does.\n * If the type is omitted, then the selector refers to the first font family that matches the specified [[name]]. If multiple families\n * with the same name exist, then a TrueType font will be preferred over a RSC font, and a RSC font preferred over an SHX font.\n * @beta\n */\nexport interface FontFamilySelector {\n  /** The encoding in which the font family's faces are stored. */\n  type?: FontType;\n  /** The name of the family. */\n  name: string;\n}\n\n/** Represents a [[FontFamilyDescriptor]] stored in an iModel with a unique numeric Id.\n * @public\n */\nexport interface FontProps extends FontFamilyDescriptor {\n  /** An integer that uniquely identifies this font family in the context of the iModel in which it is stored. */\n  id: FontId;\n}\n\n/** A specific variation of the glyphs defined by a [font family]($docs/learning/backend/Fonts.md).\n * Each face can be italicized, bolded, both, or neither.\n * Font faces are stored in [FontFile]($backend)s.\n * @beta\n */\nexport interface FontFace {\n  /** The name of the font family to which this face belongs. */\n  familyName: string;\n  isBold: boolean;\n  isItalic: boolean;\n}\n\n/** Information about the encoding of a [[FontType.Rsc]] [FontFile]($backend), used when embedding such a font into an iModel.\n * Currently, no public APIs exist to create such fonts.\n * @alpha\n */\nexport interface RscFontEncodingProps {\n  codePage?: number;\n  degree?: number;\n  plusMinus?: number;\n  diameter?: number;\n}\n\n/** The properties of a FontMap\n * @public\n * @extensions\n * @deprecated in 5.0.0. Use [IModelDb.fonts]($backend)\n */\nexport interface FontMapProps { fonts: FontProps[] }\n\n/**\n * A FontMap holds the set of font names available in an iModel.\n * Within the GeometryStream of an Element, a specific font is referenced by its FontId that is local to the iModel.\n * This class maps FontIds to FontProps.\n * @note This API has never worked properly. Don't use it. Use [IModelDb.fonts]($backend) instead.\n * @public\n * @deprecated in 5.0.0. Use [IModelDb.fonts]($backend) instead.\n */\nexport class FontMap {\n  public readonly fonts = new Map<FontId, FontProps>();\n  constructor(props?: FontMapProps) { // eslint-disable-line @typescript-eslint/no-deprecated\n    if (undefined !== props)\n      this.addFonts(props.fonts);\n  }\n  public addFonts(fonts: FontProps[]) {\n    fonts.forEach((font) => this.fonts.set(font.id, font));\n  }\n  public toJSON(): FontMapProps { // eslint-disable-line @typescript-eslint/no-deprecated\n    const fonts: FontProps[] = [];\n    this.fonts.forEach((font) => fonts.push(font));\n    return { fonts };\n  }\n  /** look up a font by case insensitive name or number and return its FontProps */\n  public getFont(arg: string | FontId): FontProps | undefined {\n    if (typeof arg === \"number\")\n      return this.fonts.get(arg);\n\n    for (const font of this.fonts.values())\n      if (font.name.toLowerCase() === arg.toLowerCase())\n        return font;\n\n    return undefined;\n  }\n}\n"]}
+{"version":3,"file":"Fonts.js","sourceRoot":"","sources":["../../src/Fonts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,QAkBX;AAlBD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,+CAAY,CAAA;IACZ;;;;OAIG;IACH,qCAAO,CAAA;IACP;;;OAGG;IACH,qCAAO,CAAA;AACT,CAAC,EAlBW,QAAQ,KAAR,QAAQ,QAkBnB;AAyED;;;;;;;GAOG;AACH,MAAM,OAAO,OAAO;IACF,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IACrD,YAAY,KAAoB;QAC9B,IAAI,SAAS,KAAK,KAAK;YACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACM,QAAQ,CAAC,KAAkB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACzD,CAAC;IACM,MAAM;QACX,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IACD,iFAAiF;IAC1E,OAAO,CAAC,GAAoB;QACjC,IAAI,OAAO,GAAG,KAAK,QAAQ;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE7B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACpC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE;gBAC/C,OAAO,IAAI,CAAC;QAEhB,OAAO,SAAS,CAAC;IACnB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\n/** The [FontFile]($backend) encodings understood by iTwin.js.\n * @see [this article]($docs/learning/backend/Fonts.md) to learn more about fonts in iModels.\n * @public\n * @extensions\n */\nexport enum FontType {\n  /** [OpenType](https://en.wikipedia.org/wiki/OpenType) format, derived from and compatible with the earlier [TrueType](https://en.wikipedia.org/wiki/TrueType) format.\n   * The vast majority of modern, scalable, aesthetically-pleasing fonts are delivered in this format.\n   * OpenType files typically use one of the following suffixes: .ttf, .ttc, .otf, and .otc.\n   * @see [FontFile.createFromTrueTypeFileName]($backend) to work with font files in this format.\n   */\n  TrueType = 1,\n  /** [RSC](https://docs.bentley.com/LiveContent/web/MicroStation%20Help-v27/en/GUID-FC78484C-E42F-30BF-BF68-2B2C025AE040.html) is a simple font format\n   * originating in [MicroStation](https://en.wikipedia.org/wiki/MicroStation). In MicroStation, they are defined in \"resource files\" with a \".rsc\" suffix.\n   * In iModels, they are encoded in a binary format. Currently, no APIs exist to convert to this binary format, but some [connectors]($docs/learning/imodel-connectors.md) can\n   * perform the conversion.\n   */\n  Rsc = 2,\n  /** [SHX](https://help.autodesk.com/view/OARX/2024/ENU/?guid=GUID-DE941DB5-7044-433C-AA68-2A9AE98A5713) is a simple font format originating in\n   * [AutoCAD](https://en.wikipedia.org/wiki/AutoCAD). SHX fonts are generally distributed as files with a \".shx\" suffix.\n   * @see [FontFile.createFromShxFontBlob]($backend) to work with font files in this format.\n   */\n  Shx = 3,\n}\n\n/** An unsigned integer uniquely identifying a [font family]($docs/learning/backend/Fonts.md) in the context of an [[IModel]].\n * The iModel stores a mapping between `FontId`s and [[FontFamilyDescriptor]]s.\n * [[TextString]]s refer to fonts by the their `FontId`s.\n * A font Id of zero represents an invalid/non-existent font.\n * @see [IModelDbFonts]($backend) to work with font Ids.\n * @public\n * @extensions\n */\nexport type FontId = number;\n\n/** Uniquely describes one or more [[FontFace]]s sharing the same name and type comprising a single [font family]($docs/learning/backend/Fonts.md).\n * @public\n */\nexport interface FontFamilyDescriptor {\n  /** The encoding in which the font family's faces are stored. */\n  type: FontType;\n  /** The name of the family. */\n  name: string;\n}\n\n/** A [[FontFamilyDescriptor]] in which the [[FontType]] is optional, used when querying [[FontId]]s via [IModelDbFonts.findId]($backend).\n * If a font type is provided, this selector exactly identifies a unique font family, just like [[FontFamilyDescriptor]] does.\n * If the type is omitted, then the selector refers to the first font family that matches the specified [[name]]. If multiple families\n * with the same name exist, then a TrueType font will be preferred over a RSC font, and a RSC font preferred over an SHX font.\n * @beta\n */\nexport interface FontFamilySelector {\n  /** The encoding in which the font family's faces are stored. */\n  type?: FontType;\n  /** The name of the family. */\n  name: string;\n}\n\n/** Represents a [[FontFamilyDescriptor]] stored in an iModel with a unique numeric Id.\n * @public\n */\nexport interface FontProps extends FontFamilyDescriptor {\n  /** An integer that uniquely identifies this font family in the context of the iModel in which it is stored. */\n  id: FontId;\n}\n\n/** A specific variation of the glyphs defined by a [font family]($docs/learning/backend/Fonts.md).\n * Each face can be italicized, bolded, both, or neither.\n * Font faces are stored in [FontFile]($backend)s.\n * @beta\n */\nexport interface FontFace {\n  /** The name of the font family to which this face belongs. */\n  familyName: string;\n  isBold: boolean;\n  isItalic: boolean;\n}\n\n/** Information about the encoding of a [[FontType.Rsc]] [FontFile]($backend), used when embedding such a font into an iModel.\n * Currently, no public APIs exist to create such fonts.\n * @alpha\n */\nexport interface RscFontEncodingProps {\n  codePage?: number;\n  degree?: number;\n  plusMinus?: number;\n  diameter?: number;\n}\n\n/** The properties of a FontMap\n * @public\n * @extensions\n * @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [IModelDb.fonts]($backend)\n */\nexport interface FontMapProps { fonts: FontProps[] }\n\n/**\n * A FontMap holds the set of font names available in an iModel.\n * Within the GeometryStream of an Element, a specific font is referenced by its FontId that is local to the iModel.\n * This class maps FontIds to FontProps.\n * @note This API has never worked properly. Don't use it. Use [IModelDb.fonts]($backend) instead.\n * @public\n * @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [IModelDb.fonts]($backend) instead.\n */\nexport class FontMap {\n  public readonly fonts = new Map<FontId, FontProps>();\n  constructor(props?: FontMapProps) { // eslint-disable-line @typescript-eslint/no-deprecated\n    if (undefined !== props)\n      this.addFonts(props.fonts);\n  }\n  public addFonts(fonts: FontProps[]) {\n    fonts.forEach((font) => this.fonts.set(font.id, font));\n  }\n  public toJSON(): FontMapProps { // eslint-disable-line @typescript-eslint/no-deprecated\n    const fonts: FontProps[] = [];\n    this.fonts.forEach((font) => fonts.push(font));\n    return { fonts };\n  }\n  /** look up a font by case insensitive name or number and return its FontProps */\n  public getFont(arg: string | FontId): FontProps | undefined {\n    if (typeof arg === \"number\")\n      return this.fonts.get(arg);\n\n    for (const font of this.fonts.values())\n      if (font.name.toLowerCase() === arg.toLowerCase())\n        return font;\n\n    return undefined;\n  }\n}\n"]}

package/lib/esm/GeoCoordinateServices.d.ts

@@ -51,7 +51,7 @@ export declare enum GeoCoordStatus {
     /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend
      *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).
      *  At the completion of the conversion promise no coordinates should have this status.
-     * @deprecated in 5.0. Pending is no longer returned as a status for coordinate conversions.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Pending is no longer returned as a status for coordinate conversions.
      */
     Pending = -41556
 }

package/lib/esm/GeoCoordinateServices.js

@@ -55,7 +55,7 @@ export var GeoCoordStatus;
     /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend
      *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).
      *  At the completion of the conversion promise no coordinates should have this status.
-     * @deprecated in 5.0. Pending is no longer returned as a status for coordinate conversions.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Pending is no longer returned as a status for coordinate conversions.
      */
     GeoCoordStatus[GeoCoordStatus["Pending"] = -41556] = "Pending";
 })(GeoCoordStatus || (GeoCoordStatus = {}));

package/lib/esm/GeoCoordinateServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeoCoordinateServices.js","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,qDAAqD;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,cA2CX;AA3CD,WAAY,cAAc;IACxB,kDAAkD;IAClD,yDAAW,CAAA;IACX,sIAAsI;IACtI,qEAAkB,CAAA;IAClB;;;;;;;;;;OAUG;IACH,2EAAoB,CAAA;IACpB;;;;OAIG;IACH,yFAA2B,CAAA;IAC3B;;;;OAIG;IACH,4EAAqB,CAAA;IACrB;;;;OAIG;IACH,8FAA8B,CAAA;IAC9B,sGAAsG;IACtG,kEAAiB,CAAA;IACjB;;;;OAIG;IACH,8DAAgB,CAAA;AAClB,CAAC,EA3CW,cAAc,KAAd,cAAc,QA2CzB;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAiB;IACrD,QAAQ,CAAC,EAAE,CAAC;QACV,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC;QAC7D,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,gBAAgB,CAAC,aAAa,CAAC;QACxE,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,uBAAuB,CAAC,CAAC,OAAO,gBAAgB,CAAC,uBAAuB,CAAC;QAC7F,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,yBAAyB,CAAC,CAAC,OAAO,gBAAgB,CAAC,yBAAyB,CAAC;QACjG,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC;QACnE,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,uDAAuD;QACrH;YACE,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;IACpF,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\n// cspell:ignore NGVD, NAVD, COMPD_CS, PROJCS, GEOGCS\n\nimport { GeoServiceStatus } from \"@itwin/core-bentley\";\nimport { XYZProps } from \"@itwin/core-geometry\";\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\n\n/** This enumeration lists all possible status as returned from a coordinate conversion to or from a\n * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].\n * @see [[GeoConverter]] to perform coordinate conversions.\n * @see [[PointWithStatus]] for the result of a coordinate conversion, including its status code.\n * @public\n * @extensions\n */\nexport enum GeoCoordStatus {\n  /** Indicates successful coordinate conversion. */\n  Success = 0,\n  /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/\n  NoGCSDefined = 100,\n  /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.\n   *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and\n   *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.\n   *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization\n   *  of global imagery or other low accuracy context data is not essential far from the project.\n   *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected\n   *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action\n   *  can be performed to verify used geolocation parameters.\n   *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical\n   *  elements.\n   */\n  OutOfUsefulRange = 1,\n  /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either\n   *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees\n   *  East or West of the projection central meridian.\n   *  The values returned may or may not be valid and should be discarded.\n   */\n  OutOfMathematicalDomain = 2,\n  /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.\n   *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained\n   *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.\n   *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.\n   */\n  NoDatumConverter = 25,\n  /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the\n   *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).\n   *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.\n   *  This status should be somehow reported so actions can be performed to provide the missing information.\n   */\n  VerticalDatumConvertError = 26,\n  /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */\n  CSMapError = 4096,\n  /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend\n   *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).\n   *  At the completion of the conversion promise no coordinates should have this status.\n   * @deprecated in 5.0. Pending is no longer returned as a status for coordinate conversions.\n   */\n  Pending = -41556,\n}\n\n/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.\n * @public\n */\nexport function mapToGeoServiceStatus(s: GeoCoordStatus): GeoServiceStatus {\n  switch (s) {\n    case GeoCoordStatus.Success: return GeoServiceStatus.Success;\n    case GeoCoordStatus.NoGCSDefined: return GeoServiceStatus.NoGeoLocation;\n    case GeoCoordStatus.OutOfUsefulRange: return GeoServiceStatus.OutOfUsefulRange;\n    case GeoCoordStatus.OutOfMathematicalDomain: return GeoServiceStatus.OutOfMathematicalDomain;\n    case GeoCoordStatus.NoDatumConverter: return GeoServiceStatus.NoDatumConverter;\n    case GeoCoordStatus.VerticalDatumConvertError: return GeoServiceStatus.VerticalDatumConvertError;\n    case GeoCoordStatus.CSMapError: return GeoServiceStatus.CSMapError;\n    case GeoCoordStatus.Pending: return GeoServiceStatus.Pending; // eslint-disable-line @typescript-eslint/no-deprecated\n    default:\n      throw new Error(\"GeoCoordStatus -> GeoServiceStatus - Missing enum conversion\");\n  }\n}\n\n/** Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates\n * @beta\n */\nexport interface IModelCoordinatesRequestProps {\n  source: string;\n  geoCoords: XYZProps[];\n}\n\n/** A point converted to iModel coordinates to geographic coordinates or vice-versa by a [[GeoConverter]].\n * The status [[s]] indicates the converted point [[p]]'s degree of accuracy.\n * @public\n */\nexport interface PointWithStatus {\n  /** A JSON representation of the converted point. */\n  p: XYZProps;\n  /** A status code indicating the degree of accuracy with the point [[p]] was converted. */\n  s: GeoCoordStatus;\n}\n\n/** @beta */\nexport interface IModelCoordinatesResponseProps {\n  iModelCoords: PointWithStatus[];\n  fromCache: number;    // the number that were read from the cache rather than calculated.\n}\n\n/** Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\n * @beta\n */\nexport interface GeoCoordinatesRequestProps {\n  target: string;\n  iModelCoords: XYZProps[];\n}\n\n/** Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\n * @beta\n */\nexport interface GeoCoordinatesResponseProps {\n  geoCoords: PointWithStatus[];\n  fromCache: number;    // the number that were read from the cache rather than calculated.\n}\n\n/** Information required to interpret or complete a Geographic CRS in the specified format.\n *  The only currently supported formats are JSON (for completion) and WKT (OGC Well Known Text)\n * @beta\n */\nexport interface GeographicCRSInterpretRequestProps {\n  /** The format of the geographic CRS definition provided in the geographicCRSDef property. */\n  format: \"WKT\" | \"JSON\";\n  /** The geographic CRS definition in the format specified in the format property.\n   *  Note that when the WKT is used the WKT fragment provided can start with a COMPD_CS clause\n   *  which should then contain both the horizontal CRS definition as well as the vertical CRS specification.\n   *  WKT fragments starting with PROJCS or GEOGCS are also supported but the vertical CRS will be assigned a\n   *  default value.\n  */\n  geographicCRSDef: string;\n}\n\n/** Information returned from a request to interpret or complete a Geographic CRS\n * @beta\n */\nexport interface GeographicCRSInterpretResponseProps {\n  /** The result status of the interpret operation. A value of zero indicates successful interpretation.\n   *  Any value other than zero is to be considered a hard error and no valid result will\n   *  be returned in the geographicCRS property.\n  */\n  status: number;\n  /** The property that receives the interpreted geographic CRS if the process was successful. */\n  geographicCRS?: GeographicCRSProps;\n}\n"]}
+{"version":3,"file":"GeoCoordinateServices.js","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,qDAAqD;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,cA2CX;AA3CD,WAAY,cAAc;IACxB,kDAAkD;IAClD,yDAAW,CAAA;IACX,sIAAsI;IACtI,qEAAkB,CAAA;IAClB;;;;;;;;;;OAUG;IACH,2EAAoB,CAAA;IACpB;;;;OAIG;IACH,yFAA2B,CAAA;IAC3B;;;;OAIG;IACH,4EAAqB,CAAA;IACrB;;;;OAIG;IACH,8FAA8B,CAAA;IAC9B,sGAAsG;IACtG,kEAAiB,CAAA;IACjB;;;;OAIG;IACH,8DAAgB,CAAA;AAClB,CAAC,EA3CW,cAAc,KAAd,cAAc,QA2CzB;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAiB;IACrD,QAAQ,CAAC,EAAE,CAAC;QACV,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC;QAC7D,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,gBAAgB,CAAC,aAAa,CAAC;QACxE,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,uBAAuB,CAAC,CAAC,OAAO,gBAAgB,CAAC,uBAAuB,CAAC;QAC7F,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,yBAAyB,CAAC,CAAC,OAAO,gBAAgB,CAAC,yBAAyB,CAAC;QACjG,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC;QACnE,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,uDAAuD;QACrH;YACE,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;IACpF,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\n// cspell:ignore NGVD, NAVD, COMPD_CS, PROJCS, GEOGCS\n\nimport { GeoServiceStatus } from \"@itwin/core-bentley\";\nimport { XYZProps } from \"@itwin/core-geometry\";\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\n\n/** This enumeration lists all possible status as returned from a coordinate conversion to or from a\n * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].\n * @see [[GeoConverter]] to perform coordinate conversions.\n * @see [[PointWithStatus]] for the result of a coordinate conversion, including its status code.\n * @public\n * @extensions\n */\nexport enum GeoCoordStatus {\n  /** Indicates successful coordinate conversion. */\n  Success = 0,\n  /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/\n  NoGCSDefined = 100,\n  /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.\n   *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and\n   *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.\n   *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization\n   *  of global imagery or other low accuracy context data is not essential far from the project.\n   *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected\n   *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action\n   *  can be performed to verify used geolocation parameters.\n   *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical\n   *  elements.\n   */\n  OutOfUsefulRange = 1,\n  /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either\n   *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees\n   *  East or West of the projection central meridian.\n   *  The values returned may or may not be valid and should be discarded.\n   */\n  OutOfMathematicalDomain = 2,\n  /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.\n   *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained\n   *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.\n   *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.\n   */\n  NoDatumConverter = 25,\n  /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the\n   *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).\n   *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.\n   *  This status should be somehow reported so actions can be performed to provide the missing information.\n   */\n  VerticalDatumConvertError = 26,\n  /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */\n  CSMapError = 4096,\n  /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend\n   *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).\n   *  At the completion of the conversion promise no coordinates should have this status.\n   * @deprecated in 5.0 - will not be removed until after 2026-06-13. Pending is no longer returned as a status for coordinate conversions.\n   */\n  Pending = -41556,\n}\n\n/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.\n * @public\n */\nexport function mapToGeoServiceStatus(s: GeoCoordStatus): GeoServiceStatus {\n  switch (s) {\n    case GeoCoordStatus.Success: return GeoServiceStatus.Success;\n    case GeoCoordStatus.NoGCSDefined: return GeoServiceStatus.NoGeoLocation;\n    case GeoCoordStatus.OutOfUsefulRange: return GeoServiceStatus.OutOfUsefulRange;\n    case GeoCoordStatus.OutOfMathematicalDomain: return GeoServiceStatus.OutOfMathematicalDomain;\n    case GeoCoordStatus.NoDatumConverter: return GeoServiceStatus.NoDatumConverter;\n    case GeoCoordStatus.VerticalDatumConvertError: return GeoServiceStatus.VerticalDatumConvertError;\n    case GeoCoordStatus.CSMapError: return GeoServiceStatus.CSMapError;\n    case GeoCoordStatus.Pending: return GeoServiceStatus.Pending; // eslint-disable-line @typescript-eslint/no-deprecated\n    default:\n      throw new Error(\"GeoCoordStatus -> GeoServiceStatus - Missing enum conversion\");\n  }\n}\n\n/** Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates\n * @beta\n */\nexport interface IModelCoordinatesRequestProps {\n  source: string;\n  geoCoords: XYZProps[];\n}\n\n/** A point converted to iModel coordinates to geographic coordinates or vice-versa by a [[GeoConverter]].\n * The status [[s]] indicates the converted point [[p]]'s degree of accuracy.\n * @public\n */\nexport interface PointWithStatus {\n  /** A JSON representation of the converted point. */\n  p: XYZProps;\n  /** A status code indicating the degree of accuracy with the point [[p]] was converted. */\n  s: GeoCoordStatus;\n}\n\n/** @beta */\nexport interface IModelCoordinatesResponseProps {\n  iModelCoords: PointWithStatus[];\n  fromCache: number;    // the number that were read from the cache rather than calculated.\n}\n\n/** Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\n * @beta\n */\nexport interface GeoCoordinatesRequestProps {\n  target: string;\n  iModelCoords: XYZProps[];\n}\n\n/** Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\n * @beta\n */\nexport interface GeoCoordinatesResponseProps {\n  geoCoords: PointWithStatus[];\n  fromCache: number;    // the number that were read from the cache rather than calculated.\n}\n\n/** Information required to interpret or complete a Geographic CRS in the specified format.\n *  The only currently supported formats are JSON (for completion) and WKT (OGC Well Known Text)\n * @beta\n */\nexport interface GeographicCRSInterpretRequestProps {\n  /** The format of the geographic CRS definition provided in the geographicCRSDef property. */\n  format: \"WKT\" | \"JSON\";\n  /** The geographic CRS definition in the format specified in the format property.\n   *  Note that when the WKT is used the WKT fragment provided can start with a COMPD_CS clause\n   *  which should then contain both the horizontal CRS definition as well as the vertical CRS specification.\n   *  WKT fragments starting with PROJCS or GEOGCS are also supported but the vertical CRS will be assigned a\n   *  default value.\n  */\n  geographicCRSDef: string;\n}\n\n/** Information returned from a request to interpret or complete a Geographic CRS\n * @beta\n */\nexport interface GeographicCRSInterpretResponseProps {\n  /** The result status of the interpret operation. A value of zero indicates successful interpretation.\n   *  Any value other than zero is to be considered a hard error and no valid result will\n   *  be returned in the geographicCRS property.\n  */\n  status: number;\n  /** The property that receives the interpreted geographic CRS if the process was successful. */\n  geographicCRS?: GeographicCRSProps;\n}\n"]}

package/lib/esm/GeometryParams.d.ts

@@ -17,7 +17,9 @@ export declare enum FillDisplay {
     ByView = 1,
     /** always fill, even if the fill attribute is off for the viewport */
     Always = 2,
-    /** always fill, fill will always be behind other geometry */
+    /** always fill, fill will always be behind other geometry belonging to the same element.
+     * @note Edge geometry is not produced for shapes with this fill type. If you want an outline, add it as separate geometry.
+     */
     Blanking = 3
 }
 /** Describes how a view's background color affects the interior area of a closed region.

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

@@ -1 +1 @@
-{"version":3,"file":"GeometryParams.d.ts","sourceRoot":"","sources":["../../src/GeometryParams.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;;GAGG;AACH,oBAAY,WAAW;IACrB,gEAAgE;IAChE,KAAK,IAAI;IACT,wDAAwD;IACxD,MAAM,IAAI;IACV,sEAAsE;IACtE,MAAM,IAAI;IACV,6DAA6D;IAC7D,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,kGAAkG;IAClG,IAAI,IAAI;IACR,8EAA8E;IAC9E,KAAK,IAAI;IACT,gGAAgG;IAChG,OAAO,IAAI;CACZ;AAED;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,kGAAkG;IAClG,OAAO,IAAI;IACX,qHAAqH;IACrH,YAAY,IAAI;IAChB,mFAAmF;IACnF,SAAS,IAAI;IACb,mGAAmG;IACnG,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,qBAAa,cAAc;IA+DN,UAAU,EAAE,UAAU;IAAS,aAAa;IA9D/D;;OAEG;IACI,UAAU,CAAC,EAAE,UAAU,CAAC;IAC/B;;OAEG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACI,MAAM,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACI,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC5B;;;OAGG;IACI,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC5B;;OAEG;IACI,cAAc,CAAC,EAAE,cAAc,CAAC;IACvC;;;OAGG;IACI,WAAW,CAAC,EAAE,WAAW,CAAC;IACjC;;;OAGG;IACI,eAAe,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACI,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACI,aAAa,CAAC,EAAE,aAAa,CAAC;IACrC;;OAEG;IACI,SAAS,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC;IAClC;;OAEG;IACI,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;IAChC;;OAEG;IACI,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAEpC;;;;OAIG;gBACgB,UAAU,EAAE,UAAU,EAAS,aAAa,SAAe;IAKvE,KAAK,IAAI,cAAc;IAkB9B,wGAAwG;IACjG,eAAe;IAgBtB,6JAA6J;IACtJ,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;IA8DnD,oLAAoL;IAC7K,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,wBAAwB,UAAO;IAO5E,gHAAgH;IACzG,gBAAgB,CAAC,aAAa,EAAE,UAAU,EAAE,wBAAwB,UAAO;CAKnF"}
+{"version":3,"file":"GeometryParams.d.ts","sourceRoot":"","sources":["../../src/GeometryParams.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;;GAGG;AACH,oBAAY,WAAW;IACrB,gEAAgE;IAChE,KAAK,IAAI;IACT,wDAAwD;IACxD,MAAM,IAAI;IACV,sEAAsE;IACtE,MAAM,IAAI;IACV;;OAEG;IACH,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,kGAAkG;IAClG,IAAI,IAAI;IACR,8EAA8E;IAC9E,KAAK,IAAI;IACT,gGAAgG;IAChG,OAAO,IAAI;CACZ;AAED;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,kGAAkG;IAClG,OAAO,IAAI;IACX,qHAAqH;IACrH,YAAY,IAAI;IAChB,mFAAmF;IACnF,SAAS,IAAI;IACb,mGAAmG;IACnG,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,qBAAa,cAAc;IA+DN,UAAU,EAAE,UAAU;IAAS,aAAa;IA9D/D;;OAEG;IACI,UAAU,CAAC,EAAE,UAAU,CAAC;IAC/B;;OAEG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACI,MAAM,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACI,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC5B;;;OAGG;IACI,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC5B;;OAEG;IACI,cAAc,CAAC,EAAE,cAAc,CAAC;IACvC;;;OAGG;IACI,WAAW,CAAC,EAAE,WAAW,CAAC;IACjC;;;OAGG;IACI,eAAe,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACI,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACI,aAAa,CAAC,EAAE,aAAa,CAAC;IACrC;;OAEG;IACI,SAAS,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC;IAClC;;OAEG;IACI,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;IAChC;;OAEG;IACI,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAEpC;;;;OAIG;gBACgB,UAAU,EAAE,UAAU,EAAS,aAAa,SAAe;IAKvE,KAAK,IAAI,cAAc;IAkB9B,wGAAwG;IACjG,eAAe;IAgBtB,6JAA6J;IACtJ,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;IA8DnD,oLAAoL;IAC7K,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,wBAAwB,UAAO;IAO5E,gHAAgH;IACzG,gBAAgB,CAAC,aAAa,EAAE,UAAU,EAAE,wBAAwB,UAAO;CAKnF"}

package/lib/esm/GeometryParams.js

@@ -19,7 +19,9 @@ export var FillDisplay;
     FillDisplay[FillDisplay["ByView"] = 1] = "ByView";
     /** always fill, even if the fill attribute is off for the viewport */
     FillDisplay[FillDisplay["Always"] = 2] = "Always";
-    /** always fill, fill will always be behind other geometry */
+    /** always fill, fill will always be behind other geometry belonging to the same element.
+     * @note Edge geometry is not produced for shapes with this fill type. If you want an outline, add it as separate geometry.
+     */
     FillDisplay[FillDisplay["Blanking"] = 3] = "Blanking";
 })(FillDisplay || (FillDisplay = {}));
 /** Describes how a view's background color affects the interior area of a closed region.

package/lib/esm/GeometryParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeometryParams.js","sourceRoot":"","sources":["../../src/GeometryParams.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAKvD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,gEAAgE;IAChE,+CAAS,CAAA;IACT,wDAAwD;IACxD,iDAAU,CAAA;IACV,sEAAsE;IACtE,iDAAU,CAAA;IACV,6DAA6D;IAC7D,qDAAY,CAAA;AACd,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,kGAAkG;IAClG,mDAAQ,CAAA;IACR,8EAA8E;IAC9E,qDAAS,CAAA;IACT,gGAAgG;IAChG,yDAAW,CAAA;AACb,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,aASX;AATD,WAAY,aAAa;IACvB,kGAAkG;IAClG,uDAAW,CAAA;IACX,qHAAqH;IACrH,iEAAgB,CAAA;IAChB,mFAAmF;IACnF,2DAAa,CAAA;IACb,mGAAmG;IACnG,uDAAW,CAAA;AACb,CAAC,EATW,aAAa,KAAb,aAAa,QASxB;AAED;;;GAGG;AACH,MAAM,OAAO,cAAc;IA+DN;IAA+B;IA9DlD;;OAEG;IACI,UAAU,CAAc;IAC/B;;OAEG;IACI,WAAW,CAAU;IAC5B;;OAEG;IACI,MAAM,CAAU;IACvB;;OAEG;IACI,SAAS,CAAY;IAC5B;;;OAGG;IACI,SAAS,CAAY;IAC5B;;OAEG;IACI,cAAc,CAAkB;IACvC;;;OAGG;IACI,WAAW,CAAe;IACjC;;;OAGG;IACI,eAAe,CAAU;IAChC;;;OAGG;IACI,gBAAgB,CAAU;IACjC;;OAEG;IACI,aAAa,CAAiB;IACrC;;OAEG;IACI,SAAS,CAAkB;IAClC;;OAEG;IACI,QAAQ,CAAiB;IAChC;;OAEG;IACI,OAAO,CAAsB;IAEpC;;;;OAIG;IACH,YAAmB,UAAsB,EAAS,gBAAgB,IAAI,CAAC,OAAO;QAA3D,eAAU,GAAV,UAAU,CAAY;QAAS,kBAAa,GAAb,aAAa,CAAe;QAC5E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACpC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC9C,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACpE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,wGAAwG;IACjG,eAAe;QACpB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3B,CAAC;IAED,6JAA6J;IACtJ,YAAY,CAAC,KAAqB;QACvC,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC,CAAC,eAAe;QAE9B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACtC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;YAChD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;YAClD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC9B,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAW;YAC1D,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7E,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC;gBAClE,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC;gBACzD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;gBAC9C,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBACrF,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;oBACpE,OAAO,KAAK,CAAC;gBACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;oBAC5D,OAAO,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAQ,CAAC;YACtD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oLAAoL;IAC7K,aAAa,CAAC,UAAsB,EAAE,wBAAwB,GAAG,IAAI;QAC1E,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAED,gHAAgH;IACzG,gBAAgB,CAAC,aAAyB,EAAE,wBAAwB,GAAG,IAAI;QAChF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { AreaPattern } from \"./geometry/AreaPattern\";\nimport { LineStyle } from \"./geometry/LineStyle\";\nimport { Gradient } from \"./Gradient\";\nimport { IModel } from \"./IModel\";\n\n/** Whether a closed region should be drawn for wireframe display with its internal area filled or not.\n * @public\n * @extensions\n */\nexport enum FillDisplay {\n  /** don't fill, even if fill attribute is on for the viewport */\n  Never = 0,\n  /** fill if the fill attribute is on for the viewport */\n  ByView = 1,\n  /** always fill, even if the fill attribute is off for the viewport */\n  Always = 2,\n  /** always fill, fill will always be behind other geometry */\n  Blanking = 3,\n}\n\n/** Describes how a view's background color affects the interior area of a closed region.\n * @public\n * @extensions\n */\nexport enum BackgroundFill {\n  /** single color fill uses the fill color and line color to draw either a solid or outline fill */\n  None = 0,\n  /** single color fill uses the view's background color to draw a solid fill */\n  Solid = 1,\n  /** single color fill uses the view's background color and line color to draw an outline fill */\n  Outline = 2,\n}\n\n/** Categorizes a piece of geometry within a GeometryStream. Visibility of classes of geometry can be toggled\n * within a view using [[ViewFlags]].\n * @see [[GeometryStreamProps]].\n * @see [[Feature]].\n * @public\n * @extensions\n */\nexport enum GeometryClass {\n  /** Used to classify the \"real\" geometry within a model. Most geometry falls within this class. */\n  Primary = 0,\n  /** Used to classify geometry used as a drawing aid in constructing the Primary geometry. For example, grid lines. */\n  Construction = 1,\n  /** Used to classify annotations which dimension (measure) the Primary geometry. */\n  Dimension = 2,\n  /** Used to classify geometry used to fill planar regions with a 2d pattern (e.g., hatch lines). */\n  Pattern = 3,\n}\n\n/** Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from [[SubCategoryAppearance]].\n * @see [[GeometryStreamProps]].\n * @public\n */\nexport class GeometryParams {\n  /** Optional render material to override [[SubCategoryAppearance.materialId]].\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.materialId]] with no material.\n   */\n  public materialId?: Id64String;\n  /** Optional display priority added to [[SubCategoryAppearance.priority]].\n   * The net display priority value is used to control z ordering when drawing to 2d views.\n   */\n  public elmPriority?: number;\n  /** Optional line weight to override [[SubCategoryAppearance.weight]].\n   * The weight is an integer in the range of [0,31] that by default corresponds to a pixel width of weight+1.\n   */\n  public weight?: number;\n  /** Optional line color to override [[SubCategoryAppearance.color]].\n   * The transparency component is ignored and should instead be specified using [[elmTransparency]].\n   */\n  public lineColor?: ColorDef;\n  /** Optional fill color for region interiors. Set the same as [[lineColor]] for an opaque fill.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]], [[gradient]] is undefined, and [[backgroundFill]] is [[BackgroundFill.None]].\n   * The transparency component is ignored and should instead be specified using [[fillTransparency]].\n   */\n  public fillColor?: ColorDef;\n  /** Optional fill using the current view background color for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]] and [[gradient]] is undefined. Default is [[BackgroundFill.None]].\n   */\n  public backgroundFill?: BackgroundFill;\n  /** Optional fill specification that determines when and if a region interior will display using [[gradient]], [[backgroundFill]], or [[fillColor]] in that order of preference.\n   * Fill only applies to [[RenderMode.Wireframe]] views. In a [[RenderMode.SmoothShade]] or [[RenderMode.SolidFill]] view, regions will always display as surfaces preferring [[fillColor]] when present over [[lineColor]].\n   * Default is [[FillDisplay.Never]].\n   */\n  public fillDisplay?: FillDisplay;\n  /** Optional line color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent element on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque and 1.0 for completely transparent.\n   */\n  public elmTransparency?: number;\n  /** Optional fill color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent fill on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque, 1.0 for completely transparent, or leave undefined to use [[elmTransparency]].\n   */\n  public fillTransparency?: number;\n  /** Optional geometry classification that can be toggled off with a [[ViewFlags]] independent of [[SubCategoryAppearance.invisible]].\n   * Default is [[GeometryClass.Primary]].\n   */\n  public geometryClass?: GeometryClass;\n  /** Optional line style to override [[SubCategoryAppearance.styleId]] plus modifiers to override the line style definition.\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.styleId]] with a solid line.\n   */\n  public styleInfo?: LineStyle.Info;\n  /** Optional gradient fill settings for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]].\n   */\n  public gradient?: Gradient.Symb;\n  /** Optional area pattern settings for region interiors.\n   * Independent of fill, a region can have both fill and pattern.\n   */\n  public pattern?: AreaPattern.Params;\n\n  /** Create a GeometryParams given a [[Category]] Id for a [[GeometricElement]] and optional [[SubCategory]] Id. The [[SubCategory.appearance]] establishes the non-overriden display properties of\n   * graphics in a GeometricElement's [[GeometryStreamProps]]. A GeometricElement refers to a single Category through [[GeometricElement.category]], while it's graphics can appear on multiple SubCategories\n   * by adding a [[GeometryAppearanceProps]] with a SubCategory change to the GeometryStream.\n   * @note If a valid SubCategory Id is not supplied, the default SubCategory for the parent Category is used. To be considered valid, [[SubCategory.getCategoryId]] must refer to the specified Category Id.\n   */\n  constructor(public categoryId: Id64String, public subCategoryId = Id64.invalid) {\n    if (!Id64.isValid(subCategoryId))\n      this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n  }\n\n  public clone(): GeometryParams {\n    const retVal = new GeometryParams(this.categoryId, this.subCategoryId);\n    retVal.materialId = this.materialId;\n    retVal.elmPriority = this.elmPriority;\n    retVal.weight = this.weight;\n    retVal.lineColor = this.lineColor;\n    retVal.fillColor = this.fillColor;\n    retVal.backgroundFill = this.backgroundFill;\n    retVal.fillDisplay = this.fillDisplay;\n    retVal.elmTransparency = this.elmTransparency;\n    retVal.fillTransparency = this.fillTransparency;\n    retVal.geometryClass = this.geometryClass;\n    retVal.styleInfo = this.styleInfo ? this.styleInfo.clone() : undefined;\n    retVal.gradient = this.gradient ? this.gradient.clone() : undefined;\n    retVal.pattern = this.pattern ? this.pattern.clone() : undefined;\n    return retVal;\n  }\n\n  /** Clears [[SubCategoryAppearance]] overrides while preserving [[categoryId]] and [[subCategoryId]]. */\n  public resetAppearance() {\n    this.materialId = undefined;\n    this.elmPriority = undefined;\n    this.weight = undefined;\n    this.lineColor = undefined;\n    this.fillColor = undefined;\n    this.backgroundFill = undefined;\n    this.fillDisplay = undefined;\n    this.elmTransparency = undefined;\n    this.fillTransparency = undefined;\n    this.geometryClass = undefined;\n    this.styleInfo = undefined;\n    this.gradient = undefined;\n    this.pattern = undefined;\n  }\n\n  /** Compare two [[GeometryParams]] for equivalence, i.e. both values are undefined and inherited from [[SubCategoryAppearance]] or have the same override. */\n  public isEquivalent(other: GeometryParams): boolean {\n    if (this === other)\n      return true; // Same pointer\n\n    if (this.categoryId !== other.categoryId)\n      return false;\n    if (this.subCategoryId !== other.subCategoryId)\n      return false;\n    if (this.geometryClass !== other.geometryClass)\n      return false;\n\n    if (this.elmPriority !== other.elmPriority)\n      return false;\n    if (this.elmTransparency !== other.elmTransparency)\n      return false;\n    if (this.fillTransparency !== other.fillTransparency)\n      return false;\n\n    if ((this.lineColor === undefined) !== (other.lineColor === undefined))\n      return false;\n    if (this.lineColor && !this.lineColor.equals(other.lineColor!))\n      return false;\n\n    if (this.weight !== other.weight)\n      return false;\n\n    if ((this.materialId === undefined) !== (other.materialId === undefined))\n      return false;\n    if (this.materialId && this.materialId !== other.materialId!)\n      return false;\n\n    if ((this.styleInfo === undefined) !== (other.styleInfo === undefined))\n      return false;\n    if (this.styleInfo && !this.styleInfo.equals(other.styleInfo!))\n      return false;\n\n    if (this.fillDisplay !== other.fillDisplay)\n      return false;\n\n    if (this.fillDisplay !== undefined && this.fillDisplay !== FillDisplay.Never) {\n      if ((this.gradient === undefined) !== (other.gradient === undefined))\n        return false;\n      if (this.gradient && !this.gradient.equals(other.gradient!))\n        return false;\n      if (this.backgroundFill !== other.backgroundFill)\n        return false;\n      if (this.backgroundFill === undefined || this.backgroundFill === BackgroundFill.None) {\n        if ((this.fillColor === undefined) !== (other.fillColor === undefined))\n          return false;\n        if (this.fillColor && !this.fillColor.equals(other.fillColor!))\n          return false;\n      }\n    }\n\n    if ((this.pattern === undefined) !== (other.pattern === undefined))\n      return false;\n    if (this.pattern && !this.pattern.equals(other.pattern!))\n      return false;\n\n    return true;\n  }\n\n  /** Change [[categoryId]] to the supplied id, [[subCategoryId]] to the supplied category's the default subCategory, and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setCategoryId(categoryId: Id64String, clearAppearanceOverrides = true) {\n    this.categoryId = categoryId;\n    this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n\n  /** Change [[subCategoryId]] to the supplied id and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setSubCategoryId(subCategoryId: Id64String, clearAppearanceOverrides = true) {\n    this.subCategoryId = subCategoryId;\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n}\n"]}
+{"version":3,"file":"GeometryParams.js","sourceRoot":"","sources":["../../src/GeometryParams.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAKvD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAN,IAAY,WAWX;AAXD,WAAY,WAAW;IACrB,gEAAgE;IAChE,+CAAS,CAAA;IACT,wDAAwD;IACxD,iDAAU,CAAA;IACV,sEAAsE;IACtE,iDAAU,CAAA;IACV;;OAEG;IACH,qDAAY,CAAA;AACd,CAAC,EAXW,WAAW,KAAX,WAAW,QAWtB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,kGAAkG;IAClG,mDAAQ,CAAA;IACR,8EAA8E;IAC9E,qDAAS,CAAA;IACT,gGAAgG;IAChG,yDAAW,CAAA;AACb,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,aASX;AATD,WAAY,aAAa;IACvB,kGAAkG;IAClG,uDAAW,CAAA;IACX,qHAAqH;IACrH,iEAAgB,CAAA;IAChB,mFAAmF;IACnF,2DAAa,CAAA;IACb,mGAAmG;IACnG,uDAAW,CAAA;AACb,CAAC,EATW,aAAa,KAAb,aAAa,QASxB;AAED;;;GAGG;AACH,MAAM,OAAO,cAAc;IA+DN;IAA+B;IA9DlD;;OAEG;IACI,UAAU,CAAc;IAC/B;;OAEG;IACI,WAAW,CAAU;IAC5B;;OAEG;IACI,MAAM,CAAU;IACvB;;OAEG;IACI,SAAS,CAAY;IAC5B;;;OAGG;IACI,SAAS,CAAY;IAC5B;;OAEG;IACI,cAAc,CAAkB;IACvC;;;OAGG;IACI,WAAW,CAAe;IACjC;;;OAGG;IACI,eAAe,CAAU;IAChC;;;OAGG;IACI,gBAAgB,CAAU;IACjC;;OAEG;IACI,aAAa,CAAiB;IACrC;;OAEG;IACI,SAAS,CAAkB;IAClC;;OAEG;IACI,QAAQ,CAAiB;IAChC;;OAEG;IACI,OAAO,CAAsB;IAEpC;;;;OAIG;IACH,YAAmB,UAAsB,EAAS,gBAAgB,IAAI,CAAC,OAAO;QAA3D,eAAU,GAAV,UAAU,CAAY;QAAS,kBAAa,GAAb,aAAa,CAAe;QAC5E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACpC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC9C,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACpE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,wGAAwG;IACjG,eAAe;QACpB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3B,CAAC;IAED,6JAA6J;IACtJ,YAAY,CAAC,KAAqB;QACvC,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC,CAAC,eAAe;QAE9B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACtC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;YAChD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;YAClD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC9B,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAW;YAC1D,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7E,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC;gBAClE,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC;gBACzD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;gBAC9C,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBACrF,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;oBACpE,OAAO,KAAK,CAAC;gBACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;oBAC5D,OAAO,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAQ,CAAC;YACtD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oLAAoL;IAC7K,aAAa,CAAC,UAAsB,EAAE,wBAAwB,GAAG,IAAI;QAC1E,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAED,gHAAgH;IACzG,gBAAgB,CAAC,aAAyB,EAAE,wBAAwB,GAAG,IAAI;QAChF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { AreaPattern } from \"./geometry/AreaPattern\";\nimport { LineStyle } from \"./geometry/LineStyle\";\nimport { Gradient } from \"./Gradient\";\nimport { IModel } from \"./IModel\";\n\n/** Whether a closed region should be drawn for wireframe display with its internal area filled or not.\n * @public\n * @extensions\n */\nexport enum FillDisplay {\n  /** don't fill, even if fill attribute is on for the viewport */\n  Never = 0,\n  /** fill if the fill attribute is on for the viewport */\n  ByView = 1,\n  /** always fill, even if the fill attribute is off for the viewport */\n  Always = 2,\n  /** always fill, fill will always be behind other geometry belonging to the same element.\n   * @note Edge geometry is not produced for shapes with this fill type. If you want an outline, add it as separate geometry.\n   */\n  Blanking = 3,\n}\n\n/** Describes how a view's background color affects the interior area of a closed region.\n * @public\n * @extensions\n */\nexport enum BackgroundFill {\n  /** single color fill uses the fill color and line color to draw either a solid or outline fill */\n  None = 0,\n  /** single color fill uses the view's background color to draw a solid fill */\n  Solid = 1,\n  /** single color fill uses the view's background color and line color to draw an outline fill */\n  Outline = 2,\n}\n\n/** Categorizes a piece of geometry within a GeometryStream. Visibility of classes of geometry can be toggled\n * within a view using [[ViewFlags]].\n * @see [[GeometryStreamProps]].\n * @see [[Feature]].\n * @public\n * @extensions\n */\nexport enum GeometryClass {\n  /** Used to classify the \"real\" geometry within a model. Most geometry falls within this class. */\n  Primary = 0,\n  /** Used to classify geometry used as a drawing aid in constructing the Primary geometry. For example, grid lines. */\n  Construction = 1,\n  /** Used to classify annotations which dimension (measure) the Primary geometry. */\n  Dimension = 2,\n  /** Used to classify geometry used to fill planar regions with a 2d pattern (e.g., hatch lines). */\n  Pattern = 3,\n}\n\n/** Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from [[SubCategoryAppearance]].\n * @see [[GeometryStreamProps]].\n * @public\n */\nexport class GeometryParams {\n  /** Optional render material to override [[SubCategoryAppearance.materialId]].\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.materialId]] with no material.\n   */\n  public materialId?: Id64String;\n  /** Optional display priority added to [[SubCategoryAppearance.priority]].\n   * The net display priority value is used to control z ordering when drawing to 2d views.\n   */\n  public elmPriority?: number;\n  /** Optional line weight to override [[SubCategoryAppearance.weight]].\n   * The weight is an integer in the range of [0,31] that by default corresponds to a pixel width of weight+1.\n   */\n  public weight?: number;\n  /** Optional line color to override [[SubCategoryAppearance.color]].\n   * The transparency component is ignored and should instead be specified using [[elmTransparency]].\n   */\n  public lineColor?: ColorDef;\n  /** Optional fill color for region interiors. Set the same as [[lineColor]] for an opaque fill.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]], [[gradient]] is undefined, and [[backgroundFill]] is [[BackgroundFill.None]].\n   * The transparency component is ignored and should instead be specified using [[fillTransparency]].\n   */\n  public fillColor?: ColorDef;\n  /** Optional fill using the current view background color for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]] and [[gradient]] is undefined. Default is [[BackgroundFill.None]].\n   */\n  public backgroundFill?: BackgroundFill;\n  /** Optional fill specification that determines when and if a region interior will display using [[gradient]], [[backgroundFill]], or [[fillColor]] in that order of preference.\n   * Fill only applies to [[RenderMode.Wireframe]] views. In a [[RenderMode.SmoothShade]] or [[RenderMode.SolidFill]] view, regions will always display as surfaces preferring [[fillColor]] when present over [[lineColor]].\n   * Default is [[FillDisplay.Never]].\n   */\n  public fillDisplay?: FillDisplay;\n  /** Optional line color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent element on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque and 1.0 for completely transparent.\n   */\n  public elmTransparency?: number;\n  /** Optional fill color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent fill on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque, 1.0 for completely transparent, or leave undefined to use [[elmTransparency]].\n   */\n  public fillTransparency?: number;\n  /** Optional geometry classification that can be toggled off with a [[ViewFlags]] independent of [[SubCategoryAppearance.invisible]].\n   * Default is [[GeometryClass.Primary]].\n   */\n  public geometryClass?: GeometryClass;\n  /** Optional line style to override [[SubCategoryAppearance.styleId]] plus modifiers to override the line style definition.\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.styleId]] with a solid line.\n   */\n  public styleInfo?: LineStyle.Info;\n  /** Optional gradient fill settings for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]].\n   */\n  public gradient?: Gradient.Symb;\n  /** Optional area pattern settings for region interiors.\n   * Independent of fill, a region can have both fill and pattern.\n   */\n  public pattern?: AreaPattern.Params;\n\n  /** Create a GeometryParams given a [[Category]] Id for a [[GeometricElement]] and optional [[SubCategory]] Id. The [[SubCategory.appearance]] establishes the non-overriden display properties of\n   * graphics in a GeometricElement's [[GeometryStreamProps]]. A GeometricElement refers to a single Category through [[GeometricElement.category]], while it's graphics can appear on multiple SubCategories\n   * by adding a [[GeometryAppearanceProps]] with a SubCategory change to the GeometryStream.\n   * @note If a valid SubCategory Id is not supplied, the default SubCategory for the parent Category is used. To be considered valid, [[SubCategory.getCategoryId]] must refer to the specified Category Id.\n   */\n  constructor(public categoryId: Id64String, public subCategoryId = Id64.invalid) {\n    if (!Id64.isValid(subCategoryId))\n      this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n  }\n\n  public clone(): GeometryParams {\n    const retVal = new GeometryParams(this.categoryId, this.subCategoryId);\n    retVal.materialId = this.materialId;\n    retVal.elmPriority = this.elmPriority;\n    retVal.weight = this.weight;\n    retVal.lineColor = this.lineColor;\n    retVal.fillColor = this.fillColor;\n    retVal.backgroundFill = this.backgroundFill;\n    retVal.fillDisplay = this.fillDisplay;\n    retVal.elmTransparency = this.elmTransparency;\n    retVal.fillTransparency = this.fillTransparency;\n    retVal.geometryClass = this.geometryClass;\n    retVal.styleInfo = this.styleInfo ? this.styleInfo.clone() : undefined;\n    retVal.gradient = this.gradient ? this.gradient.clone() : undefined;\n    retVal.pattern = this.pattern ? this.pattern.clone() : undefined;\n    return retVal;\n  }\n\n  /** Clears [[SubCategoryAppearance]] overrides while preserving [[categoryId]] and [[subCategoryId]]. */\n  public resetAppearance() {\n    this.materialId = undefined;\n    this.elmPriority = undefined;\n    this.weight = undefined;\n    this.lineColor = undefined;\n    this.fillColor = undefined;\n    this.backgroundFill = undefined;\n    this.fillDisplay = undefined;\n    this.elmTransparency = undefined;\n    this.fillTransparency = undefined;\n    this.geometryClass = undefined;\n    this.styleInfo = undefined;\n    this.gradient = undefined;\n    this.pattern = undefined;\n  }\n\n  /** Compare two [[GeometryParams]] for equivalence, i.e. both values are undefined and inherited from [[SubCategoryAppearance]] or have the same override. */\n  public isEquivalent(other: GeometryParams): boolean {\n    if (this === other)\n      return true; // Same pointer\n\n    if (this.categoryId !== other.categoryId)\n      return false;\n    if (this.subCategoryId !== other.subCategoryId)\n      return false;\n    if (this.geometryClass !== other.geometryClass)\n      return false;\n\n    if (this.elmPriority !== other.elmPriority)\n      return false;\n    if (this.elmTransparency !== other.elmTransparency)\n      return false;\n    if (this.fillTransparency !== other.fillTransparency)\n      return false;\n\n    if ((this.lineColor === undefined) !== (other.lineColor === undefined))\n      return false;\n    if (this.lineColor && !this.lineColor.equals(other.lineColor!))\n      return false;\n\n    if (this.weight !== other.weight)\n      return false;\n\n    if ((this.materialId === undefined) !== (other.materialId === undefined))\n      return false;\n    if (this.materialId && this.materialId !== other.materialId!)\n      return false;\n\n    if ((this.styleInfo === undefined) !== (other.styleInfo === undefined))\n      return false;\n    if (this.styleInfo && !this.styleInfo.equals(other.styleInfo!))\n      return false;\n\n    if (this.fillDisplay !== other.fillDisplay)\n      return false;\n\n    if (this.fillDisplay !== undefined && this.fillDisplay !== FillDisplay.Never) {\n      if ((this.gradient === undefined) !== (other.gradient === undefined))\n        return false;\n      if (this.gradient && !this.gradient.equals(other.gradient!))\n        return false;\n      if (this.backgroundFill !== other.backgroundFill)\n        return false;\n      if (this.backgroundFill === undefined || this.backgroundFill === BackgroundFill.None) {\n        if ((this.fillColor === undefined) !== (other.fillColor === undefined))\n          return false;\n        if (this.fillColor && !this.fillColor.equals(other.fillColor!))\n          return false;\n      }\n    }\n\n    if ((this.pattern === undefined) !== (other.pattern === undefined))\n      return false;\n    if (this.pattern && !this.pattern.equals(other.pattern!))\n      return false;\n\n    return true;\n  }\n\n  /** Change [[categoryId]] to the supplied id, [[subCategoryId]] to the supplied category's the default subCategory, and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setCategoryId(categoryId: Id64String, clearAppearanceOverrides = true) {\n    this.categoryId = categoryId;\n    this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n\n  /** Change [[subCategoryId]] to the supplied id and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setSubCategoryId(subCategoryId: Id64String, clearAppearanceOverrides = true) {\n    this.subCategoryId = subCategoryId;\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n}\n"]}