imodeljs-common

Classes

Name Description
AnalysisStyle
AxisAlignedBox3d A Range3d that is aligned with the axes of a coordinate space.
BentleyCloudRpcConfiguration Operating parameters for Bentley cloud RPC interface deployments.
BentleyCloudRpcManager Coordinates usage of RPC interfaces for Bentley cloud deployments.
BentleyCloudRpcProtocol An http protocol for Bentley cloud RPC interface deployments.
Camera The current position (eyepoint), lens angle, and focus distance of a camera.
Cartographic A position on the earth defined by longitude, latitude, and height above the WSG84 ellipsoid .
CartographicRange A cartographic range representing a rectangular region if low longitude/latitude > high then area crossing seam is indicated.
Code A three-part structure containing information about the Code of an Element
CodeSpec A Code Specification captures the rules for encoding and decoding significant business information into
ColorDef An integer representation of a color.
DecorationGeometryProps Information required to request a snap to a pickable decoration from the front end to the back end.
DisplayStyle3dSettings Provides access to the settings defined by a DisplayStyle3d or DisplayStyle3dState, and ensures that
DisplayStyleSettings Provides access to the settings defined by a DisplayStyle or DisplayStyleState, and ensures that
EcefLocation The position and orientation of an iModel on the earth in ECEF (Earth Centered Earth Fixed) coordinates
ECJsNames Utility to format ECProperty names according to the iModel.js formatting rules.
ElectronRpcConfiguration RPC interface configuration for an Electron-based application.
ElectronRpcManager Coordinates usage of RPC interfaces for an Electron-based application.
ElectronRpcProtocol RPC interface protocol for an Electron-based application.
ElectronRpcRequest
ElementAlignedBox2d A bounding box aligned to the orientation of a 2d Element
ElementAlignedBox3d A bounding box aligned to the orientation of a 3d Element
Metadata for an Entity.
Feature Describes a "feature" within a batched RenderGraphic.
FeatureTable Defines a look-up table for Features within a batched RenderGraphic.
FontMap A FontMap holds the table of known fonts available in an iModel.
Frustum The region of physical (3d) space that appears in a view.
GeometryParams Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from SubCategoryAppearance.
GeometryStreamBuilder GeometryStreamBuilder is a helper class for populating the GeometryStreamProps array needed to create a GeometricElement or GeometryPart.
GeometryStreamIterator GeometryStreamIterator is a helper class for iterating a GeometryStreamProps.
GeometryStreamIteratorEntry Hold current state information for GeometryStreamIterator
GraphicParams The "cooked" material and symbology for a RenderGraphic.
GroundPlane A circle drawn at a Z elevation, whose diameter is the the XY diagonal of the project extents, used to represent the ground as a reference point within a spatial view.
HSLColor A color defined by Hue, Saturation, and Lightness.
HSVColor A color defined by Hue, Saturation, and Value
ImageBuffer Uncompressed bitmap image data
ImageSource Image data encoded and compressed in either Jpeg or Png format.
IModel Represents an iModel in JavaScript.
IModelError The error type thrown by this module.
IModelNotFoundResponse Response if the IModelDb was not found at the backend
IModelReadRpcInterface The RPC interface for reading from an iModel.
IModelTileRpcInterface
IModelToken A token that identifies a specific instance of an iModel to be operated on
IModelVersion Option to specify the version of the iModel to be acquired and used
IModelWriteRpcInterface The RPC interface for writing to an iModel.
MobileRpcConfiguration Holds configuration for the RpcInterfaces used by the application.
MobileRpcManager Coordinates usage of RPC interfaces for an Mobile-based application.
MobileRpcProtocol RPC interface protocol for an Mobile-based application.
MobileRpcRequest
Placement2d The placement of a GeometricElement2d.
Placement3d The placement of a GeometricElement3d.
Metadata for a property.
RelatedElement The Id and relationship class of an Element that is somehow related to another Element
RenderMaterial Represents a material which can be applied to a surface to control aspects of its appearance such as color, reflectivity, texture, and so on.
RenderMaterial.Params Parameters used to construct a RenderMaterial
RenderTexture Represents a texture image applied to a surface during rendering.
RenderTexture.Params Parameters used to construct a RenderTexture.
RgbColor An immutable representation of a color with red, green, and blue components each in the integer range [0, 255].
RpcConfiguration A RpcConfiguration specifies how calls on an RPC interface will be marshalled, plus other operating parameters.
RpcControlChannel Manages requests and responses for an RPC configuration.
RpcControlResponse An RPC operation control response.
RpcDefaultConfiguration
RpcDirectProtocol
RpcDirectRequest
RpcInterface An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,
RpcInvocation An RPC operation invocation in response to a request.
RpcManager RPC interface management is concerned with coordination of access and configuration for RPC interfaces.
RpcMultipart Support for transporting RPC values using the HTTP multipart content type.
RpcMultipartParser
RpcNotFoundResponse A RPC operation response .
RpcOpenAPIDescription An OpenAPI-compatible description of an RPC protocol.
RpcOperation An RPC operation descriptor.
RpcOperationPolicy The policy for an RPC operation.
RpcPendingQueue Manages pending RPC requests and responses.
RpcPendingResponse A pending RPC operation response.
RpcProtocol An application protocol for an RPC interface.
RpcRequest A RPC operation request.
ServerError
StandaloneIModelRpcInterface The RPC interface for working with standalone iModels.
SubCategoryAppearance Parameters that define the way geometry on a SubCategory appears.
SubCategoryOverride Overrides selected aspects of a SubCategoryAppearance in the context of a ViewState.
TextString A single line of text, all with the same font, styles (underline, bold, italic), and size.
TextureMapping Describes how to map a RenderTexture image onto a surface.
TextureMapping.Params Parameters describing how a texture image is mapped to a surface.
TextureMapping.Trans2x3 A 2x3 matrix for mapping a texture image to a surface.
TypeDefinition A RelatedElement relationship that describes the TypeDefinitionElement of an element.
ViewFlags Flags for controlling how graphics appear within a View.
WebAppRpcProtocol The HTTP application protocol.
WebAppRpcRequest A web application RPC request.

