imodeljs-common
Classes
| Name | Description | |
|---|---|---|
| AmbientLight | Describes the ambient light associated with a LightSettings. | |
| BackendError | ||
| BackgroundMapSettings | Normalized representation of a BackgroundMapProps for which type and provider have been validated and default values have been applied where explicit values not defined. | |
| 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 WGS84 ellipsoid. | |
| CartographicRange | A cartographic range representing a rectangular region if low longitude/latitude > high then area crossing seam is indicated. | |
| CloudStorageCache | Beta | |
| CloudStorageTileCache | Beta | |
| 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. | |
| 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. | Beta |
| ElectronRpcManager | Coordinates usage of RPC interfaces for an Electron-based application. | Beta |
| ElectronRpcProtocol | RPC interface protocol for an Electron-based application. | Beta |
| ElectronRpcRequest | Beta | |
| EntityMetaData | Metadata for an Entity. | Beta |
| Feature | Describes a "feature" within a batched RenderGraphic. | |
| FeatureAppearance | Defines overrides for selected aspects of a Feature's symbology. | |
| 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. | Beta |
| 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. | |
| 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. | |
| HemisphereLights | Describes a pair of hemisphere lights associated with a LightSettings. | |
| 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. | Beta |
| ImageGraphicCorners | Defines the 4 corners of an ImageGraphic. | Beta |
| 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. | |
| MobileRpcConfiguration | Holds configuration for the RpcInterfaces used by the application. | Beta |
| MobileRpcManager | Coordinates usage of RPC interfaces for an Mobile-based application. | Beta |
| MobileRpcProtocol | RPC interface protocol for an Mobile-based application. | Beta |
| MobileRpcRequest | Beta | |
| NoContentError | Intended for API "no content" semantics where the error case should not trigger application failure monitoring systems. | |
| Placement2d | The placement of a GeometricElement2d. | |
| Placement3d | The placement of a GeometricElement3d. | |
| PlanProjectionSettings | An immutable description of how to draw a "plan projection" models. | Beta |
| PropertyMetaData | Metadata for a property. | Beta |
| 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. | Beta |
| RenderMaterial.Params | Parameters used to construct a RenderMaterial | |
| RenderTexture | Represents a texture image applied to a surface during rendering. | Beta |
| RenderTexture.Params | Parameters used to construct a RenderTexture. | |
| ResponseLike | ||
| 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, | |
| 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. | |
| RpcMultipartParser | ||
| RpcNotFoundResponse | A RPC operation response. | |
| RpcOperation | An RPC operation descriptor. | |
| RpcOperationPolicy | The policy for an RPC operation. | |
| RpcPendingResponse | A pending RPC operation response. | |
| RpcProtocol | An application protocol for an RPC interface. | |
| RpcRequest | A RPC operation request. | |
| RpcRoutingToken | ||
| ServerError | ||
| ServerTimeoutError | ||
| SolarLight | Describes the solar directional light associated with a LightSettings. | |
| SolarShadowSettings | Settings controlling display of solar shadows for a DisplayStyle3dSettings. | |
| SubCategoryAppearance | Parameters that define the way geometry on a SubCategory appears. | |
| SubCategoryOverride | Overrides selected aspects of a SubCategoryAppearance in the context of a DisplayStyleState. | |
| TerrainSettings | Normalized version of TerrainProps for which provider has been validated and default values of all members are used. | |
| 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. | Beta |
| 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. | |
| ThematicDisplay | The thematic display setup of a DisplayStyle3d. | Beta |
| ThematicGradientSettings | Thematic settings specific to creating a color gradient used by ThematicDisplay. | Beta |
| Tween | A Tween for interpolating values of an object. | Beta |
| Tweens | A group of Tweens. |
Beta |
| TypeDefinition | A RelatedElement relationship that describes the TypeDefinitionElement of an element. | |
| ViewDetails | Encapsulates access to optional view details stored in JSON properties. | Beta |
| ViewDetails3d | Encapsulates access to optional 3d view details stored in JSON properties. | Beta |
| ViewFlagOverrides | Overrides a subset of ViewFlags. | |
| ViewFlags | Flags for controlling how graphics appear within a View. | |
| WebAppRpcProtocol | The HTTP application protocol. | |
| WebAppRpcRequest | A web application RPC request. |
Constants
| Name | Description | |
|---|---|---|
| Easing | Easing functions from tween.js | Beta |
| Interpolation | Interpolation functions from tween.js | Beta |
| NpcCenter | The center point of the Normalized Plane Coordinate cube. | |
| NpcCorners | The 8 corners of an Npc Frustum. |
Enumerations
| Name | Description | |
|---|---|---|
| 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 Changes. | |
| ChangeOpCode | Equivalent of the ECEnumeration OpCode in the ECDbChange ECSchema. | |
| CloudStorageProvider | Beta | |
| ColorByName | A set of known colors by HTML color name, as a 32-bit integer in the form 0xBBGGRR (red is the low byte). | |
| CommonLoggerCategory | Logger categories used by this package | |
| DomainOptions | Option to control the validation and upgrade of domain schemas in the Db | Beta |
| 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. | |
| GeoCoordStatus | ||
| 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 geometrysummary. | Beta |
| 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. | |
| LinePixels | Enumerates the available patterns for drawing patterned lines. | |
| MassPropertiesOperation | Specify whether to accumulate volumes, areas, or lengths for the supplied elements. | Beta |
| MonochromeMode | Describes the style in which monochrome color is applied by a DisplayStyleSettings. | |
| Npc | The 8 corners of the Normalized Plane Coordinate cube. | |
| PrimitiveTypeCode | The primitive types of an Entity property. | Beta |
| ProfileOptions | Options that control whether a profile upgrade should be performed when opening a Db | Beta |
| QueryPriority | Queue priority for query and its not guaranteed | |
| QueryResponseStatus | State of query operations | |
| 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. | |
| RpcMobilePlatform | RPC supported mobile platforms. | Beta |
| 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. | |
| SectionType | An enumeration of the different types of SectionDrawings. | |
| SkyBoxImageType | Enumerates the supported types of SkyBox images. | |
| SyncMode | Operations allowed when synchronizing changes between the Briefcase and iModelHub | |
| TerrainHeightOriginMode | Correction modes for terrain height | |
| TextureFlags | Beta | |
| TextureMapping.Mode | Enumerates the possible texture mapping modes. | |
| TextureMapUnits | Beta | |
| ThematicDisplayMode | The thematic display mode. | Beta |
| ThematicGradientColorScheme | Beta | |
| ThematicGradientMode | Beta | |
| ViewFlagPresence | Values used by ViewFlagOverrides to indicate which aspects of the ViewFlags are overridden. |
Global Functions
| Name | Description | |
|---|---|---|
| calculateSolarAngles | Beta | |
| calculateSolarDirection | Beta | |
| calculateSolarDirectionFromAngles | Beta | |
| calculateSunriseOrSunset | Beta | |
| isPowerOfTwo | Returns whether the input is a power of two. | |
| mapToGeoServiceStatus | Maps a GeoCoordStatus to the equivalent GeoServiceStatus. | |
| nextHighestPowerOfTwo | Returns the first power-of-two value greater than or equal to the input. |
Interfaces
| Name | Description | |
|---|---|---|
| AmbientLightProps | Wire format for the ambient light associated with a LightSettingsProps. | |
| 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. | |
| BRepPrimitive | Represents a BRep within a GeometryStream. | |
| CalloutProps | ||
| CameraProps | JSON representation of a Camera. | |
| CategoryProps | Parameters of a Category | |
| CategorySelectorProps | Properties that define a CategorySelector | |
| 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. | |
| CloudStorageContainerDescriptor | Beta | |
| 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. | |
| CreateSnapshotIModelProps | Options that can be supplied when creating snapshot iModels. | |
| CustomAttribute | A custom attribute instance | Beta |
| DecorationGeometryProps | Information required to request a snap to a pickable decoration from the front end to the back end. | Beta |
| DefinitionElementProps | Properties of a DefinitionElement | |
| DisplayStyle3dProps | JSON representation of a DisplayStyle3d or DisplayStyle3dState. | |
| DisplayStyle3dSettingsProps | JSON representation of settings associated with a DisplayStyle3dProps. | |
| DisplayStyleLoadProps | Options for loading a DisplayStyleProps. | |
| DisplayStyleModelAppearanceProps | Describes the FeatureAppearance overrides applied to a model by a DisplayStyle. | Beta |
| DisplayStyleOverridesOptions | Controls which settings are serialized by DisplayStyleSettings.toOverrides. | Beta |
| 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. | |
| DownloadBriefcaseOptions | Options to download the briefcase | Beta |
| EcefLocationProps | Properties that position an iModel on the earth via ECEF (Earth Centered Earth Fixed) coordinates | |
| ElectronRpcParams | Initialization parameters for ElectronRpcConfiguration. | Beta |
| ElementAspectProps | Properties of an ElementAspect | |
| ElementLoadProps | Parameters to specify what element to load for IModelDb.Elements.getElementProps. | |
| ElementProps | Properties of an Element | |
| EntityMetaDataProps | Beta | |
| EntityProps | The properties of an Entity as they are read/stored from/to the iModel. | |
| EntityQueryParams | Parameters for performing a query on Entity classes. | |
| EnvironmentProps | JSON representation of the environment setup of a DisplayStyle3d. | |
| ExternalSourceAspectProps | Properties of an ExternalSourceAspect that stores synchronization information for an element originating from an external source. | |
| FeatureAppearanceProps | Properties used to initialize a FeatureAppearance. | |
| FeatureAppearanceProvider | Interface adopted by an object that can supply a FeatureAppearance given a Feature and a FeatureOverrides. | Beta |
| FilePropertyProps | ||
| FontMapProps | The properties of a FontMap | |
| FontProps | The properties of a Font. | |
| FunctionalElementProps | ||
| GeoCoordinatesRequestProps | Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude) | Beta |
| GeoCoordinatesResponseProps | Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude) | Beta |
| 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. | Beta |
| GeometryContainmentResponseProps | Information returned from the back end to the front end holding the result of the geometry containment query. | Beta |
| 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 will be returned by a geometry summary. | Beta |
| GeometrySummaryRequestProps | Describes the elements for which to generate an array of geometry summaries and the options controlling the contents of each summary. | Beta |
| GroundPlaneProps | JSON representation of a GroundPlane. | |
| HemisphereLightsProps | Wire format for a pair of hemisphere lights associated with a LightSettingsProps. | |
| HttpServerRequest | An HTTP server request object. | |
| HttpServerResponse | An HTTP server response object. | |
| ImageGraphicProps | JSON representation of an [[ImageGraphic]. | Beta |
| ImagePrimitive | Represents an image within a GeometryStream. | |
| IModelCoordinatesRequestProps | Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates | Beta |
| IModelCoordinatesResponseProps | Beta | |
| IModelEncryptionProps | Encryption-related properties that can be supplied when creating or opening snapshot iModels. | |
| IModelProps | Properties that are about an iModel. | |
| IModelRpcProps | The properties that identify a specific instance of an iModel for RPC operations. | |
| InformationPartitionElementProps | Properties of a InformationPartitionElement | |
| LatAndLong | ||
| LatLongAndHeight | ||
| LightSettingsProps | Wire format for a LightSettings describing lighting for a 3d scene. | |
| LineStyleProps | Properties of a LineStyle | Beta |
| MapLayerKey | stores key-value pair to be added to all requests made involving map layer. | Beta |
| MassPropertiesRequestProps | Information required to request mass properties for elements from the front end to the back end. | Beta |
| MassPropertiesResponseProps | Information returned from the back end to the front end holding the result of the mass properties calculation. | Beta |
| MaterialProps | Override SubCategoryAppearance.materialId for subsequent surface and solid geometry. | |
| MobileRpcGateway | Beta | |
| ModelLoadProps | Properties that specify what model should be loaded. | |
| 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. | |
| OpenAPIInfo | An OpenAPI 3.0 info object. | |
| OpenBriefcaseOptions | Options to open the briefcase | Beta |
| PartReference | Represents a reference to a GeometryPart within a GeometryStream. | |
| PhysicalElementProps | Properties that define a PhysicalElement | |
| PhysicalTypeProps | Properties of a PhysicalType | |
| Placement2dProps | Properties of a Placement2d | |
| Placement3dProps | Properties of a Placement3d | |
| PlanProjectionSettingsProps | Describes how to draw a "plan projection" model. | Beta |
| PointWithStatus | Information returned from a request to convert an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates | Beta |
| PropertyMetaDataProps | Beta | |
| QueryLimit | ECSql query subset specification | |
| QueryQuota | The desired ECSql query quota constraint. | |
| QueryResponse | Result of a query. | |
| RelatedElementProps | Properties of a NavigationProperty. | |
| RelationshipProps | Properties that are common to all types of link table ECRelationships | |
| RenderMaterialProps | Properties that define a RenderMaterial | Beta |
| RepositoryLinkProps | Parameters of a RepositoryLink | |
| RgbColorProps | JSON representation of an RgbColor, with each component an integer in the range [0, 255]. | |
| 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. | |
| RpcRequestContext | Interface to enable passing application-specific context with each RPC request. | |
| SectionDrawingLocationProps | Properties that define a SectionDrawingLocation | Beta |
| SectionDrawingProps | Properties that define a SectionDrawing. | Beta |
| SerializedRpcOperation | A serialized RPC operation descriptor. | |
| SerializedRpcRequest | A serialized RPC operation request. | |
| SheetBorderTemplateProps | Properties of a SheetBorderTemplate | Beta |
| SheetProps | Properties of a Sheet | Beta |
| SheetTemplateProps | Properties of a SheetTemplate | Beta |
| SkyBoxImageProps | JSON representation of an image or images used by a SkySphere or SkyCube. | |
| SkyBoxProps | JSON representation of a 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. | Beta |
| SnapResponseProps | Information returned from the back end to the front end holding the result of a snap operation. | Beta |
| SnapshotOpenOptions | ||
| 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. | |
| SpatialViewDefinitionProps | Parameters to construct a SpatialViewDefinition | |
| SubCategoryAppearance.Props | Properties used to create a SubCategoryAppearance | |
| SubCategoryProps | Parameters of a SubCategory | |
| SubjectProps | Properties of a Subject | |
| TerrainProps | JSON representation of the settings of the terrain applied to background map display by a DisplayStyle. | |
| TextStringPrimitive | Represents a text string within a GeometryStream. | |
| TextStringProps | Properties for a TextString class. | |
| TextureMapping.ParamProps | Properties used to construct a TextureMapping.Params. | |
| TextureMapProps | Properties that define how a texture is mapped to a material | Beta |
| TextureProps | Properties that define a Texture | Beta |
| ThematicDisplayProps | JSON representation of the thematic display setup of a DisplayStyle3d. | Beta |
| ThematicGradientSettingsProps | Beta | |
| TileContentIdentifier | Beta | |
| TypeDefinitionElementProps | Properties of a TypeDefinitionElement | |
| UpgradeOptions | Arguments to validate and update the profile and domain schemas when opening a Db | Beta |
| UrlLinkProps | Parameters of a UrlLink | |
| 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 | |
| ViewFlagOverridesProps | JSON representation of ViewFlagOverrides. | |
| 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.getViewStateData. | |
| ViewStateProps | Returned from IModelDb.Views.getViewStateData. |
Namespaces
| Name | Description | |
|---|---|---|
| AmbientOcclusion | Namespace containing types controlling how ambient occlusion should be drawn. | |
| AreaPattern | ||
| BRepEntity | Beta | |
| CloudStorageContainerUrl | Beta | |
| CodeScopeSpec | The scope of the Code. | |
| EGFBAccessors | ||
| ElementGeometry | Provides utility functions for working with data generated by IModelDb.elementGeometryRequest | |
| 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 | ||
| RenderSchedule | A schedule (or script) for controlling the visibility, position and symbology of a series of elements over a period of time. | Beta |
| RpcRequestFulfillment | ||
| RpcSerializedValue | ||
| SpatialClassificationProps | Geometry may be classified by its spatial location. | Beta |
Type Aliases
| Name | Description | |
|---|---|---|
| AxisAlignedBox3d | A Range3d that is aligned with the axes of spatial coordinates. | |
| AxisAlignedBox3dProps | The properties of a Range3d. | |
| BackgroundMapProviderName | The current set of supported background map providers. | |
| CodeScopeProps | The props that hold the identity of the object defining the uniqueness scope for a set of Code values. | |
| ColorDefProps | An unsigned 32-bit integer in 0xTTBBGGRR format | |
| CreateEmptySnapshotIModelProps | The options that can be specified when creating an empty snapshot iModel. | |
| DPoint2dProps | Contains two array entries orders X, Y containing doubles | Beta |
| EasingFunction | Beta | |
| ElementAlignedBox2d | A bounding box aligned to the orientation of a 2d Element | |
| ElementAlignedBox3d | A bounding box aligned to the orientation of a 3d Element | |
| 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. | |
| HttpMethod_T | ||
| ImageGraphicCornersProps | JSON representation of the 4 corners of an ImageGraphicProps. | Beta |
| InterpolationFunction | Beta | |
| LocalAlignedBox3d | A bounding box aligned to a local coordinate system | |
| MobileRpcChunks | Beta | |
| PlacementProps | ||
| PropertyCallback | A callback function to process properties of an Entity | Beta |
| RgbFactorProps | Contains three array entries ordered as red, green, blue containing values 0 to 1 | Beta |
| RpcConfigurationSupplier | ||
| RpcInterfaceImplementation | ||
| RpcInvocationCallback_T | Notification callback for an RPC invocation. | |
| RpcOperationPolicyProps | ||
| RpcProtocolEventHandler | Handles RPC protocol events. | |
| RpcRequestCallback_T | Notification callback for an RPC request. | |
| RpcRequestEventHandler | Handles RPC request events. | |
| RpcRequestInitialRetryIntervalSupplier_T | Supplies the initial retry interval for an RPC request. | |
| RpcRequestNotFoundHandler | Resolves "not found" responses for RPC requests. | |
| RpcRequestTokenSupplier_T | Supplies an IModelRpcProps for an RPC request. | |
| RpcResponseCachingCallback_T | Determines if caching is permitted for a RPC response. | |
| TerrainProviderName | The current set of supported terrain providers. | |
| TweenCallback | Beta | |
| UpdateCallback | Beta |
Last Updated: 18 December, 2020