Module:PanoLink

From PanoZona

Contents 1 Configuration structure 2 Configuration details 2.1 PanoLink 2.2 settings 2.3 window 2.4 close 3 Functions 3.1 setOpen 3.2 toggleOpen

Panlink works in two ways: First it interprets url of the site in which panorama is embeded, and if it is able to find variables determinig which panorama to show and what camera parameters to apply, overrides first panorama specified in configuration, and uses one found in url instead. Secondly it has window with textfiled that whenever opened contains url that points to given panorama and given view, which can be used by the same module.

Configuration structure

• PanoLink
  • settings
  • window
  • close

Configuration details

PanoLink

Attribute	Type	Sub-attribute	Type	Default	Values	Description
path	S	-		-	path to swf file	Mandatory attribute. Value points to module swf file.

settings

Attribute	Type	Sub-attribute	Type	Default	Values	Description
path	S	-		-	path to image	Bitmap grid that contains bitmaps for "copy" button.
minLength	N	-		200	-	Determines minimal text box length measured along with button size.
maxLength	N	-		600	-	Determines maximal text box length measured along with button size.
style	O	fontFamily	S	Tahoma	Tahoma, Verdana, Courier	Type of used font.
		fontBold	B	true	true, false	Weight of font.
		fontSize	N	15	-	Size of used font.
		fontColor	N	#FFFFFF	#000000 to #FFFFFF	Color of used font.
		backgroundColor	N	#000000	#000000 to #FFFFFF	Background of textbox

window

Attribute	Type	Sub-attribute	Type	Default	Values	Description
open	B	-		false	true, false	Determines visibility of module window on SaladoPlayer start.
alpha	N	-		1.0	0.1 to 1.0	Transparency of module window content.
align	O	horizontal	S	right	left, center, right	Horizontal alignment of module window against panorama window.
		vertical	S	top	top, middle, bottom	Vertical alignment of module window against panorama window.
margin	O	top	N	10	-	Minimal distance from module window and top border of panorama window.
		bottom	N	10	-	Minimal distance from module window and bottom border of panorama window.
		left	N	10	-	Minimal distance from module window and left border of panorama window.
		right	N	10	-	Minimal distance from module window and right border of panorama window.
transition	O	type	S	slideUp	fade, slideUp, slideDown, slideLeft, slideRight	Determines kind of transition used when module window is opening/closing.
openTween	O	transition	F	Linear.easeNone	avaible functions	Determines type of animation used when module window is opening.
		time	N	0.5	-	Duration in seconds of module window opening animation.
closeTween	O	transition	F	Linear.easeNone	avaible functions	Determines type of animation used when module window is closing.
		time	N	0.5	-	Duration in seconds of module window closing animation.
onOpen	S	-		-	action id	Action executed when module window changed state to closed.
onClose	S	-		-	action id	Action executed when module window changed state to opened.

close

Attribute	Type	Sub-attribute	Type	Default	Values	Description
path	S	-		-	path to image file	Image file that will be used as close button. If path is not set, close button will not be added.
align	O	horizontal	S	right	left, center, right	Horizontal alignment against module window.
		vertical	S	top	top, middle, bottom	Vertical alignment against module window.
move	O	horizontal	N	0	-	Number of pixels close button is moved horizontally.
		vertical	N	0	-	Number of pixels close button is moved vertically.

Functions

setOpen

Type	Description	Function description
B	Value assigned to open attribute.	Opens / closes map window on demand. Opening window once window is open makes no effect, same thing for closing window.

toggleOpen

Type	Description	Function description
-	-	Calling this function toggles map window open state. If called when window is opened it closes window, same thing other way around.