With URL parameters, you can configure your web widget with a customized array of navigation and exploration tools to enhance your users’ engagement with your 3D content.
The following tools appear in all BioDigital Human widgets by default:
|ui-fullscreen||Displays full-screen button, which opens your widget in a new tab. Only default when widget is embedded.|
|ui-center||Displays Center button, which users can click to reset the model to its original (centered) position.|
|ui-camera-mode||Displays Pan/Rotate button, which users can click to toggle between Pan Mode and Rotate Mode.|
|ui-zoom-in||Displays Zoom In button.|
|ui-zoom-out||Displays Zoom Out button.|
|ui-nav||Displays all navigation buttons: Center, Pan/Rotate, Zoom In, and Zoom Out. (To turn off all navigation buttons, you can set ui-nav to “=false.”)|
|ui-info||Displays model’s info panel, including title and description. Only default when widget is loaded in its own window (i.e., not embedded).||n/a|
|ui-share||Displays Share button, which opens the following sharing options: link, email, embed, Facebook, Twitter, and Google+.|
To disable any of the above tools, add its respective URL parameter to your widget URL and set the parameter to “false.”
Our assortment of customization tools enables users to explore your 3D content more deeply and encourages them to spend more time interacting.
To add customization tools to your widget, add any of the following URL parameters to your widget URL and set them to “true”:
|ui-tools||Displays toolbar containing Dissect, Undo, X-Ray/Standard Mode, Isolate Mode, and Cross Section buttons.|
|ui-tools-display||When set to “=primary,” all of the tools specified will appear as separate buttons. All tools or an individual tool must be turned on to control the display. For example, "&ui-tools=true&ui-tools-display=primary," or "&ui-dissect=true&ui-tools-display=primary."|
|ui-annotations||Displays the Toggle Annotations button, which enables the user to hide or show annotations.|
|ui-cross-section||Displays the Cross Section button. Mode varies on mobile.|
|ui-dissect||Displays the Dissect and Undo buttons.|
|ui-isolate||Displays the Isolate Mode button.|
|ui-xray||Displays the X-Ray/Standard Mode button.|
|ui-help||Displays the Help button, which opens a modal window inside the widget that explains "How to Navigate in 3D Space."|
URL parameters for all other tools can be found here.