core-common

Classes

Name	Description
AdditionalTransform	Additional Transform implementation.
AffineTransform	The equations are:
AmbientLight	Describes the ambient light associated with a LightSettings.
AnalysisStyle	As part of a DisplayStyleSettings, describes how to animate meshes in the view that have been augmented with
AnalysisStyleDisplacement	Describes how an AnalysisStyle deforms a Polyface by applying translation to its vertices.
AnalysisStyleThematic	Describes how an AnalysisStyle recolors Polyface vertices by mapping values of type
BackendError
BackgroundMapProvider	Describes one of a small set of standard, known suppliers of background map imagery as part of a BaseMapLayerSettings.
BackgroundMapSettings	As part of a DisplayStyleSettings, controls aspects of how the background map is displayed.
BaseMapLayerSettings	A ImageMapLayerSettings that can serve as the base layer for a MapImagerySettings.
BentleyCloudRpcConfiguration	Operating parameters for Bentley cloud RPC interface deployments.
BentleyCloudRpcManager	Coordinates usage of RPC interfaces for Bentley cloud deployments.
BlobOptionsBuilder
BlobReader
BoundingSphere	Describes a spherical volume of space as an approximation of the shape of some more complex geometric entity fully contained within that volume.
Camera	The current position (eyepoint), lens angle, and focus distance of a camera.
Carto2DDegrees	A 2D cartographic point in degrees
Cartographic	A position on the earth defined by longitude, latitude, and height above the WGS84 ellipsoid.
CartographicRange	A cartographic range representing a rectangular region if low longitude/latitude > high then area crossing seam is indicated.
ClipIntersectionStyle	As part of a ClipStyle, describes how to colorize geometry intersecting the clip planes.
ClipStyle	Describes symbology and behavior applied to a ClipVector when applied to a ViewState or ModelClipGroup.
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 immutable integer representation of a color.
ColorIndex	Describes the color(s) of the vertices of a MeshArgs or PolylineArgs.
ConflictingLocksError	An error raised when there is a lock conflict detected.
ContextRealityModel	A reality model not associated with a GeometricModel but instead defined in a DisplayStyle or DisplayStyleState.
ContextRealityModels	A list of ContextRealityModels attached to a DisplayStyleSettings.
Contour	Describes how to generate and style contour lines for geometry within a single ContourGroup.
ContourDisplay	Settings that specify how to apply contour lines to groups of geometry
ContourGroup	Defines a group of objects to which to apply Contour lines in a particular style.
ContourStyle	The style settings used by either a minor or major contour.
CutStyle	As part of a ClipStyle, describes how section-cut graphics should be displayed.
DbQueryError
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 iTwin.js formatting rules.
ECSqlReader	Execute ECSQL statements and read the results.
EmptyLocalization	An empty Localization used if one is not provided to IModelApp.
EntityMetaData	Metadata for an Entity.	Deprecated
Environment	As part of a DisplayStyle3dSettings, controls the display of a SkyBox and GroundPlane to simulate the
Feature	Describes a discrete entity within a batched RenderGraphic that can be
FeatureAppearance	Defines overrides for selected aspects of a Feature's symbology.
FeatureIndex	Describes the set of Features associated with a MeshArgs or PolylineArgs.
FeatureOverrides	Specifies how to customize the appearance of individual Features, typically within the context of a Viewport.
FeatureTable	Defines a look-up table for Features within a batched RenderGraphic.
FieldRun	A Run that displays the formatted value of a property of some Element.
FontMap	A FontMap holds the set of font names available in an iModel.	Deprecated
FractionRun	A Run containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.
FresnelSettings	As part of a LightSettings, describes how to apply a Fresnel effect to the contents of the view.
Frustum	The region of physical (3d) space that appears in a view.
FrustumPlanes	Represents a the planes of a Frustum for testing containment and intersection.
GeocentricTransform	This class represents a geocentric (three parameters) geodetic transformation.
GeodeticDatum	This class represents a geodetic datum.
GeodeticEllipsoid	This class defines the mathematical model of the Earth shape in the form of an ellipsoid.
GeodeticTransform	This class represents a geodetic transformation that enables transforming longitude/latitude coordinates
GeodeticTransformPath	This class represents a geodetic datum transform path.
GeographicCRS	Geographic Coordinate Reference System implementation.
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.
GraphicParams	The "cooked" material and symbology for a RenderGraphic.
GridFileDefinition	Grid file definition containing name of the file, the format and the direction it should be applied
GridFileTransform	This class represents a grid files based geodetic transformation.
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.
Helmert2DWithZOffset	An affine transformation with an additional Z Offset.
HemisphereLights	Describes a pair of hemisphere lights associated with a LightSettings.
HorizontalCRS	Horizontal Geographic Coordinate reference System implementation.
HorizontalCRSExtent	The extent in latitude, longitude bounds where a horizontal CRS is applicable
HSLColor	An immutable color defined by Hue, Saturation, and Lightness.
HSVColor	An immutable color defined by Hue, Saturation, and Value
ImageBuffer	Uncompressed rectangular bitmap image data.
ImageGraphic	A geometric primitive that displays an image mapped to the corners of a quadrilateral, with an optional border.
ImageGraphicCorners	Defines the 4 corners of an ImageGraphic.
ImageMapLayerSettings	Normalized representation of a ImageMapLayerProps for which values have been validated and default values have been applied where explicit values not defined.
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
IModelTileRpcInterface
IModelVersion	Option to specify the version of the iModel to be acquired and used
LightSettings	Describes the lighting for a 3d scene, associated with a DisplayStyle3dSettings in turn associated with a DisplayStyle3d or DisplayStyle3dState.
LineBreakRun	A Run that represents the end of a line of text within a Paragraph.
List	A collection of list items (Paragraphs).
MapImagerySettings	Provides access to the map imagery settings (Base and layers).
MapLayerSettings	Abstract base class for normalized representation of a MapLayerProps for which values have been validated and default values have been applied where explicit values not defined.
MapSubLayerSettings	Normalized representation of a MapSubLayerProps for which values
ModelClipGroup	Describes how to clip a group of models in the context of a ViewDefinition3d by applying a single [ClipVector]($core-geometry] to each model in the group.
ModelClipGroups	Describes how to clip groups of models in the context of a ViewDefinition3d or ViewState3d.
ModelMapLayerSettings	Normalized representation of a ModelMapLayerProps for which values have been validated and default values have been applied where explicit values not defined.
NoContentError	Intended for API "no content" semantics where the error case should not trigger application failure monitoring systems.
NonUniformColor	As part of a ColorIndex, describes per-vertex colors for a MeshArgs or PolylineArgs.
OctEncodedNormal	Represents a 3d normal vector compressed into a single 16-bit integer using oct-encoding.
Paragraph	A collection of Runs and Lists.
Placement2d	The placement of a GeometricElement2d.
Placement3d	The placement of a GeometricElement3d.
PlanarClipMaskSettings	Describes how to mask the geometry of one GeometricModel for display.
PlanProjectionSettings	Describes how to draw a plan projection model.
PointCloudDisplaySettings	Settings that control how a point cloud reality model is displayed within a Viewport.
PositionalVectorTransform	This class represents a positional vector (seven parameters) geodetic transformation corresponding to
Projection	This class encapsulates the projection of the CRS.
PropertyMetaData	Metadata for a property.	Deprecated
PropertyMetaDataMap
QParams2d	Parameters used for Quantization of 2d points such that the x and y components are each quantized to 16-bit unsigned integers.
QParams3d	Parameters used for Quantization of 3d points such that the x, y, and z components are each quantized to 16-bit unsigned integers.
QPoint2d	Represents a Point2d compressed such that each component x and y is quantized to the 16-bit integer range [0, 0xffff].
QPoint2dBufferBuilder	Constructs a QPoint2dBuffer using a Uint16ArrayBuilder.
QPoint2dList	A list of QPoint2ds all quantized to the same range.
QPoint3d	Represents a Point3d compressed such that each component x, y, and z is quantized to the 16-bit integer range [0, 0xffff].
QPoint3dBufferBuilder	Constructs a QPoint3dBuffer using a Uint16ArrayBuilder.
QPoint3dList	A list of QPoint3ds all quantized to the same range.
QueryBinder	Bind values to an ECSQL query.
QueryOptionsBuilder
RealityModelDisplaySettings	Settings that control how a reality model - whether a ContextRealityModel or a persistent reality Model - is displayed within a Viewport.
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.
RenderTexture	Represents a texture image applied to a surface during rendering.
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.
RpcControlResponse	An RPC operation control response.
RpcInterface	An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,
RpcManager	RPC interface management is concerned with coordination of access and configuration for RPC interfaces.
RpcNotFoundResponse	A RPC operation response.
RpcPendingResponse	A pending RPC operation response.
RpcRoutingToken
ServerError
ServerTimeoutError
SkyBox	Describes how to draw a representation of a sky, as part of an Environment.
SkyCube	Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.
SkyGradient	Describes how to map a two- or four-color Gradient to the interior of a sphere to produce a SkyBox.
SkySphere	Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.
SolarLight	Describes the solar directional light associated with a LightSettings.
SolarShadowSettings	Settings controlling display of solar shadows for a DisplayStyle3dSettings.
SpatialClassifier	Describes how to use the geometry of one GeometricModel to classify the contents of other models - most typically, reality models.
SpatialClassifierFlags	Flags affecting how a SpatialClassifier is applied.
SpatialClassifiers	A set of SpatialClassifiers for a given reality model.
SubCategoryAppearance	Parameters that define the way geometry on a SubCategory appears.
SubCategoryOverride	Overrides selected aspects of a SubCategoryAppearance in the context of a DisplayStyleState.
TabRun	A TabRun is used to shift the next tab stop.
TerrainSettings	Normalized version of TerrainProps for which provider has been validated and default values of all members are used.
TextAnnotation	Represents a formatted block of text positioned in 2d or 3d space.
TextBlock	Represents a formatted text document consisting of a series of Paragraphs, each laid out on a separate line and containing their own content.
TextBlockComponent	Abstract representation of any of the building blocks that make up a TextBlock document - namely Runs and StructuralTextBlockComponents.
TextRun	The most common type of Run, containing a sequence of characters to be displayed using a single style.
TextString	A single line of text, all with the same font, styles (underline, bold, italic), and size.
TextStyleSettings	A description of the formatting to be applied to a TextBlockComponent.
TextureMapping	Describes how to map a RenderTexture's image onto a surface as part of a RenderMaterial.
ThematicDisplay	The thematic display setup of a DisplayStyle3d.
ThematicDisplaySensor	A sensor in world space, used for InverseDistanceWeightedSensors.
ThematicDisplaySensorSettings	Settings for sensor-based thematic display for InverseDistanceWeightedSensors.
ThematicGradientSettings	Thematic settings specific to creating a color gradient used by ThematicDisplay.
Tween	A Tween for interpolating values of an object.
Tweens	A group of Tweens.
TypeDefinition	A RelatedElement relationship that describes the TypeDefinitionElement of an element.
Uint8Chunks
VerticalCRS	Vertical Coordinate reference System implementation.
ViewDetails	Encapsulates access to optional view details stored in JSON properties.
ViewDetails3d	Encapsulates access to optional 3d view details stored in JSON properties.
ViewFlags	Flags controlling how graphics appear within a view.
WhiteOnWhiteReversalSettings	As part of a DisplayStyleSettings, controls how white-on-white reversal is applied to make white geometry more
XyzRotation	Hold 3 components data of a Positional Vector rotation definition in arc seconds