Constants

Name Description
NpcCenter The center point of the Normalized Plane Coordinate cube.
NpcCorners The 8 corners of an Npc Frustum.

Enumerations

Name Description
AntiAliasPref
BackgroundFill Describes how a view's background color affects the interior area of a closed region.
BackgroundMapType Describes the type of background map displayed by a DisplayStyle
BatchType Describes the type of a 'batch' of graphics representing multiple Features.
BisCodeSpec Names of the internal BIS CodeSpecs.
ChangedValueState The enum represents the values for the ChangedValueState argument of the ECSQL function
ChangeOpCode Equivalent of the ECEnumeration OpCode in the ECDbChange ECSchema.
ColorByName A set of known colors by name, as a 32-bit integer in the form 0xBBGGRR (red is the low byte).
ECSqlSystemProperty Defines the ECSQL system properties.
ECSqlValueType Describes the different data types an ECSQL value can be of.
FillDisplay Whether a closed region should be drawn for wireframe display with its internal area filled or not.
FillFlags Flags indicating whether and how the interiors of closed planar regions is displayed within a view.
FontType The type of a font.
GeometryClass Categorizes a piece of geometry within a GeometryStream.
ImageBufferFormat Format of an ImageBuffer.
ImageSourceFormat The format of an ImageSource.
LinePixels Enumerates the available patterns for drawing patterned lines.
Npc The 8 corners of the Normalized Plane Coordinate cube.
PrimitiveTypeCode The primitive types of an Entity property.
Rank The rank for a Category
RenderMode Enumerates the available rendering modes.
RenderTexture.Type Enumerates the types of RenderTextures.
RpcContentType RPC content types.
RpcEndpoint Endpoints for RPC protocols..
RpcMarshalingDirective RPC interface type marshaling directives.
RpcMobilePlatform RPC supported mobile platforms.
RpcProtocolEvent RPC protocol event types.
RpcRequestEvent RPC request event types.
RpcRequestStatus The status of an RPC operation request.
RpcResponseCacheControl Describes available options for RPC response caching.
SkyBoxImageType Enumerates the supported types of SkyBoxImageType.SkyBox images.
TextureMapping.Mode Enumerates the possible texture mapping modes.

