Viewer Widget
use the viewer widget api to include the viewer widget in your 3d viewer instance the widget is useful for basic embedded viewer functionality for more advanced usage make use of the viewer apis installation follow the same installation steps when using using jquery docid 18q6qater8drakqldyxsl with the following changes to include the viewer widget in your project in step 4, provide the viewer ui option to include the viewer widget bimsync load(\["viewer ui"]); in step 6, after loading a model initialize the viewer widget by invoking the viewerui method on the jquery object for the div where the 3d viewer instance is attached $("#viewer 3d") viewer("loadmodelsfromtoken", tokenurl3d) then(() => { $("#viewer 3d") viewerui(); }); usage options adjust the default behavior of the viewer widget by providing an options object when creating a viewer widget instance properties true false 331,80false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type joystickposition valid values are 'middle left' 'bottom left' 'bottom center' 'bottom right' 'middle right' translations translations for the viewer widget true false 210false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type methods hidejoystick hides the joystick usage $("#viewer 3d") viewerui("hidejoystick"); joystickposition sets the joystick position usage const position = "bottom center"; $("#viewer 3d") viewerui("joystickposition", position); parameters position position of the joystick true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type valid values are 'middle left' 'bottom left' 'bottom center' 'bottom right' 'middle right' set2dlockednavigationmode set the 2d locked navigation mode when enabled, the cursor will be in the center of the 2d scene usage const islocked = true; $("#viewer 3d") viewerui("set2dlockednavigationmode", islocked); parameters islocked positions the cursor in the center of the 2d scene true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type set2dlockstoreymode set the 2d lock storey mode when disabled, the 2d viewer storey selection will follow the 3d viewer usage const islocked = false; $("#viewer 3d") viewerui("set2dlockstoreymode", islocked); parameters islocked is the 2d lock storey mode enabled true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type setspaces set the space ids to be considered when spacesvisible option is false usage const spaceids = \["space 1", "space 2"]; $("#viewer 3d") viewerui("setspaces", spaceids); parameters spaceids list of spaceids true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type setspacesvisible set spaces visibility usage const arespacesvisible = true; $("#viewer 3d") viewerui("setspacesvisible", arespacesvisible); parameters arespacesvisible are spaces visible true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type showjoystick displays the joystick if enabled usage $("#viewer 3d") viewerui("showjoystick"); updatejoystickoptions sets the joystick options usage const options = { joystickborderoffset "20px", joystickcolor "blue", joystickhidden false, joystickposition "bottom center", joystickrotationclamp 0 5, joysticksize 200, }; $("#viewer 3d") viewerui("updatejoystickoptions", options); parameters options options for the joystick true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type properties true false 242false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type joystickposition valid values are 'middle left' 'bottom left' 'bottom center' 'bottom right' 'middle right'