Constants

Name	Description
ColorByName	A set of known colors by HTML color name, as a 32-bit integer in the form 0xBBGGRR (red is the low byte).
Easing	Easing functions from tween.js
Interpolation	Interpolation functions from tween.js
NpcCenter	The center point of the Normalized Plane Coordinate cube.
NpcCorners	The 8 corners of an Npc Frustum.
textAnnotationFrameShapes	Set of predefined shapes that can be computed and drawn around the margins of a TextBlock

Enumerations

Name	Description
BackgroundFill	Describes how a view's background color affects the interior area of a closed region.
BackgroundMapType	Enumerates the types of map imagery that can be supplied by a BackgroundMapProvider.
BatchType	Describes the type of a 'batch' of graphics representing multiple Features.
BisCodeSpec	Names of the internal BIS CodeSpecs.
BriefcaseIdValue	Values of BriefcaseId that have special meaning.
CesiumIonAssetId	Ids of Cesium ion assets providing data not covered by CesiumTerrainAssetId.
CesiumTerrainAssetId	Ids of Cesium ion assets providing global terrain data.
ChangedValueState	The enum represents the values for the ChangedValueState argument of the ECSQL function Changes.
ChangeOpCode	Equivalent of the ECEnumeration OpCode in the ECDbChange ECSchema.
ChangesetType	Value to indicate whether a changeset contains schema changes or not
CommonLoggerCategory	Logger categories used by this package
DefaultSupportedTypes	All of the currently supported Reality Data types
DomainOptions	Option to control the validation and upgrade of domain schemas in the Db
ECSqlSystemProperty	Defines the ECSQL system properties.
ECSqlValueType	Describes the different data types an ECSQL value can be of.
ElementGeometryOpcode	Specifies the type of an entry in a geometry stream.
ExternalSourceAttachmentRole	The role that an attached ExternalSource plays.
FeatureIndexType	Describes the type of a FeatureIndex.
FeatureOverrideType	Options for overriding element appearance.
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 FontFile encodings understood by iTwin.js.
GeoCoordStatus	This enumeration lists all possible status as returned from a coordinate conversion to or from a
GeometryClass	Categorizes a piece of geometry within a GeometryStream.
GeometryStreamFlags	Flags applied to the entire contents of a GeometryStreamProps.
GeometrySummaryVerbosity	Describes the level of detail with which to report each geometric primitive in a GeometrySummaryRequestProps.
GlobeMode	Describes the projection of the background map
GridOrientationType	Describes the orientation of the grid displayed within a Viewport.
HSVConstants
ImageBufferFormat	Format of an ImageBuffer.
ImageSourceFormat	The format of an ImageSource.
InternetConnectivityStatus	Indicates whether or not the computer is currently connected to the internet.
LinePixels	Enumerates the available patterns for drawing patterned lines.
ListMarkerEnumerator	Predefined markers for list items in text annotations.
LockState	The state of a lock.
MassPropertiesOperation	Specify whether to accumulate volumes, areas, or lengths for the supplied elements.
ModelMapLayerDrapeTarget	The target onto which to drape a model map layer.
MonochromeMode	Describes the style in which monochrome color is applied by a DisplayStyleSettings.
NormalMapFlags	Flags applied to a NormalMapProps.
Npc	The 8 corners of the Normalized Plane Coordinate cube.
OverriddenBy	Describes whether the user or the browser overrode the internet connectivity status.
PlanarClipMaskMode	The different modes by which a PlanarClipMaskSettings collects the geometry used to mask a model.
PlanarClipMaskPriority	The default priority values for a PlanarClipMaskSettings, based on model type.
PolylineTypeFlags	Describes the semantics of a PolylineArgs.
PrimitiveTypeCode	The primitive types of an Entity property.
ProfileOptions	Options that control whether a profile upgrade should be performed when opening a Db
QueryRowFormat	Specifies the format of the rows returned by the query and restartQuery methods of
Rank	The rank for a Category
RealityDataFormat	Identify the Reality Data storage format
RealityDataProvider	Identify the Reality Data service provider
RenderMode	Enumerates the available basic rendering modes, as part of a DisplayStyle's ViewFlags.
RpcContentType	RPC content types.	Deprecated
RpcEndpoint	Endpoints for RPC protocols.	Deprecated
RpcProtocolEvent	RPC protocol event types.	Deprecated
RpcRequestEvent	RPC request event types.	Deprecated
RpcRequestStatus	The status of an RPC operation request.	Deprecated
RpcResponseCacheControl	Describes available options for RPC response caching.
SchemaState	The state of the schemas in the Db compared with what the current version of the software expects
SectionType	An enumeration of the different types of SectionDrawings.
SkyBoxImageType	Supported types of SkyBox images.
SpatialClassifierInsideDisplay	Describes how a SpatialClassifier affects the display of classified geometry - that is, geometry intersecting
SpatialClassifierOutsideDisplay	Describes how a SpatialClassifier affects the display of unclassified geometry - that is, geometry not intersecting
SyncMode	Whether a briefcase is editable or may only accept incoming changesets from iModelHub
TerrainHeightOriginMode	Correction modes for terrain height
TextureMapUnits	Describes the units in which a TextureMapProps' scale is expressed.
TextureTransparency	Describes the type of transparency in the pixels of a TextureImage.
ThematicDisplayMode	The thematic display mode.
ThematicGradientColorScheme	A color scheme used to generate the colors of a thematic gradient within an applied range.
ThematicGradientMode	A thematic gradient mode used to generate and apply a thematic effect to a scene.
ThematicGradientTransparencyMode	Describes how transparency is computed when applying a thematic gradient to a surface.
TxnAction	Describes the types of actions associated with Txns.
TypeOfChange	Bitflags describing which aspects of an Element changed as part of a ChangedElements.