Global Functions

Name Description
isPowerOfTwo Returns whether the input is a power of two.
nextHighestPowerOfTwo Returns the first power-of-two value greater than or equal to the input.

Interfaces

Name Description
AnalysisStyleProps Properties for display of analysis data
AreaFillProps Add a AreaFillProps.gradient, AreaFillProps.backgroundFill, or solid AreaFillProps.color fill to subsequent planar regions (or meshes).
AuxCoordSystem2dProps Properties of AuxCoordSystem2d
AuxCoordSystem3dProps Properties of AuxCoordSystem3d
AuxCoordSystemProps
BackgroundMapProps JSON representation of the settings associated with a background map displayed by a DisplayStyle.
BentleyCloudRpcParams Initialization parameters for BentleyCloudRpcConfiguration.
CalloutProps
CameraProps properties of a camera
CategoryProps Parameters of a Category
CategorySelectorProps Properties that define a CategorySelector
CodeProps The wire format for a Code
ContextRealityModelProps JSON representation of a context reality model
CreateIModelProps The properties that can be supplied when creating a new iModel.
CustomAttribute A custom attribute instance
DefinitionElementProps Properties of a DefinitionElement
DisplayStyle3dProps JSON representation of a DisplayStyle3d or DisplayStyle3dState.
DisplayStyle3dSettingsProps JSON representation of settings assocaited with a DisplayStyle3dProps.
DisplayStyleProps JSON representation of a DisplayStyle or DisplayStyleState.
DisplayStyleSettingsProps JSON representation of the settings associated with a DisplayStyleProps.
DisplayStyleSubCategoryProps Describes the SubCategoryOverrides applied to a SubCategory by a DisplayStyle.
EcefLocationProps Properties that position an iModel on the earth via ECEF (Earth Centered Earth Fixed) coordinates
ElectronRpcParams Initialization parameters for ElectronRpcConfiguration.
ElementAspectProps Properties of an ElementAspect
ElementLoadProps Parameters to specify what element to load for IModelDb.Elements.getElementProps.
ElementProps Properties of an Element
EntityMetaDataProps
EntityProps The properties of an Entity as they are read/stored from/to the iModel.
EntityQueryParams Parameters for performing an ECSQL SELECT query on Entity classes.
EnvironmentProps JSON representation of the environment setup of a DisplayStyle3d.
FilePropertyProps
FontMapProps The properties of a FontMap
FontProps The properties of a Font.
FunctionalElementProps
GeometricElement2dProps Properties that define a GeometricElement2d
GeometricElement3dProps Properties that define a GeometricElement3d
GeometricElementProps Properties of a GeometricElement
GeometricModel2dProps Properties that define a GeometricModel2d
GeometryAppearanceProps Establish a non-default SubCategory or to override SubCategoryAppearance for the geometry that follows.
GeometryPartInstanceProps Add a reference to a GeometryPart from the GeometryStream of a GeometricElement.
GeometryPartProps Properties of a GeometryPart
GeometryStreamEntryProps Allowed GeometryStream entries - should only set one value.
GroundPlaneProps JSON representation of a GroundPlane.
HttpServerRequest An HTTP server request object.
HttpServerResponse An HTTP server response object.
IModelProps Properties that are about an iModel.
InformationPartitionElementProps Properties of a InformationPartitionElement
LatAndLong
LatLongAndHeight
LightLocationProps Properties of a LightLocation
LineStyleProps Properties of a LineStyle
MaterialProps Override SubCategoryAppearance.materialId for subsequent surface and solid geometry.
ModelProps Properties that define a Model
ModelQueryParams Interface for querying a set of Models.
ModelSelectorProps Properties that define a ModelSelector
NavigationBindingValue An ECSQL Navigation value which can be bound to a navigation property ECSQL parameter
NavigationValue An ECSQL Navigation value.
OpenAPIContentMap An OpenAPI 3.0 content map.
OpenAPIDocument An OpenAPI 3.0 root document object.
OpenAPIEncoding An OpenAPI 3.0 encoding object.
OpenAPIInfo An OpenAPI 3.0 info object.
OpenAPIMediaType An OpenAPI 3.0 media type object.
OpenAPIOperation An OpenAPI 3.0 operation object.
OpenAPIParameter An OpenAPI 3.0 parameter object.
OpenAPIPathItem An OpenAPI 3.0 path item object.
OpenAPIPaths An OpenAPI 3.0 paths object.
OpenAPIRequestBody An OpenAPI 3.0 parameter object.
OpenAPIResponse An OpenAPI 3.0 response object.
OpenAPIResponses An OpenAPI 3.0 responses object.
OpenAPISchema An OpenAPI 3.0 schema object.
Placement2dProps Properties of a Placement2d
Placement3dProps Properties of a Placement3d
PropertyMetaDataProps
RelatedElementProps Properties of a NavigationProperty.
RootSubjectProps Properties of the Root Subject.
RpcInterfaceDefinition
RpcInterfaceEndpoints Describes the endpoints of an RPC interface.
RpcOperationsProfile Runtime information related to the operation load of one or more RPC interfaces.
SerializedRpcOperation A serialized RPC operation descriptor.
SerializedRpcRequest A serialized RPC operation request.
SheetBorderTemplateProps Properties of a SheetBorderTemplate
SheetProps Properties of a Sheet
SheetTemplateProps Properties of a SheetTemplate
SkyBoxImageProps JSON representation of an image or images used by a SkySphere or SkyCube.
SkyBoxProps JSON representation of a SkyBoxProps.SkyBox.
SkyCubeProps JSON representation of a set of images used by a SkyCube.
SnapRequestProps Information required to request a snap to an element from the front end to the back end.
SnapResponseProps Information returned from the back end to the front end holding the result of a snap operation.
SpatialViewDefinitionProps Parameters to construct a SpatialViewDefinition
SubCategoryAppearance.Props Properties used to create a SubCategoryAppearance
SubCategoryProps Parameters of a SubCategory
SubjectProps Properties of a Subject
TextStringProps Properties for a TextString class.
TextureMapping.ParamProps Properties used to construct a TextureMapping.Params.
ThumbnailFormatProps Metadata about a thumbnail.
ThumbnailProps Properties of a thumbnail in an iModel.
TypeDefinitionElementProps Properties of a TypeDefinitionElement
ViewAttachmentLabelProps
ViewAttachmentProps Properties for a ViewAttachment
ViewDefinition2dProps Parameters used to construct a ViewDefinition2d
ViewDefinition3dProps Parameters to construct a ViewDefinition3d
ViewDefinitionProps Parameters used to construct a ViewDefinition
ViewFlagProps JSON representation of ViewFlags
ViewQueryParams
ViewStateProps Returned from IModelDb.Views.getViewStateData

