Full Function List Including Internal Public and Private Functions

This listing is included to provide the context of the public functions described in the Zoomify Image Viewer Function List. Functions listed here and not in the main Function List are used internally, but may be of value to developers with more advanced JavaScript skills and greater customization and/or integration needs.

As in the main Function List, the functions below are listed in the order in which they appear in the ZoomifyImageViewer.js file - and approximately the order in which they are first used.

Some of the listed functions are accessible outside the scope of their immediate container and are therefore 'public', however, they are not listed in the main function list because they are useful primarily in enabling components such as the Viewport, Toolbar, and Navigator to interact with each other.

In addition, private functions can be made accessible outside their scope simply by creating a calling function that is accessible:

   this.whateverFunction = function (parameters) {
       whateverFunction(parameters);
   }

Such access and such modifications should be pursued with caution. As always, extensive comments are provided and function and variable names are long and, it is hoped, self-explanatory.

VIEWER

global.Z =};
Z.showImage (containerID, imagePath, optionalParams)
Z.initialize ()
Z.ZoomifyImageViewer ()

GET AND SET

this.getImagePath ()
this.getImage ()
this.setImagePath (imagePath, imageProperties)
this.setImage (imagePath, optionalParams, initializingCall)
this.setImageWithFade (imagePath, optionalParams, initializingCall)
this.setTourPath (tourPath, noReload)
this.setHotspotPath (hotspotPath, noReload)
this.setAnnotationPath (annotationPath, noReload)
this.initializePageExitEventHandler ()
this.getStatus (vState)
this.setStatus (vState, vStatus)
this.validateViewerStatus (vState)
this.validateViewerReady (vState)
validateExitBrowser (event)
validateExitCustom ()

EVENTS

initializeViewerEventListeners ()
initializeOrientationChangeHandler ()
orientationChangeHandler (event)
this.initializeViewerKeyEventListeners (enable)
keyEventsHandler (event)
this.initializeViewerKeyDefaultListeners (enable)
viewerEventsHandler (event)
viewerEventsManager (event)
autoResizeSkipTimerHandler (event)
this.autoResizeViewer ()
autoResizeViewer ()
this.resizeViewer (w, h, z)
this.mouseWheelCompleteHandler (event)

IMAGE SETS

this.parseImageSetXML (xmlDoc, imageSetType)
configureViewerMultipleViewports (imageSetMediaList)
precacheBackfillTilesDelayed ()
this.viewportChange (direction)
this.viewportPrior (skipFrames)
this.viewportNext (skipFrames)
this.viewportSelect (vpID, doNotSyncSlider)
this.setVisibilityHotspotChoiceList (visible, vpIDs)
setVisibilityHotspotChoiceList (visible, vpIDs)
ImageSetObject (imageSetNode, id)
createImageSetChoiceList (position, title, dataProvider)
getImageSetListCoords (position, listW, viewerW, viewerH)
this.sizeAndPositionImageSetList ()
imageSetListChangeHandler (event)
syncToolbarImageSetSliderToViewport (imageSetSlide)

VIEWPORT

Z.ZoomifyViewport (vpID, vpImgPath, vpAnnotPath, vpHotPath)

INITIALIZATION

loadSlidesXML (netConnector)
initializeViewport (iW, iH, tW, tH, iTileCount, iVersion, iHeaderSize, iHeaderSizeTotal, iMagnification, iFocal, iQuality)
reinitializeViewport (iW, iH, tW, tH, iTileCount, iVersion, iHeaderSize, iHeaderSizeTotal, iMagnification, iFocal, iQuality)
clearAll (clearTileVals, clearTierVals, clearDisplayVals, clearDisps)
clearTileValues ()
clearTierValues ()
clearDisplayValues ()
clearDisplays ()
createDisplays (vpID)
createCanvasContexts ()
this.setSizeAndPosition (width, height, left, top)
setSizeAndPosition (width, height, left, top)
this.syncViewportResize (imgX, imgY, imgZ, imgR, fullScrnMode, fvCntW, fvCntH)
this.resizeViewport (imgX, imgY, imgZ, imgR)
this.loadImageProperties (imgPath, netCnnctr, vpID)
loadImageProperties (imgPath, netCnnctr, vpID)
loadImagePropertiesFromZIF (imgPath, netCnnctr, vpID)
loadImagePropertiesFromPFF (imgPath, netCnnctr, vpID)
loadImagePropertiesFromImageServer (imgPath, netCnnctr, vpID)
this.parseZIFHeader (data)
this.parseZIFOffsetChunk (data, chunkID)
this.parseZIFByteCountChunk (data, chunkID)
this.parseZIFImage (data, tile, target)
this.parseImageXML (xmlDoc)
parseImageXML (xmlDoc, callback)
calculateTierValues ()
calculateTierValuesUnconvertedMethod ()
calculateTierValuesZIFMethod ()
calculateTierValuesSecondMethod ()
calculateTierValuesFirstMethod ()
this.validateXYZDefaults (override)

GET AND SET