Global Functions

Name	Description
calculateSolarAngles	calculate solar angles (in radians) based at a given date/time and cartographic location.
calculateSolarDirection	calculate solar direction based at a given date/time and cartpgrphic location.
calculateSolarDirectionFromAngles	calculate solar direction corresponding to the given azimuth and elevation (altitude) angles in degrees.
calculateSunriseOrSunset	calculate solar sunrise or sunset for a given day and cartographic location.
getMarkerText	Returns the formatted marker text for a list item based on the marker type and item number.
isBinaryImageSource	Returns true if source is a BinaryImageSource.
isPlacement2dProps	determine if this is Placement2dProps
isPlacement3dProps	determine if this is Placement3dProps
isPowerOfTwo	Returns whether the input is a power of two.
isValidImageSourceFormat	Returns true if the numeric format value is a valid member of the ImageSourceFormat enumeration.
mapToGeoServiceStatus	Maps a GeoCoordStatus to the equivalent GeoServiceStatus.
nextHighestPowerOfTwo	Returns the first power-of-two value greater than or equal to the input.
readElementMeshes	Convert the output of IModelConnection.generateElementMeshes into an array of Polyfaces.
traverseTextBlockComponent	Recursively traverses a StructuralTextBlockComponent tree, yielding each child component along with its parent container.

Interfaces

