close panorama

krpano Quick Reference Version 1.0.8.12

Startup Variables

pano / xml
license

Startup & Loading 'shortcut' Variables

sphere image.sphere.url
cylinder image.cylinder.url
mov image.qtvr.url
qtvr image.qtvr.url
zoomify image.zoomify.url
zoomifytype image.zoomify.type
hfov image.hfov
vfov image.vfov
cubestrip image.cubestrip.url
order cubestrip strip order string (e.g. "LFRBUD")
left image.left.url
front image.front.url
right image.right.url
back image.back.url
up image.up.url
down image.down.url

XML Variables Reference

version String e.g. "1.0.8.12"
build String e.g. "2010-10-25"
xmlversion String e.g. "1.0.8"
haveexternalinterface Boolean
showerrors Boolean true
lasterror String
colorcorrection String "default"
bgcolor String
stagewidth int
stageheight int
mouse.x Number
mouse.y Number
mouse.stagex Number
mouse.stagey Number
fullscreen Boolean false
keycode int
wheeldelta int
hlookat_moveforce Number 0.0 (old name: movevectorx)
vlookat_moveforce Number 0.0 (old name: movevectory)
fov_moveforce Number 0.0 (old name: movevectorz)
actionintervalbase String "timer"
idletime Number 0.5
timertick int
random Number
multireslevel int 0
lockmultireslevel String "-1"
downloadlockedlevel Boolean false
isphone Boolean read only
ispad Boolean read only
isandroid Boolean read only
ishtml5 Boolean read only
isflash Boolean read only
 
xml.url String
xml.content String
xml.scene String
 
area.x String "0%"
area.y String "0%"
area.width String "100%"
area.height String "100%"
area.pixelx int read only
area.pixely int read only
area.pixelwidth int read only
area.pixelheight int read only
 
display.fps Number 60.0
display.currentfps Number
display.flash10 String "on"
display.details int 16
display.tessmode int -1
display.movequality String "LOW"
display.stillquality String "HIGH"
display.movequality10 String "HIGH"
display.stillquality10 String "HIGH"
display.stilltime Number "0.25"
display.showpolys Boolean "false"
 
view.hlookat Number 0.0
view.vlookat Number 0.0
view.camroll Number 0.0
view.fov Number 90.0
view.fovtype String "VFOV"
view.fovmin Number 1.0
view.fovmax Number 179.0
view.vfov Number read only
view.hfov Number read only
view.maxpixelzoom Number NaN
view.limitfov Boolean true
view.fisheye Number 0.0
view.fisheyefovlink Number 1.5
view.stereographic Boolean false
view.pannini Boolean false
view.architectural Number 0.0
view.architecturalonlymiddleBoolean false
view.limitview String "auto"
view.hlookatmin Number NaN
view.hlookatmax Number NaN
view.vlookatmin Number NaN
view.vlookatmax Number NaN
 
control.usercontrol String "all"
control.mousetype String "moveto"
control.mouseaccelerate Number 1.0
control.mousespeed Number 10.0
control.mousefriction Number 0.8
control.mousefovchange Number 1.0
control.keybaccelerate Number 0.5
control.keybspeed Number 10.0
control.keybfriction Number 0.9
control.keybfovchange Number 0.75
control.keybinvert Boolean false
control.fovspeed Number 3.0
control.fovfriction Number 0.9
control.movetocursor String "none"
control.cursorsize Number 10.0
control.headswing Number 0.0
control.keycodesleft String "37"
control.keycodesright String "39"
control.keycodesup String "38"
control.keycodesdown String "40"
control.keycodesin String "16,65,107"
control.keycodesout String "17,89,90,109"
control.zoomtocursor Boolean false
control.zoomoutcursor Boolean true
control.touchfriction Number 0.87
control.trackpadzoom Boolean true
 
cursors.url String
cursors.type String "8way"
cursors.move String
cursors.drag String
cursors.arrow_l String
cursors.arrow_lu String
cursors.arrow_ld String
cursors.arrow_r String
cursors.arrow_ru String
cursors.arrow_rd String
cursors.arrow_u String
cursors.arrow_d String
 
autorotate.enabled Boolean false
autorotate.waittime Number 1.5
autorotate.accel Number 1.0
autorotate.speed Number 10.0
autorotate.horizon Number 0.0
autorotate.tofov Number NaN
 
