imodeljs-backend

Classes

Name Description
AnnotationElement2d 2d element used to annotate drawings and sheets.
AutoPush Use AutoPush to automatically push local changes to a specified IModel.
AuxCoordSystem An auxiliary coordinate system element.
AuxCoordSystem2d A 2d auxiliary coordinate system.
AuxCoordSystem3d A 3d auxiliary coordinate system.
AuxCoordSystemSpatial A spatial auxiliary coordinate system.
BackendActivityMonitor An implementation of AppActivityMonitor that should be suitable for most backends.
BisCore The BisCore schema is the lowest level Schema in an iModel.
BriefcaseEntry Entry in the briefcase cache
BriefcaseId The Id assigned to a briefcase by iModelHub, or one of the special values that identify special kinds of iModels
BriefcaseManager Utility to manage briefcases
CachedECSqlStatement A cached ECSqlStatement.
CachedSqliteStatement A cached SqliteStatement.
Callout
Category A Category element is the target of the category member of GeometricElement.
CategoryOwnsSubCategories Relates a parent Category to SubCategory child elements.
CategorySelector Holds a list of Ids of Categories to be displayed in a view.
ChangeSetToken A token that represents a ChangeSet
ChangeSummaryManager Class to extract Change Summaries for a briefcase.
ClassRegistry The mapping between a class name (schema.class) and its constructor function
CodeSpecs Manages CodeSpecs within an IModelDb
ConcurrencyControl ConcurrencyControl enables an app to coordinate local changes with changes that are being made by others to an iModel.
ConcurrencyControl.Codes Code manager
ConcurrencyControl.ConflictResolutionPolicy The options for how conflicts are to be handled during change-merging in an OptimisticConcurrencyControlPolicy.
ConcurrencyControl.OptimisticPolicy Specifies an optimistic concurrency policy.
ConcurrencyControl.PessimisticPolicy Specifies a pessimistic concurrency policy.
ConcurrencyControl.Request A request for locks and/or code reservations.
ConcurrencyControl.RequestError Thrown when iModelHub denies or cannot process a request.
DefinitionElement A Definition Element holds configuration-related information that is meant to be referenced / shared.
DefinitionModel A container for persisting definition elements.
DefinitionPartition An Element that indicates that there is a definition-related modeling perspective within
DetailCallout
DetailingSymbol
DictionaryModel The singleton container for repository-specific definition elements.
DisplayStyle A DisplayStyle defines the parameters for 'styling' the contents of a view.
DisplayStyle2d A DisplayStyle for 2d views.
DisplayStyle3d A DisplayStyle for 3d views.
Document An InformationContentElement that identifies the content of a document.
DocumentCarrier An Information Carrier that carries a Document.
DocumentListModel Contains a list of document elements.
DocumentPartition A Document Partition element indicates that there is a document-related modeling perspective within
Drawing A document that represents a drawing, that is, 2-D graphical representation of engineering data.
DrawingCategory Categorizes 2d GeometricElements.
DrawingGraphic 2d element used to persist graphics for use in drawings.
DrawingGraphicRepresentsElement Relates a DrawingGraphic to the Element that it represents
DrawingGraphicRepresentsFunctionalElement Relates a DrawingGraphic to the FunctionalElement that it represents
DrawingModel A 2d model that holds DrawingGraphics.
DrawingViewDefinition Defines a view of a DrawingModel.
DriverBundleElement Element used in conjunction with bis:ElementDrivesElement relationships to bundle multiple inputs before
ECDb An ECDb file
ECSqlBinder Binds a value to an ECSQL parameter.
ECSqlInsertResult The result of an ECSQL INSERT statement as returned from ECSqlStatement.stepForInsert.
ECSqlStatement Executes ECSQL statements.
ECSqlStatementCache A cache for ECSqlStatements.
ECSqlValue Value of a column in a row of an ECSQL query result.
ECSqlValueIterator Iterator over members of a struct ECSqlValue or the elements of an array ECSqlValue.
Element Elements are the smallest individually identifiable building blocks for modeling the real world in an iModel.
ElementAspect An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.
ElementDrivesElement A Relationship where one Element drives another Element
ElementEncapsulatesElements Relates a parent Element to child Elements which represent hidden parts of the Entity.
ElementGroupsMembers An ElementRefersToElements relationship where one Element groups a set of other Elements.
ElementMultiAspect An Element Multi-Aspect is an ElementAspect where there can be n instances of the Element Aspect class per Element.
ElementOwnsChildElements Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.
ElementRefersToElements A Relationship where one Element refers to another Element
ElementUniqueAspect An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.
ElevationCallout
An information element that links to an embedded file.
Entity Base class for all Entities in an iModel.
Functional
FunctionalBreakdownElement A FunctionalBreakdownElement is a folder node in the functional hierarchy.
FunctionalComponentElement A FunctionalComponentElement is a leaf node in the functional hierarchy.
FunctionalComposite
FunctionalElement A FunctionalElement captures functional requirements that will ultimately be fulfilled by a PhysicalElement.
FunctionalElementIsOfType Relates a FunctionalElement to its FunctionalType
FunctionalModel A container for persisting FunctionalElements.
FunctionalPartition A FunctionalPartition element is a key part of the iModel information hierarchy and is always parented
FunctionalType Defines a set of properties (the 'type') that can be associated with a Functional Element.
Generic
GeometricElement An abstract base class to model real world entities that intrinsically have geometry.
GeometricElement2d An abstract base class to model information entities that intrinsically have 2d geometry.
GeometricElement3d An abstract base class to model real world entities that intrinsically have 3d geometry.
GeometricModel A container for persisting geometric elements.
GeometricModel2d A container for persisting 2d geometric elements.
GeometricModel3d A container for persisting 3d geometric elements.
GeometryPart A Definition Element that specifies a collection of geometry that is meant to be reused across Geometric
Graphic3d
GraphicalElement2d An abstract base class for 2d Geometric Elements that are used to convey information within graphical presentations (like drawings).
GraphicalElement2dIsOfType Relates a GraphicalElement2d to its GraphicalType2d
GraphicalElement3d A 3D Graphical Element
GraphicalModel2d A container for persisting 2d graphical elements.
GraphicalType2d Defines a set of properties (the type) that can be associated with a 2D Graphical Element.
Group
GroupInformationElement Group Information is an abstract base class for modeling entities whose main purpose is to reference
GroupInformationModel A container for persisting group information elements.
GroupInformationPartition A Group Information Partition element indicates that there is a group-information-related modeling perspective
GroupModel
IModelDb Represents a physical copy (a briefcase) of an iModel that can be accessed as a file on the local computer.
IModelDb.Elements The collection of elements in an IModelDb.
IModelDb.Models The collection of models in an IModelDb.
IModelDb.Views The collection of views in an IModelDb.
IModelHost IModelHost initializes imodeljs-backend and captures its configuration.
IModelHostConfiguration Configuration of imodeljs-backend.
IModelJsElectronAppManager A StandardElectronAppManager that adds some reasonable defaults for applications built with @bentley/webpack-tools.
IModelJsExpressServer An express web server with some reasonable defaults for web applications built with @bentley/webpack-tools.
IModelJsFs File system operations that are defined on all platforms.
IModelJsFsStats Information about a file.
InformationCarrierElement An Information Carrier carries information, but is not the information itself.
InformationContentElement Information Content Element is an abstract base class for modeling pure information entities.
InformationModel A container for persisting information elements.
InformationPartitionElement An abstract base class for elements that introduce a new modeling
InformationRecordElement Information Record Element is an abstract base class for modeling information records.
InformationRecordModel A container for persisting Information Record Elements
InformationRecordPartition A Information Record Partition element indicates that there is an information-record-related modeling
InformationReferenceElement Information Reference is an abstract base class for modeling entities whose main purpose is to reference
KnownLocations Well known directories that may be used by the app.
LightLocation The position in space of a Light.
LineStyle The definition element for a line style
LinkElement An information element that specifies a link.
LinkModel A container for persisting link elements.
LinkPartition A Link Partition element indicates that there is a link-related modeling perspective within the overall
Model A Model is a container for persisting a collection of related elements within an iModel.
ModelSelector Holds the list of Ids of GeometricModels displayed by a SpatialViewDefinition.
OpenParams Parameters to open an IModelDb
OrthographicViewDefinition Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.
PhysicalElement An Element that is spatially located, has mass, and can be 'touched'.
PhysicalElementAssemblesElements Relates a parent PhysicalElement to PhysicalElement children that it assembles.
PhysicalElementFulfillsFunction Relates a PhysicalElement to the FunctionalElement elements that it fulfills.
PhysicalElementIsOfType Relates a PhysicalElement to its PhysicalType
PhysicalModel A container for persisting physical elements that model physical space.
PhysicalObject
PhysicalPartition A Physical Partition element indicates that there is a physical modeling perspective within the overall
PhysicalType Defines a set of properties (the type) that can be associated with a Physical Element.
PlanCallout
Platform Information about the platform on which the app is running.
RecipeDefinitionElement Defines a recipe for generating a type.
Relationship Base class for all link table ECRelationships
Relationships Manages Relationships.
RenderMaterialOwnsRenderMaterials Relates a parent RenderMaterial to RenderMaterial child elements.
An information element that links to a repository.
RepositoryModel The singleton container of repository-related information elements.
RoleElement A real world entity is modeled as a Role Element when a set of external circumstances define an important
RoleModel A container for persisting role elements.
Schema Base class for all schema classes - see working with schemas and elements in TypeScript.
Schemas Manages registered schemas
SectionCallout
SectionDrawing A document that represents a section drawing, that is, 2-D graphical documentation derived from a planar
SectionDrawingModel A container for persisting section DrawingGraphics.
Sheet A digital representation of a sheet of paper.
SheetBorderTemplate The template for a SheetBorder
SheetModel A container for persisting ViewAttachments and DrawingGraphics.
SheetTemplate The template for a Sheet
SheetViewDefinition Defines a view of a SheetModel.
SpatialCategory Categorizes SpatialElements.
SpatialElement An Element that occupies real world space.
SpatialLocation
SpatialLocationElement Identifies a tracked real world location but has no mass and cannot be touched.
SpatialLocationIsOfType Relates a SpatialLocationElement to its SpatialLocationType
SpatialLocationModel A container for persisting spatial location elements.
SpatialLocationPartition A Spatial Location Partition element indicates that there is a spatial-location-related modeling perspective
SpatialLocationType Defines a set of properties (the type) that can be associated with a spatial location.
SpatialModel A container for persisting 3d geometric elements that are spatially located.
SpatialViewDefinition Defines a view of one or more SpatialModels.
SqliteStatement Executes SQLite SQL statements.
SqliteStatementCache A cache for SqliteStatements.
SqliteValue Value of a column in a row of an SQLite SQL query result.
StandardElectronAppManager Wrap electron's app object simplify the creation of simple
SubCategory Defines the appearance for graphics in Geometric elements
Subject A Subject is an information element that describes what this repository (or part thereof) is about.
SubjectOwnsPartitionElements Relates a parent Subject to InformationPartitionElement child elements.
SubjectOwnsSubjects Relates a parent Subject to Subject child elements.
TemplateRecipe2d A recipe that uses a 2D template for creating new instances.
TemplateRecipe3d A recipe that uses a 3d template for creating new instances.
TemplateViewDefinition2d A ViewDefinition used to display a 2d template model.
TemplateViewDefinition3d A ViewDefinition used to display a 3d template model.
TextAnnotation2d 2D Text Annotation
TextAnnotation3d 3D Text Annotation
Texture Defines a rendering texture.
TitleText
TxnManager Local Txns in an IModelDb.
TypeDefinitionElement Defines a set of properties (the type) that may be associated with an element.
An information element that specifies a URL link.
ViewAttachment Represents an attachment of a ViewDefinition to a Sheet.
ViewAttachmentLabel
ViewDefinition The definition element for a view.
ViewDefinition2d Defines a view of a single 2d model.
ViewDefinition3d Defines a view of one or more 3d models.
VolumeElement A Volume Element is a Spatial Location Element that is restricted to defining a volume.
WebMercatorModel Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.