Name	Description
AdditionalTransformProps	Additional Transform definition
AffineTransformProps	The equations are:
AmbientLightProps	Wire format for the ambient light associated with a LightSettingsProps.
AnalysisStyleDisplacementProps	JSON representation of an AnalysisStyleDisplacement.
AnalysisStyleProps	JSON representation of an AnalysisStyle.
AnalysisStyleThematicProps	JSON representation of an AnalysisStyleThematic.
AnnotationTextStyleProps	Properties that define an AnnotationTextStyle.
AppearanceOverrideProps	JSON representation of an appearance override in an EmphasizeElementsProps.
AreaFillProps	Add a gradient, backgroundFill, or solid color fill to subsequent planar regions (or meshes).
AuthorizationClient	Provides authorization to access APIs.
AuxCoordSystem2dProps	Properties of AuxCoordSystem2d
AuxCoordSystem3dProps	Properties of AuxCoordSystem3d
AuxCoordSystemProps
BackgroundMapProps	In-memory JSON representation of a BackgroundMapSettings.
BackgroundMapProviderProps	JSON representation of a BackgroundMapProvider.
BaseMapLayerProps	JSON representation of a BaseMapLayerSettings.
BaseReaderOptions	Config for all request made to concurrent query engine.
BasicPlanarClipMaskArgs	Basic arguments supplied to PlanarClipMaskSettings.create.
BentleyCloudRpcParams	Initialization parameters for BentleyCloudRpcConfiguration.
BinaryImageSource	An ImageSource encoded in binary form as a Jpeg or Png, as opposed to one encoded
BlobOptions
BRepPrimitive	Represents a BRep within a GeometryStream.
BriefcaseDownloader	Manages the download of a briefcase
BriefcaseProps	Properties that specify a briefcase within the local briefcase cache.
CalloutProps
CameraProps	JSON representation of a Camera.
Carto2DDegreesProps	A 2D cartographic point in degrees
CartographicProps	The JSON representation of a Cartographic object.
CategoryProps	Parameters of a Category
CategorySelectorProps	Properties that define a CategorySelector
ChangedElements	Changed elements found in a changeset or between a range of changesets.
ChangedEntities	JSON representation of the set of Elements or Models that were changed by a Txn.
ChangesetFileProps	Properties of a changeset file
ChangesetHealthStats	Aggregated health statistics for a changeset application.
ChangesetIdWithIndex	The Id and optionally the index of a changeset
ChangesetIndexAndId	Both the index and Id of a changeset
ChangesetProps	Properties of a changeset
ChangesetRange	A range of changesets
ChannelControlError	Errors originating from the ChannelControl interface.
ChannelRootAspectProps	Properties of an ChannelRootAspect that identifies an Element as the root of a channel which is a subset of the overall iModel hierarchy that is independently maintained.
ClearTextStyleOptions	Options supplied to clearStyleOverrides to control how the style overrides are cleared on the component and its child components.
ClipIntersectionStyleProps	Wire format describing a ClipIntersectionStyle.
ClipStyleCreateArgs	Arguments supplied to ClipStyle.create.
ClipStyleProps	Wire format describing a ClipStyle.
CloudContainerUri	TODO documentation
CloudSqliteError	An error originating from the CloudSqlite API.
CodeProps	The parameters that define a Code
CodeSpecProperties	The JSON properties of a CodeSpec
CommonMapLayerProps	JSON representation of properties common to both ImageMapLayerProps and ModelMapLayerProps.
ConflictingLock	Detailed information about a particular object Lock that is causing the Lock update conflict.
ConflictingLocks	Interface that describes the contents of ConflictingLocksError without relying on that class, since
ContextRealityModelProps	JSON representation of a ContextRealityModel.
ContextRealityModelsArgs	Arguments supplied to the constructor of ContextRealityModels.
ContextRealityModelsContainer	An object that can store the JSON representation of a list of ContextRealityModels.
ContourDisplayProps	JSON representation of ContourDisplay settings.
ContourGroupProps	JSON representation of a ContourGroup.
ContourProps	JSON representation of a Contour.
ContourStyleProps	JSON representation of a ContourStyle.
CreateIModelProps	The properties that can be supplied when creating a new iModel.
CreateSnapshotIModelProps	Options that can be supplied when creating snapshot iModels.
CreateStandaloneIModelProps	Options that can be supplied when creating standalone iModels.
CustomAttribute	A custom attribute instance	Deprecated
CutStyleProps	Wire format describing a CutStyle applied to section-cut geometry produced at intersections with a view's ClipVector.
DateTimeFieldFormatOptions	As part of a FieldFormatOptions, specifies how to format properties of FieldPropertyType "datetime".
DbRuntimeStats
DefinitionElementProps	Properties of a DefinitionElement
DeletedElementGeometryChange	Represents the deletion of a GeometricElement.
DeprecatedBackgroundMapProps	Properties of PersistentBackgroundMapProps that have been deprecated, but are retained for backwards compatibility.
DisplayStyle3dProps	JSON representation of a DisplayStyle3d or DisplayStyle3dState.
DisplayStyle3dSettingsProps	JSON representation of DisplayStyle3dSettings associated with a DisplayStyle3dProps.
DisplayStyleLoadProps	Options controlling which properties are included or excluded when querying DisplayStyleProps.
DisplayStyleModelAppearanceProps	A FeatureAppearanceProps applied to a specific model to override its appearance within the context of a DisplayStyle.
DisplayStyleOverridesOptions	Controls which settings are serialized by toOverrides.
DisplayStylePlanarClipMaskProps	A PlanarClipMaskProps associated with a specific reality model.
DisplayStyleProps	JSON representation of a DisplayStyle or DisplayStyleState.
DisplayStyleRealityModelDisplayProps	RealityModelDisplaySettings applied to a reality Model to change how it is rendered within the context of a DisplayStyle.
DisplayStyleSettingsOptions	Options supplied when constructing a DisplayStyleSettings.
DisplayStyleSettingsProps	JSON representation of the DisplayStyleSettings associated with a DisplayStyleProps.
DisplayStyleSubCategoryProps	Describes the SubCategoryOverrides applied to a SubCategory by a DisplayStyle.
DrawingProps	Properties that define a Drawing.
DynamicGraphicsRequest2dProps	Wire format describing a request to produce graphics in "iMdl" format for a 2d geometry stream.
DynamicGraphicsRequest3dProps	Wire format describing a request to produce graphics in "iMdl" format for a 3d geometry stream.
DynamicGraphicsRequestProps	Wire format describing a request to produce graphics in "iMdl" format for a single geometry stream.
EcefLocationProps	Properties that position an iModel on the earth via ECEF (Earth Centered Earth Fixed) coordinates
ECSchemaItemProps
ECSchemaProps	Properties of an ECSchema
ECSchemaReferenceProps
ElementAspectProps	Properties of an ElementAspect
ElementGeometryBuilderParams	Parameters for building the geometry stream of a GeometricElement using Builder.
ElementGeometryBuilderParamsForPart	Parameters for building the geometry stream of a GeometryPart using Builder.
ElementGeometryCacheOperationRequestProps	Request parameters for IModelDb.elementGeometryCacheOperation
ElementGeometryCacheRequestProps	Request parameters for IModelDb.updateElementGeometryCache
ElementGeometryCacheResponseProps	Response parameters for IModelDb.updateElementGeometryCache
ElementGeometryDataEntry	Describes an entry in a geometry stream as an op-code plus the binary flatbuffer representation of the associated data.
ElementGeometryInfo	Information provided to ElementGeometryFunction.
ElementGeometryRequest	Parameters for IModelDb.elementGeometryRequest
ElementIdsAndRangesProps	Compact wire format representing geometric changes to a set of elements as part of a ModelGeometryChangesProps.
ElementLoadOptions	Options used to specify properties to include or exclude when querying ElementProps with functions like
ElementLoadProps	Parameters to specify what element to load for functions like IModelDb.Elements.getElementProps.
ElementMeshOptions	Options used to control how Polyfaces are produced from elements by IModelConnection.generateElementMeshes.
ElementMeshRequestProps	Describes a request to generate Polyfaces from an element.
ElementPlanarClipMaskArgs	Arguments supplied to PlanarClipMaskSettings.create to create a mask of IncludeElements or ExcludeElements.
ElementProps	Properties of an Element
EmphasizeElementsProps	JSON representation of an EmphasizeElements.
EntityIdAndClassId	Describes an Entity and its ECClass by Id.
EntityMetaDataProps		Deprecated
EntityProps	The persistent format of an Entity, also used as the "wire format" when transmitting information about entities
EntityQueryParams	Parameters for performing a query on Entity classes.
EnvironmentProps	JSON representation of an Environment.
ExtantElementGeometryChange	Represents the insertion of a new GeometricElement, or a change to the geometric properties of an existing GeometricElement.
ExternalSourceAspectProps	Properties of an ExternalSourceAspect that stores synchronization information for an element originating from an external source.
ExternalSourceAttachmentProps	Properties of an ExternalSourceAttachment
ExternalSourceProps	Properties of an ExternalSource
FeatureAppearanceProps	JSON representation of a FeatureAppearance.
FeatureAppearanceProvider	Interface adopted by an object that can supply the FeatureAppearance supplied by a FeatureAppearanceSource.
FeatureAppearanceSource	Interface adopted by an object that can supply a FeatureAppearance given a low-level description of a Feature.
FieldFormatOptions	Customizes how to format the raw property value resolved by a FieldPropertyPath into a FieldRun's display string.
FieldPropertyHost	Describes the source of the property value against which a FieldPropertyPath is evaluated.
FieldPropertyPath	A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content
FieldRunProps	JSON representation of a FieldRun.
FilePropertyProps
FlatBufferGeometryStream	As part of a DynamicGraphicsRequestProps, specifies the geometry from which to generate the graphics in binary flatbuffer-encoded format.
FontFace	A specific variation of the glyphs defined by a font family.
FontFamilyDescriptor	Uniquely describes one or more FontFaces sharing the same name and type comprising a single font family.
FontFamilySelector	A FontFamilyDescriptor in which the FontType is optional, used when querying FontIds via IModelDbFonts.findId.
FontMapProps	The properties of a FontMap	Deprecated
FontProps	Represents a FontFamilyDescriptor stored in an iModel with a unique numeric Id.
FractionRunProps	JSON representation of a FractionRun.
FresnelSettingsProps	JSON representation of a FresnelSettings.
FunctionalElementProps
GenericInstanceFilter	Generic instance filter that has all the necessary information to build filtering query.
GenericInstanceFilterRelatedInstanceDescription	Describes related instance whose property was used in the filter.
GenericInstanceFilterRelationshipStep	Describes single step between source class and target class.
GenericInstanceFilterRule	Defines single filter rule.
GenericInstanceFilterRuleGroup	Group of filter rules joined by logical operator.
GeocentricTransformProps	This interface represents a geocentric (three parameters) geodetic transformation.
GeoCoordinatesRequestProps	Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)
GeoCoordinatesResponseProps	Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)
GeodeticDatumProps	This interface represents a geodetic datum.
GeodeticEllipsoidProps	This interface defines the mathematical model of the Earth shape in the form of an ellipsoid.
GeodeticTransformPathProps	This interface represents a geodetic datum transform path.
GeodeticTransformProps	This interface represents a geodetic transformation that enables transforming longitude/latitude coordinates
GeographicCRSInterpretRequestProps	Information required to interpret or complete a Geographic CRS in the specified format.
GeographicCRSInterpretResponseProps	Information returned from a request to interpret or complete a Geographic CRS
GeographicCRSProps	Geographic Coordinate Reference System definition that includes the horizontal and vertical definitions as well as an optional
GeometricElement2dProps	Properties that define a GeometricElement2d
GeometricElement3dProps	Properties that define a GeometricElement3d
GeometricElementProps	Properties of a GeometricElement
GeometricModel2dProps	Properties that define a GeometricModel2d
GeometricModel3dProps	Properties that define a GeometricModel3d
GeometricModelProps	Properties that describe a GeometricModel
GeometryAppearanceProps	Establish a non-default SubCategory or to override SubCategoryAppearance for the geometry that follows.
GeometryContainmentRequestProps	Information required to request clip containment status for elements from the front end to the back end.
GeometryContainmentResponseProps	Information returned from the back end to the front end holding the result of the geometry containment query.
GeometryPartInstanceProps	Add a reference to a GeometryPart from the GeometryStream of a GeometricElement.
GeometryPartProps	Properties of a GeometryPart
GeometryPrimitive	Represents one of a variety of GeometryQuery objects within a GeometryStream.
GeometryStreamEntryProps	Allowed GeometryStream entries - should only set one value.
GeometryStreamHeaderProps	An entry in a GeometryStreamProps containing GeometryStreamFlags that apply to the geometry stream as a whole.
GeometryStreamIteratorEntry	Holds current state information for GeometryStreamIterator.
GeometrySummaryOptions	Describes what information to include in a GeometrySummaryRequestProps.
GeometrySummaryRequestProps	Describes the elements for which to generate an array of geometry summaries and the options controlling the contents of each summary.
GraphicsRequestProps	Wire format describing properties common to PersistentGraphicsRequestProps and DynamicGraphicsRequestProps.
GridFileDefinitionProps	Grid file definition containing name of the file, the format and the direction it should be applied
GridFileTransformProps	This interface represents a grid files based geodetic transformation.
GroundPlaneProps	JSON representation of a GroundPlane.
Helmert2DWithZOffsetProps	An affine transformation with an additional Z Offset.
HemisphereLightsProps	Wire format for a pair of hemisphere lights associated with a LightSettingsProps.
HorizontalCRSExtentProps	The extent in latitude, longitude bounds where a horizontal CRS is applicable
HorizontalCRSProps	Horizontal Geographic Coordinate Reference System definition
HttpServerRequest	An HTTP server request object.	Deprecated
HttpServerResponse	An HTTP server response object.	Deprecated
IgnoreAnimationOverridesArgs	Arguments provided to a function of type IgnoreAnimationOverrides.
ImageGraphicProps	JSON representation of an ImageGraphic.
ImageMapLayerProps	JSON representation of an ImageMapLayerSettings.
ImagePrimitive	Represents an image within a GeometryStream.
IModelCoordinatesRequestProps	Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates
IModelCoordinatesResponseProps
IModelProps	Properties of an iModel that are always held in memory whenever one is opened, both on the frontend and on the backend .
IModelRpcOpenProps	The properties to open a connection to an iModel for RPC operations.
IModelRpcProps	The properties that identify an opened iModel for RPC operations.
InformationPartitionElementProps	Properties of a InformationPartitionElement
IpcSocket	An inter-process socket connection between a single IModelHost on the backend (the node process), and an IModelApp on
IpcSocketBackend	Interface for the backend (Node.js) side of a socket connection.
IpcSocketFrontend	Interface for the frontend (browser) side of a socket connection.
JsonGeometryStream	As part of a DynamicGraphicsRequestProps, specifies the geometry from which to generate the graphics in JSON format.
LightSettingsProps	Wire format for a LightSettings describing lighting for a 3d scene.
LineBreakRunProps	JSON representation of a LineBreakRun.
LineLayoutResult	Represents a single line in a TextBlockLayoutResult.
LineStyleProps	Properties of a LineStyle
ListMarker	A settings to specify how to mark or denote the start of a list item in a List.
ListProps	JSON representation of a List.
LocalBriefcaseProps	Properties of a local briefcase file, returned by BriefcaseManager.getCachedBriefcases and BriefcaseManager.downloadBriefcase
Localization	The interface defining the localization requirements of IModelApp.
MapImageryProps	The JSON representation of the map imagery.
MapLayerKey	stores key-value pair to be added to all requests made involving map layer.
MapLayerProviderProperties	Type for map layer provider properties.
MapSubLayerProps	JSON representation of the settings associated with a map sublayer included within a MapLayerProps.
MassPropertiesPerCandidateRequestProps	Information required to request mass properties for each element separately from the front end to the back end.	Deprecated
MassPropertiesPerCandidateResponseProps	Information returned from the back end to the front end holding the result of the mass properties calculation for a single candidate.	Deprecated
MassPropertiesRequestProps	Information required to request mass properties for elements from the front end to the back end.
MassPropertiesResponseProps	Information returned from the back end to the front end holding the result of the mass properties calculation.
MaterialProps	Override materialId for subsequent surface and solid geometry.
ModelClipGroupProps	JSON representation of a ModelClipGroup.
ModelExtentsProps	Describes the volume of geometry contained with a GeometricModel as returned by
ModelFeature	A Feature with a modelId identifying the model containing the feature, obtained from a RenderFeatureTable.
ModelGeometryChanges	Represents geometric changes to a set of GeometricElements belonging to a single GeometricModel.
ModelGeometryChangesProps	Compact wire format representing geometric changes to GeometricElements within a GeometricModel.
ModelIdAndGeometryGuid	Specifies a GeometricModel's Id and a Guid identifying the current state of the geometry contained within the model.
ModelLoadProps	Properties that specify what model should be loaded.
ModelMapLayerProps	JSON representation of a ModelMapLayerSettings.
ModelPlanarClipMaskArgs	Arguments supplied to PlanarClipMaskSettings.create to create a mask of PlanarClipMaskMode.Models.
ModelProps	Properties that define a Model
ModelQueryParams	Parameters for performing a query on Model classes.
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.
NormalMapParams	Defines normal map parameters.
NormalMapProps	Describes how to apply normal mapping to a surface material.
OpenAPIInfo	An OpenAPI 3.0 info object.	Deprecated
OpenBriefcaseOptions	Options to open a previously downloaded briefcase
OpenBriefcaseProps	Properties for opening a local briefcase file via BriefcaseDb.open
OpenCheckpointArgs	Arguments to open a Checkpoint directly from its cloud container
OpenDbKey	A key used to identify an opened IModelDb between the frontend and backend for Rpc and Ipc communications.
OpenSqliteArgs	Sqlite options.
OverrideElementAppearanceOptions	Options for using override to override the appearance of a GeometricElement.
OverrideFeatureAppearanceOptions	Common options for override.
OverrideModelAppearanceOptions	Options for using override to override the appearance of a GeometricModel.
OverrideSubCategoryAppearanceOptions	Options for using override to override the appearance of a SubCategory.
PackedFeature	Represents a Feature within a RenderFeatureTable.
PackedFeatureWithIndex	Represents a PackedFeature obtained from a RenderFeatureTable, including the index of that feature within the table.
ParagraphProps	JSON representation of a Paragraph.
PartReference	Represents a reference to a GeometryPart within a GeometryStream.
PersistentGraphicsRequestProps	Wire format describing a request to produce graphics in "iMdl" format for a single element.
PerStatementHealthStats	Statistics for a single SQL statement executed during changeset application.
PhysicalElementProps	Properties that define a PhysicalElement
PhysicalTypeProps	Properties of a PhysicalType
Placement2dProps	Properties of a Placement2d
Placement3dProps	Properties of a Placement3d
PlanarClipMaskProps	JSON representation of a PlanarClipMaskSettings.
PlanProjectionSettingsProps	Wire format describing PlanProjectionSettings.
PointCloudDisplayProps	The JSON representation of PointCloudDisplaySettings.
PointWithStatus	A point converted to iModel coordinates to geographic coordinates or vice-versa by a GeoConverter.
PolylineFlags	Flags describing a PolylineArgs.
PositionalVectorTransformProps	This interface represents a positional vector (seven parameters) geodetic transformation corresponding to
PriorityPlanarClipMaskArgs	Arguments supplied to PlanarClipMaskSettings.create to create a mask of Priority.
ProjectionProps	This class encapsulates the projection of the CRS.
PropertyMetaDataProps		Deprecated
QPoint2dBuffer	A compact representation of a list of QPoint2ds stored in a Uint16Array
QPoint3dBuffer	A compact representation of a list of QPoint3ds stored in a Uint16Array.
QueryLimit	Specify limit or range of rows to return
QueryOptions	ECSql query config
QueryPropertyMetaData
QueryQuota	Quota hint for the query.
QueryRowProxy	Methods and ways of accessing values from rows returned by ECSqlReader.
QueryStats	Performance-related statistics for ECSqlReader.
RealityData	RealityData
RealityDataAccess	Client wrapper to Reality Data Service.
RealityDataSourceKey	Key used by RealityDataSource to identify provider and reality data format
RealityDataSourceProps	JSON representation of the reality data reference attachment properties.
RealityModelDisplayProps	The JSON representation of RealityModelDisplaySettings.
RelatedElementProps	Properties of a NavigationProperty.
RelationshipProps	Properties that are common to all types of link table ECRelationships
RenderFeatureTable	Representation of a FeatureTable suitable for use with RenderSystem.createBatch.
RenderMaterialAssetMapsProps	Describes different types of textures to be applied to a surface material to alter its appearance.
RenderMaterialAssetProps	Describes the graphical properties of a RenderMaterialElement as part of a RenderMaterialProps.
RenderMaterialProps	Properties that define a RenderMaterialElement.
RenderTimelineLoadProps	Options controlling which properties are included or excluded when querying RenderTimelineProps.
RenderTimelineProps	Wire format describing a RenderTimeline.
RepositoryLinkProps	Parameters of a RepositoryLink
RequestNewBriefcaseProps	Properties for downloading a briefcase to a local file, from iModelHub.
RgbColorProps	JSON representation of an RgbColor, with each component an integer in the range [0, 255].
RootSubjectProps	Properties of the Root Subject.
RpcActivity	The properties of an RpcActivity.
RpcInterfaceDefinition	Specifies the required static properties of an RpcInterface class.
RpcInterfaceEndpoints	Describes the endpoints of an RPC interface.
RunLayoutResult	Represents a single run in a LineLayoutResult.
SectionDrawingLocationProps	Properties that define a SectionDrawingLocation
SectionDrawingProps	Properties that define a SectionDrawing.
SectionDrawingViewProps	As part of a ViewStateProps, describes the SpatialViewDefinition from which a SectionDrawing was generated.
SerializedRpcActivity	Serialized format for sending the request across the RPC layer
SessionProps	Properties that identify a session.
SheetBorderTemplateProps	Properties of a SheetBorderTemplate
SheetIndexEntryProps	Properties of a SheetIndexEntry.
SheetIndexReferenceProps	Properties of a SheetIndexReference
SheetProps	Properties of a Sheet.
SheetReferenceProps	Properties of a SheetReference
SheetTemplateProps	Properties of a SheetTemplate
SkyBoxProps	JSON representation of a SkyBox that can be drawn as the background of a ViewState3d.
SkyCubeImageProps	JSON representation of the images used for a SkyCube.
SkyCubeProps	JSON representation of the six images used by a SkyCube.
SkySphereImageProps	JSON representation of the image used for a SkySphere.
SnapshotOpenOptions	Options to open a SnapshotDb.
SolarLightProps	Wire format for the solar directional light associated with a LightSettingsProps.
SolarShadowSettingsProps	JSON representation of SolarShadowSettings.
SourceAndTarget	Specifies the source and target elements of a Relationship instance.
SpatialClassifierFlagsProps	JSON representation of a SpatialClassifierFlags.
SpatialClassifierProps	JSON representation of a SpatialClassifier.
SpatialClassifiersContainer	An object that can store the JSON representation of a list of SpatialClassifiers.
SpatialViewDefinitionProps	Parameters to construct a SpatialViewDefinition
SqliteError	An error originating from the SQLiteDb API.
SubCategoryPlanarClipMaskArgs	Arguments supplied to PlanarClipMaskSettings.create to create a mask of IncludeSubCategories.
SubCategoryProps	Parameters of a SubCategory
SubjectProps	Properties of a Subject
SynchronizationConfigLinkProps	The properties of a SynchronizationConfigLink
TabRunProps	JSON representation of a TabRun.
TerrainProps	JSON representation of the settings of the terrain applied to background map display by a DisplayStyle.
TextAnnotation2dProps	Properties that define a TextAnnotation2d.
TextAnnotation3dProps	JSON representation of a TextAnnotation3d.
TextAnnotationAnchor	Describes how to compute the "anchor point" for a TextAnnotation.
TextAnnotationCreateArgs	Arguments supplied to TextAnnotation.create.
TextAnnotationLeader	A line that connects a TextAnnotation to a point in space relative to another element in the iModel.
TextAnnotationLeaderProps	JSON representation of a TextAnnotationLeader.
TextAnnotationProps	JSON representation of a TextAnnotation.
TextBlockComponentProps	The JSON representation of a TextBlockComponent.
TextBlockGeometryProps	JSON representation of the geometric primitives that can be used to display a TextBlock.
TextBlockLayoutResult	Represents the result of laying out a TextBlock's contents into a series of lines containing runs.
TextBlockMargins	Describes the margins around the content inside a TextBlock, measured in meters.
TextBlockProps	JSON representation of a TextBlock.
TextBlockStringifyContext	Context information that may be useful when converting a TextBlock to a string.
TextBlockStringifyOptions	Options supplied to stringify to control how the content is formatted.
TextFrameStyleProps	Describes how to draw the frame around a TextAnnotation.
TextLeaderStyleProps	Properties describing the appearance of TextAnnotationLeader in a TextAnnotation.
TextRunProps	JSON representation of a TextRun.
TextStringGlyphData	Optional cached text layout information used to support legacy proxy graphics.
TextStringPrimitive	Represents a text string within a GeometryStream.
TextStringProps	Properties for a TextString class.
TextStyleSettingsProps	Serves both as the JSON representation of a TextStyleSettings, and a way for a TextBlockComponent to selectively override aspects of a AnnotationTextStyle's properties.
TextureData	Information about Texture data returned by queryTextureData.
TextureLoadProps	Properties that specify what texture should be loaded and how it should be loaded.
TextureMapProps	As part of a RenderMaterialAssetProps, describes how to map a RenderTexture's image to the triangles of a mesh to which the material is applied.
TextureProps	Properties that define a Texture element.
ThematicDisplayProps	JSON representation of the thematic display setup of a DisplayStyle3d.
ThematicDisplaySensorProps	JSON representation of a ThematicDisplaySensor.
ThematicDisplaySensorSettingsProps	JSON representation of a ThematicDisplaySensorSettings for InverseDistanceWeightedSensors.
ThematicGradientSettingsProps	JSON representation of a ThematicGradientSettings.
ThumbnailFormatProps	Metadata about a thumbnail image.
ThumbnailProps	Describes a thumbnail image for an IModel or ViewDefinition.
TileContentIdentifier
TileVersionInfo	Metadata describing the version/format of the tiles supplied by the backend.
TranslationOptions	Options for Localization
TypeDefinitionElementProps	Properties of a TypeDefinitionElement
UpgradeOptions	Arguments to validate and update the profile and domain schemas when opening a Db
UrlLinkProps	Parameters of a UrlLink
VersionedJSON	Wrapper for versioned JSON data.
VerticalCRSProps	Vertical Geographic Coordinate reference System definition
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
ViewDetails3dProps	Properties of a ViewDefinition3dProps stored as JSON.
ViewDetailsProps	Properties of a ViewDefinitionProps stored as JSON.
ViewFlagProps	JSON representation of ViewFlags.
ViewQueryParams	Parameters for performing a query on ViewDefinition classes.
ViewStateLoadProps	Options for loading a ViewStateProps via IModelConnection.Views.load or IModelDb.Views.getViewStateProps.
ViewStateProps	Returned from IModelDb.Views.getViewStateProps.
ViewStoreError	Errors thrown by the ViewStore API.
WhiteOnWhiteReversalProps	JSON representation of a WhiteOnWhiteReversalSettings.
XyzRotationProps	Holds 3 components of a Positional Vector rotation definition in arc seconds