this.getViewW ()
this.getViewH ()
this.getDisplayW ()
this.getDisplayH ()
this.getImagePath ()
this.setImagePath (value)
this.getViewportID ()
this.getTierCount ()
this.getTileW ()
this.getTileH ()
this.getTierCurrent ()
this.getTierBackfill ()
this.getTierBackfillDynamic ()
this.getTierBackfillOversize ()
this.getTierScale ()
this.getX ()
this.getY ()
this.getZoom ()
this.getRotation ()
this.getTiersScaleUpMax ()
this.getTiersScaleDownMax ()
this.getTilesCacheMax ()
this.getTierWs ()
this.getTierHs ()
this.getTierTileCounts ()
this.getTilesToLoad ()
this.getTilesLoadingNames ()
this.getTilesToDraw ()
this.getConstrainPan (value)
this.setConstrainPan (value)
this.getSmoothPan ()
this.setSmoothPan (value)
this.getSmoothPanEasing ()
this.setSmoothPanEasing (value)
this.getSmoothPanGlide ()
this.setSmoothPanGlide (value)
this.setCoordinatesDisplayVisibility (visible)
this.setTourPath (tourPath, noReload)
this.setHotspotPath (hotspotPath, noReload)
this.getHotspots ()
this.setHotspots (hotsArr)
this.setAnnotationPath (annotationPath, noReload)
this.getAnnotationsXML ()
this.setAnnotationsXML (annotsXML)
this.testSetAnnotationPath ()
this.setVisibility (visible)
visibility (visible)
this.showLists (visible)

CORE

this.precacheBackfillTiles (delayed)
precacheTierTileNames (tier, cacheArr)
updateViewWhilePanning (stepX, stepY)
this.updateView (override)
resetDisplays (override)
selectTier ()
selectBackfillTier ()
selectTiles (backfill)
redisplayCachedTiles (display, tier, cacheArray, drawMethod, delayClear, purpose)
displayCacheDisplay (tier, cacheArray)
syncTransitionCanvas ()

UNCONVERTED IMAGES

this.loadUnconvertedImage (imgPath)
loadUnconvertedImage (imgPath)
initializeViewportUnconverted ()
unconvertedImageLoadingFailed ()
this.getUnconvertedImage ()
this.createUnconvertedImageThumbnail ()

TILE LOADING

loadNewTiles (tileNamesArray, loadHandler, drawMethod, requester)
Tile (name, requester)
TileCoords (name)
this.formatTilePath (t, c, r, requester)
formatTilePathZIF (t, c, r, requester)
OffsetChunkValues (t, c, r)
ByteCountChunkValues (t, c, r)
formatTilePathImageFolder (t, c, r, requester)
formatTilePathPFF (t, c, r, requester)
loadOffsetChunk (offsetStartByte, offsetEndByte, chunk)
this.parseOffsetChunk (xmlDoc)
selectTilesRetryZIF (chunkID, type)
selectTilesRetryPFF (chunkN)
loadNewTilesRetry (tileNamesArray, loadHandler, drawMethod, requester)
skipTile (tile)
loadTile (tile, loadTime, loadHandler)
onTileLoad (tile, image)
onTileBackfillLoad (tile, image)
onTileLoadWhilePanning (tile, image)

DRAWING

fadeInIntervalHandler (event)
displayTile (display, tier, tile)
drawTileOnCanvas (container, tile, x, y)
drawTileInHTML (container, tile, x, y, scale)
drawTileNameOnTile (container, tileName, x, y, scale)
drawTileNameOnCanvas (container, tileName, x, y, scale)
drawTileNameInHTML (container, tileName, x, y, scale)

IMAGE SERVER

formatTilePathImageServer (t, c, r, requester)
convertViewerZoomToImageServerZoom ()

CALCULATION AND CONVERSION

this.getClickCoordsAtZoom (event, zoom)
this.getClickCoordsInImage (event, zoom, mPt)
getClickZoomCoords3DAsString (event)
this.getClickZoomCoords3D (event, pageClickPt, tCurrent, tScale, dblClick)
this.calculateCurrentCenterCoordinates (viewportPt, z, r)
this.getViewportDisplayBoundingBoxInTiles (tier, viewportOnly)
this.getViewportDisplayBoundingBoxInPixels (viewportOnly)
this.HotspotsAllBoundingBoxInPixels ()
BoundingBoxInTiles (pixelsBoundingBox, tier)
BoundingBoxInPixels (x, y, vpPixelsLeft, vpPixelsRight, vpPixelsTop, vpPixelsBottom, zoom)
convertPageCoordsToViewportCoords (pagePixelX, pagePixelY)
convertPageCoordsToViewportDisplayCoords (pagePixelX, pagePixelY)
convertViewerCoordsToImageCoords (displayX, displayY, z, r)
convertImageCoordsToViewerCoords (imageX, imageY, z, r)
convertViewportCoordsToImageCoords (viewportX, viewportY, z, r)
convertImageCoordsToViewportCoords (imageX, imageY, z, r)
convertImageCoordsToViewportEdgeCoords (imageX, imageY, z, r)
this.calculateZoomToFit (targetR)
this.calculateZoomToFill (targetR)
this.calculateZoomForResize (currZ, priorViewW, priorViewH, newViewW, newViewH)
this.convertTierScaleToZoom (tier, scale)
convertTierScaleToZoom (tier, scale)
convertZoomToTierScale (tier, zoom)

