Skip to main content
Version: v5.3

IafViewer 2D-3D Features

Overview​

The IafViewer offers a range of features for viewing 2D and 3D models.

The main features are as follows:

Click on a feature to view the relevant page.

Core components​

{{view3d}} and {{view2d}} are top-level prop groups on {{IafViewerDBM}}. They decide how models are shown once {{modelComposition}} has decided which models belong in the session. See How prop groups fit together on the Enhanced Viewing Modes hub.

View3D props​

View3D supplies 3D building visualization and renders one or more BIMPK models.

PropTypePurposeDefault
view3d.enablebooleanEnable/disable 3D viewertrue
view3d.visiblebooleanShow or hide the enabled widget without turning the mode off. When false, the launcher can still open the widget if showLauncher is true.true
view3d.keepAlivebooleanKeep the 3D viewer session alive (spawn and session activity). This is separate from the HTTP keep-alive.false
view3d.opacitynumberModel opacity (0.0 to 1.0)1.0
view3d.displayModeenumDEFAULT, SPLIT, FULLSCREEN, FIXEDFULLSCREEN
view3d.showToolbarbooleanShow/hide the 3D widget's own toolbarfalse
view3d.showLauncherbooleanShow/hide the main-toolbar button that opens the 3D viewertrue
view3d.alignmentenumLEFT_TOP, LEFT_BOTTOM, RIGHT_TOP, RIGHT_BOTTOM. Applies only to SPLIT and FIXED.RIGHT_TOP
view3d.ordernumberDisplay order when several widgets are shown1
view3d.marginnumberMargin around the widget0
view3d.renderingModeenumDraw mode, such as Shaded or WireframeShaded
view3d.onRenderingModeChangefunction(mode) => void when the rendering mode changes—
view3d.cameraobjectStructured camera, aligned with aps.camera: enable, mode ('spherical' | 'absolute'), projection, fov, view, spherical, absolute{ enable: false }
view3d.onCameraUpdateobject{ delayInMs, callback } — throttle and callback. To restore a camera, store the payload and assign it back to view3d.camera.—
view3d.rendering.ignoreSpaceTransparencyInGlassbooleanIn Glass mode, draws isolated spaceElementIds in the XRay Selected overlay. Set to false to keep authored space transparency.true

View2D props​

View2D supplies 2D visualization for 2D plans and sheet viewers.

PropTypePurposeDefault
view2d.enablebooleanEnable/disable 2D viewertrue
view2d.visiblebooleanShow or hide the enabled widget without turning the mode off. When false, the launcher can still open the widget if showLauncher is true.true
view2d.keepAlivebooleanKeep the 2D viewer session alivefalse
view2d.fullscreenbooleanFull-screen modefalse
view2d.displayModeenumDEFAULT, SPLIT, FULLSCREEN, FIXEDDEFAULT
view2d.showToolbarbooleanShow/hide the 2D widget's own toolbartrue
view2d.showLauncherbooleanShow/hide the main-toolbar button that opens the 2D viewertrue
view2d.alignmentenumLEFT_TOP, LEFT_BOTTOM, RIGHT_TOP, RIGHT_BOTTOM. Applies only to SPLIT and FIXED.LEFT_TOP
view2d.ordernumberDisplay order when several widgets are shown2
view2d.marginnumberMargin around the widget10
view2d.sheetstringName of the active 2D drawing sheetundefined
view2d.onSheetChangefunction({ sheetIdx, sheetName, sheetNames, sheetIds }) => void when sheets load or the active sheet changes—

For the full prop reference with required flags, see IafViewer — View3d / View2d (mode object tables) and IafViewerDBM (DBM forwards the same props). For which models load into these views, see Model composition.

The IafViewerExView3dStandalone example in the IafViewer Examples view shows View3D with a configuration panel and the structured view3d.camera prop.