AVFlashVR - AVPano  3.0
Documentation for all parameters of AVFlashVR (Standalone version or AVPano for Joomla!)
 All Variables
List of parameters

Variable Documentation

Show / hide this object.

Usage: active: "true",

Values: true, false.

Note:
If a "true/false" parameter is commented (// before the line) this is equivalent to "false".

Alignement.

Usage: align: "tr", (or align: "3dtr",)

These values allow to place the object (button, text, image, background) in a 2D space

Values:

  • "tl" = top left
  • "t" = top
  • "tr" = top right
  • "l" = left
  • "c" = center
  • "r" = right
  • "bl" = bottom left
  • "b" = bottom
  • "br" = bottom right



Optional values for hotspots 3D
These values allow to place the button of hotspot in a 3D space and others elements (text, image, background) in 2D.

Values:

  • "3dtl" = 3D space for button, and top left for text ans image.
  • "3dt" = 3D space for button, and top for text ans image.
  • "3dtr" = 3D space for button, and top right for text ans image.
  • "3dl" = 3D space for button, and left for text ans image.
  • "3dc" = 3D space for button, and center for text ans image.
  • "3dr" = 3D space for button, and right for text ans image.
  • "3dbl" = 3D space for button, and bottom left for text ans image.
  • "3db" = 3D space for button, and bottom for text ans image.
  • "3dbr" = 3D space for button, and bottom right for text ans image.
  • "3d" = 3D space for all.

Define color for background.

Usage: backgroundColor: "#000000",

Values: hexadecimal color code with or without '#'.

Background shadow size.

Usage: backgroundShadow: "3",

Values: 0 to 20 (px).

Image file.

Usage: image: "images/avlogo.png",

Values: "image_path/image_file.jpg" "<replaceByPanoImage>" (Dynamic replace option, which allows different image for each pano)

Note:
Allowed files:
  • .jpg,
  • .png (transparent),
  • .gif(animated),
  • .swf

Show this object before other (during load).

Usage: loadAtStep: "4",

Values: 0 to 6.

Note:
0 = before load pano, 1 to 6 = five loading steps.

Text for logo.

Comment the line (//) if you don't use.

Usage: logoText: "myLogo",

Values: text.

See also:
image if you prefer use an image for logo.

Horizontal distance between image and the edge (pixels).

The edge is defined in the parameter "align".

Usage: offsetX: "5",

Values: number beetween 0 to pano with (pixel).

Vertical distance between image and the edge (pixels).

The edge is defined in the parameter "align".

Usage: offsetY: "5",

Values: number beetween 0 to pano height (pixel).

Fonctions for onClick parameter

Action when this object is clicked.

Usage: onClick: "function:panoOpenMap",Values:

function:panoAutoDir        // (0) = left, (1) = right
function:stopAutoRun        
function:panoOpenMap        // Open GMap with pano cords (gMapLat, gMapLon)
function:toggleScroller
function:panoGoTo           // (p, t, f, s) Go to position (pan, tilt, fov, speed)
function:panoInit           // Return to initial position


Short Syntax fonctions for onClick parameter

List of onClick parameter Short Syntax.

Usage: onClick: "spot01",Values:

spotXX                      // (XX = spot number) Show/Hide text. Play/Pause sound. Show/Hide image (if no text)
toggle                      // toggle = (Click on image = Show/Hide text, Play/Pause sound, or hide image if don't exist text or sound)
panoXX                      // Load panoXX
showInfo
showPanoText                // Show the panoXX [text] in center text box with panoXX [textWidth] option.
http://...                  // Open this url in browser.
javascript:jsFunctionName() // Call external javascript in browser (now all is possible!).


Extra replace fonctions for onClick parameter.

Different action for each pano

Usage: onClick: "<replaceByPanoInfoUrl>",Values:

<replaceByPanoInfoUrl>
<replaceByPanoText>
<replaceByPanoImage>


Text align.

Usage: textAlign: "left",

Values: left, right.

Note:
Optional parameter to ajust text position in textFrame.

Text Alpha (Transparency).

Usage: textAlpha: "0.8",

Values: 0 to 1 (decimal value).

Text bold.

Usage: textBold: "false",

Values: true, false.

Note:
If a "true/false" parameter is commented (// before the line) this is equivalent to "false".

Define color for text.

Usage: textColor: "#ffffff",

Values: hexadecimal color code with or without '#'.

Text background Alpha (Transparency).

Usage: textFrameAlpha: "0.6",

Values: 0 to 1 (decimal value).

Note:
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Text background border size.

Usage: textFrameBorder: "6",

Values: 0 to x (px).

Note:
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Define color for text background border.

Usage: textFrameBorderColor: "#000000",

Values: hexadecimal color code with or without '#'.

Note:
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Define color for text background.

Usage: textFrameColor: "#000000",

Values: hexadecimal color code with or without '#'.

Note:
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Text background height.

Usage: textFrameHeight: "30",

Values: Number of pixel.

Note:
Optional parameter. The background is auto size if this value is null.
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Horizontal distance between background and the edge (pixels).

The edge is defined in the parameter "align".

Usage: textFrameOffsetX: "5",

Values: number beetween 0 to pano with (pixel).

Vertical distance between background and the edge (pixels).

The edge is defined in the parameter "align".

Usage: textFrameOffsetY: "5",

Values: number beetween 0 to pano height (pixel).

Text background Rounded.

Usage: textFrameRounded: "5",

Values: Radius for rounded border (pixel).

Note:
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Text background shadow size.

Usage: textFrameShadow: "6",

Values: 0 to 20 (px).

Note:
all parameters beginning with "textFrame.." may be abbreviated with "tf.." (eg: textFrameColor = tfColor) but we must respect the case of text.

Text background width.

Usage: textFrameWidth: "180",

Values: Number of pixel.

Note:
Optional parameter. The background is auto size if this value is null.

Text italic.

Usage: textItalic: "false",

Values: true, false.

Note:
If a "true/false" parameter is commented (// before the line) this is equivalent to "false".

Horizontal distance between text and the edge (pixels).

The edge is defined in the parameter "align".

Usage: textOffsetX: "0",

Values: number beetween 0 to pano width (pixel).

Vertical distance between text and the edge (pixels).

The edge is defined in the parameter "align".

Usage: textOffsetY: "0",

Values: number beetween 0 to pano height (pixel).

Text background height padding.

Usage: textPadHeight: "10",

Values: Number of pixel

Text background width padding.

Usage: textPadWidth: "10",

Values: Number of pixel

Shadow size.

Usage: textShadow: "6",

Values: 0 to 20 (px).

Text size.

Usage: textSize: "16",

Values: Number of pixel

Define color for transition mask.

Usage: transitionColor: "#5f5f5f",

Values: hexadecimal color code with or without '#'.

Note:
The color setting in panoXX can replace this color for each transition.

Define moving effect for transition.

Usage: transitionFx: "t",

Values:

  • l(eft)
  • r(ight)
  • b(ottom)
  • a(lpha)
  • s(cale)

Defines a texture for transition mask.

Usage: transitionTexture: "3",

Values:

  • 0 = No transition
  • 1 = Uniform color
  • 2 = Filled by preview image
  • 3 = Sky texture
  • 4 = Curtain texture
  • 5 = Marble texture
  • 6 to 60 = more 50 dynamic colors and textures effects.

Effect duration (second).

Usage: transitionTime: "2.4",

Values: number (seconds).

Tween effect transition for objects.

Usage: tweenEase: "l",

Values:

  • Linear (Default)
  • Bounce.easeOut
  • Elastic.easeOut
  • Quint.easeOut
  • Sine.easeOut
  • Quart.easeOut
  • Bounce.easeIn
  • Elastic.easeIn
  • Quint.easeIn
  • Sine.easeIn
  • Quart.easeIn

Tween effect direction for objects.

Usage: tweenFx: "left",

Values:

  • left
  • right
  • bottom
  • alpha
  • scale
  • rotx (rotation X axis)
  • roty (rotation Y axis)
  • rotz (rotation Z axis)