Zoomify ActionScript API Reference



The Zoomify API Reference describes the syntax and use of Zoomify API methods, properties, and events. These elements are specifically designed for use with Actionscript 3.0 in Adobe Flash. The Reference presents elements grouped by their context of use as delivered in the viewers and utility components of Zoomify Flash.

This page includes an index of Zoomify API methods and properties, a listing of Zoomify API events, information on changes between versions 3 and 4 of the Zoomify API, and an example reference entry. In the actual Reference included in Zoomify Flash, the methods and properties listed below link to pages describing each method or property in detail.

See the template entry below for example coverage.



Index Of Methods And Properties

The following public methods and properties are documented in the Reference. In the Reference each element can be clicked to view a page describing the syntax, parameters, return values, use, and related functions. The linked pages also include example code.
calcZoomDecimalToFitDisplay() getHotspotCoords() set minZoom()
createHotspot() getHotspotListSourceAndIDs() set panConstrain()
createWatermarkHotspotsXML() getHotspotsChoiceList() set showSlider()
displayStateToggle() getHotspotsGeoBottom() set showToolbarTooltips()
get autoLoop() getHotspotsGeoDisplay() set showZoomifyButton()
get autoPlay() getHotspotsGeoLeft() set sizeToFit()
get clickZoom() getHotspotsGeoRight() set slidesXMLPath()
get eventsEnabled() getHotspotsGeoTop() set splashScreenVisibility()
get fadeInSpeed() getHotspotsVisibility() set toolbarSkinXMLPath()
get height() getSelectedIndex() set toolbarSpacing()
get hotspotsXMLPath() getSlidesChoiceList() set viewX()
get imageHeight() goToDestination() set viewY()
get imagePath() goToNextDestination() set viewZoom()
get imageWidth() goToPrevDestination() set viewer()
get initialRotation() hideMessage() set viewerName()
get initialX() loadNextSlide() set zoomSpeed()
get initialY() loadPrevSlide() setBackColor()
get initialZoom() loadSlide() setGeoText()
get initialized() modifyHotspot() setHotspotsVisibility()
get maxZoom() panDown() setInitialView()
get minZoom() panLeft() setSelectedIndex()
get name() panRight() setSize()
get panConstrain() panStop() setSync()
get showSlider() panUp() setView()
get showToolbarTooltips() removeHotspot() setWatermarkValues()
get showZoomifyButton() rotateClockwise() showCaptionTooltips()
get sizeToFit() rotateCounterwise() showMessage()
get slideCount() rotateStop() sizeNavigatorToFitImage()
get slidesXMLPath() roundToDecimalPlaces() sizeNavigatorToFitViewer()
get splashScreenVisibility() set autoLoop() startSlideshow()
get toolbarSkinXMLPath() set autoPlay() startTour()
get toolbarSpacing() set clickZoom() stopSlideshow()
get viewX() set eventsEnabled() stopTour()
get viewY() set fadeInSpeed() zoomIn()
get viewZoom() set hotspotsXMLPath() zoomOut()
get viewer() set imagePath() zoomStop()
get viewerName() set initialRotation() zoomToFitDisplay()
get width() set initialX() zoomToInitialView()
get zoomSpeed() set initialY() zoomToView()
getGeoText() set initialZoom() zoomToViewStop()
getHotspot3DCoords() set maxZoom()



Events

Numerous events are dispatched in the Zoomify codebase. The listing below can be listened for using the standard ActionScript addEventListener method, however, these events must first be enabled. To enable the events simply use the HTML parameter zoomifyEventsEnabled=1 or the XML parameter EVENTS="1" or programmatically enable event dispatching: zoomifyViewerInstance.eventsEnabled=true. Additional internally used events exist and can be listened for. These can be found throughout the codebase and should not be altered except with caution. (Note that the built-in ActionScript events model eliminates the need for the registerCallback method of the Zoomify v3 API.) The following events' names are self-explanatory (the items are not links).
imageChanged viewLoadingComplete viewerInitializationComplete
imagePropertiesLoadingComplete viewLoadingProgress viewerKeyDown
imagePropertiesLoadingFailed viewLoadingStarted viewerKeyUp
navigatorMouseDown viewPanComplete viewerMouseDown
navigatorMouseMove viewPanning viewerMouseUp
navigatorMouseUp viewZoomComplete XMLParametersLoadingComplete
stageMouseMove viewZoomingIn XMLParametersLoadingFailed
stageMouseWheel viewZoomingOut zoomConstrainedToMax
toolbarButtonDown viewerConstrainingPan zoomConstrainedToMin
toolbarButtonUp viewerFirstFullViewDraw
toolbarSliderDrag viewerFirstTileDraw



Migration: Version 3 To Version 4

Every effort has been made to limit API changes between versions 3 and 4 to those that were essential to update the technology for ActionScript 3.0, those that provided real benefits in coding efficiency and power, and those requested by users for clarity or ease of use.

Numerous properties have been implemented. Methods of the form
setValue(newValue)
are in most cases now implemented as properties of the form
set value()
to be used in the form
zoomifyViewerInstance.value = newValue;
Take note that the above statement does not contain parentheses before the assignment (=). Also note, where get or set is integrated in the method name as in
setView()
the usage continues to be
setView(values)
where any parameters are within parentheses rather than assigned via an equal (=) sign.

The updateView() method has been made unnecessary by a state engine, event model, and self-updating methods. Therefore, methods such as setView(), setInitialView(), zoomToView(), and zoomToInitialView() do not require subsequent method calls to ensure proper updating.

Methods such as panLeft(), panUp(), panDown(), zoomOut(), and zoomIn() now set a state and are followed by calls to panStop() or zoomStop(). For example, where panning is initiated on the press of a button, it is ended on the button's release.

As noted above, the built-in ActionScript events model eliminates the need for the registerCallback method of the Zoomify v3 API.

Lastly, many method/property names have been updated for clarity or to avoid namespace or reserved word conflicts:
setX(), setY(), setZoom() - are now - set viewX(), set viewY(), set viewZoom()

resetView() - is now - setInitialView() - or - zoomToInitialView()

addLabel() - has changed and is now - addHotspot()

createHotspot() - now provides a simplified parameter-based interface

See the Viewer source code (.as) files as well as the Developer Examples source files for additional instruction on new implementations and alternatives.



Template: Example Reference Entry

The following illustrates the contents and format of each method, property, and event entry.

exampleMethod(exampleParameter:String):void   method

Language & Runtime Versions

Actionscript 3.0 and Flash Player 9 (presumed by Zoomify v4 API)

Usage

This section provides correct syntax for using the ActionScript element in your code. The required portion of the syntax is in code font, and the code that you provide is in italicized code font. Brackets ([]) indicate optional parameters.

Parameters

This section describes any parameters listed in the syntax.

Returns

This section identifies the values the element returns, if any.

Description

This section describes the purpose and use of the element and provides notes regarding related issues, as appropriate.

Example

This section provides a code sample demonstrating how to use the element.

See also:

This section lists and links to related Zoomify API Reference entries.



Copyright © 1999-2012 Zoomify, Inc.
All Rights Reserved