Views

Classes for working with views of models and elements.

Classes

Name Description  
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. Beta
DisplayStyle3dSettings Provides access to the settings defined by a DisplayStyle3d or DisplayStyle3dState, and ensures that Beta
DisplayStyleSettings Provides access to the settings defined by a DisplayStyle or DisplayStyleState, and ensures that Beta
Frustum The region of physical (3d) space that appears in a view.  
SubCategoryAppearance Parameters that define the way geometry on a SubCategory appears.  
SubCategoryOverride Overrides selected aspects of a SubCategoryAppearance in the context of a ViewState.  

Constants

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

Enumerations

Name Description  
BackgroundMapType Describes the type of background map displayed by a DisplayStyle  
GeoCoordStatus  
Npc The 8 corners of the Normalized Plane Coordinate cube.  
Rank The rank for a Category  
SkyBoxImageType Enumerates the supported types of SkyBox images.  

Interfaces

Name Description  
AuxCoordSystem2dProps Properties of AuxCoordSystem2d  
AuxCoordSystem3dProps Properties of AuxCoordSystem3d  
AuxCoordSystemProps  
BackgroundMapProps JSON representation of the settings associated with a background map displayed by a DisplayStyle.  
CameraProps properties of a camera  
CategorySelectorProps Properties that define a CategorySelector  
ContextRealityModelProps JSON representation of a context reality model  
DecorationGeometryProps Information required to request a snap to a pickable decoration from the front end to the back end. Beta
DisplayStyle3dProps JSON representation of a DisplayStyle3d or DisplayStyle3dState.  
DisplayStyle3dSettingsProps JSON representation of settings associated with a DisplayStyle3dProps.  
DisplayStyleProps JSON representation of a DisplayStyle or DisplayStyleState.  
DisplayStyleSettingsProps JSON representation of the settings associated with a DisplayStyleProps.  
DisplayStyleSubCategoryProps Describes the SubCategoryOverrides applied to a SubCategory by a DisplayStyle.  
EnvironmentProps JSON representation of the environment setup of a DisplayStyle3d.  
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
GroundPlaneProps JSON representation of a GroundPlane.  
IModelCoordinatesRequestProps Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates Beta
IModelCoordinatesResponseProps Beta
ModelSelectorProps Properties that define a ModelSelector  
PointWithStatus Information returned from a request to convert an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates 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
SolarShadowProps JSON representation of a solar shadow settings. Beta
SpatialViewDefinitionProps Parameters to construct a SpatialViewDefinition  
SubCategoryAppearance.Props Properties used to create a SubCategoryAppearance  
ViewDefinition2dProps Parameters used to construct a ViewDefinition2d  
ViewDefinition3dProps Parameters to construct a ViewDefinition3d  
ViewDefinitionProps Parameters used to construct a ViewDefinition  
ViewFlagProps JSON representation of ViewFlags  
ViewQueryParams Parameters for performing a query on ViewDefinition classes.  
ViewStateProps Returned from IModelDb.Views.getViewStateData  

Type Aliases

Name Description  
BackgroundMapProviderName The current set of supported background map providers. Beta

Last Updated: 20 September, 2019