progress.showload String "bar()"
progress.showwait String "loopings()"
progress.showreloadsBoolean false
 
progress.progress Number 0.0 read only
progress.isloading Boolean false read only
progress.loaddone Boolean false read only
progress.blenddone Boolean false read only
progress.isblending Boolean false read only
progress.previewdoneBoolean false read only
progress.bytesloadedNumber 0.0 read only
progress.bytestotal Number 0.0 read only
 
preview.type String
preview.url String
preview.striporderString "LFRBUD"
preview.details int 8
 
image.type String
image.tiled Boolean false
image.baseindex int 1
image.tilesize int
image.tiledimagewidth int
image.tiledimageheight int
image.prealign String
image.hfov Number
image.vfov Number
image.voffset Number
image.multires Boolean false
image.multiresthreshold Number 0.025
image.progressive Boolean true
image.frame int 1
image.frames int 1
image.layer Sprite AS3 usage only
image.sphere.url String
image.cylinder.url String
image.qtvr.url String
image.qtvr.preview Boolean true
image.qtvr.setview Boolean true
image.zoomify.url String
image.zoomify.type String "SPHERE"
image.zoomify.setview Boolean true
image.cubestrip.url String
image.left.url String
image.left.strip int 1
image.left.rotate int 0
image.left.flip String
image.front.url String
image.front.strip int 2
image.front.rotate int 0
image.front.flip String
image.right.url String
image.right.strip int 3
image.right.rotate int 0
image.right.flip String
image.back.url String
image.back.strip int 4
image.back.rotate int 0
image.back.flip String
image.up.url String
image.up.strip int 5
image.up.rotate int 0
image.up.flip String
image.down.url String
image.down.strip int 6
image.down.rotate int 0
image.down.flip String
image.level.count int 0 read only
image.level[...].tiledimagewidth int
image.level[...].tiledimageheight int
image.level[...].download String "auto"
image.level[...].decode String "auto"
image.level[...].details int
image.level[...].aspreview Boolean false
image.level[...].sphere.url String
image.level[...].cylinder.url String
image.level[...].left.url String
image.level[...].front.url String
image.level[...].right.url String
image.level[...].back.url String
image.level[...].up.url String
image.level[...].down.url String
 
events.onenterfullscreen Action Event
events.onexitfullscreen Action Event
events.onxmlcomplete Action Event
events.onpreviewcomplete Action Event
events.onloadcomplete Action Event
events.onloaderror Action Event
events.onkeydown Action Event
events.onkeyup Action Event
events.onviewchange Action Event
events.onclick Action Event
events.onmousedown Action Event
events.onmouseup Action Event
events.onmousewheel Action Event
events.onidle Action Event
events.onresize Action Event
 
security.crossdomainxml.count int 0
security.crossdomainxml[...].url String
security.allowdomain.count int 0
security.allowdomain[...].domain String
 
contextmenu.fullscreen Boolean true
contextmenu.enterfs String "Fullscreen"
contextmenu.exitfs String "Exit Fullscreen"
contextmenu.item.count int 0 read only
contextmenu.item[...].enabled Boolean true
contextmenu.item[...].visible Boolean true
contextmenu.item[...].caption String
contextmenu.item[...].separator Boolean false
contextmenu.item[...].onclick Action Event
 
network.downloadqueues int 0 0 = auto
network.decodequeues int 0 0 = auto
network.retrycount int 2
network.caching Boolean true
network.cachesize Number true MB
 
memory.maxmem int 350 MB
 
plugin.count int 0
plugin.enabled Boolean true
plugin.visible Boolean true
plugin.alpha Number 1.0
plugin.layer Sprite AS3 usage only
 