Namespaces

Name	Description
AmbientOcclusion	Namespace containing types controlling how ambient occlusion should be drawn.
AreaPattern
Atmosphere	Namespace containing types controlling how atmospheric scattering should be rendered.
Base64EncodedString	Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an ECDb for properties of binary type.
BaseLayerSettings
BRepEntity	JSON representation of a brep GeometryStream entry.
CatalogError	Errors produced by the CatalogIModel API.
CatalogIModel	A "catalog iModel" is an IModel containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.
ChannelControlError
CloudSqliteError
CodeScopeSpec	The scope of the Code.
ContextRealityModelProps
ElementGeometry	Provides utility functions for working with ElementGeometryDataEntry.
ElementGeometryChange	Represents a change to the geometry of a GeometricElement, as exposed by elements.
FeatureAppearanceProvider
FrustumPlanes
GenericInstanceFilter
GenericInstanceFilterRuleValue
Gradient	Namespace containing types for defining a color gradient, often used for filled planar regions.
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
ModelFeature
ModelGeometryChanges	Represents geometric changes to a set of GeometricElements belonging to a single GeometricModel.
PackedFeature
QPoint2dBuffer
QPoint3dBuffer
Quantization	Provides facilities for quantizing floating point values within a specified range into 16-bit unsigned integers.
RealityDataFormat	Utility function for RealityDataFormat
RealityDataSourceKey	RealityDataSourceKey utility functions
RenderSchedule	Namespace containing types that collectively define a script that animates the contents of a view by adjusting the visibility, position,
RenderTexture
RpcRequestStatus		Deprecated
Run	A sequence of characters within a Paragraph that share a single style.
SqliteError
SubCategoryAppearance
TextureMapping
ViewStoreError
ViewStoreRpc	Access to a ViewStore from the frontend.
WorkspaceError	Errors thrown by the Workspace APIs.

