My account
Shopping cart
Knowledge base
Support


JC Panorama Properties



Overview | Properties | Methods | Events | Hotspots | Editor

Most of these properties can be set in the Component Inspector (Alt + F7), also can be set from XML, using the xmlPath optional parameter.

Property Type
Component Inspector
Description
autoPlay Boolean
yes
A boolean value that specifies whether the panorama will start playing after it is initialized.

Default:
false

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.keyboardControl = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
content Array
yes
The list of references to the loaded content. The content could be images or external .swf files. In case of .swf files, the references point to the root of the files. The number of items in the list can range from 1 (in case of cylindrical panoramas) to 6 (in case of cubical panoramas).

Example:
import com.jumpeye.Events.JCPanoramaViewerEvents;

var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.keyboardControl = true;
addChild(myPanorama);

myPanorama.xmlPath = "panoramaData.xml";
myPanorama.addEventListener( JCPanoramaViewerEvents.INIT, panoramaInitialized);

function panoramaInitialized(evt: JCPanoramaViewerEvents):void {
   trace(evt.target.content[0]); // [object BitmapData]
}
direction String
yes
Specifies in which direction the panorama plays (if autoPlay is set to true). Possible values are left and right.

Default:
right

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.keyboardControl = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
keyboardControl Boolean
yes
A boolean value that specifies whether the panorama can be controlled using the keyboard (arrow keys) to move the camera up, down, left and right.

Default:
false

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.keyboardControl = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
lockPan Boolean
yes
A boolean value which specifies whether the camera is allowed to pan or not. If panning is allowed, the camera can rotate around its vertical axis (pan) in 360 degrees, without stopping at the leftmost and the rightmost edge of the panorama. The camera rotates left and right without being blocked at the left or right ends. It is similar to the lockTilt property which allows the camera to rotate up and down.

Default:
false

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.lockPan = false;
myPanorama.lockTilt = false;
myPanorama.mouseAction = "DragDirect";
myPanorama.mouseControl = true;
myPanorama.speed = 4;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
lockTilt Boolean
no
A boolean value which specifies whether the camera is allowed to tilt or not. If tilting is allowed, the camera can rotate around its horizontal axis (tilt) in 360 degrees without stopping at the top or the bottom of the panorama. The camera rotates upwards and downwards without being blocked at the top or bottom. It is similar to the lockPan property which allows the camera to rotate left and right.

Default:
true

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.lockPan = false;
myPanorama.lockTilt = false;
myPanorama.mouseAction = "DragDirect";
myPanorama.mouseControl = true;
myPanorama.speed = 4;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
mouseAction String
yes
Specifies how mouse movement controls the movement of the panorama. When the mouse pointer rolls over the panorama, it starts controlling it as mentioned bellow:

  • MoveDirect - the panorama moves on the same direction and in the same way as the mouse does and it rotates with a speed which is directly proportional to the distance between the point where the mouse changes direction and the point where the current location of the mouse is.

  • MoveReverse - the panorama moves on the same direction but in the opposite way as the mouse does and it rotates with a speed which is directly proportional to the distance between the point where the mouse changes direction and the point where the current location of the mouse is.

  • PressDirect - the mouse controls the panorama only after the mouse button has been pressed over the panorama: the panorama moves on the same direction and in the same way as the mouse does and it rotates with a speed which is directly proportional to the distance between the point where the mouse changes direction and the point where the current location of the mouse is.

  • PressReverse - the mouse controls the panorama only after the mouse button has been pressed over the panorama: the panorama moves on the same direction but in the opposite way as the mouse does and it rotates with a speed which is directly proportional to the distance between the point where the mouse changes direction and the point where the current location of the mouse is.

  • MoveRelativeToMiddleDirect - the mouse controls the movement of the panorama relative to the middle of the panorama: the panorama moves on the same direction and in the same way as the mouse does.

  • MoveRelativeToMiddleReverse - the mouse controls the movement of the panorama relative to the middle of the panorama: the panorama moves on the same direction and in the opposite way as the mouse does.

  • PressRelativeToMiddleDirect - the mouse controls the panorama only after the mouse button has been pressed over the panorama and relative to the middle of the panorama: the panorama moves on the same direction and in the same way as the mouse does.

  • PressRelativeToMiddleReverse - the mouse controls the panorama only after the mouse button has been pressed over the panorama and relative to the middle of the panorama: the panorama moves on the same direction and in the opposite way as the mouse does.

  • MoveRelativeToPressPoint - the mouse controls the panorama only after the mouse button has been pressed over the panorama and the panorama rotates relative to the point where the the button has been pressed on the same direction and in the same way.

  • DragDirect - the panorama moves as it is being dragged by the mouse. The panorama moves in the same direction as the mouse.

  • DragReverse - the panorama moves as it is being dragged by the mouse. The panorama moves in the same direction as the mouse.

Default:
Move_Relative_To_PressPoint

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.lockPan = false;
myPanorama.lockTilt = false;
myPanorama.mouseAction = "DragDirect";
myPanorama.mouseControl = true;
myPanorama.speed = 4;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
mouseControl Boolean
yes
A boolean value that specifies whether the panorama can be controlled by mouse movement or not.

Default:
true

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.mouseAction = "DragDirect";
myPanorama.mouseControl = true;
myPanorama.speed = 4;
myPanorama.motionSpeed = 3;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
motionSpeed Number
yes
Specifies the speed of the panorama's rotation when it is no longer controlled by mouse or keyboard actions. This speed is applied after the mouse is released or after an arrow key has been pressed. During the mouse or keyboard control, the panorama moves with a speed specified by the speed property. As soon as the user releases the mouse or the arrow key, the motionSpeed property is applied until the panorama slows down and stops.