plugin[...].index int read only
plugin[...].name String
plugin[...].sprite Sprite read only
plugin[...].url String
plugin[...].alturl String
plugin[...].devices String "all"
plugin[...].visible Boolean true
plugin[...].enabled Boolean true
plugin[...].capture Boolean true
plugin[...].children Boolean true
plugin[...].handcursor Boolean true
plugin[...].keep Boolean false
plugin[...].zorder int
plugin[...].preload Boolean false
plugin[...].loader Loader null read only
plugin[...].loading Boolean false read only
plugin[...].loaded Boolean false read only
plugin[...].hovering Boolean false read only
plugin[...].pressed Boolean false read only
plugin[...].accuracy int 0
plugin[...].alpha Number 1.0
plugin[...].blendmode String "normal"
plugin[...].align String
plugin[...].edge String
plugin[...].x String
plugin[...].y String
plugin[...].ox String
plugin[...].oy String
plugin[...].rotate Number 0.0
plugin[...].width String
plugin[...].height String
plugin[...].usecontentsize Boolean false
plugin[...].scale Number 1.0
plugin[...].altscale Number
plugin[...].scale9grid String
plugin[...].crop String
plugin[...].onovercrop String
plugin[...].ondowncrop String
plugin[...].scalechildren Boolean false
plugin[...].parent String
plugin[...].mask String
plugin[...].effect String
plugin[...].jsborder String
plugin[...].style String
plugin[...].smoothing Boolean true
plugin[...].onover Action Event
plugin[...].onhover Action Event
plugin[...].onout Action Event
plugin[...].onclick Action Event
plugin[...].ondown Action Event
plugin[...].onup Action Event
plugin[...].onloaded Action Event
plugin[...].altonloaded Action Event
plugin[...].loadstyle(name) Action
plugin[...].resetsize() Action
plugin[...].changeorigin(align) Action
plugin[...].getfullpath() AS3 Function AS3 usage only
 
hotspot.count int
hotspot.enabled Boolean
hotspot.visible Boolean
hotspot.alpha Number
hotspot.layer Sprite
hotspot[...].index int
hotspot[...].name String
hotspot[...].sprite Sprite
hotspot[...].loader Loader
hotspot[...].zorder String
hotspot[...].url String
hotspot[...].alturl String
hotspot[...].devices String "all"
hotspot[...].visible Boolean true
hotspot[...].enabled Boolean true
hotspot[...].capture Boolean true
hotspot[...].children Boolean true
hotspot[...].handcursor Boolean true
hotspot[...].keep Boolean false
hotspot[...].loading Boolean false
hotspot[...].loaded Boolean false
hotspot[...].hovering Boolean false
hotspot[...].pressed Boolean false
hotspot[...].alpha Number 1.0
hotspot[...].blendmode String "normal"
hotspot[...].distorted Boolean false
hotspot[...].zoom Boolean false
hotspot[...].ath Number 0.0
hotspot[...].atv Number 0.0
hotspot[...].flying Number 0.0
hotspot[...].details int 8
hotspot[...].rx Number 0.0
hotspot[...].ry Number 0.0
hotspot[...].rz Number 0.0
hotspot[...].inverserotation Boolean false
hotspot[...].ismovie Boolean false
hotspot[...].refreshrate String "auto"
hotspot[...].align String "center"
hotspot[...].edge String "center"
hotspot[...].ox String
hotspot[...].oy String
hotspot[...].rotate Number 0.0
hotspot[...].width String
hotspot[...].height String
hotspot[...].usecontentsize Boolean false
hotspot[...].scale Number 1.0
hotspot[...].altscale Number
hotspot[...].scale9grid String
hotspot[...].crop String
hotspot[...].onovercrop String
hotspot[...].ondowncrop String
hotspot[...].scalechildren Boolean false
hotspot[...].parent String
hotspot[...].mask String
hotspot[...].effect String
hotspot[...].style String
hotspot[...].smoothing Boolean true
hotspot[...].onover Action Event
hotspot[...].onhover Action Event
hotspot[...].onout Action Event
hotspot[...].onclick Action Event
hotspot[...].ondown Action Event
hotspot[...].onup Action Event
hotspot[...].onloaded Action Event
hotspot[...].altonloaded Action Event
hotspot[...].loadstyle()
hotspot[...].resetsize()
hotspot[...].getfullpath() AS3 Function return:String AS3 usage only
hotspot[...].getcenter() AS3 Function return:Object
hotspot[...].fillcolor int 0xFFFFFF
hotspot[...].fillcolorhover int 0xFFFFFF
hotspot[...].fillalpha Number 0.0
hotspot[...].fillalphahover Number 0.1
hotspot[...].borderwidth Number 0
hotspot[...].borderwidthhover Number 4
hotspot[...].bordercolor int 0xFFFFFF
hotspot[...].bordercolorhover int 0xFFFFFF
hotspot[...].borderalpha Number 0.0
hotspot[...].borderalphahover Number 0.8
hotspot[...].fadeintime Number 0.15
hotspot[...].fadeincurve Number 1.1
hotspot[...].fadeouttime Number 0.3
hotspot[...].fadeoutcurve Number 0.7
hotspot[...].point.count
hotspot[...].point[...].ath
hotspot[...].point[...].atv
 
