@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/Element.d.ts

@@ -0,0 +1,1082 @@
+/** @packageDocumentation
+ * @module Elements
+ */
+import { GuidString, Id64Set, Id64String } from "@itwin/core-bentley";
+import { ClipVector, Transform } from "@itwin/core-geometry";
+import { AxisAlignedBox3d, Code, CodeScopeProps, DefinitionElementProps, ElementAlignedBox3d, ElementProps, EntityMetaData, GeometricElement2dProps, GeometricElement3dProps, GeometricElementProps, GeometryPartProps, GeometryStreamProps, InformationPartitionElementProps, LineStyleProps, ModelProps, PhysicalElementProps, PhysicalTypeProps, Placement2d, Placement3d, RelatedElement, RenderSchedule, RenderTimelineProps, RepositoryLinkProps, SectionDrawingLocationProps, SectionDrawingProps, SectionType, SheetBorderTemplateProps, SheetProps, SheetTemplateProps, SubjectProps, TypeDefinition, TypeDefinitionElementProps, UrlLinkProps } from "@itwin/core-common";
+import { Entity } from "./Entity";
+import { IModelCloneContext } from "./IModelCloneContext";
+import { IModelDb } from "./IModelDb";
+/** Argument for the `Element.onXxx` static methods
+ * @beta
+ */
+export interface OnElementArg {
+    /** The iModel for the Element affected by this method. */
+    iModel: IModelDb;
+}
+/** Argument for `Element.onInsert` and `Element.onUpdate` static methods.
+ * @beta
+ */
+export interface OnElementPropsArg extends OnElementArg {
+    /** The properties of the Element affected by this method.
+     * @note the properties may be modified. If so the modified values will be inserted/updated.
+     */
+    props: ElementProps;
+}
+/** Argument for the `Element.onXxx` static methods that only supply the Id of the affected Element.
+ * @beta
+ */
+export interface OnElementIdArg extends OnElementArg {
+    /** The Id of the Element affected by this method */
+    id: Id64String;
+}
+/** Argument for the `Element.onChildXxx` static methods
+ * @beta
+ */
+export interface OnChildElementArg extends OnElementArg {
+    parentId: Id64String;
+}
+/** Argument for the `Element.onChildXxx` static methods that supply the properties of the child Element to be inserted or updated.
+ * @beta
+ */
+export interface OnChildElementPropsArg extends OnChildElementArg {
+    /** The new properties of the child Element for this method. */
+    childProps: Readonly<ElementProps>;
+}
+/** Argument for the `Element.onChildXxx` static methods that only supply the Id of the child Element.
+ * @beta
+ */
+export interface OnChildElementIdArg extends OnChildElementArg {
+    /** The Id of the child element for this method */
+    childId: Id64String;
+}
+/** Argument for the `Element.onSubModelInsert` static method
+ * @beta
+ */
+export interface OnSubModelPropsArg extends OnElementArg {
+    /** The properties of the prospective sub-model */
+    subModelProps: ModelProps;
+}
+/** Argument for several `Element.onSubModelXxx` static methods
+ * @beta
+ */
+export interface OnSubModelIdArg extends OnElementArg {
+    /** The modelId of the sub Model */
+    subModelId: Id64String;
+}
+/** Elements are the smallest individually identifiable building blocks for modeling the real world in an iModel.
+ * Each element represents an entity in the real world. Sets of Elements (contained in [[Model]]s) are used to model
+ * other Elements that represent larger scale real world entities. Using this recursive modeling strategy,
+ * Elements can represent entities at any scale. Elements can represent physical things or abstract concepts
+ * or simply be information records.
+ *
+ * Every Element has a 64-bit id (inherited from Entity) that uniquely identifies it within an iModel. Every Element also
+ * has a "code" that identifies its meaning in the real world. Additionally, Elements may have a "federationGuid"
+ * to hold a GUID, if the element was assigned that GUID by some other federated database. The iModel database enforces
+ * uniqueness of id, code, and federationGuid.
+ *
+ * See:
+ * * [Element Fundamentals]($docs/bis/intro/element-fundamentals.md)
+ * * [Working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md)
+ * * [Creating elements]($docs/learning/backend/CreateElements.md)
+ * @public
+ */
+export declare class Element extends Entity implements ElementProps {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    static get protectedOperations(): string[];
+    /** The ModelId of the [Model]($docs/bis/intro/model-fundamentals.md) containing this element */
+    readonly model: Id64String;
+    /** The [Code]($docs/bis/intro/codes.md) for this element */
+    code: Code;
+    /** The parent element, if present, of this element. */
+    parent?: RelatedElement;
+    /** A [FederationGuid]($docs/bis/intro/element-fundamentals.md#federationguid) assigned to this element by some other federated database */
+    federationGuid?: GuidString;
+    /** A [user-assigned label]($docs/bis/intro/element-fundamentals.md#userlabel) for this element. */
+    userLabel?: string;
+    /** Optional [json properties]($docs/bis/intro/element-fundamentals.md#jsonproperties) of this element. */
+    readonly jsonProperties: {
+        [key: string]: any;
+    };
+    /** constructor for Element.
+     * @internal
+     */
+    constructor(props: ElementProps, iModel: IModelDb);
+    /** Called before a new Element is inserted.
+     * @note throw an exception to disallow the insert
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Element to be inserted
+     * @beta
+     */
+    protected static onInsert(arg: OnElementPropsArg): void;
+    /** Called after a new Element was inserted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Element that was inserted
+     * @beta
+     */
+    protected static onInserted(arg: OnElementIdArg): void;
+    /** Called before an Element is updated.
+     * @note throw an exception to disallow the update
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Element to be updated
+     * @beta
+     */
+    protected static onUpdate(arg: OnElementPropsArg): void;
+    /** Called after an Element was updated.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Element that was updated
+     * @beta
+     */
+    protected static onUpdated(_arg: OnElementIdArg): void;
+    /** Called before an Element is deleted.
+     * @note throw an exception to disallow the delete
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Element to be deleted
+     * @beta
+     */
+    protected static onDelete(arg: OnElementIdArg): void;
+    /** Called after an Element was deleted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Element that was deleted
+     * @beta
+     */
+    protected static onDeleted(_arg: OnElementIdArg): void;
+    /** Called when an element with an instance of this class as its parent is about to be deleted.
+     * @note throw an exception if the element should not be deleted
+     * @note implementers should not presume that the element was deleted if this method does not throw,
+     * since the delete may fail for other reasons. Instead, rely on [[onChildDeleted]] for that purpose.
+     * @note `this` is the class of the parent Element whose child will be deleted
+     * @beta
+     */
+    protected static onChildDelete(_arg: OnChildElementIdArg): void;
+    /** Called after an element with an instance of this class as its parent was successfully deleted.
+     * @note `this` is the class of the parent Element whose child was deleted
+     * @beta
+     */
+    protected static onChildDeleted(_arg: OnChildElementIdArg): void;
+    /** Called when a *new element* with an instance of this class as its parent is about to be inserted.
+     * @note throw an exception if the element should not be inserted
+     * @note `this` is the class of the prospective parent Element.
+     * @beta
+     */
+    protected static onChildInsert(_arg: OnChildElementPropsArg): void;
+    /** Called after a *new element* with an instance of this class as its parent was inserted.
+     * @note `this` is the class of the parent Element.
+     * @beta
+     */
+    protected static onChildInserted(_arg: OnChildElementIdArg): void;
+    /** Called when an element with an instance of this class as its parent is about to be updated.
+     * @note throw an exception if the element should not be updated
+     * @note `this` is the class of the parent Element.
+     * @beta
+     */
+    protected static onChildUpdate(_arg: OnChildElementPropsArg): void;
+    /** Called after an element with an instance of this the class as its parent was updated.
+     * @note `this` is the class of the parent Element.
+     * @beta
+     */
+    protected static onChildUpdated(_arg: OnChildElementIdArg): void;
+    /** Called when an *existing element* is about to be updated so that an instance of this class will become its new parent.
+     * @note throw an exception if the element should not be added
+     * @note `this` is the class of the prospective parent Element.
+     * @beta
+     */
+    protected static onChildAdd(_arg: OnChildElementPropsArg): void;
+    /** Called after an *existing element* has been updated so that an instance of this class is its new parent.
+     * @note `this` is the class of the new parent Element.
+     * @beta
+     */
+    protected static onChildAdded(_arg: OnChildElementIdArg): void;
+    /** Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
+     * @note throw an exception if the element should not be dropped
+     * @note `this` is the class of the parent Element.
+     * @beta
+     */
+    protected static onChildDrop(_arg: OnChildElementIdArg): void;
+    /** Called after an element with an instance of this class as its previous parent was updated to have a new parent.
+     * @note `this` is the class of the previous parent Element.
+     * @beta
+     */
+    protected static onChildDropped(_arg: OnChildElementIdArg): void;
+    /** Called when an instance of this class is being *sub-modeled* by a new Model.
+     * @note throw an exception if model should not be inserted
+     * @note `this` is the class of Element to be sub-modeled.
+     * @beta
+     */
+    protected static onSubModelInsert(_arg: OnSubModelPropsArg): void;
+    /** Called after an instance of this class was *sub-modeled* by a new Model.
+     * @note `this` is the class of Element that is now sub-modeled.
+     * @beta
+     */
+    protected static onSubModelInserted(_arg: OnSubModelIdArg): void;
+    /** Called when a sub-model of an instance of this class is being deleted.
+     * @note throw an exception if model should not be deleted
+     * @note `this` is the class of Element that is sub-modeled.
+     * @beta
+     */
+    protected static onSubModelDelete(_arg: OnSubModelIdArg): void;
+    /** Called after a sub-model of an instance of this class was deleted.
+     * @note `this` is the class of Element that was sub-modeled.
+     * @beta
+     */
+    protected static onSubModelDeleted(_arg: OnSubModelIdArg): void;
+    /** Called during the iModel transformation process after an Element from the source iModel was *cloned* for the target iModel.
+     * The transformation process automatically handles remapping BisCore properties and those that are properly described in ECSchema.
+     * This callback is only meant to be overridden if there are other Ids in non-standard locations that need to be remapped or other data that needs to be fixed up after the clone.
+     * @param _context The context that persists any remapping between the source iModel and target iModel.
+     * @param _sourceProps The ElementProps for the source Element that was cloned.
+     * @param _targetProps The ElementProps that are a result of the clone. These can be further modified.
+     * @note If you override this method, you must call super.
+     * @beta
+     */
+    protected static onCloned(_context: IModelCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void;
+    /** Called when a *root* element in a subgraph is changed and before its outputs are processed.
+     * This special callback is made when:
+     * * the element is part of an [[ElementDrivesElement]] graph, and
+     * * the element has no inputs, and
+     * * none of the element's outputs have been processed.
+     * @see [[ElementDrivesElement]] for more on element dependency graphs.
+     * @beta
+     */
+    protected static onBeforeOutputsHandled(_id: Id64String, _iModel: IModelDb): void;
+    /** Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
+     * This callback is made when:
+     * * the specified element is part of an [[ElementDrivesElement]] graph, and
+     * * there was a direct change to some element upstream in the dependency graph.
+     * * all upstream elements in the graph have been processed.
+     * * none of the downstream elements have been processed.
+     * This method is not called if none of the element's inputs were changed.
+     * @see [[ElementDrivesElement]] for more on element dependency graphs.
+     * @beta
+     */
+    protected static onAllInputsHandled(_id: Id64String, _iModel: IModelDb): void;
+    /** Save this Element's properties to an object for serializing to JSON.
+     * @internal
+     */
+    toJSON(): ElementProps;
+    /** Collect the Ids of this element's *predecessors* at this level of the class hierarchy.
+     * A *predecessor* is an element that had to be inserted before this element could have been inserted.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @param predecessorIds The Id64Set to populate with predecessor Ids.
+     * @note In order to clone/transform an element, all predecessor elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
+     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces predecessors.
+     * @see getPredecessorIds
+     * @beta
+     */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+    /** Get the Ids of this element's *predecessors*. A *predecessor* is an element that had to be inserted before this element could have been inserted.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @see collectPredecessorIds
+     * @beta
+     */
+    getPredecessorIds(): Id64Set;
+    /** Get the class metadata for this element. */
+    getClassMetaData(): EntityMetaData | undefined;
+    private getAllUserProperties;
+    /** Get a set of JSON user properties by namespace */
+    getUserProperties(namespace: string): any;
+    /** Change a set of user JSON properties of this Element by namespace. */
+    setUserProperties(nameSpace: string, value: any): void;
+    /** Remove a set of JSON user properties, specified by namespace, from this Element */
+    removeUserProperties(nameSpace: string): void;
+    /** Get a JSON property of this element, by namespace */
+    getJsonProperty(nameSpace: string): any;
+    setJsonProperty(nameSpace: string, value: any): void;
+    /** Get a display label for this Element. By default returns userLabel if present, otherwise code value. */
+    getDisplayLabel(): string;
+    /** Get a list of HTML strings that describe this Element for the tooltip. Strings will be listed on separate lines in the tooltip.
+     * Any instances of the pattern `%{tag}` will be replaced by the localized value of tag.
+     */
+    getToolTipMessage(): string[];
+    /** Insert this Element into the iModel. */
+    insert(): string;
+    /** Update this Element in the iModel. */
+    update(): void;
+    /** Delete this Element from the iModel. */
+    delete(): void;
+}
+/** An abstract base class to model real world entities that intrinsically have geometry.
+ * @public
+ */
+export declare abstract class GeometricElement extends Element implements GeometricElementProps {
+    /** @internal */
+    static get className(): string;
+    /** The Id of the [[Category]] for this GeometricElement. */
+    category: Id64String;
+    /** The GeometryStream for this GeometricElement. */
+    geom?: GeometryStreamProps;
+    /** The origin, orientation, and bounding box of this GeometricElement. */
+    abstract get placement(): Placement2d | Placement3d;
+    /** @internal */
+    constructor(props: GeometricElementProps, iModel: IModelDb);
+    /** Type guard for instanceof [[GeometricElement3d]] */
+    is3d(): this is GeometricElement3d;
+    /** Type guard for instanceof [[GeometricElement2d]] */
+    is2d(): this is GeometricElement2d;
+    /** Get the [Transform]($geometry) from the Placement of this GeometricElement */
+    getPlacementTransform(): Transform;
+    calculateRange3d(): AxisAlignedBox3d;
+    /** @internal */
+    toJSON(): GeometricElementProps;
+    /** @internal */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+}
+/** 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
+ */
+export declare abstract class GeometricElement3d extends GeometricElement implements GeometricElement3dProps {
+    /** @internal */
+    static get className(): string;
+    placement: Placement3d;
+    typeDefinition?: TypeDefinition;
+    /** @internal */
+    constructor(props: GeometricElement3dProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): GeometricElement3dProps;
+    /** @internal */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+}
+/** A 3d Graphical Element
+ * @public
+ */
+export declare abstract class GraphicalElement3d extends GeometricElement3d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement3dProps, iModel: IModelDb);
+}
+/** An abstract base class to model information entities that intrinsically have 2d geometry.
+ * @public
+ */
+export declare abstract class GeometricElement2d extends GeometricElement implements GeometricElement2dProps {
+    /** @internal */
+    static get className(): string;
+    placement: Placement2d;
+    typeDefinition?: TypeDefinition;
+    /** @internal */
+    constructor(props: GeometricElement2dProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): GeometricElement2dProps;
+    /** @internal */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+}
+/** An abstract base class for 2d Geometric Elements that are used to convey information within graphical presentations (like drawings).
+ * @public
+ */
+export declare abstract class GraphicalElement2d extends GeometricElement2d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement2dProps, iModel: IModelDb);
+}
+/** 2d element used to annotate drawings and sheets.
+ * @public
+ */
+export declare class AnnotationElement2d extends GraphicalElement2d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement2dProps, iModel: IModelDb);
+}
+/** 2d element used to persist graphics for use in drawings.
+ * @public
+ */
+export declare class DrawingGraphic extends GraphicalElement2d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement2dProps, iModel: IModelDb);
+}
+/** 2D Text Annotation
+ * @public
+ */
+export declare class TextAnnotation2d extends AnnotationElement2d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement2dProps, iModel: IModelDb);
+}
+/** 3D Text Annotation
+ * @public
+ */
+export declare class TextAnnotation3d extends GraphicalElement3d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement3dProps, iModel: IModelDb);
+}
+/** An Element that occupies real world space. Its coordinates are in the project space of its iModel.
+ * @public
+ */
+export declare abstract class SpatialElement extends GeometricElement3d {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement3dProps, iModel: IModelDb);
+}
+/** An Element that is spatially located, has mass, and can be *touched*.
+ * @public
+ */
+export declare abstract class PhysicalElement extends SpatialElement {
+    /** @internal */
+    static get className(): string;
+    /** If defined, the [[PhysicalMaterial]] that makes up this PhysicalElement. */
+    physicalMaterial?: RelatedElement;
+    /** @internal */
+    constructor(props: PhysicalElementProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): PhysicalElementProps;
+}
+/** Identifies a *tracked* real world location but has no mass and cannot be *touched*.
+ * @public
+ */
+export declare abstract class SpatialLocationElement extends SpatialElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement3dProps, iModel: IModelDb);
+}
+/** A Volume Element is a Spatial Location Element that is restricted to defining a volume.
+ * @public
+ */
+export declare class VolumeElement extends SpatialLocationElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: GeometricElement3dProps, iModel: IModelDb);
+}
+/** 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
+ */
+export declare class SectionDrawingLocation extends SpatialLocationElement {
+    /** The Id of the [[ViewDefinition]] to which this location refers. */
+    sectionView: RelatedElement;
+    /** @internal */
+    static get className(): string;
+    constructor(props: SectionDrawingLocationProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): SectionDrawingLocationProps;
+}
+/** 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
+ */
+export declare abstract class InformationContentElement extends Element {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+}
+/** Element used in conjunction with bis:ElementDrivesElement relationships to bundle multiple inputs before
+ * driving the output element.
+ * @beta
+ */
+export declare abstract class DriverBundleElement extends InformationContentElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+}
+/** Information Reference is an abstract base class for modeling entities whose main purpose is to reference something else.
+ * @public
+ */
+export declare abstract class InformationReferenceElement extends InformationContentElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+}
+/** A Subject is an information element that describes what this repository (or part thereof) is about.
+ * See [how to create a Subject element]$(docs/learning/backend/CreateElements.md#Subject).
+ * @public
+ */
+export declare class Subject extends InformationReferenceElement implements SubjectProps {
+    /** @internal */
+    static get className(): string;
+    description?: string;
+    /** @internal */
+    constructor(props: SubjectProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): SubjectProps;
+    /** Create a Code for a Subject given a name that is meant to be unique within the scope of its parent Subject.
+     * @param iModelDb The IModelDb
+     * @param parentSubjectId The Id of the parent Subject that provides the scope for names of its child Subjects.
+     * @param codeValue The child Subject name
+     */
+    static createCode(iModelDb: IModelDb, parentSubjectId: CodeScopeProps, codeValue: string): Code;
+    /** Create a Subject
+     * @param iModelDb The IModelDb
+     * @param parentSubjectId The new Subject will be a child of this Subject
+     * @param name The name (codeValue) of the Subject
+     * @param description The optional description of the Subject
+     * @returns The newly constructed Subject
+     * @throws [[IModelError]] if there is a problem creating the Subject
+     */
+    static create(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, description?: string): Subject;
+    /** Insert a Subject
+     * @param iModelDb Insert into this IModelDb
+     * @param parentSubjectId The new Subject will be inserted as a child of this Subject
+     * @param name The name (codeValue) of the Subject
+     * @param description The optional description of the Subject
+     * @returns The Id of the newly inserted Subject
+     * @throws [[IModelError]] if there is a problem inserting the Subject
+     */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, description?: string): Id64String;
+}
+/** An InformationContentElement that identifies the content of a document.
+ * The realized form of a document is called a DocumentCarrier (different class than Document).
+ * 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
+ */
+export declare abstract class Document extends InformationContentElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    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
+ */
+export declare class Drawing extends Document {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+    /** Create a Code for a Drawing given a name that is meant to be unique within the scope of the specified DocumentListModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DocumentListModel that contains the Drawing and provides the scope for its name.
+     * @param codeValue The Drawing name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+    /** Insert a Drawing element and a DrawingModel that breaks it down.
+     * @param iModelDb Insert into this iModel
+     * @param documentListModelId Insert the new Drawing into this DocumentListModel
+     * @param name The name of the Drawing.
+     * @returns The Id of the newly inserted Drawing element and the DrawingModel that breaks it down (same value).
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb: IModelDb, documentListModelId: Id64String, name: string): Id64String;
+}
+/** 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
+ */
+export declare class SectionDrawing extends Drawing {
+    /** The type of section used to generate the drawing. */
+    sectionType: SectionType;
+    /** The spatial view from which the section was generated. */
+    spatialView: RelatedElement;
+    /** A transform from the section drawing model's coordinates to spatial coordinates. */
+    drawingToSpatialTransform?: Transform;
+    /** If the section drawing is placed onto a [[Sheet]] via a [[ViewAttachment]], a transform from the sheet's coordinates to spatial coordinates. */
+    sheetToSpatialTransform?: Transform;
+    /** 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?: ClipVector;
+    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */
+    displaySpatialView: boolean;
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: SectionDrawingProps, iModel: IModelDb);
+    /** Convert to JSON representation. */
+    toJSON(): SectionDrawingProps;
+}
+/** The template for a SheetBorder
+ * @public
+ */
+export declare class SheetBorderTemplate extends Document implements SheetBorderTemplateProps {
+    /** @internal */
+    static get className(): string;
+    height?: number;
+    width?: number;
+    /** @internal */
+    constructor(props: SheetBorderTemplateProps, iModel: IModelDb);
+}
+/** The template for a [[Sheet]]
+ * @public
+ */
+export declare class SheetTemplate extends Document implements SheetTemplateProps {
+    /** @internal */
+    static get className(): string;
+    height?: number;
+    width?: number;
+    border?: Id64String;
+    /** @internal */
+    constructor(props: SheetTemplateProps, iModel: IModelDb);
+    /** @internal */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+}
+/** A digital representation of a *sheet of paper*. Modeled by a [[SheetModel]].
+ * @public
+ */
+export declare class Sheet extends Document implements SheetProps {
+    /** @internal */
+    static get className(): string;
+    height: number;
+    width: number;
+    scale?: number;
+    sheetTemplate?: Id64String;
+    /** @internal */
+    constructor(props: SheetProps, iModel: IModelDb);
+    /** @internal */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+    /** Create a Code for a Sheet given a name that is meant to be unique within the scope of the specified DocumentListModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DocumentListModel that contains the Sheet and provides the scope for its name.
+     * @param codeValue The Sheet name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+}
+/** 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
+ */
+export declare abstract class InformationRecordElement extends InformationContentElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+}
+/** A Definition Element holds configuration-related information that is meant to be referenced / shared.
+ * @public
+ */
+export declare abstract class DefinitionElement extends InformationContentElement implements DefinitionElementProps {
+    /** @internal */
+    static get className(): string;
+    /** If true, don't show this DefinitionElement in user interface lists. */
+    isPrivate: boolean;
+    /** @internal */
+    constructor(props: DefinitionElementProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): DefinitionElementProps;
+}
+/** 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
+ */
+export declare abstract class DefinitionSet extends DefinitionElement {
+    /** @internal */
+    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
+ */
+export declare class DefinitionContainer extends DefinitionSet {
+    /** @internal */
+    static get className(): string;
+    /** Create a DefinitionContainer
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that will contain this DefinitionContainer element.
+     * @param code The Code for this DefinitionContainer.
+     * @param isPrivate The optional hint, that if `true` means it should not be displayed in the UI.
+     * @returns The newly constructed DefinitionContainer
+     * @note There is not a predefined CodeSpec for DefinitionContainer elements, so it is the responsibility of the domain or application to create one.
+     * @throws [[IModelError]] if there is a problem creating the DefinitionContainer
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, code: Code, isPrivate?: boolean): DefinitionContainer;
+    /** Insert a DefinitionContainer and its sub-model.
+     * @param iModelDb Insert into this IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that will contain this DefinitionContainer element.
+     * @param code The Code for this DefinitionContainer.
+     * @param isPrivate The optional hint, that if `true` means it should not be displayed in the UI.
+     * @returns The Id of the newly inserted DefinitionContainer and its newly inserted sub-model (of type DefinitionModel).
+     * @note There is not a predefined CodeSpec for DefinitionContainer elements, so it is the responsibility of the domain or application to create one.
+     * @throws [[IModelError]] if there is a problem inserting the DefinitionContainer
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, code: Code, isPrivate?: boolean): Id64String;
+}
+/** 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
+ */
+export declare class DefinitionGroup extends DefinitionSet {
+    /** @internal */
+    static get className(): string;
+    /** Create a DefinitionGroup
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that will contain this DefinitionGroup element.
+     * @param code The Code for this DefinitionGroup
+     * @param isPrivate The optional hint, that if `true` means it should not be displayed in the UI.
+     * @returns The newly constructed DefinitionGroup
+     * @note There is not a predefined CodeSpec for DefinitionGroup elements, so it is the responsibility of the domain or application to create one.
+     * @throws [[IModelError]] if there is a problem creating the DefinitionGroup
+     */
+    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
+ */
+export declare abstract class TypeDefinitionElement extends DefinitionElement implements TypeDefinitionElementProps {
+    /** @internal */
+    static get className(): string;
+    recipe?: RelatedElement;
+    /** @internal */
+    constructor(props: TypeDefinitionElementProps, iModel: IModelDb);
+    /** @internal */
+    protected collectPredecessorIds(predecessorIds: Id64Set): void;
+}
+/** Defines a recipe for generating instances from a definition.
+ * @beta
+ */
+export declare abstract class RecipeDefinitionElement extends DefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+}
+/** 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
+ */
+export declare abstract class PhysicalType extends TypeDefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** If defined, the [[PhysicalMaterial]] that makes up this PhysicalType. */
+    physicalMaterial?: RelatedElement;
+    /** @internal */
+    constructor(props: PhysicalTypeProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): PhysicalTypeProps;
+    /** Create a Code for a PhysicalType element given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the PhysicalType element and provides the scope for its name.
+     * @param codeValue The PhysicalType name
+     */
+    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
+ */
+export declare abstract class SpatialLocationType extends TypeDefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: TypeDefinitionElementProps, iModel: IModelDb);
+    /** Create a Code for a SpatialLocationType element given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the SpatialLocationType element and provides the scope for its name.
+     * @param codeValue The SpatialLocationType name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+}
+/** A TemplateRecipe3d is a DefinitionElement that has a sub-model that contains the 3d template elements.
+ * @beta
+ */
+export declare class TemplateRecipe3d extends RecipeDefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+    /** Create a Code for a TemplateRecipe3d given a name that is meant to be unique within the scope of its Model.
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that contains this TemplateRecipe3d element.
+     * @param codeValue The name of the TemplateRecipe3d element.
+     */
+    static createCode(iModelDb: IModelDb, definitionModelId: CodeScopeProps, codeValue: string): Code;
+    /** Create a TemplateRecipe3d
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that contains this TemplateRecipe3d element.
+     * @param name The name (Code.value) of the TemplateRecipe3d
+     * @returns The newly constructed TemplateRecipe3d
+     * @throws [[IModelError]] if there is a problem creating the TemplateRecipe3d
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, isPrivate?: boolean): TemplateRecipe3d;
+    /** Insert a TemplateRecipe3d and a PhysicalModel (sub-model) that will contain the 3d template elements.
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that contains this TemplateRecipe3d element.
+     * @param name The name (Code.value) of the TemplateRecipe3d
+     * @returns The Id of the newly inserted TemplateRecipe3d and the PhysicalModel that sub-models it.
+     * @throws [[IModelError]] if there is a problem inserting the TemplateRecipe3d or its sub-model.
+     */
+    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
+ */
+export declare abstract class GraphicalType2d extends TypeDefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: TypeDefinitionElementProps, iModel: IModelDb);
+    /** Create a Code for a GraphicalType2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the GraphicalType2d element and provides the scope for its name.
+     * @param codeValue The GraphicalType2d name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+}
+/** A recipe that uses a 2D template for creating new instances.
+ * @beta
+ */
+export declare class TemplateRecipe2d extends RecipeDefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** @internal */
+    constructor(props: ElementProps, iModel: IModelDb);
+    /** Create a Code for a TemplateRecipe2d given a name that is meant to be unique within the scope of its Model.
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that contains this TemplateRecipe2d element.
+     * @param codeValue The name of the TemplateRecipe2d element.
+     */
+    static createCode(iModelDb: IModelDb, definitionModelId: CodeScopeProps, codeValue: string): Code;
+    /** Create a TemplateRecipe2d
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that contains this TemplateRecipe2d element.
+     * @param name The name (Code.value) of the TemplateRecipe2d
+     * @returns The newly constructed TemplateRecipe2d
+     * @throws [[IModelError]] if there is a problem creating the TemplateRecipe2d
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, isPrivate?: boolean): TemplateRecipe2d;
+    /** Insert a TemplateRecipe2d and a DrawingModel (sub-model) that will contain the 2d template elements.
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the [DefinitionModel]($backend) that contains this TemplateRecipe2d element.
+     * @param name The name (Code.value) of the TemplateRecipe2d
+     * @returns The Id of the newly inserted TemplateRecipe2d and the PhysicalModel that sub-models it.
+     * @throws [[IModelError]] if there is a problem inserting the TemplateRecipe2d or its sub-model.
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, isPrivate?: boolean): Id64String;
+}
+/** 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/intro/top-of-the-world), [[Subject]], [[Model]]
+ * @public
+ */
+export declare abstract class InformationPartitionElement extends InformationContentElement implements InformationPartitionElementProps {
+    /** @internal */
+    static get className(): string;
+    /** A human-readable string describing the intent of the partition. */
+    description?: string;
+    /** @internal */
+    constructor(props: InformationPartitionElementProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): InformationPartitionElementProps;
+    /** Create a code that can be used for any subclass of InformationPartitionElement.
+     * @param iModelDb The IModelDb
+     * @param parentSubjectId The Id of the parent Subject that provides the scope for names of its child InformationPartitionElements.
+     * @param codeValue The InformationPartitionElement name
+     */
+    static createCode(iModel: IModelDb, parentSubjectId: CodeScopeProps, codeValue: string): Code;
+}
+/** A DefinitionPartition element establishes a *Definition* modeling perspective for its parent Subject.
+ * A DefinitionPartition is always sub-modeled by a DefinitionModel.
+ * @see [[DefinitionModel]]
+ * @public
+ */
+export declare class DefinitionPartition extends InformationPartitionElement {
+    /** @internal */
+    static get className(): string;
+}
+/** A DocumentPartition element establishes a *Document* modeling perspective for its parent Subject.
+ * A DocumentPartition is always sub-modeled by a DocumentListModel.
+ * @see [[DocumentListModel]]
+ * @public
+ */
+export declare class DocumentPartition extends InformationPartitionElement {
+    /** @internal */
+    static get className(): string;
+}
+/** 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
+ */
+export declare class GroupInformationPartition extends InformationPartitionElement {
+    /** @internal */
+    static get className(): string;
+}
+/** A GraphicalPartition3d element establishes a *3D Graphical* modeling perspective for its parent Subject.
+ * 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
+ */
+export declare class GraphicalPartition3d extends InformationPartitionElement {
+    /** @internal */
+    static get className(): string;
+}
+/** 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
+ */
+export declare class InformationRecordPartition extends InformationPartitionElement {
+    /** @internal */
+    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
+ */
+export declare class LinkPartition extends InformationPartitionElement {
+    /** @internal */
+    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
+ */
+export declare class PhysicalPartition extends InformationPartitionElement {
+    /** @internal */
+    static get className(): string;
+}
+/** A SpatialLocationPartition element establishes a *SpatialLocation* modeling perspective for its parent Subject.
+ * A SpatialLocationPartition is always sub-modeled by a SpatialLocationModel.
+ * @see [[SpatialLocationModel]]
+ * @public
+ */
+export declare class SpatialLocationPartition extends InformationPartitionElement {
+    /** @internal */
+    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
+ */
+export declare abstract class GroupInformationElement extends InformationReferenceElement {
+    /** @internal */
+    static get className(): string;
+}
+/** An information element that specifies a link.
+ * @public
+ */
+export declare abstract class LinkElement extends InformationReferenceElement {
+    /** @internal */
+    static get className(): string;
+    /** Create a Code for a LinkElement given a name that is meant to be unique within the scope of the specified Model.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the Model that contains the LinkElement and provides the scope for its name.
+     * @param codeValue The LinkElement name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+}
+/** An information element that specifies a URL link.
+ * @public
+ */
+export declare class UrlLink extends LinkElement implements UrlLinkProps {
+    /** @internal */
+    static get className(): string;
+    description?: string;
+    url?: string;
+    /** @internal */
+    constructor(props: UrlLinkProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): UrlLinkProps;
+}
+/** Represents a folder-like structure that organizes repositories (typically files) in an external system.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @alpha
+ */
+export declare class FolderLink extends UrlLink {
+    /** @internal */
+    static get className(): string;
+}
+/** An information element that links to a repository.
+ * @public
+ */
+export declare class RepositoryLink extends UrlLink implements RepositoryLinkProps {
+    /** @internal */
+    static get className(): string;
+    repositoryGuid?: GuidString;
+    /** @note This property was added to the BisCore schema in version 1.0.13 */
+    format?: string;
+    /** @internal */
+    constructor(props: RepositoryLinkProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): RepositoryLinkProps;
+}
+/** An information element that links to an embedded file.
+ * @public
+ */
+export declare class EmbeddedFileLink extends LinkElement {
+    /** @internal */
+    static get className(): string;
+}
+/** 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
+ */
+export declare abstract class RoleElement extends Element {
+    /** @internal */
+    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
+ */
+export declare class GeometryPart extends DefinitionElement implements GeometryPartProps {
+    /** @internal */
+    static get className(): string;
+    geom?: GeometryStreamProps;
+    bbox: ElementAlignedBox3d;
+    /** @internal */
+    constructor(props: GeometryPartProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): GeometryPartProps;
+    /** Create a Code for a GeometryPart element given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the GeometryPart element and provides the scope for its name.
+     * @param codeValue The GeometryPart name
+     * @note GeometryPart elements are not required to be named (have a non-empty Code).
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+}
+/** The definition element for a line style
+ * @public
+ */
+export declare class LineStyle extends DefinitionElement implements LineStyleProps {
+    /** @internal */
+    static get className(): string;
+    description?: string;
+    data: string;
+    /** @internal */
+    constructor(props: LineStyleProps, iModel: IModelDb);
+    /** 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.
+     * @param codeValue The name of the LineStyle
+     * @returns A LineStyle Code
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+}
+/** 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
+ */
+export declare class RenderTimeline extends InformationRecordElement {
+    /** @internal */
+    static get className(): string;
+    /** A human-readable description of the timeline, which may be an empty string. */
+    description: string;
+    /** The JSON representation of the instructions for visualizing change over time.
+     * @see [RenderSchedule.Script]($common) for the API for working with the script.
+     */
+    scriptProps: RenderSchedule.ScriptProps;
+    /** @internal */
+    protected constructor(props: RenderTimelineProps, iModel: IModelDb);
+    static fromJSON(props: RenderTimelineProps, iModel: IModelDb): RenderTimeline;
+    toJSON(): RenderTimelineProps;
+    private static parseScriptProps;
+    /** @alpha */
+    protected collectPredecessorIds(ids: Id64Set): void;
+    /** @alpha */
+    protected static onCloned(context: IModelCloneContext, sourceProps: RenderTimelineProps, targetProps: RenderTimelineProps): void;
+    /** Remap Ids when cloning a RenderSchedule.Script between iModels on a DisplayStyle or RenderTimeline.
+     * @internal
+     */
+    static remapScript(context: IModelCloneContext, input: RenderSchedule.ScriptProps): RenderSchedule.ScriptProps;
+}
+//# sourceMappingURL=Element.d.ts.map