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.

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).

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.

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