Viewer API


Manual Spin

Allows a user to manually spin the product

Allowed arguments: true, false

API Example: viewer.manual_spin(false)

URL Example: http://embed.imajize.com/8rLM5DRyKik?manual_spin=false

→ Preview


Allowed arguments: "drag”, "hover”

API Example: viewer.manual_spin_interaction("hover")

URL Example: http://embed.imajize.com/8rLM5DRyKik?manual_spin_interaction=hover

→ Preview

Manual Spin Interaction

Changes how the user can spin the 360 viewer.

Users can either click and drag spin or simply hover their cursor over the 360 viewer


Allowed arguments: 1.0..5.0

API Example: viewer.manual_spin_sensitivity(1.9)

URL Example: http://embed.imajize.com/8rLM5DRyKik?manual_spin_sensitivity=1.9

→ Preview

Manual Spin Sensitivity

Changes how quickly the viewer spins


Allowed arguments: 1..5

API Example: viewer.manual_spin_inertia(3)

URL Example: http://embed.imajize.com/8rLM5DRyKik?manual_spin_inertia=3

→ Preview

Manual Spin Inertia

Changes how quickly the viewer slows to a stop after a spin


Allowed arguments: true, false

API Example: viewer.zoom(true)

URL Example: http://embed.imajize.com/8rLM5DRyKik?zoom=true

→ Preview

Zoom

Allows users to zoom into image


Allowed arguments: 2..5

API Example: viewer.zoom_ratio(4)

URL Example: http://embed.imajize.com/8rLM5DRyKik?zoom_ratio=4

→ Preview

Zoom Magnification

Set how deep the zoom goes


Allowed arguments: 1..1000

API Example: viewer.zoom_speed(80)

URL Example: http://embed.imajize.com/8rLM5DRyKik?zoom_speed=80

→ Preview

Zoom Animation Speed

Control the speed of the zoom animation


Allowed arguments: true, false

API Example: viewer.auto_spin(true)

URL Example: http://embed.imajize.com/8rLM5DRyKik?auto_spin=true

→ Preview

Auto Spin

Allows viewer spin automatically on start-up


Allowed arguments: 0..n (or "inifinite” for the viewer to keep spinning)

API Example: viewer.auto_spin_count("infinite")

URL Example: http://embed.imajize.com/8rLM5DRyKik?auto_spin_count=infinite

→ Preview

Number of Auto Spins

Control the number of automatic spins


Allowed arguments: 1..1000

API Example: viewer.auto_spin_speed(50)

URL Example: http://embed.imajize.com/8rLM5DRyKik?auto_spin_speed=50

→ Preview

Speed of Auto Spins

Control the speed of the automatic spin


Allowed arguments: true, false

API Example: viewer.fullscreen(true)

URL Example: http://embed.imajize.com/8rLM5DRyKik?fullscreen=true

→ Preview

Full Screen Mode

Allow a full screen mode by using icon on top right of the screen


Allowed arguments: "a", "b", "c"

API Example: viewer.fullscreen_icon_variant("b")

URL Example: http://embed.imajize.com/8rLM5DRyKik?fullscreen_icon_variant=b

→ Preview

Full Screen Icon

Change the different styles of the full screen icon


Allowed arguments: 4..18

API Example: viewer.fullscreen_icon_size(10)

URL Example: http://embed.imajize.com/8rLM5DRyKik?fullscreen_icon_size=10

→ Preview

Full Screen Icon Size

Change the size of the full screen icon


Allowed arguments: any hex color (or "transparent” for PNG based 360 views)

API Example: viewer.background_color("ffffff")

URL Example: http://embed.imajize.com/8rLM5DRyKik?background_color=ffffff

→ Preview

Viewer Background Color

Change the background color of the viewer


Allowed arguments: 1..max_image

API Example: viewer.key_image(10)

URL Example: http://embed.imajize.com/8rLM5DRyKik?key_image=10

→ Preview

Starting Frame

Change the frame that viewers see when the product first loads


Allowed arguments: "en", "ru", "zh", "fr", "th", "de", "bg", "uk", "es", "vi", "ja", "sk", "tr", "it", "no", "fi", "el", "pt", "cs", "sv", "pl", "hu", "sr", "nl", "da", "id", "he", "ro", "ms", "ar", "ko"

API Example: viewer.instruction_language("th")

URL Example: http://embed.imajize.com/8rLM5DRyKik?instruction_language=th

→ Preview

Instruction Language

Change language of the instructions strip


Allowed arguments: "top", "middle", "bottom"

API Example: viewer.instruction_position("top")

URL Example: http://embed.imajize.com/8rLM5DRyKik?instruction_position=top

→ Preview

Instruction Display Position

Change where the instruction is located


Allowed arguments: "never", "once", "always"

API Example: viewer.instruction_display("once")

URL Example: http://embed.imajize.com/8rLM5DRyKik?instruction_display=once

→ Preview

Instruction Display

Allows instruction to never, once, or always be displayed


Allowed arguments: "a", "b", "c"

API Example: viewer.instruction_background("c")

URL Example: http://embed.imajize.com/8rLM5DRyKik?instruction_background=c

→ Preview

Instruction Style

Change the design of the instruction message


Allowed arguments: true, false

API Example: viewer.reverse_spin(true)

URL Example: http://embed.imajize.com/8rLM5DRyKik?reverse_spin=true

→ Preview

Manual Spin Direction

Allows you control which direction the viewer spins. Recommended to go with the direction of the cursor


Allowed arguments: true, false

API Example: viewer.reverse_thumbs(false)

URL Example: http://embed.imajize.com/8rLM5DRyKik?reverse_thumbs=false

→ Preview

Thumbnail Order

Reverse the order in which the still images in the thumbnails are displayed


Allowed arguments: any hex color

API Example: viewer.dock_background_color("aaaaaa")

URL Example: http://embed.imajize.com/8rLM5DRyKik?dock_background_color=aaaaaa

→ Preview

Thumbnail Dock Background Color

Allows adjustments of the dock’s background color


Allowed arguments: 0..100

API Example: viewer.dock_background_gradient(50)

URL Example: http://embed.imajize.com/8rLM5DRyKik?dock_background_gradient=50

→ Preview

Thumbnail Dock Gradient

Fine tune gradient of the dock


Allowed arguments: 0..100

API Example: viewer.dock_thumbs_border_radius(10)

URL Example: http://embed.imajize.com/8rLM5DRyKik?dock_thumbs_border_radius=10

→ Preview

Thumbnail Rounded Corners

Adds rounded corners to thumbnails