CONSTRAIN AND SYNCHRONIZATION

constrainPan (x, y, newZ, newR, input)
constrainZoom (z)
constrainRotation (targetR)
syncToolbarSliderToViewport ()
syncNavigatorToViewport ()
syncRulerToViewport (reset)
this.syncViewportToNavigator (newVPImgCtrPt)

VALIDATION: CACHE, STATUS, VIEW, AND PROGRESS

validateCache ()
cacheTile (tile)
this.getStatus (vState)
this.setStatus (vState, vStatus)
this.traceDebugValues (step, infoTxt, infoNum, dataArr)
validateViewTimerHandler ()
this.updateProgress (total, current)
calculateProgressPercent (total, current)

VIRTUAL POINTER

configureVirtualPointer ()
this.showVirtualPointer ()
this.hideVirtualPointer ()
drawVirtualPointerInHTML (piW, piH, piL, piT)
virtualPointerLoadingFailed ()
virtualPointerMouseDownHandler (event)
virtualPointerMouseMoveHandler (event)
virtualPointerMouseUpHandler (event)
virtualPointerTouchStartHandler (event)
virtualPointerTouchMoveHandler (event)
virtualPointerTouchEndHandler (event)
virtualPointerTouchCancelHandler (event)

WATERMARKS

loadWatermark ()
displayWatermarks ()
displayWatermark (wiScaledW, wiScaledH, wicL, wicT)
drawWatermarkInHTML (wiScaledW, wiScaledH, wicL, wicT)
redisplayWatermarks ()
watermarkLoadingFailed ()

SAVE TO FILE

this.saveAnnotationsToImageFile (saveAll, showSaved)
syncSavingDisplay (saveAll)
loadTilesToSave (saveAll)
precacheFullImageTiles ()
loadNewTilesThrottled (tileNamesArray, loadHandler, drawMethod, requester)
onTileBackfillLoadToSave (tile, image)
onTileLoadToSave (tile, image, backfill)
cacheTileToSave (tile, backfill)
drawAllOnCanvasToSave (saveAll)
drawImageOnCanvasToSave (saveAll)
drawAnnotationsOnCanvasToSave (saveAll)
drawLabelOnCanvas (hotspot, clickPt, rollover, mask, saving, saveAll, counter)
drawCaptionOnCanvas (hotspot, hC, clickPt, rollover, mask, saving, saveAll)
HotspotDimensions (hotspot, hC, clickPt, ignoreZoom)
validateDrawLabelCount ()
self.saveCanvasDataToFile (saveAll, showSaved)

HOTSPOTS & ANNOTATIONS

