@itwin/core-common 3.6.0-dev.65 → 3.6.0-dev.66

package/lib/esm/ElementProps.js

@@ -1,93 +1,93 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Entities
- */
-import { Id64 } from "@itwin/core-bentley";
-import { IModelError, IModelStatus } from "./IModelError";
-/** The Id and relationship class of an Element that is somehow related to another Element
- * @public
- */
-export class RelatedElement {
-    constructor(props) {
-        this.id = Id64.fromJSON(props.id);
-        this.relClassName = props.relClassName;
-    }
-    static fromJSON(json) {
-        return json ? new RelatedElement(json) : undefined;
-    }
-    /** 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. */
-    static idFromJson(json) {
-        if ((typeof json === "object") && ("id" in json)) {
-            const r = RelatedElement.fromJSON(json);
-            if (r === undefined)
-                throw new IModelError(IModelStatus.BadArg, "Problem parsing Id64 from json");
-            return r.id;
-        }
-        return Id64.fromJSON(json);
-    }
-    toJSON() {
-        return {
-            id: this.id,
-            relClassName: this.relClassName,
-        };
-    }
-}
-/** Used to *null out* an existing navigation relationship. */
-RelatedElement.none = new RelatedElement({ id: Id64.invalid });
-/** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.
- * @public
- */
-export class TypeDefinition extends RelatedElement {
-}
-/** determine if this is Placement2dProps
- * @public
- */
-export function isPlacement2dProps(props) {
-    return props.angle !== undefined;
-}
-/** determine if this is Placement3dProps
- * @public
- */
-export function isPlacement3dProps(props) {
-    return !isPlacement2dProps(props);
-}
-/** An enumeration of the different types of [SectionDrawing]($backend)s.
- * @public
- * @extensions
- */
-export var SectionType;
-(function (SectionType) {
-    SectionType[SectionType["Section"] = 3] = "Section";
-    SectionType[SectionType["Detail"] = 4] = "Detail";
-    SectionType[SectionType["Elevation"] = 5] = "Elevation";
-    SectionType[SectionType["Plan"] = 6] = "Plan";
-})(SectionType || (SectionType = {}));
-/** The role that an attached [ExternalSource]($backend) plays.
- * @beta
- */
-export var ExternalSourceAttachmentRole;
-(function (ExternalSourceAttachmentRole) {
-    /** The attached [ExternalSource]($backend) provides context. */
-    ExternalSourceAttachmentRole[ExternalSourceAttachmentRole["SpecifyContext"] = 0] = "SpecifyContext";
-    /** The attached [ExternalSource]($backend) models a part of the whole. */
-    ExternalSourceAttachmentRole[ExternalSourceAttachmentRole["SpecifyPart"] = 1] = "SpecifyPart";
-})(ExternalSourceAttachmentRole || (ExternalSourceAttachmentRole = {}));
-/** The *rank* for a Category
- * @public
- * @extensions
- */
-export var Rank;
-(function (Rank) {
-    /** This category is predefined by the system */
-    Rank[Rank["System"] = 0] = "System";
-    /** This category is defined by a schema. Elements in this category are not recognized by system classes. */
-    Rank[Rank["Domain"] = 1] = "Domain";
-    /** This category is defined by an application. Elements in this category are not recognized by system and schema classes. */
-    Rank[Rank["Application"] = 2] = "Application";
-    /** This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. */
-    Rank[Rank["User"] = 3] = "User";
-})(Rank || (Rank = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Entities
+ */
+import { Id64 } from "@itwin/core-bentley";
+import { IModelError, IModelStatus } from "./IModelError";
+/** The Id and relationship class of an Element that is somehow related to another Element
+ * @public
+ */
+export class RelatedElement {
+    constructor(props) {
+        this.id = Id64.fromJSON(props.id);
+        this.relClassName = props.relClassName;
+    }
+    static fromJSON(json) {
+        return json ? new RelatedElement(json) : undefined;
+    }
+    /** 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. */
+    static idFromJson(json) {
+        if ((typeof json === "object") && ("id" in json)) {
+            const r = RelatedElement.fromJSON(json);
+            if (r === undefined)
+                throw new IModelError(IModelStatus.BadArg, "Problem parsing Id64 from json");
+            return r.id;
+        }
+        return Id64.fromJSON(json);
+    }
+    toJSON() {
+        return {
+            id: this.id,
+            relClassName: this.relClassName,
+        };
+    }
+}
+/** Used to *null out* an existing navigation relationship. */
+RelatedElement.none = new RelatedElement({ id: Id64.invalid });
+/** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.
+ * @public
+ */
+export class TypeDefinition extends RelatedElement {
+}
+/** determine if this is Placement2dProps
+ * @public
+ */
+export function isPlacement2dProps(props) {
+    return props.angle !== undefined;
+}
+/** determine if this is Placement3dProps
+ * @public
+ */
+export function isPlacement3dProps(props) {
+    return !isPlacement2dProps(props);
+}
+/** An enumeration of the different types of [SectionDrawing]($backend)s.
+ * @public
+ * @extensions
+ */
+export var SectionType;
+(function (SectionType) {
+    SectionType[SectionType["Section"] = 3] = "Section";
+    SectionType[SectionType["Detail"] = 4] = "Detail";
+    SectionType[SectionType["Elevation"] = 5] = "Elevation";
+    SectionType[SectionType["Plan"] = 6] = "Plan";
+})(SectionType || (SectionType = {}));
+/** The role that an attached [ExternalSource]($backend) plays.
+ * @beta
+ */
+export var ExternalSourceAttachmentRole;
+(function (ExternalSourceAttachmentRole) {
+    /** The attached [ExternalSource]($backend) provides context. */
+    ExternalSourceAttachmentRole[ExternalSourceAttachmentRole["SpecifyContext"] = 0] = "SpecifyContext";
+    /** The attached [ExternalSource]($backend) models a part of the whole. */
+    ExternalSourceAttachmentRole[ExternalSourceAttachmentRole["SpecifyPart"] = 1] = "SpecifyPart";
+})(ExternalSourceAttachmentRole || (ExternalSourceAttachmentRole = {}));
+/** The *rank* for a Category
+ * @public
+ * @extensions
+ */
+export var Rank;
+(function (Rank) {
+    /** This category is predefined by the system */
+    Rank[Rank["System"] = 0] = "System";
+    /** This category is defined by a schema. Elements in this category are not recognized by system classes. */
+    Rank[Rank["Domain"] = 1] = "Domain";
+    /** This category is defined by an application. Elements in this category are not recognized by system and schema classes. */
+    Rank[Rank["Application"] = 2] = "Application";
+    /** This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. */
+    Rank[Rank["User"] = 3] = "User";
+})(Rank || (Rank = {}));
 //# sourceMappingURL=ElementProps.js.map

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

package/lib/esm/EmphasizeElementsProps.d.ts

@@ -1,56 +1,56 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { Id64Array } from "@itwin/core-bentley";
-import { ColorDefProps } from "./ColorDef";
-import { FeatureAppearanceProps } from "./FeatureSymbology";
-/** Options for overriding element appearance.
- * @see [EmphasizeElements]($frontend)
- * @see [[AppearanceOverrideProps]]
- * @public
- * @extensions
- */
-export declare enum FeatureOverrideType {
-    /** Override color only. */
-    ColorOnly = 0,
-    /** Override alpha only. */
-    AlphaOnly = 1,
-    /** Override both color and alpha. */
-    ColorAndAlpha = 2
-}
-/** JSON representation of an appearance override in an [[EmphasizeElementsProps]].
- * @see [EmphasizeElements]($frontend).
- * @public
- * @extensions
- */
-export interface AppearanceOverrideProps {
-    /** Whether to override color, transparency, or both. */
-    overrideType?: FeatureOverrideType;
-    /** The 0xTTBBGGRR format color/transparency value. */
-    color?: ColorDefProps;
-    /** The element IDs to display with the specified override. */
-    ids?: Id64Array;
-}
-/** JSON representation of an [EmphasizeElements]($frontend).
- * @public
- * @extensions
- */
-export interface EmphasizeElementsProps {
-    /** See [EmphasizeElements.getNeverDrawnElements]($frontend) */
-    neverDrawn?: Id64Array;
-    /** See [EmphasizeElements.getAlwaysDrawnElements]($frontend) */
-    alwaysDrawn?: Id64Array;
-    /** See [EmphasizeElements.getIsolatedElements]($frontend) */
-    isAlwaysDrawnExclusive?: boolean;
-    /** See [EmphasizeElements.getEmphasizedIsolatedElements]($frontend) */
-    alwaysDrawnExclusiveEmphasized?: Id64Array;
-    /** See [EmphasizeElements.defaultAppearance]($frontend) */
-    defaultAppearance?: FeatureAppearanceProps;
-    /** See [EmphasizeElements.getOverriddenElementsByKey]($frontend) */
-    appearanceOverride?: AppearanceOverrideProps[];
-    /** See [EmphasizeElements.wantEmphasis]($frontend) */
-    wantEmphasis?: boolean;
-    /** See [EmphasizeElements.unanimatedAppearance]($frontend) */
-    unanimatedAppearance?: FeatureAppearanceProps;
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { Id64Array } from "@itwin/core-bentley";
+import { ColorDefProps } from "./ColorDef";
+import { FeatureAppearanceProps } from "./FeatureSymbology";
+/** Options for overriding element appearance.
+ * @see [EmphasizeElements]($frontend)
+ * @see [[AppearanceOverrideProps]]
+ * @public
+ * @extensions
+ */
+export declare enum FeatureOverrideType {
+    /** Override color only. */
+    ColorOnly = 0,
+    /** Override alpha only. */
+    AlphaOnly = 1,
+    /** Override both color and alpha. */
+    ColorAndAlpha = 2
+}
+/** JSON representation of an appearance override in an [[EmphasizeElementsProps]].
+ * @see [EmphasizeElements]($frontend).
+ * @public
+ * @extensions
+ */
+export interface AppearanceOverrideProps {
+    /** Whether to override color, transparency, or both. */
+    overrideType?: FeatureOverrideType;
+    /** The 0xTTBBGGRR format color/transparency value. */
+    color?: ColorDefProps;
+    /** The element IDs to display with the specified override. */
+    ids?: Id64Array;
+}
+/** JSON representation of an [EmphasizeElements]($frontend).
+ * @public
+ * @extensions
+ */
+export interface EmphasizeElementsProps {
+    /** See [EmphasizeElements.getNeverDrawnElements]($frontend) */
+    neverDrawn?: Id64Array;
+    /** See [EmphasizeElements.getAlwaysDrawnElements]($frontend) */
+    alwaysDrawn?: Id64Array;
+    /** See [EmphasizeElements.getIsolatedElements]($frontend) */
+    isAlwaysDrawnExclusive?: boolean;
+    /** See [EmphasizeElements.getEmphasizedIsolatedElements]($frontend) */
+    alwaysDrawnExclusiveEmphasized?: Id64Array;
+    /** See [EmphasizeElements.defaultAppearance]($frontend) */
+    defaultAppearance?: FeatureAppearanceProps;
+    /** See [EmphasizeElements.getOverriddenElementsByKey]($frontend) */
+    appearanceOverride?: AppearanceOverrideProps[];
+    /** See [EmphasizeElements.wantEmphasis]($frontend) */
+    wantEmphasis?: boolean;
+    /** See [EmphasizeElements.unanimatedAppearance]($frontend) */
+    unanimatedAppearance?: FeatureAppearanceProps;
+}
 //# sourceMappingURL=EmphasizeElementsProps.d.ts.map

package/lib/esm/EmphasizeElementsProps.js

@@ -1,23 +1,23 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-/** Options for overriding element appearance.
- * @see [EmphasizeElements]($frontend)
- * @see [[AppearanceOverrideProps]]
- * @public
- * @extensions
- */
-export var FeatureOverrideType;
-(function (FeatureOverrideType) {
-    /** Override color only. */
-    FeatureOverrideType[FeatureOverrideType["ColorOnly"] = 0] = "ColorOnly";
-    /** Override alpha only. */
-    FeatureOverrideType[FeatureOverrideType["AlphaOnly"] = 1] = "AlphaOnly";
-    /** Override both color and alpha. */
-    FeatureOverrideType[FeatureOverrideType["ColorAndAlpha"] = 2] = "ColorAndAlpha";
-})(FeatureOverrideType || (FeatureOverrideType = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+/** Options for overriding element appearance.
+ * @see [EmphasizeElements]($frontend)
+ * @see [[AppearanceOverrideProps]]
+ * @public
+ * @extensions
+ */
+export var FeatureOverrideType;
+(function (FeatureOverrideType) {
+    /** Override color only. */
+    FeatureOverrideType[FeatureOverrideType["ColorOnly"] = 0] = "ColorOnly";
+    /** Override alpha only. */
+    FeatureOverrideType[FeatureOverrideType["AlphaOnly"] = 1] = "AlphaOnly";
+    /** Override both color and alpha. */
+    FeatureOverrideType[FeatureOverrideType["ColorAndAlpha"] = 2] = "ColorAndAlpha";
+})(FeatureOverrideType || (FeatureOverrideType = {}));
 //# sourceMappingURL=EmphasizeElementsProps.js.map

package/lib/esm/EmphasizeElementsProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmphasizeElementsProps.js","sourceRoot":"","sources":["../../src/EmphasizeElementsProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAMH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,2BAA2B;IAC3B,uEAAS,CAAA;IACT,2BAA2B;IAC3B,uEAAS,CAAA;IACT,qCAAqC;IACrC,+EAAa,CAAA;AACf,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B","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 Rendering\n */\n\nimport { Id64Array } from \"@itwin/core-bentley\";\nimport { ColorDefProps } from \"./ColorDef\";\nimport { FeatureAppearanceProps } from \"./FeatureSymbology\";\n\n/** Options for overriding element appearance.\n * @see [EmphasizeElements]($frontend)\n * @see [[AppearanceOverrideProps]]\n * @public\n * @extensions\n */\nexport enum FeatureOverrideType {\n  /** Override color only. */\n  ColorOnly,\n  /** Override alpha only. */\n  AlphaOnly,\n  /** Override both color and alpha. */\n  ColorAndAlpha,\n}\n\n/** JSON representation of an appearance override in an [[EmphasizeElementsProps]].\n * @see [EmphasizeElements]($frontend).\n * @public\n * @extensions\n */\nexport interface AppearanceOverrideProps {\n  /** Whether to override color, transparency, or both. */\n  overrideType?: FeatureOverrideType;\n  /** The 0xTTBBGGRR format color/transparency value. */\n  color?: ColorDefProps;\n  /** The element IDs to display with the specified override. */\n  ids?: Id64Array;\n}\n\n/** JSON representation of an [EmphasizeElements]($frontend).\n * @public\n * @extensions\n */\nexport interface EmphasizeElementsProps {\n  /** See [EmphasizeElements.getNeverDrawnElements]($frontend) */\n  neverDrawn?: Id64Array;\n  /** See [EmphasizeElements.getAlwaysDrawnElements]($frontend) */\n  alwaysDrawn?: Id64Array;\n  /** See [EmphasizeElements.getIsolatedElements]($frontend) */\n  isAlwaysDrawnExclusive?: boolean;\n  /** See [EmphasizeElements.getEmphasizedIsolatedElements]($frontend) */\n  alwaysDrawnExclusiveEmphasized?: Id64Array;\n  /** See [EmphasizeElements.defaultAppearance]($frontend) */\n  defaultAppearance?: FeatureAppearanceProps;\n  /** See [EmphasizeElements.getOverriddenElementsByKey]($frontend) */\n  appearanceOverride?: AppearanceOverrideProps[];\n  /** See [EmphasizeElements.wantEmphasis]($frontend) */\n  wantEmphasis?: boolean;\n  /** See [EmphasizeElements.unanimatedAppearance]($frontend) */\n  unanimatedAppearance?: FeatureAppearanceProps;\n}\n"]}
+{"version":3,"file":"EmphasizeElementsProps.js","sourceRoot":"","sources":["../../src/EmphasizeElementsProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAMH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,2BAA2B;IAC3B,uEAAS,CAAA;IACT,2BAA2B;IAC3B,uEAAS,CAAA;IACT,qCAAqC;IACrC,+EAAa,CAAA;AACf,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { Id64Array } from \"@itwin/core-bentley\";\r\nimport { ColorDefProps } from \"./ColorDef\";\r\nimport { FeatureAppearanceProps } from \"./FeatureSymbology\";\r\n\r\n/** Options for overriding element appearance.\r\n * @see [EmphasizeElements]($frontend)\r\n * @see [[AppearanceOverrideProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport enum FeatureOverrideType {\r\n  /** Override color only. */\r\n  ColorOnly,\r\n  /** Override alpha only. */\r\n  AlphaOnly,\r\n  /** Override both color and alpha. */\r\n  ColorAndAlpha,\r\n}\r\n\r\n/** JSON representation of an appearance override in an [[EmphasizeElementsProps]].\r\n * @see [EmphasizeElements]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AppearanceOverrideProps {\r\n  /** Whether to override color, transparency, or both. */\r\n  overrideType?: FeatureOverrideType;\r\n  /** The 0xTTBBGGRR format color/transparency value. */\r\n  color?: ColorDefProps;\r\n  /** The element IDs to display with the specified override. */\r\n  ids?: Id64Array;\r\n}\r\n\r\n/** JSON representation of an [EmphasizeElements]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EmphasizeElementsProps {\r\n  /** See [EmphasizeElements.getNeverDrawnElements]($frontend) */\r\n  neverDrawn?: Id64Array;\r\n  /** See [EmphasizeElements.getAlwaysDrawnElements]($frontend) */\r\n  alwaysDrawn?: Id64Array;\r\n  /** See [EmphasizeElements.getIsolatedElements]($frontend) */\r\n  isAlwaysDrawnExclusive?: boolean;\r\n  /** See [EmphasizeElements.getEmphasizedIsolatedElements]($frontend) */\r\n  alwaysDrawnExclusiveEmphasized?: Id64Array;\r\n  /** See [EmphasizeElements.defaultAppearance]($frontend) */\r\n  defaultAppearance?: FeatureAppearanceProps;\r\n  /** See [EmphasizeElements.getOverriddenElementsByKey]($frontend) */\r\n  appearanceOverride?: AppearanceOverrideProps[];\r\n  /** See [EmphasizeElements.wantEmphasis]($frontend) */\r\n  wantEmphasis?: boolean;\r\n  /** See [EmphasizeElements.unanimatedAppearance]($frontend) */\r\n  unanimatedAppearance?: FeatureAppearanceProps;\r\n}\r\n"]}