English German

Home • News • Examples • Flash 10 • Documentation • Tools • Plugins • Externals • Download • Purchase • Forum • Contact

Documentation

• Usage
• Embedding into HTML
• Panorama Formats
• XML Structure
• Actions / Scripting
• API Variables
• Controls
• Javascript Interface
• AS3 Interface / Plugins
• Fisheye Projection
• Architectural Projection
• Multiresolution Panoramas
• Local Access
• IIS Servers / MIME Type
• System Requirements

last update: 2008-08-16

API - Application Programming Interface

Table description:

• Variable - Variablename / XML tag / Attriubate name
• Access - Access to variable via "get" or "set" interface functions
  
  • read only - value can only be readed via get()
  • load only - value will be only parsed on loading, if you change it, you must call reloadpano(), reading via get() is allowed
  • update - value can be changed by set(), but needs a a special update call to get parsed, reading via get() is allowed
  • instant - value can be readed and written by get() and set(), changes will be intermediately active

XML to API
the XML tags are direct projected to the API variables:
e.g.:

<krpano>
    <image type="SPHERE" />
    ...

is the same as:

krpano.image.type="SHPERE"

NOTE: if you use interface functions to access the variable - the "krpano." prefix is not needed!
e.g. to get version - just use:

get(version)

and NOT:

get(krpano.version)

API Variables