loadHotspotsOrAnnotationsData (vpID)
this.parseHotspotsXML (xmlDoc)
this.createHotspotFromParameters (id, name, mediaType, media, audio, x, y, zoom, xScale, yScale, url, urlTarget, rollover, caption, tooltip, textColor, backColor, lineColor, fillColor, textVisible, backVisible, lineVisible, fillVisible, captionPosition, saved, internalID, poiID, captionHTML, tooltipHTML, polyClosed, polygonPts, showFor, transition, changeFor, rotation)
this.createHotspotFromXML (hotspotNode, validate)
addHotspotMedia (hotspot, displayNow)
Hotspot (hotspotNode)
this.modifyHotspot (idValue, property, newVal, delay, useInternalID)
this.deleteHotspot (idValue, replace, useInternalID)
this.deleteAllHotspots ()
this.deleteAllMeasureHotspots ()
loadHotspotMedia (media, loadTime)
onHotspotMediaLoad (media, loadTime, element)
this.redisplayHotspots ()
redisplayHotspots ()
displayHotspotsWithoutMedia ()
this.getLabelsVisibility ()
this.setLabelsVisibility (visible)
this.setLabelVisibility (hotspotElement, visible)
this.setHotspotsVisibilityByFilter (filterBy, filterValue, visible)
this.setHotspotVisibilityByID (id, visible, useInternalID)
this.setLabelFilterByDisplayList (idList, useInternalID)
this.setHotspotFilterByDisplayList (idList, useInternalID)
this.clearLabelFilterByDisplayList ()
this.clearHotspotFilterByDisplayList ()
displayHotspots ()
displayHotspot (hotspot, hC)
drawHotspotInHTML (hotspot, hC, clickPt, skipSetVisibility)
HotspotContext (viewportOnly)
this.getHotspotTarget (target)
getHotspotTarget (target)
this.getLabelIDsInCurrentView (useInternalID, viewportOnly, includePartials)
updateHotspotPosition (event, hotspotDragging, hotClickPt)
polygonPointsPan (hotspot, clickPt)
polygonPointsScale (hotspot, property, scaleVal)
polygonPointsZoom (hotspot, zoom)
polygonPointsZoomXML (hotspotNode)
createHotspotCaption (hotspot, hC, noCaptionBoxes, dropShadow)
positionHotspotCaption (hotspot, hCaption, hiScaledW, hiScaledH, dropShadow)
positionPolygonCaption (hotspot, hC)
calculateHotspotCaptionPosition (hCaption, p, hW, hH, r, isCurrHotAndPoly)
calculateCaptionSize (hCaption, hZoom, onCanvas)
adjustCalculationForRotation (position, r)
setHotspotCaptionMeasure (hotspot, clickPt)
setHotspotCaption (hCaption, captionContent, isHTML)
removeHotspotCaption (hotspot)
getHotspotCaptionElement (hotspot)
createHotspotChoiceList (position, title, dataProvider, vpID)
addToHotspotChoiceList (text, value)
clearHotspotFromChoiceList (intID)
clearAllFromHotspotChoiceList ()
clearHotspotFromHTML (intID)
this.getHotspots ()
this.getHotspotsVisibility ()
this.setHotspotsVisibility (visible)
this.setHotspotVisibility (hotspotElement, visible)
this.setHotspotsVisibilityByFilter (filterBy, filterValue, visible)
this.setHotspotVisibilityByID (id, visible, useInternalID)
calculateHotspotListCoords (position, listW, viewerW, viewerH)
hotspotIsValid (hotspot)
hotspotToString (hotspot)
this.createAnnotationsXMLFile ()
this.parseAnnotationsXML (xmlDoc, vpID)
validateAnnotationsXMLToLoad (xmlDocIn)
loadAnnotationSetupNode (setupNew, setupSource)
loadAnnotationPOINode (poiNew, poiSource)
loadAnnotationLabelNode (xmlDocNew, labelNew, labelSource)
loadAnnotationNoteNode (noteNew, noteSource)
removeAnnotationDefaults (xmlDocIn)
validateAnnotationMedia (nodeToValidate)
createAnnotationsXML ()
createAnnotationsXMLNode (xmlDoc, nodeType)
createFirstPOI ()
createPOIFromParameters (id, name, x, y, zoom, internalID)
createPOIFromXML (poiNode, validate)
this.createLabelFromParameters (id, name, mediaType, media, audio, x, y, zoom, xScale, yScale, url, urlTarget, rollover, caption, comment, tooltip, textColor, backColor, lineColor, fillColor, textVisible, backVisible, lineVisible, fillVisible, captionPosition, saved, internalID, poiID, captionHTML, tooltipHTML, polyClosed, polygonPts, showFor, transition, changeFor, rotation)
this.createLabelFromJSON (labelObject, validate)
this.createLabelFromXML (labelNode, validate)
updateLabelsForHotspot (hotspot, poiID)
createNoteFromParameters (id, name, noteText, internalID, poiID)
createNoteFromXML (noteNode, validate)
validateAnnotationXMLNode (xmlNode, nodeType)
this.modifyLabel (intID, property, newVal, delay, useInternalID)
sortAnnotationAssocArrayByField (objA, objB)
this.createAnnotationPanel (vpID)
createAnnotationPanelEditingFeatures (vpID)
drawLayoutAnnotationPanel (tlbrSknSzs, vpID)
populateAnnotationPanel ()
this.calculateAnnotationPanelDimensions (poiVis, labelVis, noteVis, commentVis)
this.calculateAnnotationPanelCoords (position, annotPanelW, annotPanelH, viewerW, viewerH)
this.sizeAndPositionAnnotationPanel (panel, width, height, left, top)
this.clearAnnotationPanel (vpIDStr)
getFreeID (idTarget)

HOTSPOT / ANNOTATION MASKS

this.setLabelMaskByDisplayID (id, useInternalID)
this.setLabelMaskByDisplayList (idList, useInternalID)
this.setHotspotMaskByDisplayList (idList, useInternalID)
setMask (idList, useInternalID)
syncMask ()
displayMask ()
cutMaskRegions (idList, useInternalID)
cutPolygonFromMask (hotspot)
this.clearMask ()
this.maskFadeTimeoutHandler (direction)

HOTSPOT & ANNOTATION EVENTS

hotspotMouseOverHandler (event)
hotspotMouseDownHandler (event)
hotspotMouseUpHandler (event)
hotspotMouseOutHandler (event)
hotspotTouchStartHandler (event)
hotspotTouchEndHandler (event)
hotspotTouchCancelHandler (event)
hotspotEditMouseDownHandler (event)
hotspotEditTouchStartHandler (event)
executeExternalFunction ()
hotspotListMouseDownHandler (event)
hotspotListChangeHandler (event)
populatePOIs (poiID, labelID, noteID)
populateCurrentPOIDetails (poiID)
populateLabels (poiID, labelID)
populateCurrentLabelDetails (labelID)
populateNotes (poiID, noteID)
populateCurrentNoteDetails (noteID)
poiListMouseDownHandler (event)
poiListChangeHandler (event)
labelListMouseDownHandler (event)
labelListChangeHandler (event)
this.goToLabelByID (labelID, hotCurr, useInternalID)
this.getCurrentLabel ()
this.setCurrentLabel (labelID, useInternalID)
this.getLabelXMLText (labelID)
this.getLabelJSONObject (labelID, useInternalID)
labelIconListChangeHandler (event)
labelCaptionPositionListChangeHandler (event)
labelTargetListChangeHandler (event)
rolloverCheckboxClickHandler (event)
noteListChangeHandler (event)
annotationEditFocusHandler (event)
annotationEditBlurHandler (event)
manageTabIndices (focusTarget)
filterListByPOIID (dependentArray, poiID)

