Using the panorama portlet

This document describes the using of the panorama portlet.

1. Install and add panorama portlet into your Liferay portal

Panorama portlet looks like this when you place it to your portal:

Place the panorama portlet

The image is missing the actual panorama because of screen capture.

2. Configure the panorama portlet

Configuring panorama portlet

Configuration options:

Identifier Range / Default Value Description
imageUrl URL
The current image's URL.

Setting a new value to this variable forces a load of a new panorama. The URL must point to a (possibly scrambled) GIF or JPG file.

initAutorot -N ... 0 ... +N
Number of seconds needed for a full circumscription of the panorama. A negative number specifies reverse direction.

Setting this variable to a non-zero value enables auto-rotation at the specified speed. Default is ON, with such an "auto-tour" reaching its starting point after 60 seconds again and continuing indefinitely.

Note that this is a machine independent parameter i.e., the number of frames displayed during a circumscription depends on the speed of the machine: But after the specified N seconds all machines will display the same view again.

initRenderQuality simple, bilinear The rendering quality which can be either bilinear (default) or simple.

The simple quality, which selects the "next neighbor" pixels, is much faster than bilinear rendering. However, pixel borders are clearly visible.

initRenderPanMode full, incremental The rendering mode when interactively panning through a panorama.

Incremental pan mode (default setting) means that the view is rendered in consequtively smaller blocks until a time limit is reached. This enables fast panning even on slow machines, at the price of reduced resolution. In full rendering mode each pixel is rendered before a next view is computed.

overlayUrl URL
URL of a (possibly scrambled) transparent GIF image.

This image enables arbitrary contours being overlayed to the panorama view. The overlay image is center aligned.

Set this variable to the empty string in order to disable the overlay.

splashUrl URL URL of a (possibly scrambled) GIF or JPEG image which will be displayed during the loading of the panorama image.

This value can only be set via the applet's parameter list and is used during applet initialization time only, center alignment.

splashBgcolor 000000 ... ffffff RGB value in hexadecimal notation of the applet's background color during the loading of the panorama image.

The background color is only visible if a splash image is specified that is smaller than the applet's size.

viewCaption String A string that is displayed in the status bar of the browser each time the mouse enters the applet window.
viewHfov 1.0 ... 179.9
Horizontal-field-of-view value, in degrees.

New values are subject to the limits defined in the viewLimitHfovMin/max variables and other constraints (e.g., pan limits or VFOV limits imposed by a cylindrical panorama) and will be automatically adjusted.

viewPan -180.0 ... +180.0
Pan (yaw) position of the current view, in degrees.

Pan values refer to the horizontal axis. Note that JsphereLite uses the mathematical coordinate system where pan values increase counter-clock wise. The same coordinate system is also used in Apple's Quicktime environment.

New values are subject to the limits defined in the view.limit.pan.min/max variables and will be automatically adjusted.

viewTilt -90.0 ... +90.0
Tilt (pitch) position of the current view, in degrees.

Tilt values refer to the vertical axis, zenith is +90 degrees, nadir is -90 degrees.

New values are subject to the limits defined in the view.limit.pan.min/max variables and will be automatically adjusted.

1.0 ... 179.9
Zoom limits, expressed for the horizontal-field-of-view, in degrees.
-180.0 ... +180.0
Border values of the allowed panning area, in degrees.

Setting both limits to the same value effectively disables pan limits.

The pan region can wrap around the +180/-180 degree position. Thus, it is perfectly valid to specify the following min/max pan limits: +160.0 / -160 which defines a 40 degree pan region.

Pan regions affect the way autorotation behaves: once one of the borders has been reached, the JsphereLite applet automatically reverses the sign of the init.autorot variable. The autorot tour then continues in the other direction, continuously sweeping the region from left to right and back.

-90.0 ... +90.0
Border values of the allowed tilting area, in degrees.

Setting both limits to the same value effectively disables tilt limits.

Note that cylindrical panoramas implicitely define tilt limits that can not be overriden.

Special rules apply for equitectangular panoramas. With tilt limits disabled (e.g., both variables set to 0.0), the view center is restricted to the -90...90 tilt range. With differing min/max values for tilt, these limits apply the view border, instead.

Width int Width of panorama in pixels.
Height int Height of panorama in pixels
Message String Message to show under panorama.


3. Interactive Commands


The mouse is used to change the viewing direction (panning). Click inside the applet and drag the mouse in order to change the direction and the speed of change. The center is the neutral zone: simply drag the mouse cursor towards one of the edges - the closer you get to the edge, the bigger will the change in viewing direction be. By pressing either the or key before clicking inside the applet you can zoom in or zoom out, respectively.


Panning can also be controlled by the cursor keys LEFT, RIGHT, UP and DOWN. Several other keys are
associated with actions too as is shown in the following table:

Key Action
Zoom in
Zoom out
Zero - reset viewing direction to initial value
Stop/Start - toggle auto-rotate action (= continuously panning through 360 degrees)


0 Attachments
Average (0 Votes)
The average rating is 0.0 stars out of 5.