Classes for working with Views


Name Description  
AuxCoordSystem2dState The state of an AuxCoordSystem2d element in the frontend  
AuxCoordSystem3dState The state of an AuxCoordSystem3d element in the frontend  
AuxCoordSystemSpatialState The state of an AuxCoordSystemSpatial element in the frontend  
AuxCoordSystemState The state of an AuxCoordSystem element in the frontend  
CategorySelectorState A set of Categories to be displayed in a ViewState.  
ChangeFlags Viewport event synchronization flags. Beta
Cluster A cluster of one or more Markers that overlap one another in the view.  
ContextRealityModelState A reference to a TileTree obtained from a reality data service and associated to a ViewState by way of its DisplayStyleState. Beta
DisplayStyle2dState A display style that can be applied to 2d views.  
DisplayStyle3dState A DisplayStyleState that can be applied to spatial views.  
DisplayStyleState A DisplayStyle defines the parameters for 'styling' the contents of a ViewState.  
DrawingViewState A view of a DrawingModel  
Environment Describes the SkyBox and Environment.GroundPlane associated with a DisplayStyle3dState.  
IconSprites Icon sprites are loaded from .png files in the assets directory of imodeljs-native.  
MarginPercent Margins for white space to be left around view volumes for ViewState.lookAtVolume.  
Marker A Marker is a CanvasDecoration, whose position follows a fixed location in world space.  
MarkerSet A set of Markers that are logically related, such that they cluster when they overlap one another in screen space.  
ModelSelectorState The state of a ModelSelector.  
OrthographicViewState Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.  
PlanarClipMaskState The State of Planar Clip Mask applied to a reality model or background map. Beta
ScreenViewport An interactive Viewport that exists within an HTMLDivElement.  
SheetViewState A view of a SheetModel.  
SkyBox The SkyBox is part of an Environment drawn in the background of spatial views to provide context.  
SkyBox.CreateParams Parameters used by the RenderSystem to instantiate a SkyBox.  
SkyBox.SphereParams Parameters defining a spherical SkyBox.  
SkyCube A SkyBox drawn as a cube with an image mapped to each of its interior faces.  
SkyCube.CreateParams Parameters used by the RenderSystem to instantiate a SkyBox.  
SkyCube.SphereParams Parameters defining a spherical SkyBox.  
SkyGradient A SkyBox drawn as a sphere with a gradient mapped to its interior surface.  
SkyGradient.CreateParams Parameters used by the RenderSystem to instantiate a SkyBox.  
SkyGradient.SphereParams Parameters defining a spherical SkyBox.  
SkySphere A SkyBox drawn as a sphere with an image mapped to its interior surface.  
SkySphere.CreateParams Parameters used by the RenderSystem to instantiate a SkyBox.  
SkySphere.SphereParams Parameters defining a spherical SkyBox.  
SpatialViewState Defines a view of one or more SpatialModels.  
Sprite Sprites are small raster images that are drawn on top of Viewports by a ViewDecoration.  
SpriteLocation A Sprite location.  
StandardView Supplies access to a set of commonly-used view rotations.  
TwoWayViewportSync Forms a 2-way connection between 2 Viewports of the same iModel, such that any change of the parameters in one will be reflected in the other. Beta
ViewCreator2d Beta
ViewCreator3d Beta
ViewingSpace Describes a Viewport's viewing volume, plus its size on the screen. Beta
ViewManager The ViewManager holds the list of opened views, plus the selected view.  
Viewport A Viewport renders the contents of one or more GeometricModels onto an HTMLCanvasElement.  
ViewPose The "pose" for a view.  
ViewRect A rectangle in integer view coordinates with (0,0) corresponding to the top-left corner of the view.  
ViewState The front-end state of a ViewDefinition element.  
ViewState2d Defines the state of a view of a single 2d model.  
ViewState3d Defines the state of a view of 3d models.  


Name Description  
ChangeFlag Beta
CoordSystem Coordinate system types  
StandardViewId Describes a set of commonly-used view rotations.  
ViewStatus Describes the result of a viewing operation such as those exposed by ViewState and Viewport.  
ViewUndoEvent Beta


Name Description  
Animator An object to animate a transition of a Viewport. Beta
ChangeViewedModel2dOptions Options for changing the viewed Model of a 2d view via Viewport.changeViewedModel2d  
Decorator Interface for drawing Decorations into, or on top of, the active ScreenViewports managed by ViewManager.  
DepthRangeNpc The minimum and maximum values for the z-depth of a rectangle of screen space.  
ExtentLimits Describes the largest and smallest values allowed for the extents of a ViewState.  
FeatureOverrideProvider An object that customizes the appearance of Features within a Viewport.  
OsmBuildingDisplayOptions Beta
SelectedViewportChangedArgs Argument for ViewManager.onSelectedViewportChanged  
TiledGraphicsProvider Provides a way for applications to inject additional non-decorative graphics into a Viewport by supplying one or more TileTreeReferences capable of loading and drawing the graphics. Beta
ViewAnimationOptions Options that control how an Viewport animation behaves.  
ViewChangeOptions Options that control how operations that change a viewport behave.  
ViewCreator2dOptions Beta
ViewCreator3dOptions Beta
ViewportDecorator Interface for drawing Decorations into, or on top of, a ScreenViewport.  
ZoomToOptions Options to allow changing the view rotation with zoomTo methods.  


Name Description  
Frustum2d Constants and functions for working with two-dimensions Frustums.  
PerModelCategoryVisibility Allows the visibility of categories within a Viewport to be controlled on a per-ModelState basis. Beta

Type Aliases

Name Description  
MarkerImage The types that may be used for Markers  

Last Updated: 02 April, 2021