Enumerations

Name Description
AccessMode Mode to access the IModelDb
AutoPushEventType Identifies an AutoPush event.
AutoPushState Identifies the current state of an AutoPush object.
ConcurrencyControl.OnConflict How to handle a conflict.
ECDbOpenMode Modes for how to open ECDb files.
ExclusiveAccessOption Additional options for exclusive access to IModelDb
KeepBriefcase Option to keep briefcase when the imodel is closed
SqliteValueType Data type of a value in in an SQLite SQL query result.
SyncMode Operations allowed when synchronizing changes between the IModelDb and the iModel Hub
TxnAction

Global Functions

Name Description
initializeRpcBackend

Interfaces

Name Description
AppActivityMonitor Monitors backend activity.
AutoPushParams Configuration for AutoPush.
ChangeSummary Represents an instance of the ChangeSummary ECClass from the ECDbChange ECSchema
ChangeSummaryExtractOptions Options for ChangeSummaryManager.extractChangeSummaries.
ECSqlColumnInfo Information about an ECSQL column in an ECSQL query result.
ElementDrivesElementProps Properties that are common to all types of ElementDrivesElements
ElementGroupsMembersProps Properties that are common to all types of link table ECRelationships
InstanceChange Represents an instance of the InstanceChange ECClass from the ECDbChange ECSchema
RelationshipProps Properties that are common to all types of link table ECRelationships
SourceAndTarget Specifies the source and target elements of a Relationship instance.
StringParam Marks a string as either an Id64String or GuidString, so
ValidationError An error generated during dependency validation.

Namespaces

Name Description
LineStyleDefinition A line style definition is a uniquely named pattern that repeats as it is displayed along a curve path.

Type Aliases

Name Description
AutoPushEventHandler The signature of an AutoPush event handler.
ChangeSetDescriber The signature of a function that can supply a description of local Txns in the specified briefcase up to and including the specified endTxnId.
SchemaKey
SchemaMatchType

Last Updated: 17 December, 2018