POLYGONS

drawPolygonOnCanvas (hotspot, clickPt, rollover, mask, saving, saveAll, counter)
drawControlPoint (x, y, firstCtrlPt, scaleOffset)
drawPolygonBungeeLine (mPtX, mPtY, clickPt)
redisplayPolygons (rollover)
drawFreehand (fromX, fromY, toX, toY, clickPt)
updatePolygon (hotspotInternalID, ctrlPtIndex, clickPt)
updateRectangleControlPoints (ptsArray, ctrlPtIndex)
polygonClickHandler (event, clickPt, isDblClick)
createControlPoint (hotspotInternalID, polygonRedisplay, clickPt)
getClickedControlPoint (event, clickPt)
completePolygon (hotspotInternalID, closePoly)
captionPolygon (hotspotInternalID, clickPt, saving, saveAll)

ANNOTATION EDITING

this.toggleEditMode ()
this.setEditModeLabel (mode, syncUIToLabel, media, hideList)
setAnnotationPanelEditability (annotElement, editing)
this.toggleLabelColorPicker (override)
this.setDrawingColor (buttonName, override)
this.toggleLabelIconPicker (override)
this.addNewPOI ()
this.editCurrentPOI ()
this.deleteCurrentPOI ()
this.cancelEditsPOI ()
this.saveEditsPOI (continueEditing)
this.addNewLabel ()
this.editCurrentLabel ()
this.deleteCurrentLabel ()
this.deleteLabel (labelID, useInternalID)
this.cancelEditsLabel ()
this.saveEditsLabel (continueEditing, saveForce, saveImage)
this.addNewNote ()
this.editCurrentNote ()
this.deleteCurrentNote ()
this.cancelEditsNote ()
this.saveEditsNote (continueEditing)
savePoint (mode, target)
this.deleteAllAnnotations ()
this.saveLabel (labelID, useInternalID)
this.convertLabelToXML (hotspot)
this.convertLabelToJSON (hotspot)
this.saveAnnotations (saveForce, saveImage, target)
updateAnnotationsXML (xmlDocPrior)
updateAnnotationSetupNode (setupNew, setupSource)
updateAnnotationPOINode (poiNew, poiSource)
updateAnnotationLabelNode (xmlDocNew, labelNew, labelSource)
updateAnnotationNoteNode (noteNew, noteSource)
this.setAllHotspotsSaved ()
this.verifyEditsUnsaved (target)

SCREENSAVER, TOURS & SLIDESHOWS

this.tourStart ()
this.tourStop ()
this.priorDestination (override)
this.nextDestination (override)
destinationChange (direction)
this.goToDestination (index)
this.parseSlidesXML (xmlDoc)
Slide (slideNode)
createSlideChoiceList (position, title, dataProvider)
calculateSlideListCoords (position, listW, viewerW, viewerH)
slideListChangeHandler (event)
this.slideshowStart (initialCall)
this.slideshowStop ()
this.priorSlide (override)
this.nextSlide (override)
slideChange (direction)
this.goToSlide (index, initializingCall, changeHandler, buttonHandler)
getSlideOptionalParams (slide)
this.slideTransitionTimeoutHandler (direction, imagePath, optionalParams, initializingCall)
calculateTargetIndex (index, direction, max)
this.initializeAudioMuteButtons ()
this.audioMute (muted)

INTERACTION

recordPriorViewCoordinates (called)
this.setView (x, y, z, r, callback, override)
view (x, y, z, r, callback, override)
this.zoom (zoomDir)
this.pan (panDir)
zoomAndPanContinuousStep ()
zoomAndPan (stepX, stepY, stepZ)
this.zoomAndPanToView (targetX, targetY, targetZ, targetR, duration, steps, callback)
zoomAndPanToViewStep (tX, tY, tZ, tR, duration, steps, callback)
this.zoomAndPanAllStop (override, overridePlaying)
zoomAndPanContinuousStop ()
zoomAndPanToViewStop ()
this.syncViewportRelated (syncWatermarks, syncHotspots, syncSlider, syncNav, syncRuler, syncImageSetSlider)
this.scaleTierToZoom (imageZ, syncOversize)
scaleTierToZoom (imageZ, syncOversize)
this.reset (prior)
this.labelScale (scaleDir)
labelScaleContinuousStep ()
labelScaleContinuousStop ()
this.toggleWatermarks (override)
this.toggleConstrainPan (override)
this.toggleSmoothPan ()
this.toggleBackfill ()
this.toggleDisplay ()

FULL VIEW, ROTATION, & IMAGE FILTERS

this.toggleFullViewModeExternal ()
this.toggleFullViewMode (override, escaped)
showButtonFullViewExitInternal (value)
showButtonFullViewExitExternal (value)
configureButtonFullViewExitExternal ()
buttonFullViewExitExternalHandler ()
this.rotateClockwise ()
this.rotateCounterwise ()
this.rotate (degreesDelta, useZaptv)
this.toggleEditModeMeasure (override)
this.increaseImageFilter (filter)
this.decreaseImageFilter (filter)
this.setImageFilter (filter, delta)
validateImageFiltersConvolve ()
this.clearImageFilterLast ()
this.clearImageFiltersAll ()
applyImageFilter (filter, delta, tileSet)
filterImageDisplay (display, filter, delta, tileSet)
filterImageObject (imageDataObject, filter, delta)
multiFilterImageObject (imageDataObject, filter, delta)
applyImageFilters (tileSet)
applyImageFiltersTile (image)
applyImageFiltersObject (imageDataObject)
syncImageFilterCanvas (frontOrBack)