Namespaces

Name Description
AreaPattern
BRepEntity
CodeScopeSpec The scope of the Code.
Gradient
HiddenLine Namespace containing types controlling how edges and surfaces should be drawn in "hidden line" and "solid fill" RenderModes.
Hilite Contains types related to display of hilited elements within a Viewport.
LineStyle
MarshalingBinaryMarker
RenderSchedule
RpcSerializedValue

Type Aliases

Name Description
CodeScopeProps The props that hold the identity of the object defining the uniqueness scope for a set of Code values.
ColorDefProps A number in 0xTTBBGGRR format
GeometryStreamProps A GeometricElement's GeometryStream is represented by an array of GeometryStreamEntryProps.
HttpMethod_T
MobileRpcChunks
PlacementProps
PropertyCallback a callback function to process properties of an Entity
RpcConfigurationSupplier
RpcInterfaceImplementation
RpcInvocationCallback_T Notification callback for an RPC invocation.
RpcProtocolEventHandler Handles RPC protocol events.
RpcRequestCallback_T Notification callback for an RPC request.
RpcRequestEventHandler Handles RPC request events.
RpcRequestIdSupplier_T Supplies a unique identifier for an RPC request.
RpcRequestInitialRetryIntervalSupplier_T Supplies the initial retry interval for an RPC request.
RpcRequestNotFoundHandler Resolves "not found" responses for RPC requests.
RpcRequestTokenSupplier_T Supplies an IModelToken for an RPC request.
RpcResponseCachingCallback_T Determines if caching is permitted for a RPC response.

Last Updated: 17 December, 2018