Variable	Access	Default Value	Allowed Values / Description
krpano
krpano.version	read only	1.0
krpano.onstart	load only	-
krpano.image
krpano.image.type	load only	-	cube, cubestrip, sphere
krpano.image.tiled	load only	false	true, false
krpano.image.tilesize	load only	auto
krpano.image.tiledimagewidth	load only	-
krpano.image.tiledimageheight	load only	-
krpano.image.baseindex	load only	1
krpano.image.sphere.url	load only	-
krpano.image.cubestrip.url	load only	-
krpano.image.left.url	load only	-
krpano.image.left.strip	load only	1
krpano.image.left.rotate	load only	0
krpano.image.left.flip	load only	-
krpano.image.front.url	load only	-
krpano.image.front.strip	load only	2
krpano.image.front.rotate	load only	0
krpano.image.front.flip	load only	-
krpano.image.right.url	load only	-
krpano.image.right.strip	load only	3
krpano.image.right.rotate	load only	0
krpano.image.right.flip	load only	-
krpano.image.back.url	load only	-
krpano.image.back.strip	load only	4
krpano.image.back.rotate	load only	0
krpano.image.back.flip	load only	-
krpano.image.up.url	load only	-
krpano.image.up.strip	load only	5
krpano.image.up.rotate	load only	0
krpano.image.up.flip	load only	-
krpano.image.down.url	load only	-
krpano.image.down.strip	load only	6
krpano.image.down.rotate	load only	0
krpano.image.down.flip	load only	-
krpano.image.multires	load only	false	true, false
krpano.image.level
krpano.image.level.count	load only	0
krpano.image.level[]
krpano.image.level[].tiledimagewidth	load only	-
krpano.image.level[].tiledimageheight	load only	-
krpano.image.level[].download	load only	auto	auto, all, view
krpano.image.level[].decode	load only	auto	auto, all, view
krpano.image.level[].sphere.url	load only	-
krpano.image.level[].cubestrip.url	load only	-
krpano.image.level[].left.url	load only	-
krpano.image.level[].left.strip	load only	1
krpano.image.level[].left.rotate	load only	0
krpano.image.level[].left.flip	load only	-
krpano.image.level[].front.url	load only	-
krpano.image.level[].front.strip	load only	2
krpano.image.level[].front.rotate	load only	0
krpano.image.level[].front.flip	load only	-
krpano.image.level[].right.url	load only	-
krpano.image.level[].right.strip	load only	3
krpano.image.level[].right.rotate	load only	0
krpano.image.level[].right.flip	load only	-
krpano.image.level[].back.url	load only	-
krpano.image.level[].back.strip	load only	4
krpano.image.level[].back.rotate	load only	0
krpano.image.level[].back.flip	load only	-
krpano.image.level[].up.url	load only	-
krpano.image.level[].up.strip	load only	5
krpano.image.level[].up.rotate	load only	0
krpano.image.level[].up.flip	load only	-
krpano.image.level[].down.url	load only	-
krpano.image.level[].down.strip	load only	6
krpano.image.level[].down.rotate	load only	0
krpano.image.level[].down.flip	load only	-
krpano.preview
krpano.preview.type	load only	-	SPHERE, SPHERE(url), CUBESTRIP, CUBESTRIP(url), CUBESTRIP(url,order), GRID(...)
krpano.preview.url	load only	-
krpano.preview.striporder	load only	LFRBUD	left,front,right,back,up,down
krpano.preview.details	load only	9
krpano.progress
krpano.progress.showload	load only	bar()
krpano.progress.showwait	load only	loopings()
krpano.progress.loaddone	read only	-
krpano.progress.blenddone	read only	-
krpano.progress.previewdone	read only	-
krpano.progress.bytesloaded	read only	-
krpano.progress.bytestotal	read only	-
krpano.progress.filesloaded	read only	-
krpano.progress.filestotal	read only	-
krpano.progress.filesneeded	read only	-
krpano.progress.decodesneeded	read only	-
krpano.network
krpano.network.downloadqueues	load only	-
krpano.network.decodequeues	load only	-
krpano.memory
krpano.memory.maxmem	load only	350
krpano.security (Version 1.0.4 and higher)
krpano.security.crossdomainxml.url	load only	-
krpano.display
krpano.display.fps	load only	60
krpano.display.currentfps	read only	-
krpano.display.details	update	16
krpano.display.tessmode	update	5
krpano.display.movequality	instant	LOW
krpano.display.stillquality	instant	HIGH
krpano.display.currentquality	read only	-
krpano.display.stilltime	instant	0.2
krpano.display.showpolys	instant	false
krpano.view
krpano.view.hlookat	instant	0
krpano.view.vlookat	instant	0
krpano.view.camroll	instant	0
krpano.view.fov	instant	90
krpano.view.fovmin	instant	1
krpano.view.fovmax	instant	179
krpano.view.fovmax	instant	179
krpano.view.limitfov	instant	false	true or false
krpano.view.fisheye	instant	0.35
krpano.view.fisheyefovlink	instant	0.50
Version 1.0.3 and higher:
krpano.view.limitview	instant	auto	off, auto, range, lookat
krpano.view.hlookatmin	instant	-180
krpano.view.hlookatmax	instant	+180
krpano.view.vlookatmin	instant	-90
krpano.view.vlookatmax	instant	+90
krpano.control
krpano.control.usercontrol	instant	all	all, mouse, keyb
krpano.control.mousetype	instant	drag2d	drag2d, drag3d, moveto
krpano.control.mouseaccelerate	instant	1
krpano.control.mousespeed	instant	10
krpano.control.mousefriction	instant	0.8
krpano.control.mousefovchange	instant	1
krpano.control.keybaccelerate	instant	0.5	negatives values invert axises
krpano.control.keybspeed	instant	10
krpano.control.keybfriction	instant	0.9
krpano.control.keybfovchange	instant	1
krpano.control.keybinvert	instant	false	true, false - invert Y-axis
krpano.control.fovspeed	instant	3
krpano.control.fovfriction	instant	0.9
krpano.control.movetocursor	instant	-	-, vector, arrow
krpano.control.cursorsize	instant	10
krpano.autorotate (Version 1.0.4 and higher)
krpano.autorotate.enabled	instant	false	true or false
krpano.autorotate.waittime	instant	1.5	time in seconds to wait after last user-interaction
krpano.autorotate.accel	instant	1.0	moving acceleration in degrees/second²
krpano.autorotate.speed	instant	10.0	maximum moving speed in degrees/second
krpano.autorotate.horizon	instant	0.0	destination horizon ("off" or "-90" to "+90")
krpano.autorotate.tofov	instant	off	destination field of view ("off" or "0" to "180")
krpano.plugin
krpano.plugin.visible	instant	true
krpano.plugin.count	load only	0
krpano.plugin[]
krpano.plugin[].name	instant	-
krpano.plugin[].url	instant	-
krpano.plugin[].visible	instant	true
krpano.plugin[].zorder	instant	-
krpano.plugin[].alpha	instant	1
krpano.plugin[].blendmode	instant	normal
krpano.plugin[].autopos	instant	false
krpano.plugin[].autoscale	instant	false
krpano.plugin[].onhover	instant	-
krpano.plugin[].onout	instant	-
krpano.plugin[].onclick	instant	-
krpano.plugin[].ondown	instant	-
krpano.plugin[].onup	instant	-
krpano.hotspot
krpano.hotspot.count	load only	0
krpano.hotspot.visible	instant	true
krpano.hotspot[]
krpano.hotspot[].name	instant	-
krpano.hotspot[].visible	instant	true
krpano.hotspot[].fillcolor	instant	0xFFFFFF
krpano.hotspot[].fillcolorhover	instant	0xFFFFFF
krpano.hotspot[].fillalpha	instant	0.0
krpano.hotspot[].fillalphahover	instant	0.1
krpano.hotspot[].borderwidth	instant	0
krpano.hotspot[].borderwidthhover	instant	4
krpano.hotspot[].bordercolor	instant	0xFFFFFF
krpano.hotspot[].bordercolorhover	instant	0xFFFFFF
krpano.hotspot[].borderalpha	instant	0.0
krpano.hotspot[].borderalphahover	instant	0.8
krpano.hotspot[].fadeintime	instant	0.15
krpano.hotspot[].fadeincurve	instant	1.10
krpano.hotspot[].fadeouttime	instant	0.30
krpano.hotspot[].fadeoutcurve	instant	0.70
krpano.hotspot[].onclick	instant	-
krpano.hotspot[].onhover	instant	-
krpano.hotspot[].point.count	load only	0
krpano.hotspot[].point[]
krpano.hotspot[].point[].ath	instant	-
krpano.hotspot[].point[].atv	instant	-
krpano.lensflareset
krpano.lensflareset.count	load only	0
krpano.lensflareset[]
krpano.lensflareset[].name	load only	-
krpano.lensflareset[].url	load only	-
krpano.lensflareset[].flare.count	load only	0
krpano.lensflareset[].flare[]
krpano.lensflareset[].flare[].pixsize	load only	-
krpano.lensflareset[].flare[].pixupos	load only	-
krpano.lensflareset[].flare[].pixvpos	load only	-
krpano.lensflareset[].flare[].color	load only	0xFFFFFF
krpano.lensflareset[].flare[].pos	load only	-
krpano.lensflareset[].flare[].scale	load only	1
krpano.lensflare
krpano.lensflare.visible	update	true
krpano.lensflare.count	update	0
krpano.lensflare[]
krpano.lensflare[].set	update	DEFAULT
krpano.lensflare[].visible	update	true
krpano.lensflare[].ath	update	-
krpano.lensflare[].atv	update	-
krpano.lensflare[].size	update	0.80
krpano.lensflare[].blind	update	0.60
krpano.lensflare[].blindcurve	update	4.00