@itwin/core-backend 5.0.0-dev.55 → 5.0.0-dev.57

package/lib/cjs/Element.js

@@ -44,6 +44,18 @@ class Element extends Entity_1.Entity {
     static get className() { return "Element"; }
     /** @internal */
     static get protectedOperations() { return ["onInsert", "onUpdate", "onDelete"]; }
+    /** The ModelId of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element */
+    model;
+    /** The [Code]($docs/bis/guide/fundamentals/codes.md) for this element */
+    code;
+    /** The parent element, if present, of this element. */
+    parent;
+    /** A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element by some other federated database */
+    federationGuid;
+    /** A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. */
+    userLabel;
+    /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. */
+    jsonProperties;
     constructor(props, iModel) {
         super(props, iModel);
         this.code = core_common_1.Code.fromJSON(props.code); // TODO: Validate props.code - don't silently fail if it is the wrong type
@@ -265,15 +277,15 @@ class Element extends Entity_1.Entity {
      * @note any property listed here must be added to the reference ids in [[collectReferenceIds]]
      * @beta
      */
-    static { this.requiredReferenceKeys = ["parent", "model"]; }
+    static requiredReferenceKeys = ["parent", "model"];
     /** A map of every [[requiredReferenceKeys]] on this class to their entity type.
      * @note This should be overridden (with `super` called) at each level of the class hierarchy that introduces required references.
      * @alpha
      */
-    static { this.requiredReferenceKeyTypeMap = {
+    static requiredReferenceKeyTypeMap = {
         parent: core_common_1.ConcreteEntityTypes.Element,
         model: core_common_1.ConcreteEntityTypes.Model,
-    }; }
+    };
     /** Get the class metadata for this element. */
     getClassMetaData() { return this.iModel.classMetaDataRegistry.find(this.classFullName); }
     getAllUserProperties() {
@@ -327,6 +339,10 @@ exports.Element = Element;
  */
 class GeometricElement extends Element {
     static get className() { return "GeometricElement"; }
+    /** The Id of the [[Category]] for this GeometricElement. */
+    category;
+    /** The GeometryStream for this GeometricElement. */
+    geom;
     constructor(props, iModel) {
         super(props, iModel);
         this.category = core_bentley_1.Id64.fromJSON(props.category);
@@ -352,12 +368,12 @@ class GeometricElement extends Element {
         // TODO: GeometryPartIds?
     }
     /** @beta */
-    static { this.requiredReferenceKeys = [...super.requiredReferenceKeys, "category"]; }
+    static requiredReferenceKeys = [...super.requiredReferenceKeys, "category"];
     /** @alpha */
-    static { this.requiredReferenceKeyTypeMap = {
+    static requiredReferenceKeyTypeMap = {
         ...super.requiredReferenceKeyTypeMap,
         category: core_common_1.ConcreteEntityTypes.Element,
-    }; }
+    };
 }
 exports.GeometricElement = GeometricElement;
 /** An abstract base class to model real world entities that intrinsically have 3d geometry.
@@ -366,6 +382,8 @@ exports.GeometricElement = GeometricElement;
  */
 class GeometricElement3d extends GeometricElement {
     static get className() { return "GeometricElement3d"; }
+    placement;
+    typeDefinition;
     constructor(props, iModel) {
         super(props, iModel);
         this.placement = core_common_1.Placement3d.fromJSON(props.placement);
@@ -399,6 +417,8 @@ exports.GraphicalElement3d = GraphicalElement3d;
  */
 class GeometricElement2d extends GeometricElement {
     static get className() { return "GeometricElement2d"; }
+    placement;
+    typeDefinition;
     constructor(props, iModel) {
         super(props, iModel);
         this.placement = core_common_1.Placement2d.fromJSON(props.placement);
@@ -456,6 +476,8 @@ exports.SpatialElement = SpatialElement;
  */
 class PhysicalElement extends SpatialElement {
     static get className() { return "PhysicalElement"; }
+    /** If defined, the [[PhysicalMaterial]] that makes up this PhysicalElement. */
+    physicalMaterial;
     constructor(props, iModel) {
         super(props, iModel);
         this.physicalMaterial = core_common_1.RelatedElement.fromJSON(props.physicalMaterial);
@@ -489,6 +511,8 @@ exports.VolumeElement = VolumeElement;
  * @public
  */
 class SectionDrawingLocation extends SpatialLocationElement {
+    /** The Id of the [[ViewDefinition]] to which this location refers. */
+    sectionView;
     static get className() { return "SectionDrawingLocation"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -535,7 +559,11 @@ exports.InformationReferenceElement = InformationReferenceElement;
  */
 class Subject extends InformationReferenceElement {
     static get className() { return "Subject"; }
-    constructor(props, iModel) { super(props, iModel); }
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.description = props.description;
+    }
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }
@@ -637,6 +665,21 @@ exports.Drawing = Drawing;
  * @public
  */
 class SectionDrawing extends Drawing {
+    /** The type of section used to generate the drawing. */
+    sectionType;
+    /** The spatial view from which the section was generated. */
+    spatialView;
+    /** A transform from the section drawing model's coordinates to spatial coordinates. */
+    drawingToSpatialTransform;
+    /** If the section drawing is placed onto a [[Sheet]] via a [[ViewAttachment]], a transform from the sheet's coordinates to spatial coordinates. */
+    sheetToSpatialTransform;
+    /** If the section drawing is placed onto a [[Sheet]] via a [[ViewAttachment]], the clip to apply to the sheet graphics when drawn in the context
+     * of the spatial view.
+     * @note The ClipVector is defined in spatial coordinates.
+     */
+    drawingBoundaryClip;
+    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */
+    displaySpatialView;
     static get className() { return "SectionDrawing"; }
     static get drawingModelFullClassName() { return Model_1.SectionDrawingModel.classFullName; }
     constructor(props, iModel) {
@@ -675,7 +718,13 @@ exports.SectionDrawing = SectionDrawing;
  */
 class SheetBorderTemplate extends Document {
     static get className() { return "SheetBorderTemplate"; }
-    constructor(props, iModel) { super(props, iModel); }
+    height;
+    width;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.height = props.height;
+        this.width = props.width;
+    }
 }
 exports.SheetBorderTemplate = SheetBorderTemplate;
 /** The template for a [[Sheet]]
@@ -683,7 +732,15 @@ exports.SheetBorderTemplate = SheetBorderTemplate;
  */
 class SheetTemplate extends Document {
     static get className() { return "SheetTemplate"; }
-    constructor(props, iModel) { super(props, iModel); }
+    height;
+    width;
+    border;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.height = props.height;
+        this.width = props.width;
+        this.border = props.border;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         if (undefined !== this.border)
@@ -696,6 +753,10 @@ exports.SheetTemplate = SheetTemplate;
  */
 class Sheet extends Document {
     static get className() { return "Sheet"; }
+    height;
+    width;
+    scale;
+    sheetTemplate;
     constructor(props, iModel) {
         super(props, iModel);
         this.height = core_bentley_1.JsonUtils.asDouble(props.height);
@@ -733,6 +794,8 @@ exports.InformationRecordElement = InformationRecordElement;
  */
 class DefinitionElement extends InformationContentElement {
     static get className() { return "DefinitionElement"; }
+    /** If true, don't show this DefinitionElement in user interface lists. */
+    isPrivate;
     constructor(props, iModel) {
         super(props, iModel);
         this.isPrivate = true === props.isPrivate;
@@ -829,7 +892,11 @@ exports.DefinitionGroup = DefinitionGroup;
  */
 class TypeDefinitionElement extends DefinitionElement {
     static get className() { return "TypeDefinitionElement"; }
-    constructor(props, iModel) { super(props, iModel); }
+    recipe;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.recipe = this.recipe;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         if (undefined !== this.recipe)
@@ -852,6 +919,8 @@ exports.RecipeDefinitionElement = RecipeDefinitionElement;
  */
 class PhysicalType extends TypeDefinitionElement {
     static get className() { return "PhysicalType"; }
+    /** If defined, the [[PhysicalMaterial]] that makes up this PhysicalType. */
+    physicalMaterial;
     constructor(props, iModel) {
         super(props, iModel);
         this.physicalMaterial = core_common_1.RelatedElement.fromJSON(props.physicalMaterial);
@@ -1013,7 +1082,12 @@ exports.TemplateRecipe2d = TemplateRecipe2d;
  */
 class InformationPartitionElement extends InformationContentElement {
     static get className() { return "InformationPartitionElement"; }
-    constructor(props, iModel) { super(props, iModel); }
+    /** A human-readable string describing the intent of the partition. */
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.description = props.description;
+    }
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }
@@ -1135,6 +1209,8 @@ exports.LinkElement = LinkElement;
  */
 class UrlLink extends LinkElement {
     static get className() { return "UrlLink"; }
+    description;
+    url;
     constructor(props, iModel) {
         super(props, iModel);
         this.description = props.description;
@@ -1161,6 +1237,9 @@ exports.FolderLink = FolderLink;
  */
 class RepositoryLink extends UrlLink {
     static get className() { return "RepositoryLink"; }
+    repositoryGuid;
+    /** @note This property was added to the BisCore schema in version 1.0.13 */
+    format;
     constructor(props, iModel) {
         super(props, iModel);
         this.repositoryGuid = props.repositoryGuid;
@@ -1196,6 +1275,8 @@ exports.RoleElement = RoleElement;
  */
 class GeometryPart extends DefinitionElement {
     static get className() { return "GeometryPart"; }
+    geom;
+    bbox;
     constructor(props, iModel) {
         super(props, iModel);
         this.geom = props.geom;
@@ -1224,7 +1305,13 @@ exports.GeometryPart = GeometryPart;
  */
 class LineStyle extends DefinitionElement {
     static get className() { return "LineStyle"; }
-    constructor(props, iModel) { super(props, iModel); }
+    description;
+    data;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.description = props.description;
+        this.data = props.data;
+    }
     /** Create a Code for a LineStyle definition given a name that is meant to be unique within the scope of the specified model.
      * @param iModel The IModel
      * @param scopeModelId The Id of the DefinitionModel that contains the LineStyle and provides the scope for its name.
@@ -1242,6 +1329,12 @@ exports.LineStyle = LineStyle;
  */
 class RenderTimeline extends InformationRecordElement {
     static get className() { return "RenderTimeline"; }
+    /** A human-readable description of the timeline, which may be an empty string. */
+    description;
+    /** The JSON representation of the instructions for visualizing change over time.
+     * @see [RenderSchedule.Script]($common) for the API for working with the script.
+     */
+    scriptProps;
     constructor(props, iModel) {
         super(props, iModel);
         this.description = props.description ?? "";