Module:ImageGallery

From PanoZona

Contents 1 Configuration structure 2 Configuration details 2.1 ImageGallery 2.2 window 2.3 close 2.4 viewer 2.5 group 2.6 image 3 Functions 3.1 setOpen 3.2 toggleOpen 3.3 setGroup

ImageGallery is simple module for browsing groups of images inside panorama window.

Configuration structure

• ImageGallery
  • window
  • close
  • viewer
  • groups
    • group
      • image

Configuration details

ImageGallery

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

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.
minSize	O	width	N	300	-	Minimal width of module window.
		height	N	200	-	Minimal height of module window.
maxSize	O	width	N	800	-	Maximal width of module window.
		height	N	600	-	Maximal height of module window.
align	O	horizontal	S	center	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	50	-	Minimal distance from module window and top border of panorama window.
		bottom	N	50	-	Minimal distance from module window and bottom border of panorama window.
		left	N	50	-	Minimal distance from module window and left border of panorama window.
		right	N	50	-	Minimal distance from module window and right border of panorama window.
transition	O	type	S	slideRight	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 swf file	Mandatory attribute. Value points to image used as close button.
align	O	horizontal	S	right	left, center, right	Horizontal alignment of close button against module window.
		vertical	S	top	top, middle, bottom	Vertical alignment of close button 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.

viewer

Attribute	Type	Sub-attribute	Type	Default	Values	Description
path	S	-		-	path to image file	Mandatory attribute. Points to image file that will be used as bitmaps for navigation.
spacing	N	-		0	-	Determines spacing between buttons used for selecting image in a group.
padding	N	-		20	-	Distance between image and inner module window border.
throbber	S	-		-	path to gif file	Path to animated gif file that is used as throbbe that indicates that new image is being loaded.
style	O	color	N	#000000	#000000 to #FFFFFF	Color of module window background.
		alpha	N	1	0.1 to 1.0	Transparency of module window background.

group

Attribute	Type	Sub-attribute	Type	Default	Values	Description
id	S	-		-	-	Mandatory attribute. Must be unique among other group nodes.

image

Attribute	Type	Sub-attribute	Type	Default	Values	Description
path	S	-		-	path to image file	Mandatory attribute. Path to displayed image, it also should work with swf file.

Functions

setOpen

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

toggleOpen

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

setGroup

Type	Description	Function description
S	group id	Makes module display group of given id.