Customizing ORBITTOUR embed code

When using ORBITTOUR embed codes it is possible to customise generated code. This might be necessary in some cases, e.g. when trying to embed the same ORBITTOUR multiple times on the single page or if you want to dynamically load/inject ORBITTOUR using JavaScript.

With ORBITTOUR you can also use most of ORBITVU VIEWER parameters.

ORBITTOUR parameters can be applied to embed code generated by ORBITVU SUN.

An example of adding the teaser parameter:

<div id="orbittour-hhyoAwhnuh2NQLgNfpdRYk" class="orbittour-container"></div>
<script type="text/javascript" src="//orbitvu.co/001/hhyoAwhnuh2NQLgNfpdRYk/2/orbittour/523/script"></script?teaser=autorotate>

background_color

Set the background colour of ORBITTOUR. The value of this parameter should be defined as a hexadecimal colour number (same as used in HTML) + hexadecimal opacity value, eg:

  • 000000ff
    color code: 000000 (black) and opacity value: ff (opaque)
  • 00000000 (transparent)
    color code: 000000 and opacity value: 00 (transparent)

orbittour_uid

Set it to unique value if you’d like to have the same ORBITTOUR embedded multiple times on the single page. This will cause that both ORBITTOUR container element id and ORBITTOUR inject function (JavaScript) will have unique names across the page.

Default: unique ORBITVU SUN presentation uid

Example: myuid_1

orbittour_container_id

You can explicitly set id of the ORBITTOUR container element

Default: orbittour-<orbittour_uid>

preferred_language

You can force ORBITTOUR to use specific language (if only ORBITTOUR has translations for this  language)

Default: not set - language will be automatically chosen according to browser language preference

Value: language code from the list of available ORBITTOUR translations, e.g. en, de

orbittour_width

ORBITTOUR tries to automatically calculate its size according to the container dimensions but in some cases, it might be required to explicitly set width and height. For example, if ORBITTOUR is initialized inside a hidden container (with display: none) then it will not be possible to calculate proper dimensions.

Default: not set - calculated automatically

orbittour_height

ORBITTOUR tries to automatically calculate its size according to the container dimensions but in some cases, it might be required to explicitly set width and height. For example, if ORBITTOUR is initialized inside a hidden container (with display: none) then it will not be possible to calculate proper dimensions.

Default: not set - calculated automatically

orbittour_delayed

By default, ORBITTOUR will be immediately injected into your web page, but if you want to inject it later, then you can block immediate injection using orbittour_delayed parameter and then call inject function programmatically when needed. The function that injects ORBITTOUR is:

inject_orbittour_(<orbittour_id>)

Values: yes | no

Default: no

orbittour_style

Change style used by ORBITTOUR:

Values: default | right_views | noviews

Default: uses value set for ORBITTOUR at ORBITVU SUN

custom_viewer

If you have your own VIEWER license, e.g. for a customised VIEWER look, then you can use it with ORBITVU SUN. You have to visit your Orbitvu SUN account preferences and upload your custom VIEWER (zip archive). From then you can add custom_viewer=yes to embed codes to use your copy of ORBITVU VIEWER.

Values: yes | no

Default: no

exernal_init

Name of the globally available JavaScript function that will be called after ORBITTOUR is initialized. The function will be passed API object that provides some ORBITTOUR manipulation methods, e.g.:

<script type="text/javascript">
  var orbittour_api = null;
  window['my_orbit_init'] = function(orbit_api){
      orbittour_api = orbit_api;
  }

  // (...)
  function call_on_dynamic_resize(){
      if (orbittour_api){
          orbittour_api.handle_resize();
      }
  }
</script>

The method name is passed like:

<div id="orbittour-hhyoAwhnuh2NQLgNfpdRYk" class="orbittour-container"></div>
<script type="text/javascript" src="//orbitvu.co/001/hhyoAwhnuh2NQLgNfpdRYk/2/orbittour/523/script?external_init=my_orbit_init"></script>

play_type

If set to the value other than none will cause play/pause button to be shown. When pressed, ORBITTOUR will start animating between subsequent views or hotspots (depending on play_type value). Note that if there are no views or hotspots then play button will not be shown.

Values: none | views | hotspots

Default: no

play_time

How long to wait between moving to next view or hotspot (in milliseconds) when animation is played (play_type is set to views or hotspots)

Values: 2500 | 3000 | 3500 | 4000 | 4500 | 5000 | 7500 | 10000

Default: 2500

play_auto

Enable autoplay of ORBITTOUR (if play_type is not set to none). Playing will start 1 second after presentation is loaded

Values: yes | no

Default: no