Default:
2

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.mouseAction = "DragDirect";
myPanorama.mouseControl = true;
myPanorama.speed = 4;
myPanorama.motionSpeed = 3;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
pan Number
yes
Specifies by how many degrees (0 359) will the panorama initially be rotated on the horizontal direction (around its vertical axis).

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.pan = 45;
myPanorama.tilt = 45;
myPanorama.zoom = 50;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
quality Number
yes
The number of triangles used to display the content. The quality of the panorama itself depends on this setting. For higher settings, the panorama will display bent and rounded content with more fidelity. But this setting also affects the movement of the panorama: the higher the quality setting, the more CPU intensive the panorama will be. Values range from 1 to 10.

Default:
2

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.quality = 5;
myPanorama.smooth = true;
myPanorama.staticSmooth = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
smooth Boolean
no
A boolean value which specifies if the panorama will apply smoothing to the content during each rendering (during movement too).

Default:
false

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.quality = 5;
myPanorama.smooth = true;
myPanorama.staticSmooth = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
speed Number
yes
Specifies the speed at which the panorama will rotate during mouse or keyboard control and when the panorama is rotating automatically (autoPlay is set to true).

Default:
2

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.mouseAction = "DragDirect";
myPanorama.mouseControl = true;
myPanorama.speed = 4;
myPanorama.motionSpeed = 3;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
staticSmooth Boolean
no
A boolean value which specifies whether the panorama applies smoothing on the content, when it is no longer moving.

Default:
true

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.quality = 5;
myPanorama.smooth = true;
myPanorama.staticSmooth = false;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
tilt Number
yes
Specifies by how many degrees (0 359) will the panorama initially be rotated on the vertical direction (around its horizontal axis).

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.pan = 45;
myPanorama.tilt = 45;
myPanorama.zoom = 50;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
transitionType String
no
The type of transition between two XML contents assigned to the panorama. When a new XML is set either by setting the xmlPath to a new .xml file or setting the xml property to a new XML object, there's a transition taking place between the two panoramas. Possible values are zoom and alpha.

Default:
zoom

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.transitionType = "alpha";
myPanorama.transitionDuration = 2;
myPanorama.useEmbedPreloader = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
transitionDuration Number
no
The duration of the transition between two panoramas.

Default:
1

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.transitionType = "alpha";
myPanorama.transitionDuration = 2;
myPanorama.useEmbedPreloader = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
useEmbedPreloader Boolean
no
[only available for the full version] A boolean value that specifies whether the component should display an internal preloader while the panorama content is loaded.

Default:
true

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.transitionType = "alpha";
myPanorama.transitionDuration = 2;
myPanorama.useEmbedPreloader = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
useToolTips Boolean
no
A boolean value which specifies whether the panorama should display a tool tip with information on the hotspot, when the mouse rolls over hotspots.

Default:
true

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.useToolTips = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
xml XML
no
The XML data containing all the necessary data of the panorama. If the xml property is changed to another XML object, the new panorama will be displayed using a transition specified at transitionType.

Please note that if the component's source XML data contains property settings too then those settings have priority over the ones made previously from the Component Inspector or by ActionScript code. If you wish to overwrite the settings from the XML data, please set those properties again using ActionScript code, after the XML data has been processed (listen for the XML_LOAD_COMPLETE event).

Example:
import flash.net.URLLoader;
import flash.net.URLRequest;

var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.transitionType = "alpha";
myPanorama.useToolTips = true;
addChild(myPanorama);

var panoXML:XML = new XML();
panoXML.ignoreWhitespace = true;
var request:URLRequest = new URLRequest("panoramaData.xml");
var ldr:URLLoader = new URLLoader();
ldr.addEventListener(Event.COMPLETE, dataLoaded);
ldr.load(request);

function dataLoaded(evt:Event):void {
   panoXML = XML(ldr.data);
   myPanorama.xml = panoXML;
}
xmlPath String
yes
The path and file name of the .xml file containing all the necessary data of the panorama. If another .xml file is set, the new panorama will be displayed using a transition specified at transitionType.

Please note that if the component's source XML data contains property settings too then those settings have priority over the ones made previously from the Component Inspector or by ActionScript code. If you wish to overwrite the settings from the XML data, please set those properties again using ActionScript code, after the XML data has been processed (listen for the XML_LOAD_COMPLETE event).

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.autoPlay = true;
myPanorama.direction = "left";
myPanorama.useEmbedPreloader = true;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";
zoom Number
yes
The horizontal viewing angle under which the panorama is visible. This horizontal angle sets the viewable area of the images in the panorama. A large viewing angle means that a larger area of the panorama is visible, which means practically that the panorama is zoomed out. A smaller viewing angle means zooming in.

Default:
70

Example:
var myPanorama:JCPanoramaViewer = new JCPanoramaViewer();
myPanorama.width = 500;
myPanorama.height = 300;
myPanorama.pan = 45;
myPanorama.tilt = 45;
myPanorama.zoom = 50;
addChild(myPanorama);
myPanorama.xmlPath = "panoramaData.xml";

Overview | Properties | Methods | Events | Hotspots | Editor

The pack includes the .mxp install file, the AIR virtual tour creator and panorama editing software and the documentation files.
Planar, cylindrical, spherical and cubic panorama types
Virtual tours
User-friendly editor interface
Transitions
Hotspots
The free version contains limitations and displays a watermark. This version can be used for trial purposes.
Planar and cylindrical panorama types only
Watermarked