Type Aliases

Name	Description
AxisAlignedBox3d	A Range3d that is aligned with the axes of spatial coordinates.
AxisAlignedBox3dProps	The properties of a Range3d.
BackgroundMapProviderName	Enumerates a set of supported BackgroundMapProviders that can provide map imagery.
Base64EncodedString	Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as required when converting EC properties of binary type to and from JSON.
BaseLayerProps	JSON representation of a BaseLayerSettings.
BaseLayerSettings	The base layer for a MapImagerySettings.
BaselineShift	Describes whether the characters of a TextRun should be displayed normally, in subscript, or in superscript.
BlobRange
BriefcaseId	The Id assigned to a briefcase by iModelHub, or Unassigned .
ChangesetId	A string that identifies a changeset.
ChangesetIndex	The index of a changeset, assigned by iModelHub.
ChangesetIndexOrId	either changeset index, id, or both
CodeScopeProps	The ElementId of the element that defines the scope for a Code value.
ColorDefProps	The JSON representation of a ColorDef - an unsigned 32-bit integer in 0xTTBBGGRR format.
ContourDisplayProperties	A type containing all of the properties of ContourDisplay with none of the methods and with the readonly modifiers removed.
ContourGroupProperties	A type containing all of the properties of ContourGroup with none of the methods and with the readonly modifiers removed.
ContourProperties	A type containing all of the properties of Contour with none of the methods and with the readonly modifiers removed.
ContourStyleProperties	A type containing all of the properties of ContourStyle with none of the methods and with the readonly modifiers removed.
CreateEmptySnapshotIModelProps	The options that can be specified when creating an empty snapshot iModel.
CreateEmptyStandaloneIModelProps	The options that can be specified when creating an empty standalone iModel.
DanishSystem34Region	The type to define the three zones of the Danish System 34 projections.
EasingFunction
ECVersionString	A string in the format read.write.minor where the semantics match those of ECVersion.
ElementAlignedBox2d	A bounding box aligned to the orientation of a 2d Element
ElementAlignedBox3d	A bounding box aligned to the orientation of a 3d Element
ElementGeometryChange
ElementGeometryFunction	A callback function that receives geometry stream data.
ElementGraphicsRequestProps	Wire format describing a request to produce graphics in "iMdl" format for a single element or geometry stream.
EntityIdAndClassIdIterable	A collection of EntityIdAndClassIds, as used by TxnChangedEntities.
EnvironmentProperties	A type containing all of the properties of Environment with none of the methods and with the readonly modifiers removed.
FieldCase	As part of FieldFormatOptions, specifies how to modify the case of the display string.
FieldPropertyType	Enumerates the different kinds of Property values that can be used as the basis for a FieldRun's display string.
FontId	An unsigned integer uniquely identifying a font family in the context of an IModel.
GenericInstanceFilterRuleGroupOperator	Type definition that describes operators supported by GenericInstanceFilterRuleGroup.
GenericInstanceFilterRuleOperator	Type definition that describes operators supported by GenericInstanceFilterRule.
GenericInstanceFilterRuleValue	Type definition that describes value of GenericInstanceFilterRule.
GeodeticTransformMethod	Type indicating the geodetic transformation method
GeometryStreamPrimitive	Union of all possible geometric primitive types that may appear within a GeometryStream.
GeometryStreamProps	A GeometricElement's GeometryStream is represented by an array of GeometryStreamEntryProps.
GridFileDirection	type to indicate the grid file application direction.
GridFileFormat	Type indicating the file format of the grid files.
GroundPlaneProperties	A type containing all of the properties and none of the methods of GroundPlane, with readonly modifiers removed.
HemisphereEnum	Type used in the definition of UTM Zoning projection.
IgnoreAnimationOverrides	A function that can be supplied to ignoreAnimationOverrides to indicate whether the color or transparency overrides defined
ImageGraphicCornersProps	JSON representation of the 4 corners of an ImageGraphicProps.
ImageryMapLayerFormatId	The current set of supported map layer formats.
IModelConnectionProps	The properties returned by the backend when creating a new IModelConnection from the frontend, either with Rpc or with Ipc.
IModelErrorNumber	Numeric values for common errors produced by iTwin.js APIs, typically provided by IModelError.
IModelVersionProps	Properties for IModelVersion
InterpolationFunction
IpcListener	A function to handle an Ipc message.
LeaderAttachment	Describes how to attach a TextAnnotationLeader to the frame around a TextBlock.
LeaderTextPointOptions	Specifies the possible positions to attach a leader on the frame around a TextBlock
LocalAlignedBox3d	A bounding box aligned to a local coordinate system
LocalDirName
LocalFileName
MapLayerProps	JSON representation of a MapLayerSettings.
MapLayerProviderArrayProperty	Type for map layer provider array property.
OverrideFeatureAppearanceArgs	Arguments supplied to override.
PersistentBackgroundMapProps	Persistent JSON representation of a BackgroundMapSettings.
Placement	Either a Placement2d or Placement3d
PlacementProps
Point2dProps	A 2d point specified as an array of 2 numbers [x, y].
PointCloudEDLMode	Specifies the Eye-Dome Lighting mode used for a point cloud.
PointCloudShape	Specifies the shape drawn for each individual point within a point cloud.
PointCloudSizeMode	Specifies how the sizes of the individual points within a point cloud are computed.
PolylineIndices	Describes the vertex indices of a single line within a PolylineArgs.
ProjectionMethod	This enum contains the list of all projection methods that can be represented as part of the HorizontalCRS
PropertyCallback	A callback function to process properties of an Entity	Deprecated
QueryValueType	The format for rows returned by ECSqlReader.
RemoveFunction	Function returned when establishing an Ipc receive listener or invoke handler.
RgbFactorProps	Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,
RpcInterfaceImplementation	A class that implements the operations of an RPC interface.
Run	TextBlockComponents contained within a Paragraph.
RunProps	The JSON representation of a Run.
SheetIndexFolderProps	Properties of a SheetIndexFolder
SkyBoxImageProps	JSON representation of the image(s) to be mapped to the surfaces of a SkyBox.
SkyGradientProperties	A type containing all of the properties and none of the methods of SkyGradient with readonly modifiers removed.
StackedFractionType	Specifies how to separate the numerator and denominator of a FractionRun, by either a horizontal or diagonal bar.
StandaloneOpenOptions	Options to open a StandaloneDb via StandaloneDb.openFile from the backend,
StorageValue	Type of value for storage values
StructuralTextBlockComponent	A union of all the TextBlockComponents that can contain other components.
SubLayerId
TextAnnotationFillColor	Describes what color to use when filling the frame around a TextBlock.
TextAnnotationFrameShape	Describes a predefined shape that can be computed and drawn around the margins of a TextBlock
TextBlockGeometryPropsEntry	A single entry in a TextBlockGeometryProps, representing one of the following primitive types:
TextJustification	Describes the relative alignment of text.
TextStyleColor	Describes the color in which to draw the text in a TextRun.
TextureImageSpec	Identifies an image to be used to produce a RenderTexture for a given purpose - for example,
TweenCallback
UnitType	This type indicates possible linear and angular units supported.
UpdateCallback
ViewFlagOverrides	A type that describes how to override selected properties of a ViewFlags.
ViewFlagsProperties	A type containing all of the properties of ViewFlags with none of the methods and with the readonly modifiers removed.
ViewIdString	The id of either an element or an entry in a ViewStore.