textstyle.count int 0 read only
textstyle[...].name String
textstyle[...].index int read only
textstyle[...].font String "Times"
textstyle[...].fontsize Number 12.0
textstyle[...].bold Boolean true
textstyle[...].italic Boolean false
textstyle[...].background Boolean true
textstyle[...].backgroundcolor int 0xFFFFFF
textstyle[...].border Boolean true
textstyle[...].bordercolor int 0x000000
textstyle[...].textcolor int 0x000000
textstyle[...].alpha Number 1.0
textstyle[...].blendmode String "normal"
textstyle[...].effect String
textstyle[...].origin String "cursor"
textstyle[...].edge String "bottom"
textstyle[...].textalign String "none"
textstyle[...].xoffset int 0
textstyle[...].yoffset int -3
textstyle[...].showtime Number 0.1
textstyle[...].fadetime Number 0.0
textstyle[...].fadeintime Number 0.0
textstyle[...].noclip Boolean true
 
lensflareset.count int read only
lensflareset[...].name String
lensflareset[...].index int read only
lensflareset[...].url String
lensflareset[...].flare.count int read only
lensflareset[...].flare[...].name String
lensflareset[...].flare[...].index int read only
lensflareset[...].flare[...].pixsize int 0
lensflareset[...].flare[...].pixupos int 0
lensflareset[...].flare[...].pixvpos int 0
lensflareset[...].flare[...].color int 0xFFFFFF
lensflareset[...].flare[...].pos Number 0.0
lensflareset[...].flare[...].scale Number 1.0
 
lensflare.count int 0 read only
lensflare.visible Boolean true
lensflare.alpha Number 1.0
lensflare.layer Sprite AS3 usage only
lensflare[...].name String
lensflare[...].index int read only
lensflare[...].set String "DEFAULT"
lensflare[...].visible Boolean true
lensflare[...].keep Boolean false
lensflare[...].ath Number 0.0
lensflare[...].atv Number 0.0
lensflare[...].size Number 0.8
lensflare[...].blind Number 0.6
lensflare[...].blindcurve Number 4.0
 
action.count int 0
action[...].name String
action[...].content String
 
scene.count int 0
scene[...].name String
scene[...].onstart Action Event
scene[...].content String
 
data.count int 0
data[...].name String
data[...].content String

Actions Reference

action(name)
add(dstvar,addvar)
add(dstvar,var1,var2)
addhotspot(name)
addlensflare(name,ath,atv)
addplugin(name)
adjusthlookat(desthlookat)
breakall()
copy(destvar,srcvar)
dec(var,by*,min*,max*)
delayedcall(time, actions)
div(dstvar,divvar)
div(dstvar,var1,var2)
error(message)
freezeview(state*)
fscommand(...)
if(condition, true-actions, false-actions*)
ifnot(condition, true-actions, false-actions*)
inc(var,by*,max*,min*)
invalidatescreen()
js( jsfunction(parameters...) )
loadpano(xml,vars*,flags*,blend*)
loadscene(scene,vars*,flags*,blend*)
loadxml(xmlstring,vars*,flags*,blend*)
lookat(h,v,fov*)
lookto(h,v,fov*,motiontype*,shortestway*)
looktohotspot(name, fov*, motiontype*)
mod(dstvar,modvar)
mod(dstvar,var1,var2)
moveto(h,v,motiontype*)
mul(dstvar,mulvar)
mul(dstvar,var1,var2)
oninterrupt(break or actions)
openurl(url,target*)
pop(var)
pow(dstvar,modvar)
pow(dstvar,var1,var2)
push(var)
removehotspot(name)
removelensflare(name)
removeplugin(name)
roundval(var,nk*)
screentosphere(x,y,h,v)
set(var,value)
showlog(state*)
showtext(text,textstyle*)
spheretoscreen(h,v,x,y)
stopall()
stoptween(var,var*,...*)
sub(dstvar,subvar)
sub(dstvar,var1,var2)
switch(var,states...)
trace(....)
tween(var,value,time*,type*,done-actions*)
txtadd(dstvar, addtext)
txtadd(dstvar, text, text, ...*)
updateobject(updateall*,updatefov*)
updatescreen()
wait(event or time in seconds)
zoomto(fov, motiontype*)