API Reference › core-common› Views

Views

Types for defining graphical views of the contents of an iModel.

Classes

Name Description  
Camera The current position (eyepoint), lens angle, and focus distance of a camera.  
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.  
CutStyle As part of a ClipStyle, describes how section-cut graphics should be displayed.  
Frustum The region of physical (3d) space that appears in a view.  
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.  
ViewDetails Encapsulates access to optional view details stored in JSON properties.  
ViewDetails3d Encapsulates access to optional 3d view details stored in JSON properties.  

Constants

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

Enumerations

Name Description  
GridOrientationType Describes the orientation of the grid displayed within a Viewport.  
Npc The 8 corners of the Normalized Plane Coordinate cube.  

Interfaces

Name Description  
AuxCoordSystem2dProps Properties of AuxCoordSystem2d  
AuxCoordSystem3dProps Properties of AuxCoordSystem3d  
AuxCoordSystemProps  
CameraProps JSON representation of a Camera.  
CategorySelectorProps Properties that define a CategorySelector  
ClipIntersectionStyleProps Wire format describing a ClipIntersectionStyle.  
ClipStyleCreateArgs Arguments supplied to ClipStyle.create.  
ClipStyleProps Wire format describing a ClipStyle.  
CutStyleProps Wire format describing a CutStyle applied to section-cut geometry produced at intersections with a view's ClipVector.  
ModelClipGroupProps JSON representation of a ModelClipGroup.  
ModelSelectorProps Properties that define a ModelSelector  
SectionDrawingViewProps As part of a ViewStateProps, describes the SpatialViewDefinition from which a SectionDrawing was generated.  
SpatialViewDefinitionProps Parameters to construct a SpatialViewDefinition  
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.  
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.  

Namespaces

Name Description  
ViewStoreRpc Access to a ViewStore from the frontend.  

Type Aliases

Name Description  
ViewIdString The id of either an element or an entry in a ViewStore.  

Last Updated: 11 June, 2025