EVENTS

initializeViewportEventListeners ()
viewportEventsHandler (event)
viewportEventsManager (event)
smoothPanStart (newPan)
smoothPanStop (clearPan)
smoothPanIntervalHandler (event)
smoothPanStep (event)
smoothAnimateStep (event)
viewerDisplayGestureChangeHandler (event)
zoomGesture (event)
calculateGestureZoom (tier, scale, gesturePercent)
this.fullScreenEscapeHandler (event)
this.mouseWheelHandler (delta)
displayEventsCoordinatesHandler (event)

TOOLBAR

Z.ZoomifyToolbar (tbViewport)

INITIALIZATION

initializeToolbar (tlbrSknDims, tlbrSknArr)
createImageFilterPanel (tlbrSknArr)

GET & SET

this.getInitialized ()
this.getSkinArray ()
this.getSkinSizes ()
this.show (value)
this.setVisibility (visible)
this.minimize (value)
this.setVisibilityAnnotationPanel (visible, vpIDs)
setVisibilityAnnotationPanel (visible, vpIDs)
this.toggleAnnotationPanelMode (editMode)
this.showProgress ()
this.hideProgress ()
this.updateProgress (total, current)
clearProgress ()
this.setViewport (tbVwprt)

CORE

getInitialized ()
setInitialized (initialized)
this.parseSkinXML (xmlDoc)
this.setSizeAndPosition (width, height, left, top)
drawLayout (width, height)
drawLayoutFilterPanel ()
show (value)
visibility (visible)
minimize (value)
this.syncSliderToViewportZoom (imageZ)
syncSliderToViewportZoom (imageZ)
sliderSnapZoom (event)
sliderSlideStartZoom (event)
sliderSlideZoom ()
sliderSlideEndZoom ()
calculateSliderZoom (sliderPosition, trkL, trkR)

IMAGESETS

this.syncSliderToViewportImageSet (imageSetSlide)
syncSliderToViewportImageSet (imageSetSlide)
sliderSnapImageSet (event)
sliderSlideStartImageSet (event)
sliderSlideImageSet ()
sliderSlideEndImageSet ()
calculateSliderImage (trackPosition, trkL, trkR)
sliderMouseMoveHandlerImageSet (event)
sliderTouchMoveHandlerImageSet (event)

EVENTS

this.buttonEventsHandler (event)
buttonEventsHandler (event)
buttonEventsManager (event, tbID)
this.backgroundEventsHandler (event)
setToolbarDefaults ()
sliderMouseMoveHandlerZoom (event)
sliderTouchMoveHandler (event)
buttonGraphicsUpdate (targetBtn, eT)
textElementRemoveFocus ()
this.positionButtonBorder (tbID)
this.imageFilterPanelShow ()
this.imageFilterPanelHide ()
imageFilterListChangeHandler (event)
this.addCounterToImageFilterList (imgFltrSel, count)
this.removeLastCounterFromImageFilterList (count)
this.removeAllCountersFromImageFilterList ()

NAVIGATOR

Z.ZoomifyNavigator (navViewport)

INITIALIZATION

loadNavigatorImage (successFunction, multiViewport)
loadNavigatorImagesMultiple (successFunction)
this.initializeNavigator (placeholder, image)
initializeNavigator (placeholder, image)
initializeNavigatorMultipleViewports ()
this.setImage (imagePath)
reinitializeNavigator (image)

GET & SET

this.getInitialized ()
getInitialized ()
setInitialized (initialized)
this.setVisibility (visible)
this.syncToViewport ()
this.syncNavigatorRectangleDimensions ()
this.syncNavigatorRotation ()
this.syncNavigatorRectangleToViewport (currentCenterPt)
this.setViewport (navVwprt)

CORE

this.validateNavigatorGlobals ()
validateNavigatorGlobals ()
this.setSizeAndPosition (width, height, left, top, fit, niW, niH)
setSizeAndPosition (width, height, left, top, fit, niW, niH)
drawLayout (width, height)
setSizeNavigatorImage (navW, navH)
visibility (visible)
syncToViewport ()
syncNavigatorRectangleDimensions ()
syncNavigatorRotation ()
syncNavigatorRectangleToViewport (vpImgCtrPt)
syncViewportToNavigatorRectangle ()
navigatorImageLoadingFailed ()

EVENTS

navigatorMouseDownHandler (event)
navigatorMouseMoveHandler (event)
navigatorMouseUpHandler (event)
navigatorTouchStartHandler (event)
navigatorTouchMoveHandler (event)
navigatorTouchEndHandler (event)
navigatorTouchCancelHandler (event)

RULER

Z.ZoomifyRuler (rulerViewport)

INITIALIZATION

initializeRuler ()
populateUnitsArray ()
populateMagnificationsArray ()
validateMagnificationList ()
drawLayout ()

