@itwin/core-backend 5.1.0-dev.4 → 5.1.0-dev.41

package/lib/cjs/Element.d.ts

@@ -90,7 +90,7 @@ export interface OnSubModelIdArg extends OnElementArg {
  * * [Element Fundamentals]($docs/bis/guide/fundamentals/element-fundamentals.md)
  * * [Working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md)
  * * [Creating elements]($docs/learning/backend/CreateElements.md)
- * @public
+ * @public @preview
  */
 export declare class Element extends Entity {
     static get className(): string;
@@ -292,7 +292,7 @@ export declare class Element extends Entity {
      */
     static readonly requiredReferenceKeyTypeMap: Record<string, ConcreteEntityTypes>;
     /** Get the class metadata for this element.
-     * @deprecated in 5.0. Please use `getMetaData` provided by the parent class `Entity` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `getMetaData` provided by the parent class `Entity` instead.
      *
      * @example
      * ```typescript
@@ -335,7 +335,7 @@ export declare class Element extends Entity {
     delete(): void;
 }
 /** An abstract base class to model real world entities that intrinsically have geometry.
- * @public
+ * @public @preview
  */
 export declare abstract class GeometricElement extends Element {
     static get className(): string;
@@ -380,7 +380,7 @@ export declare abstract class GeometricElement extends Element {
 }
 /** An abstract base class to model real world entities that intrinsically have 3d geometry.
  * See [how to create a GeometricElement3d]($docs/learning/backend/CreateElements.md#GeometricElement3d).
- * @public
+ * @public @preview
  */
 export declare abstract class GeometricElement3d extends GeometricElement {
     static get className(): string;
@@ -412,14 +412,14 @@ export declare abstract class GeometricElement3d extends GeometricElement {
     static serialize(props: GeometricElement3dProps, iModel: IModelDb): ECSqlRow;
 }
 /** A 3d Graphical Element
- * @public
+ * @public @preview
  */
 export declare abstract class GraphicalElement3d extends GeometricElement3d {
     static get className(): string;
     protected constructor(props: GeometricElement3dProps, iModel: IModelDb);
 }
 /** An abstract base class to model information entities that intrinsically have 2d geometry.
- * @public
+ * @public @preview
  */
 export declare abstract class GeometricElement2d extends GeometricElement {
     static get className(): string;
@@ -451,35 +451,35 @@ export declare abstract class GeometricElement2d extends GeometricElement {
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** An abstract base class for 2d Geometric Elements that are used to convey information within graphical presentations (like drawings).
- * @public
+ * @public @preview
  */
 export declare abstract class GraphicalElement2d extends GeometricElement2d {
     static get className(): string;
     protected constructor(props: GeometricElement2dProps, iModel: IModelDb);
 }
 /** 2d element used to annotate drawings and sheets.
- * @public
+ * @public @preview
  */
 export declare class AnnotationElement2d extends GraphicalElement2d {
     static get className(): string;
     protected constructor(props: GeometricElement2dProps, iModel: IModelDb);
 }
 /** 2d element used to persist graphics for use in drawings.
- * @public
+ * @public @preview
  */
 export declare class DrawingGraphic extends GraphicalElement2d {
     static get className(): string;
     protected constructor(props: GeometricElement2dProps, iModel: IModelDb);
 }
 /** An Element that occupies real world space. Its coordinates are in the project space of its iModel.
- * @public
+ * @public @preview
  */
 export declare abstract class SpatialElement extends GeometricElement3d {
     static get className(): string;
     protected constructor(props: GeometricElement3dProps, iModel: IModelDb);
 }
 /** An Element that is spatially located, has mass, and can be *touched*.
- * @public
+ * @public @preview
  */
 export declare abstract class PhysicalElement extends SpatialElement {
     static get className(): string;
@@ -489,14 +489,14 @@ export declare abstract class PhysicalElement extends SpatialElement {
     toJSON(): PhysicalElementProps;
 }
 /** Identifies a *tracked* real world location but has no mass and cannot be *touched*.
- * @public
+ * @public @preview
  */
 export declare abstract class SpatialLocationElement extends SpatialElement {
     static get className(): string;
     protected constructor(props: GeometricElement3dProps, iModel: IModelDb);
 }
 /** A Volume Element is a Spatial Location Element that is restricted to defining a volume.
- * @public
+ * @public @preview
  */
 export declare class VolumeElement extends SpatialLocationElement {
     static get className(): string;
@@ -505,7 +505,7 @@ export declare class VolumeElement extends SpatialLocationElement {
 /** A SectionDrawingLocation element identifies the location of a [[SectionDrawing]] in the context of a [[SpatialModel]],
  * enabling [HyperModeling]($hypermodeling).
  * @note The associated ECClass was added to the BisCore schema in version 1.0.11.
- * @public
+ * @public @preview
  */
 export declare class SectionDrawingLocation extends SpatialLocationElement {
     /** The Id of the [[ViewDefinition]] to which this location refers. */
@@ -517,7 +517,7 @@ export declare class SectionDrawingLocation extends SpatialLocationElement {
 /** Information Content Element is an abstract base class for modeling pure information entities. Only the
  * core framework should directly subclass from Information Content Element. Domain and application developers
  * should start with the most appropriate subclass of Information Content Element.
- * @public
+ * @public @preview
  */
 export declare abstract class InformationContentElement extends Element {
     static get className(): string;
@@ -532,14 +532,14 @@ export declare abstract class DriverBundleElement extends InformationContentElem
     protected constructor(props: ElementProps, iModel: IModelDb);
 }
 /** Information Reference is an abstract base class for modeling entities whose main purpose is to reference something else.
- * @public
+ * @public @preview
  */
 export declare abstract class InformationReferenceElement extends InformationContentElement {
     static get className(): string;
     protected constructor(props: ElementProps, iModel: IModelDb);
 }
 /** A Subject is an information element that describes what this repository (or part thereof) is about.
- * @public
+ * @public @preview
  */
 export declare class Subject extends InformationReferenceElement {
     static get className(): string;
@@ -576,14 +576,14 @@ export declare class Subject extends InformationReferenceElement {
  * For example, a will is a legal document. The will published into a PDF file is an ElectronicDocumentCopy.
  * The will printed onto paper is a PrintedDocumentCopy.
  * In this example, the Document only identifies, names, and tracks the content of the will.
- * @public
+ * @public @preview
  */
 export declare abstract class Document extends InformationContentElement {
     static get className(): string;
     protected constructor(props: ElementProps, iModel: IModelDb);
 }
 /** A document that represents a drawing, that is, a two-dimensional graphical representation of engineering data. A Drawing element is usually modelled by a [[DrawingModel]].
- * @public
+ * @public @preview
  */
 export declare class Drawing extends Document {
     private _scaleFactor;
@@ -591,7 +591,7 @@ export declare class Drawing extends Document {
      * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).
      * Default: 1.
      * @note Attempting to set this property to a value less than or equal to zero will produce an exception.
-     * @public
+     * @public @preview
      */
     get scaleFactor(): number;
     set scaleFactor(factor: number);
@@ -620,7 +620,7 @@ export declare class Drawing extends Document {
 /** A document that represents a section drawing, that is, a graphical documentation derived from a planar
  * section of a spatial view. A SectionDrawing element is modelled by a [[SectionDrawingModel]] or a [[GraphicalModel3d]].
  * A [[SectionDrawingLocation]] can associate the drawing with a spatial location, enabling [HyperModeling]($hypermodeling).
- * @public
+ * @public @preview
  */
 export declare class SectionDrawing extends Drawing {
     /** The type of section used to generate the drawing. */
@@ -644,7 +644,7 @@ export declare class SectionDrawing extends Drawing {
     toJSON(): SectionDrawingProps;
 }
 /** The template for a SheetBorder
- * @public
+ * @public @preview
  */
 export declare class SheetBorderTemplate extends Document {
     static get className(): string;
@@ -653,7 +653,7 @@ export declare class SheetBorderTemplate extends Document {
     protected constructor(props: SheetBorderTemplateProps, iModel: IModelDb);
 }
 /** The template for a [[Sheet]]
- * @public
+ * @public @preview
  */
 export declare class SheetTemplate extends Document {
     static get className(): string;
@@ -664,7 +664,7 @@ export declare class SheetTemplate extends Document {
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** A digital representation of a *sheet of paper*. Modeled by a [[SheetModel]].
- * @public
+ * @public @preview
  */
 export declare class Sheet extends Document {
     static get className(): string;
@@ -683,14 +683,14 @@ export declare class Sheet extends Document {
 }
 /** Information Record Element is an abstract base class for modeling information records. Information Record
  * Element is the default choice if no other subclass of Information Content Element makes sense.
- * @public
+ * @public @preview
  */
 export declare abstract class InformationRecordElement extends InformationContentElement {
     static get className(): string;
     protected constructor(props: ElementProps, iModel: IModelDb);
 }
 /** A Definition Element holds configuration-related information that is meant to be referenced / shared.
- * @public
+ * @public @preview
  */
 export declare abstract class DefinitionElement extends InformationContentElement {
     static get className(): string;
@@ -719,14 +719,14 @@ export declare abstract class DefinitionElement extends InformationContentElemen
 }
 /** This abstract class unifies DefinitionGroup and DefinitionContainer for relationship endpoint purposes.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.10
- * @public
+ * @public @preview
  */
 export declare abstract class DefinitionSet extends DefinitionElement {
     static get className(): string;
 }
 /** A DefinitionContainer exclusively owns a set of DefinitionElements contained within its sub-model (of type DefinitionModel).
  * @note The associated ECClass was added to the BisCore schema in version 1.0.10
- * @public
+ * @public @preview
  */
 export declare class DefinitionContainer extends DefinitionSet {
     static get className(): string;
@@ -753,7 +753,7 @@ export declare class DefinitionContainer extends DefinitionSet {
 }
 /** A non-exclusive set of DefinitionElements grouped using the DefinitionGroupGroupsDefinitions relationship.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.10
- * @public
+ * @public @preview
  */
 export declare class DefinitionGroup extends DefinitionSet {
     static get className(): string;
@@ -769,7 +769,7 @@ export declare class DefinitionGroup extends DefinitionSet {
     static create(iModelDb: IModelDb, definitionModelId: Id64String, code: Code, isPrivate?: boolean): DefinitionGroup;
 }
 /** Defines a set of properties (the *type*) that may be associated with an element.
- * @public
+ * @public @preview
  */
 export declare abstract class TypeDefinitionElement extends DefinitionElement {
     static get className(): string;
@@ -787,7 +787,7 @@ export declare abstract class RecipeDefinitionElement extends DefinitionElement
 /** Defines a set of properties (the *type*) that can be associated with a Physical Element. A Physical
  * Type has a strong correlation with something that can be ordered from a catalog since all instances
  * share a common set of properties.
- * @public
+ * @public @preview
  */
 export declare abstract class PhysicalType extends TypeDefinitionElement {
     static get className(): string;
@@ -803,7 +803,7 @@ export declare abstract class PhysicalType extends TypeDefinitionElement {
     static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
 }
 /** Defines a set of properties (the *type*) that can be associated with a spatial location.
- * @public
+ * @public @preview
  */
 export declare abstract class SpatialLocationType extends TypeDefinitionElement {
     static get className(): string;
@@ -845,7 +845,7 @@ export declare class TemplateRecipe3d extends RecipeDefinitionElement {
     static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, isPrivate?: boolean): Id64String;
 }
 /** Defines a set of properties (the *type*) that can be associated with a 2D Graphical Element.
- * @public
+ * @public @preview
  */
 export declare abstract class GraphicalType2d extends TypeDefinitionElement {
     static get className(): string;
@@ -889,7 +889,7 @@ export declare class TemplateRecipe2d extends RecipeDefinitionElement {
 /** An abstract base class for elements that establishes a particular modeling perspective for its parent Subject.
  * Instances are always sub-modeled by a specialization of Model of the appropriate modeling perspective.
  * @see [iModel Information Hierarchy]($docs/bis/guide/data-organization/top-of-the-world), [[Subject]], [[Model]]
- * @public
+ * @public @preview
  */
 export declare abstract class InformationPartitionElement extends InformationContentElement {
     static get className(): string;
@@ -907,7 +907,7 @@ export declare abstract class InformationPartitionElement extends InformationCon
 /** A DefinitionPartition element establishes a *Definition* modeling perspective for its parent Subject.
  * A DefinitionPartition is always sub-modeled by a DefinitionModel.
  * @see [[DefinitionModel]]
- * @public
+ * @public @preview
  */
 export declare class DefinitionPartition extends InformationPartitionElement {
     static get className(): string;
@@ -915,7 +915,7 @@ export declare class DefinitionPartition extends InformationPartitionElement {
 /** A DocumentPartition element establishes a *Document* modeling perspective for its parent Subject.
  * A DocumentPartition is always sub-modeled by a DocumentListModel.
  * @see [[DocumentListModel]]
- * @public
+ * @public @preview
  */
 export declare class DocumentPartition extends InformationPartitionElement {
     static get className(): string;
@@ -923,7 +923,7 @@ export declare class DocumentPartition extends InformationPartitionElement {
 /** A GroupInformationPartition element establishes a *Group Information* modeling perspective for its parent Subject.
  * A GroupInformationPartition is always sub-modeled by a GroupInformationModel.
  * @see [[GroupInformationModel]]
- * @public
+ * @public @preview
  */
 export declare class GroupInformationPartition extends InformationPartitionElement {
     static get className(): string;
@@ -932,7 +932,7 @@ export declare class GroupInformationPartition extends InformationPartitionEleme
  * A GraphicalPartition3d is always sub-modeled by a GraphicalModel3d.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.8
  * @see [[GraphicalModel3d]]
- * @public
+ * @public @preview
  */
 export declare class GraphicalPartition3d extends InformationPartitionElement {
     static get className(): string;
@@ -940,21 +940,21 @@ export declare class GraphicalPartition3d extends InformationPartitionElement {
 /** An InformationRecordPartition element establishes a *Information Record* modeling perspective for its parent Subject.
  * A InformationRecordPartition is always sub-modeled by an InformationRecordModel.
  * @see [[InformationRecordModel]]
- * @public
+ * @public @preview
  */
 export declare class InformationRecordPartition extends InformationPartitionElement {
     static get className(): string;
 }
 /** A LinkPartition element establishes a *Link* modeling perspective for its parent Subject. A LinkPartition is always sub-modeled by a LinkModel.
  * @see [[LinkModel]]
- * @public
+ * @public @preview
  */
 export declare class LinkPartition extends InformationPartitionElement {
     static get className(): string;
 }
 /** A PhysicalPartition element establishes a *Physical* modeling perspective for its parent Subject. A PhysicalPartition is always sub-modeled by a PhysicalModel.
  * @see [[PhysicalModel]]
- * @public
+ * @public @preview
  */
 export declare class PhysicalPartition extends InformationPartitionElement {
     static get className(): string;
@@ -962,7 +962,7 @@ export declare class PhysicalPartition extends InformationPartitionElement {
 /** A SpatialLocationPartition element establishes a *SpatialLocation* modeling perspective for its parent Subject.
  * A SpatialLocationPartition is always sub-modeled by a SpatialLocationModel.
  * @see [[SpatialLocationModel]]
- * @public
+ * @public @preview
  */
 export declare class SpatialLocationPartition extends InformationPartitionElement {
     static get className(): string;
@@ -975,13 +975,13 @@ export declare class SheetIndexPartition extends InformationPartitionElement {
     static get className(): string;
 }
 /** Group Information is an abstract base class for modeling entities whose main purpose is to reference a group of related elements.
- * @public
+ * @public @preview
  */
 export declare abstract class GroupInformationElement extends InformationReferenceElement {
     static get className(): string;
 }
 /** An information element that specifies a link.
- * @public
+ * @public @preview
  */
 export declare abstract class LinkElement extends InformationReferenceElement {
     static get className(): string;
@@ -993,7 +993,7 @@ export declare abstract class LinkElement extends InformationReferenceElement {
     static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
 }
 /** An information element that specifies a URL link.
- * @public
+ * @public @preview
  */
 export declare class UrlLink extends LinkElement {
     static get className(): string;
@@ -1028,7 +1028,7 @@ export declare class FolderLink extends UrlLink {
     static get className(): string;
 }
 /** An information element that links to a repository.
- * @public
+ * @public @preview
  */
 export declare class RepositoryLink extends UrlLink {
     static get className(): string;
@@ -1039,7 +1039,7 @@ export declare class RepositoryLink extends UrlLink {
     toJSON(): RepositoryLinkProps;
 }
 /** An information element that links to an embedded file.
- * @public
+ * @public @preview
  */
 export declare class EmbeddedFileLink extends LinkElement {
     static get className(): string;
@@ -1047,14 +1047,14 @@ export declare class EmbeddedFileLink extends LinkElement {
 /** A real world entity is modeled as a Role Element when a set of external circumstances define an important
  * role (one that is worth tracking) that is not intrinsic to the entity playing the role. For example,
  * a person can play the role of a teacher or a rock can play the role of a boundary marker.
- * @public
+ * @public @preview
  */
 export declare abstract class RoleElement extends Element {
     static get className(): string;
 }
 /** A Definition Element that specifies a collection of geometry that is meant to be reused across Geometric
  * Element instances. Leveraging Geometry Parts can help reduce file size and improve display performance.
- * @public
+ * @public @preview
  */
 export declare class GeometryPart extends DefinitionElement {
     static get className(): string;
@@ -1089,7 +1089,7 @@ export declare class GeometryPart extends DefinitionElement {
     static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
 }
 /** The definition element for a line style
- * @public
+ * @public @preview
  */
 export declare class LineStyle extends DefinitionElement {
     static get className(): string;
@@ -1124,7 +1124,7 @@ export declare class LineStyle extends DefinitionElement {
 }
 /** Describes how to animate a view of a [[GeometricModel]] to show change over time using a [RenderSchedule.Script]($common).
  * @note This class was introduced in version 01.00.13 of the BisCore ECSchema. It should only be used with [[IModelDb]]s containing that version or newer.
- * @public
+ * @public @preview
  */
 export declare class RenderTimeline extends InformationRecordElement {
     static get className(): string;