GET & SET

this.getInitialized ()
getInitialized ()
setInitialized (initialized)
this.setVisibility (visible)
this.setSizeAndPosition (panel, width, height, left, top)
setSizeAndPosition (width, height, left, top)
this.syncToViewport (reset)

CORE

visibility (visible)
syncToViewport (reset)
setScaleBar ()
setMagnificationList (reset)
convertPercentToMagZoom (percent, srcMag)

EVENTS
magnificationListChangeHandler (event)

NETCONNECTOR

Z.NetConnector ()

this.loadXML (xmlPath, vpID)
this.loadJSON (jsonPath)
this.loadByteRange (filePath, rangeStart, rangeEnd, contentType, tile, chunkID)
loadImageByteRange (filePath, contentType, tile)
this.postXML (saveHandlerPath, xmlData)
this.postImage (saveImageHandlerPath, imageData)
makeNetRequest (url, callback, data, contentType, tile, chunkN)
createXMLHttpRequest ()
netRequestErrorHandler (e, url, contentType)
receiveResponse (xhr, vpID)
validateBytes (xhr, vpID)
validateJSON (jsonText, vpID)
validateXML (xmlDoc, vpID)
this.loadImage (src, callback, contentType, tile)
loadImage (src, callback, contentType, tile)
loadImagesFromQueue ()
onComplete (callback, src, img)
ImageNetRequest (src, callback, contentType)

UTILITY

Z.Utils =

addCrossBrowserMethods ()
this.disableTextInteraction (tN)
this.renderQuality (image, quality)
this.setOpacity (element, value, altColor)

addCrossBrowserEvents ()
this.addEventListener (target, eventName, handler)
this.removeEventListener (target, eventName, handler)
this.event (event)
this.target (event)
this.relatedTarget (event)
this.isRightMouseButton (event)
this.preventDefault (event)
this.stopPropagation (event)

declareGlobals ()
detectBrowserFeatures ()

COPYRIGHT

enforceCopyright ()
readCookie (name)
loadCopyrightText ()
showCopyright (cStateTxt, cDecTxt)
hideCopyright ()
copyrightAgreeButtonHandler (event)
copyrightExitButtonHandler (event)

PARAMETERS & RESOURCES

parseParameters (params)
parametersToDelimitedString (params, delimiter)
setParameters (params)
resetParametersXYZ (params)
validateImagePath (imageSetPath)
clearImageParameters ()
getResource (resName)

ELEMENTS & OBJECTS

clearDisplay (display)
clearCanvas (canvas)
colorCanvas (canvas, color)
deleteDiv (divID)
createCallback (object, method)
validateCallback (callbackEvent)
validateCallbackDelayed (callbackEvent, callbacksTempArr)
getContainerSize (container, display)
createContainerElement (tagName, id, display, position, overflow, width, height, left, top, borderStyle, borderWidth, background, margin, padding, whiteSpace, cursor, preventSelect)
createCenteredElement (elmt, id)
createTextElement (id, value, width, height, left, top, padding, border, borderWidth, readOnly, fontFamily, fontSize, resize, columns, rows, overflowX, overflowY, wrap)
createSelectElement (listID, listTitle, dataProvider, listW, listX, listY, fontSize, visible, handler, handlerType)
updateSelectElement (listObject, dataProvider, selID)
getChildElementByID (container, id)
getElementPosition (elmt)
getOffsetParent (elmt, isFixed)
getElementSize (elmt)
getElementStyle (elmt)
getElementStyleProperty (elmt, styleProp)
isElementFluid (element)
getEventTargetCoords (event)
getFirstTouch (event)
getMousePosition (event)
getMouseScroll (event)
getPageScroll ()
getScreenSize ()
getWindowSize ()
Button (id, label, graphicPath, graphicUp, graphicOver, graphicDown, w, h, x, y, btnEvnt, btnEvntHndlr, tooltipResource, borderStyle, borderWidth, background, margin, padding, whiteSpace, cursor)
buttonSize (targetBtn, w, h)
setButtonDefaults (targetBtn)
clearButtonSettings (targetBtn)
setButtonState (targetBtn, state)
setButtonHandler (target, btnEvnt, btnEvntHndlr)
Checkbox (id, value, w, h, x, y, checkEvnt, checkEvntHndlr, tooltipResource)
Graphic (id, graphicPath, graphic, w, h, x, y, altResource)
createGraphicElement (imageSrc)
graphicSize (targetGphc, w, h)
Point (x, y)
Point3D (x, y, z)
Trio (a, b, c)
Range (start, end)
swapZIndices (element1, element2)

COLORS, STRINGS, TEXT STYLES

stringValidate (value)
stringReadable (stringToModify)
stringLowerCaseFirstLetter (string)
stringUpperCaseFirstLetter (string)
stringMultiply (str, num)
stringRemoveTrailingSlashCharacters (stringToClean)
stringRemoveTabAndLineWrapCharacters (stringToClean)
stringUnescapeAmpersandCharacters (stringToClean)
setHTMLTextDefaultCaptionStyle (htmlTextNode, HTML, color, fontFamily, fontSize, fontSizeAdjust, fontStyle, fontStretch, fontVariant, fontWeight, lineHeight, textAlign, textDecoration)
setHTMLTextStyle (htmlTextNode, color, fontFamily, fontSize, fontSizeAdjust, fontStyle, fontStretch, fontVariant, fontWeight, lineHeight, textAlign, textDecoration)
setTextAreaStyle (textBox, color, fontFamily, fontSize, fontSizeAdjust, fontStyle, fontStretch, fontVariant, fontWeight, lineHeight, textAlign, textDecoration, padding)
setTextNodeStyle (textNode, color, fontFamily, fontSize, fontSizeAdjust, fontStyle, fontStretch, fontVariant, fontWeight, lineHeight, textAlign, textDecoration)
stringValidateColorValue (value)
hexToRGB (hexStr)

XML & JSON

xmlConvertTextToDoc (xmlText)
xmlConvertDocToText (xmlDoc)
xmlEscapeMinimal (content)
xmlUnescapeMinimal (content)
jsonConvertObjectToXMLText (jsonObject)
jsonConvertXMLTextToJSONText (xmlIn)
convertToObject (xml)
escapeMinimal (content)
innerXML (node)

ARRAYS

arrayClear (arr)
arrayClone (arrName, arrFrom, arrTo)
arrayIndexOf (arr, obj, fromIndex)
arrayIndexOfObjectValue (arr, subobj, obj, fromIndex)
arrayIndexOfObjectTwoValues (arr, subobj, obj, fromIndex, subobj2, obj2)
arrayIndexOfSubstring (arr, obj, fromIndex)
arrayIndexOfObjectValueSubstring (arr, subobj, obj, fromIndex, caseInsensitive)
arrayIntersect (a1, a2)
arrayMap (arr, fxn)
arraySplice (arr, iStart, iLength)
arraySubarraySimple (start, end)
arraySortNumericAscending (arr, a, b)
arraySortNumericDescending (arr, a, b)
arraySortByObjectValue (arr, subobj, a, b)
arraySubarray (arr, iIndexA, iIndexB )
arraySubarrayLen (arr, iStart, iLength)
arraySubtract (a1, a2)
arrayToArrayOfStrings (inputArr)
arrayUnique (arr)
arrayUniqueByObjectValue (arr, subobj)

AUDIO

playAudio (destinationNextAudio, destinationCurrentAudioSrc)
loadAudio (destinationNextAudioSrc)

MEASURING

calculatePointsDistance (x1, y1, x2, y2)
convertPixelsToUnits (pixels, pixelsPerUnit, unitsPerImage)
polygonArea (polyPts, polyClosed, clickPt, digits)
polygonCenter (polyPts, polyClosed, clickPt)
polygonDimensions (polyPts, clickPt)
polygonPerimeter (polyPts, polyClosed, clickPt, digits)

SCREEN MODE, ROTATION, & TRANSLATION

fullScreenView (element, fullScreen, escaped)
rotatePoint (x, y, rotDegs)
rotateElement (displayS, r, override)
getDisplayPositionRotated (displayS, r)
translateElement (displayS, x, y)

IMAGE FILTERS

filterImage (imageDataObject, filter, delta)
getImageData (img)
getCanvas (w, h)
createImageData (w,h)
createImageDataFloat32 (w,h)
createFloat32Array (len)
convolveImage (imgDataObj, weights, opaque)
convolveImageHorizontal (imgDataObj, weightsVector, opaque)
convolveImageVertical (imgDataObj, weightsVector, opaque)
convolveImageSeparable (imgDataObj, weightsH, weightsV, opaque)
convolveImageFloat32 (imgDataObj, weights, opaque)
convolveImageFloat32Horizontal (imgDataObj, weightsVector, opaque)
convolveImageFloat32Vertical (imgDataObj, weightsVector, opaque)

ZIF STORAGE

intValue (array, offset)
longValue (array, offset)
shortValue (array, offset)
createUint8Array (array, offset)
TypedArray (arg1)
setSimple (array, offset)
encodeBase64 (data)
validateResponseArrayFunctionality ()
defineObjectProperty (obj, name, def)
createImageElementFromBytes (src, callback)

MISCELLANEOUS

getCurrentUTCDateAsString ()
cacheProofPath (url)
easing (b, t, c, d)
functionCallWithDelay (functionToCall, delay)
nodeIsInViewer (nodeToTest)
roundToFixed (value, digits)
getRandomInt (min, max)
getSign (x)

DEBUGGING

drawCrosshairs (display, w, h)
configureHelpDisplay ()
helpOkButtonHandler (event)
showHelp (helpContent)
hideHelp ()
configureMessageDisplay ()
messageOkButtonHandler (event)
messageCancelButtonHandler (event)
showMessage (messageText, button, displayTime, textAlign, once)
getMessage ()
hideMessage ()
hideMessageTimerHandler ()
uploadProgress (event)
configureCoordinatesDisplay ()
showCoordinates (coordsText)
saveCoordinates (coordsText)
configureTraceDisplay ()
showTraces ()
hideTraces ()
trace (text, blankLineBefore, blankLineAfter)
traceTileStatus (required, cached, requested, loaded, displayed, waiting)
traceTileSpeed (tmElpsd, loadsPerSec)
showGlobals ()