JsDoc:

Overview

This is the Pictometry Online Image Navigator API. The Image Navigator is written entirely in Javascript and uses AJAX technology to interface to the Pictometry Online Image Database. Using the API a user can Search, View and Navigate oblique and orthogonal images.

See: Getting Started for a quick tutorial on how the Image Navigator API can be used in a web browser.

author: Steven D. Adams [email protected]
namespace: Pol.VI.ImageNavigator
version: 1.0.4.0

Pol.VI.ImageNavigator(obj, params)

Construct a new ImageNavigator object.

parameters

HTMLelement	obj	Bind to this HTML element.
Object	params	An object containing the parameters required to initialize the navigator.

methods

Init()

SetConfig(params)

GetConfig()

Search(latitude, longitude, cb, data)

GetSearchFilter()

SetSearchFilter(filter)

Navigate()

GetBookmark()

GotoBookmark(bookmark)

GetNextImage()

GetPrevImage()

GotoImage(position)

GetViewInfo()

IsViewActive()

SetView(level, type, orientation)

GetView()

ClearView(image)

SetImageLevel(level)

SetImageType(type)

SetOrientation(orientation)

SetAutoNavigate(onoff)

GetAutoNavigate()

SetMousePan(onoff)

GetMousePan()

SetCursors(cursors, x, y)

ResetCursors()

SetMouseWheelZoom(onoff, reverse)

GetMouseWheelZoom()

SetMouseWheelIncr(incr)

GetMouseWheelIncr()

GetMagnifier()

SetMagnifier(cfg)

EnableKeyDown(keys)

DisableKeyDown()

EnableKeyUp(keys)

DisableKeyUp()

AttachEvent(event, fn, sObj)

DetachEvent(event, fn, sObj)

PanImage(deltaX, deltaY)

PanTo(latitude, longitude)

ContinuousPan(deltaX, deltaY)

StopContinuousPan()

GetCenter()

SetCenter(imageX, imageY)

GetViewer()

SetViewerSize(width, height)

GetViewerSize()

GetViewerPosition()

SetScoreBias(bias)

GetScoreBias()

SetScale(scalefactor)

SetOpacity(opacity)

Hide()

Show()

IsAvailable(level, type, orientation)

FindFirstOblique()

GetX()

GetY()

GetWidth()

GetHeight()

GetLevel()

GetType()

GetOrientation()

GetHeading()

GetDay()

GetMonth()

GetYear()

GetName()

GetThumbnail()

GetScale()

GetGSD()

GetImageInfo()

GetVersion()

GetViewPort()

GetCenterLatLng(cb)

GetXYZ(imageinfo, cb)

GetLatLngBounds(cb)

GetTileUrl(x, y)

SetEdgeLimit(limit)

GetEdgeLimit()

SetRequestTimeout(timeout)

GetRequestTimeout()

SetExportOverlay(onoff)

GetExportOverlay()

Export(region, format, callback)

AddGeoFence(xmin, xmax, ymin, ymax)

GetStatistics(cb, total)

ConvertCoordinate(latitude, longitude, format)

ConvertDistanceUnit(distance, from, to)

ConvertAreaUnit(area, from, to)

Print(region, cfg)

ExportImage(region, format)

ExportWorldFile(region)

GetLink(region, cb, format)

Pol.VI.ImageNavigator.Init()

Initialize the Image Navigator object. This must be called before any other methods.

Pol.VI.ImageNavigator.SetConfig(params)

Set Image Navigator API configuration.

The configuration object can take these fields:

 UserId - (int) User identification.
 ServerProxy - (string) Server proxy URL.
 SSL - (Boolean) Makes all requests using SSL (https). Default is false.
 AutoNavigate - (Boolean) Enables automatic navigation from image set to image set. Default is false.
 EnableMousePan - (Boolean) Enables the mouse for panning an image. Default is true.
 EnableMouseWheelZoom - (Boolean) Enables the mouse wheel for changing zoom levels. Default is false.
 FadeEffect - (Object) Enables the fade effect on view and scale changes and sets the fade duration. The FadeEffect fields and defaults are described below:
    enable - (Boolean) True enables, false disables. Default is true.
    duration - (float) Duration, in seconds, of the fade effect. Default is 1 second.
 CenterMarker - (Object) Places a fixed marker at the center of the viewport. The CenterMarker fields and defaults are described below:
    enable - (Boolean) True enables, false disables. Default is false.
    url - (string) A URL to the marker image.
    width - (int) Width of the marker image.
    height - (int) Height of the marker image.
 HideOnDrag - (Boolean) Hides overlays when dragging an image. This can improve performance with dense or multiple layers. Default is true.
 EnhancedCursor - (Object) Enables a crosshair cursor in place of the "hand" cursor.
 	active - (boolean) Turns the enhanced cursor on/off.
 	strokeColor - (HTML color code) Cursor color.
 	strokeWeight - (int) Cursor line thickness in pixels.
 	strokeOpacity - (float) Cursor line opacity. 0.0 - Transparent, 1.0 - Opaque. Default is 1.0.
 	gap - (int) Gap around the center point of the crosshair. Default is 3 pixels.

 NOTE: The field names are case-sensitive.

parameters

Object

params

The configuration parameters object.

Pol.VI.ImageNavigator.GetConfig()

Get Image Navigator API configuration.

The returned configuration object contains these fields:

 UserId - (int) User identification.
 ServerProxy - (string) Server proxy URL.
 SSL - (Boolean) Makes all requests using SSL (https).
 AutoNavigate - (Boolean) Enables automatic navigation from image set to image set.
 EnableMousePan - (Boolean) Enables the mouse for panning an image.
 EnableMouseWheelZoom - (Boolean) Enables the mouse wheel for changing zoom levels.
 FadeEffect - (Object) Enables the fade effect on view and scale changes and sets the fade duration.
    enable - (Boolean) True enables, false disables.
    duration - (float) Duration, in seconds, of the fade effect.
 CenterMarker - (Object) Places a fixed marker at the center of the viewport. The CenterMarker fields and defaults are described below:
    enable - (Boolean) True enables, false disables. Default is false.
    url - (string) A URL to the marker image.
    width - (int) Width of the marker image.
    height - (int) Height of the marker image.
 HideOnDrag - (Boolean) Hides overlays when dragging an image.
 EnhancedCursor - (Object) Enables a crosshair cursor in place of the "hand" cursor.
 	active - (boolean) Turns the enhanced cursor on/off.
 	strokeColor - (HTML color code) Cursor color.
 	strokeWeight - (int) Cursor line thickness in pixels.
 	strokeOpacity - (float) Cursor line opacity. 0.0 - Transparent, 1.0 - Opaque. Default is 1.0.
 	gap - (int) Gap around the center point of the crosshair. Default is 3 pixels.

returns

Object

The configuration parameters object.

Pol.VI.ImageNavigator.Search(latitude, longitude, cb, data)

Search image database based on latitude/longitude.

parameters

float	latitude	Latitude to search.
float	longitude	Longitude to search.
function	cb	User provided method to call with search status.
Object	data	(Optional) User provided data to return with search status.

Pol.VI.ImageNavigator.GetSearchFilter()

Get Search Filter.

Returned object contains these fields:

 range - Search range.
 depth - View depth.

returns

Object

The search filter.

Pol.VI.ImageNavigator.SetSearchFilter(filter)

Set Search Filter.

parameters

Object

filter

New search filter.

Pol.VI.ImageNavigator.Navigate()

Navigate to a new image set using the position in the current view as a reference.

Pol.VI.ImageNavigator.GetBookmark()

Bookmark the current image.

This method captures the current image and returns a bookmark that can later be used with the GotoBookmark() method.
method to return to this image.

returns

string

Bookmark link.

Pol.VI.ImageNavigator.GotoBookmark(bookmark)

Goto a bookmarked image.

parameters

string

bookmark

The bookmark link.

Pol.VI.ImageNavigator.GetNextImage()

Get the next image in the selected view. Cycles to the first entry after hitting the end.

Pol.VI.ImageNavigator.GetPrevImage()

Get the previous image in the selected view. Cycles to the last entry after hitting the beginning.

Pol.VI.ImageNavigator.GotoImage(position)

Goto specific image in the selected view.

parameters

int

position

Index of image within the selected view.

Pol.VI.ImageNavigator.GetViewInfo()

Get information about this view.

Returned object contains these fields:

 position - Position in list of selected image.
 count - Total number of images in this view.
 view - Array of positions, names and dates for each image in the selected view.
   position - Position of image in view.
   name - Image name
   date.year - Image capture year.
   date.month - Image capture month.
   date.day - Image capture day.
   thumb - Link to the thumbnail image.

The view.position field can be passed to the GotoImage() method to select a specific image.

returns

Object

Total number of images available and position in the selected view.

Pol.VI.ImageNavigator.IsViewActive()

Determine if there is an active view.

returns

boolean

True if a view is active.

Pol.VI.ImageNavigator.SetView(level, type, orientation)

Display the image with the specified level, type and orientation.

NOTE: Returns false for image type Orthogonal with any orientation other than North.

parameters

ImageLevel	level	Neighboorhood or Community.
ImageType	type	Orthogonal or Oblique.
Orientation	orientation	North, East, South, or West.

returns

boolean

True if image can be displayed.

Pol.VI.ImageNavigator.GetView()

Return an object containing the current image level, type and orientation.

Returned object contains these fields:

 level - Image Level.
 type  - Image Type.
 orientation - Image Orientation.

returns

Object

The image view.

Pol.VI.ImageNavigator.ClearView(image)

Clear all tiles in the view and set them to image or default.

parameters

string

image

(Optional) URL to image.

Pol.VI.ImageNavigator.SetImageLevel(level)

Changes the image level, but keeps the same type and orientation set in SetView

parameters

ImageLevel

level

Neighboorhood or Community.

returns

boolean

True if requested level exists.

Pol.VI.ImageNavigator.SetImageType(type)

Changes the image type, but keeps the same level set in SetView

NOTE: Switching to Orthogonal automatically changes the orientation to North.

parameters

ImageType

type

Orthogonal or Oblique.

returns

boolean

True if requested type exists.

Pol.VI.ImageNavigator.SetOrientation(orientation)

Changes the image orientation, but keeps the same level and type set in SetView

parameters

Orientation

orientation

North, East, South, or West.

returns

boolean

True if requested orientation exists.

Pol.VI.ImageNavigator.SetAutoNavigate(onoff)

Sets the auto navigate flag.

parameters

boolean

onoff

True enables auto navigate. False disables auto navigate.

Pol.VI.ImageNavigator.GetAutoNavigate()

Gets the auto navigate flag.

returns

boolean

True if AutoNavigate is on.

Pol.VI.ImageNavigator.SetMousePan(onoff)

Sets the mouse pan flag.

parameters

boolean

onoff

True enables mouse pan. False disables mouse pan.

Pol.VI.ImageNavigator.GetMousePan()

Gets the mouse pan flag.

returns

boolean

True if mouse pan is enabled.

Pol.VI.ImageNavigator.SetCursors(cursors, x, y)

Sets the specified cursors.

 cursors.grab - URL to new grab cursor or a built-in cursor.
 cursors.grabbing - URL to new grabbing cursor or a built-in cursor.
 cursors.navigate - URL to new navigate cursor or a built-in cursor.

parameters

Object	cursors	Object containing new cursors.
int	x	(Optional) x-coordinate for cursor hotspot.
int	y	(Optional) y-coordinate for cursor hotspot.

Pol.VI.ImageNavigator.ResetCursors()

Reset the default cursors.

Pol.VI.ImageNavigator.SetMouseWheelZoom(onoff, reverse)

Sets the mouse wheel zoom flag.

parameters

boolean	onoff	True enables mouse wheel zoom. False disables mouse wheel zoom.
boolean	reverse	(Optional) Reverse zoom action when the mouse wheel is rotated. Default is zoom out when the wheel is rotated toward the user.

Pol.VI.ImageNavigator.GetMouseWheelZoom()

Gets the mouse wheel zoom flag.

returns

boolean

True if mouse wheel is enabled.

Pol.VI.ImageNavigator.SetMouseWheelIncr(incr)

Set the mouse wheel scale increment. Range is 0.01 - 1.0

parameters

float

incr

The new scale increment.

Pol.VI.ImageNavigator.GetMouseWheelIncr()

Get the mouse wheel scale increment.

returns

float

The current mouse wheel scale increment.

Pol.VI.ImageNavigator.GetMagnifier()

Get the Magnifier Loupe configuration.

The returned configuration object contains these fields:

 visible - (Boolean) Turns the magnifier on/off.
 width  - (Integer) Width of the magnifer in pixels.
 height  - (Integer) Height of the magnifer in pixels.
 level - (Integer) Zoom level.
 border - (Object) Fields are:
    width - Border width in pixels.
    style - Border style: solid, dashed or dotted.
    color - Border color.

returns

Object

Configuration object.

Pol.VI.ImageNavigator.SetMagnifier(cfg)

Set the Magnifier Loupe configuration.

The configuration object takes these fields:

 visible - (boolean) Turns the magnifier on/off.
 width  - (integer) Width of the magnifer in pixels.
 height  - (integer) Height of the magnifer in pixels.
 level - (integer) Zoom level.
 border - (Object) Fields are:
    width - Border width in pixels.
    style - Border style: solid, dashed or dotted.
    color - Border color.

parameters

cfg

Configuration object.

Pol.VI.ImageNavigator.EnableKeyDown(keys)

Enable the key down listener.

parameters

Object

keys

Object containing the listener keys.

Pol.VI.ImageNavigator.DisableKeyDown()

Disable the key down listener.

Pol.VI.ImageNavigator.EnableKeyUp(keys)

Enable the key up listener.

parameters

Object

keys

Object containing the listener keys.

Pol.VI.ImageNavigator.DisableKeyUp()

Disable the key up listener.

Pol.VI.ImageNavigator.AttachEvent(event, fn, sObj)

Attach function to an event.

parameters

string	event	The name of the event that generates the call.
function	fn	The name of the function to run when the event fires.
Object	sObj	Optional shape object.

returns

boolean

True if event is valid.

Pol.VI.ImageNavigator.DetachEvent(event, fn, sObj)

Detach the function from the event.

parameters

string	event	The name of the event to detach.
function	fn	The name of the function to detach.
Object	sObj	Optional shape object.

returns

boolean

True if event is valid.

Pol.VI.ImageNavigator.PanImage(deltaX, deltaY)

Pan the image deltaX pixels horizontally and deltaY pixels vertically.

parameters

int	deltaX	Number of pixels to pan horizontally.
int	deltaY	Number of pixels to pan vertically.

Pol.VI.ImageNavigator.PanTo(latitude, longitude)

Pan to the latitude/longitude image.

parameters

float	latitude	Latitude to pan.
float	longitude	Longitude to pan.

Pol.VI.ImageNavigator.ContinuousPan(deltaX, deltaY)

Continuously pan the image in deltaX/deltaY pixel increments until told to stop or change direction. A call to this method can be made at anytime to cancel the current pan direction and begin using the new deltaX/deltaY.

parameters

int	deltaX	Number of pixels to pan horizontally.
int	deltaY	Number of pixels to pan vertically.

Pol.VI.ImageNavigator.StopContinuousPan()

Stop continuous pan.

Pol.VI.ImageNavigator.GetCenter()

Get the x,y coordinates where the image is centered.

Returned object contains these fields:

 x - X image coordinate.
 y - Y image coordinate.

returns

Object

The x,y coordinates.

Pol.VI.ImageNavigator.SetCenter(imageX, imageY)

Center the image on imageX/imageY

parameters

int	imageX	The X image coordinate.
int	imageY	The Y image coordinate.

Pol.VI.ImageNavigator.GetViewer()

Returns the HTML element to which the Image Navigator is bound.

returns

HTMLelement

Image viewer HTML element.

Pol.VI.ImageNavigator.SetViewerSize(width, height)

Set the image viewport to the specified size.

NOTE: A width/height without units defaults to pixels. To specify a precentage or em, you must pass a string like '100%' or '200em'.

parameters

int or string	width	The width of the viewport.
int or string	height	The height of the viewport.

Pol.VI.ImageNavigator.GetViewerSize()

Returns an object containing the viewer's width and height in pixels.

Returned object contains these fields:

 width  - Viewer width.
 height - Viewer height.

returns

Object

viewer width/height in pixels.

Pol.VI.ImageNavigator.GetViewerPosition()

Returns an object containing the viewer's top and left offset in pixels.

Returned object contains these fields:

 top  - Top offset in pixels.
 left - Left offset in pixels.

returns

Object

viewer top/left in pixels.

Pol.VI.ImageNavigator.SetScoreBias(bias)

Sets the Image Score Bias value.

parameters

int

bias

Bias values are 0 = Oblique, 1 = Center.

Pol.VI.ImageNavigator.GetScoreBias()

Returns the Image Score Bias value.

returns

int	Score bias.

Pol.VI.ImageNavigator.SetScale(scalefactor)

Scale the image tiles and grid to the specified factor.

parameters

float

scalefactor

The new scale factor.

Pol.VI.ImageNavigator.SetOpacity(opacity)

Set the opacity of the viewer.

parameters

float

opacity

The new opacity value (0.0 - 1.0).

Pol.VI.ImageNavigator.Hide()

Hide the image viewport.

Pol.VI.ImageNavigator.Show()

Display the image viewport.

Pol.VI.ImageNavigator.IsAvailable(level, type, orientation)

Determines if the image is available with the specified level, type and orientation.

NOTE: Returns false for image type Orthogonal with any orientation other than North.

parameters

ImageLevel	level	Neighboorhood or Community.
ImageType	type	Orthogonal or Oblique.
Orientation	orientation	North, East, South, or West.

returns

boolean

True if image exists.

Pol.VI.ImageNavigator.FindFirstOblique()

Finds the first oblique image in the scene or an orthogonal if no obliques exist.

The search order is:

  1) Neighborhood-level Oblique. First from North, East, South and West.
  2) Community-level Oblique. First from North, East, South and West.
  3) Neighborhood-level Orthogonal.
  4) Community-level Orthogonal.

Returned object contains these fields:

 level - Image Level.
 type  - Image Type.
 orientation - Image Orientation.

returns

Object

First available image.

Pol.VI.ImageNavigator.GetX()

Gets the image x coordinate of the selected image that corresponds to the search location.

returns

int	x coordinate.

Pol.VI.ImageNavigator.GetY()

Gets the image y coordinate of the selected image that corresponds to the search location.

returns

int	y coordinate.

Pol.VI.ImageNavigator.GetWidth()

Gets the width, in pixels, of the selected image.

returns

int	Image width.

Pol.VI.ImageNavigator.GetHeight()

Gets the height, in pixels, of the selected image.

returns

int	Image height.

Pol.VI.ImageNavigator.GetLevel()

Gets the level for the selected image.

returns

Pol.VI.ImageLevel

Image shot level.

Pol.VI.ImageNavigator.GetType()

Gets the type for the selected image.

returns

Pol.VI.ImageType

Image shot type.

Pol.VI.ImageNavigator.GetOrientation()

Gets the general orientation for the selected image.

returns

Pol.VI.Orientation

Image shot orientation.

Pol.VI.ImageNavigator.GetHeading()

Gets the compass heading, in degrees, for the selected image.

returns

float

Compass heading.

Pol.VI.ImageNavigator.GetDay()

Gets the numeric day (1-31) when the selected image was shot.

returns

int	Image shot day.

Pol.VI.ImageNavigator.GetMonth()

Gets the numeric month (1-12) when the selected image was shot.

returns

int	Image shot month.

Pol.VI.ImageNavigator.GetYear()

Gets the year (20XX) when the selected image was shot.

returns

int	Image shot year.

Pol.VI.ImageNavigator.GetName()

Gets the name of the selected image.

returns

string

Image name.

Pol.VI.ImageNavigator.GetThumbnail()

Gets the thumbnail URL for the selected image.

returns

string

Thumbnail URL.

Pol.VI.ImageNavigator.GetScale()

Gets the scale factor.

returns

float

Scale factor.

Pol.VI.ImageNavigator.GetGSD()

Gets the Ground Sample Distance (GSD) of the selected image.

The GSD object contains two fields:

  current - The GSD of the the current image.
  next - The GSD of the image at the next level.

  If the current image is a Neighbhorhood, then next is the GSD for its Community partner.
  If the current image is a Community, then next is the GSD for its Neighborhood partner.

returns

Object

Image GSD object.

Pol.VI.ImageNavigator.GetImageInfo()

Get an Image Info container object for the selected image.

returns

Pol.VI.ImageInfo

Image Info object.

Pol.VI.ImageNavigator.GetVersion()

Get the API version string.

returns

string

Version string.

Pol.VI.ImageNavigator.GetViewPort()

Get the image coordinates visible in the view port.

Returned object contains these fields:

 ul.x - Upper left X coordinate.
 ul.y - Upper left Y coordinate.

 ur.x - Upper right X coordinate.
 ur.y - Upper right Y coordinate.

 lr.x - Lower right X coordinate.
 lr.y - Lower right Y coordinate.

 ll.x - Lower left X coordinate.
 ll.y - Lower left Y coordinate.

returns

Object

Image coordinates.

Pol.VI.ImageNavigator.GetCenterLatLng(cb)

Get the lat/lng of the point centered in the viewport.

Returned object in the callback contains these fields:

 status - Status code.
 reason - Text description of the status code.
 latitude - Latitude where image is centered.
 longitude - Longitude where image is centered.

parameters

function

cb

User provided method to call with result.

Pol.VI.ImageNavigator.GetXYZ(imageinfo, cb)

Calculate 3D Points. This feature calculates the latitude, longitude and elevation of points using two images as references.

IMPORTANT: For best results use an oblique and an orthogonal image for the measurement.

NOTE: This feature requires activation by Pictometry.

This method requires a minimum of two ImageInfo objects. These objects represent the two images on which
the calculation will be performed. These objects are obtained by calling GetImageInfo().

Multiple pairs of ImageInfo objects can be sent to GetXYZ in the imageinfo array.

The ImageInfo object exposes a method: AddPoint that is used to add the image coordinates for the
computation.

The callback object contains these fields:

 status - Status code.
 reason - Text description of status code.
 points - Array of objects.

 Each entry in the array is an object containing these fields:

   latitude - The computed latitude of the point.
   longitude - The computed longitude of the point.
   elevation - The computed elevation above mean sea level (MSL) in meters.

parameters

Array	imageinfo	Array of ImageInfo objects.
function	cb	User provided method to call with result.

returns

Object

Array of 3D point objects.

Pol.VI.ImageNavigator.GetLatLngBounds(cb)

Get the lat/lng bounds of the visible image.

NOTE: This feature requires activation of the Tools module..

Returned object in the callback contains these fields:

 status - Status code.
 reason - Text description of the status code.
 center.latitude - Latitude where image is centered.
 center.longitude - Longitude where image is centered.
 ul.latitude - Upper left latitude of visible image.
 ul.longitude - Upper left longitude of visible image.
 ur.latitude - Upper right latitude of visible image.
 ur.longitude - Upper right longitude of visible image.
 lr.latitude - Lower right latitude of visible image.
 lr.longitude - Lower right longitude of visible image.
 ll.latitude - Lower left latitude of visible image.
 ll.longitude - Lower left longitude of visible image.

parameters

function

cb

User provided method to call with result.

Pol.VI.ImageNavigator.GetTileUrl(x, y)

Get the URL to fetch the tile that maps to the give x,y. If no x,y are given, the method returns the url for the tile currently centered in the viewport.

parameters

int	x	Image x coordinate (optional).
int	y	Image y coordinate (optional).

returns

string

Image tile url. Returns null if x,y is out of bounds.

Pol.VI.ImageNavigator.SetEdgeLimit(limit)

Sets the Edge Limit value. Must be greater than or equal to 0 and less than or equal to 256. Default is 100.

parameters

int

limit

Edge limit in pixels.

Pol.VI.ImageNavigator.GetEdgeLimit()

Gets the Edge Limit value.

returns

int	Edge limit.

Pol.VI.ImageNavigator.SetRequestTimeout(timeout)

Sets the Request Timeout value. Default is 15000 ms.

parameters

int

timeout

Timeout value in milliseconds.

Pol.VI.ImageNavigator.GetRequestTimeout()

Gets the Request Timeout value.

returns

int	Timeout value in milliseconds.

Pol.VI.ImageNavigator.SetExportOverlay(onoff)

Set the export overlay flag. When true, the overlay shape data is added to the image when Export() is called.

NOTE: This feature requires activation of the Export option..

parameters

boolean

onoff

True for export. Default is false.

Pol.VI.ImageNavigator.GetExportOverlay()

Get the export overlay flag.

NOTE: This feature requires activation of the Export option..

returns

boolean

Current state of export overlay flag.

Pol.VI.ImageNavigator.Export(region, format, callback)

Export a region of an image in the specified format.

NOTE: Each export type requires activation by Pictometry.
NOTE: World file export is valid for Orthogonal images only.

 The region object requires these fields containing image coordinates:
   ul.x - Upper-left x-coordinate.
   ul.y - Upper-left y-coordinate.
   lr.x - Lower-right x-coordinate.
   lr.y - Lower-right y-coordinate.

 The format object requires these fields describing the export type and image format:
   format.type - Export Type: Image, WorldFile, KML or KMZ.
   format.image - Image format: JPEG, GIF or PNG.

 There is an optional format field:
   format.options - Image options: Add datestamp and/or north pointer.

parameters

Object	region	Image coordinates that specify the image region to save.
Object	format	Export type and image format. See ExportTypes and ImageFormats and ImageOptions.
function	callback	(Optional) User provided method returns a URL instead of a "Save As" dialog.

Pol.VI.ImageNavigator.AddGeoFence(xmin, xmax, ymin, ymax)

Restrict access to the geographic boundary defined by xmin,xmax,ymin,ymax.

parameters

float	xmin	Minimum longitude of the fence.
float	xmax	Maximum longitude of the fence.
float	ymin	Minumum latitude of the fence.
float	ymax	Maximum latitude of the fence.

returns

boolean

True if fence is valid.

Pol.VI.ImageNavigator.GetStatistics(cb, total)

Return the Image Navigator API statistics.

The statistics object has these fields:

blocks - The number of activity blocks.
searches - The number of searches/navigations.
views - The number of views.
exports - The number of exports.

parameters

function	cb	User provided method to call with results.
boolean	total	True returns total stats for this user. False returns stats for this instantiation of the ImageNavigator object.

returns

Object

Object containing Image Navigator API statistics.

Pol.VI.ImageNavigator.ConvertCoordinate(latitude, longitude, format)

Convert a coordinate in Decimal Degrees to format.

parameters

float	latitude	Latitude to convert.
float	longitude	Longitude to convert.
Pol.VI.CoordinateFormats	format	Coordinate conversion format.

returns

Location

Object containing a latitude and longitude field.

Pol.VI.ImageNavigator.ConvertDistanceUnit(distance, from, to)

Convert a distance value from one unit to another.

parameters

float	distance	Distance value to convert.
Pol.VI.DistanceUnits	from	Unit to convert from.
Pol.VI.DistanceUnits	to	Unit to convert to.

returns

float

Converted distance value.

Pol.VI.ImageNavigator.ConvertAreaUnit(area, from, to)

Convert an area value from one unit to another.

parameters

float	area	Area value to convert.
Pol.VI.AreaUnits	from	Unit to convert from.
Pol.VI.AreaUnits	to	Unit to convert to.

returns

float

Converted area value.

Pol.VI.ImageNavigator.Print(region, cfg)

Print the image.

  The cfg object contains these fields. Only set the fields you wish to change.

     flags - (int) Print with Date, NorthPointer and/or Overlays. There are no flags set by default. See: ImageOptions
     title - (string) Title for the image. Defaults to the image name.
     cb - (function) Callback method to return the print URL. Defaults to submitting the image for printing.

  NOTE: Adding a callback prevents the API from submitting the URL to the printer.
  NOTE: The print URL is a one-time use only.

  The object returned in the callback has 3 fields:
     status - Status code.
     reason - Text description of the status code.
     url - The print URL.

parameters

Object	region	Image coordinates that specify the image region to print.
Object	cfg	(Optional) Print configuration object. See description above.

Pol.VI.ImageNavigator.ExportImage(region, format)

Export the current image with dimensions defined by the specified region.

NOTE: This method is deprecated since version 1.0.3.7. You should now use Export.

parameters

Object	region	Image coordinates that specify the image region to save.
Pol.VI.ImageFormats	format	Image output format in JPEG, GIF or PNG. Default is JPEG.

Pol.VI.ImageNavigator.ExportWorldFile(region)

Export a world file for the current image with dimensions defined by the specified region.

NOTE: This method is deprecated since version 1.0.3.7. You should now use Export.

parameters

Object

region

Image coordinates that specify the image region to export.

Pol.VI.ImageNavigator.GetLink(region, cb, format)

Return a link for the current image with dimensions defined by the specified region.

NOTE: This method is deprecated since version 1.0.3.7. You should now use Export.

parameters

Object	region	Image coordinates that specify the image region to save.
function	cb	User provided method to call with results.
Pol.VI.ImageFormats	format	(Optional) Output format in JPEG, GIF, PNG or WorldFile. Default is JPEG.

Pol.VI.ImageInfo(table, index)

The ImageInfo container object.

This object is returned from a call to GetImageInfo().

parameters

string	table	Table id of the image.
string	index	Index of the image.

returns

Object

A new ImageInfo object.

Pol.VI.ImageInfo.AddPoint(x, y)

Add an x,y point to the container.

parameters

int	x	Image X-coordinate.
int	y	Image Y-Coordinate.

Pol.VI.Base64

Base64 encode / decode

 See:  Base64

Pol.VI.ImageLevel

An enumeration of image levels.

properties

string	Neighborhood	Smaller area, Higher resolution.
string	Community	Larger area, Lower resolution.

Pol.VI.ImageType

An enumeration of image types.

properties

string	Orthogonal	View is straight down.
string	Oblique	View is from an angle.

Pol.VI.Orientation

An enumeration of image orientations.

properties

string	North	Top of the image looks toward the North.
string	East	Top of the image looks toward the East.
string	South	Top of the image looks toward the South.
string	West	Top of the image looks toward the West.

Pol.VI.Events

Events supported by the ImageNavigator API.

properties

ImageEvent	onclick	Fired when user left mouse clicks an image.
ImageEvent	ondblclick	Fired when user left mouse double clicks an image.
ImageEvent	onmousedown	Fired when user presses the mouse on an image.
ImageEvent	onmouseup	Fired when user releases the mouse on an image.
ImageEvent	oncontextmenu	Fired when user right mouse clicks an image.
ImageEvent	onstartmeasurement	Fired when a user begins a measurement.
ImageEvent	onendmeasurement	Fired when a user ends a measurement.
ImageEvent	onstartselect	Fired when the Select tool is active and a user begins a selection.
ImageEvent	onendselect	Fired when the Select tool is active and a user ends a selection.
KeyEvent	onkeydown	Fired when the key listener is active and the user presses a specified key.
KeyEvent	onkeyup	Fired when the key listener is active and the user releases a specified key.
ViewEvent	onviewchange	Fired when a new view is loaded in the viewport.
ViewEvent	onscalechange	Fired when the scale factor changes.
ViewEvent	onresize	Fired when the viewport is resized.
InfoEvent	onedgedetect	Fired when user pans to limit of an image.
InfoEvent	ondragstart	Fired when user starts dragging the image with the mouse.
InfoEvent	ondragend	Fired when user stops dragging the image and releases the mouse.
InfoEvent	onstartcontinuouspan	Fired when user calls the ContinuousPan() method.
InfoEvent	onstopcontinuouspan	Fired when user calls the StopContinuousPan() method.
InfoEvent	onoverlayrendered	Fired when an overlay has completed rendering.
InfoEvent	onnavigatefail	Fired when a Navigate() operation has failed.
InfoEvent	onerror	Fired when there is an internal ImageNavigator API error.
AncillaryEvent	ongroundplanechange	Fired when the Ground Plane has changed.

Pol.VI.ImageEvent

Image event object returned to the user.

Object Pol.VI.ImageEvent.mouse

Contains the mouse click coordinates relative to the ImageNavigator container element.

properties

int	x	Mouse x coordinate.
int	y	Mouse y coordinate.

Object Pol.VI.ImageEvent.image

Contains the image relative coordinates of the mouse click.

properties

int	x	Image x coordinate.
int	y	Image y coordinate.

Object Pol.VI.ImageEvent.type

Contains the mouse event type.

properties

string

type

Mouse event type.

Object Pol.VI.ImageEvent.target

Contains a reference to the event object.

properties

Object

target

Reference to object on which the event was taken.

Pol.VI.ViewEvent

View event object returned to the user.

Object Pol.VI.ViewEvent.view

Contains information about the current view.

properties

ImageLevel	level	Image level.
ImageType	type	Image type.
Orientation	orientation	Image orientation.

float Pol.VI.ViewEvent.scale

Contains the current view scale factor.

properties

float

scale

Scale factor.

Pol.VI.InfoEvent

Info event object returned to the user.

int Pol.VI.InfoEvent.status

Status code.

properties

int

status

Status code of operation.

string Pol.VI.InfoEvent.reason

Text description.

properties

string

reason

Text description of the status code.

Pol.VI.KeyEvent

Key event object returned to the user.

string Pol.VI.KeyEvent.type

Key event type.

properties

string

type

Key event type. keydown or keyup.

int Pol.VI.KeyEvent.keycode

Text description.

properties

int

keycode

ASCII code of the key.

Pol.VI.AncillaryEvent

The Ancillary event object is a catch-all for events that don't conform to the standard Image, View, or Info events.

The Ancillary events are:

Ground Plane

Pol.VI.AncillaryEvent.GroundPlane

Ground Plane event object returned when an 'ongroundplanechange' event has fired.

The ground plane event returns these fields:

active - Indicates the ground plane status.
elevation - The new offset ground plane elevation (in meters).
offset - The offset from the true ground plane (in meters).

boolean Pol.VI.AncillaryEvent.GroundPlane.active

Is ground plane active?

properties

boolean

active

Indicates the ground plane status.

float Pol.VI.AncillaryEvent.GroundPlane.elevation

The new offset ground plane elevation.

properties

float

elevation

The new offset ground plane elevation (in meters).

float Pol.VI.AncillaryEvent.GroundPlane.offset

The offset from the true ground plane.

properties

float

offset

The offset from the true ground plane (in meters).

Pol.VI.Status

Status object. Returned as search callback object or when the onerror event is fired.

Status Code	Reason	Meaning
0	OK	Search completed successfully.
1	No Images Available	No image coverage for the given latitude/longitude.
2	Server Error	An error occurred on the server. Retry the request.
3	Service Unavailable	The Image Service is currently unavailable. Try again at a later time.
4	Bad Request	The supplied coordinates are undefined or out of bounds.
5	Authorization Failed	The supplied user credentials are not valid.
6	Access Denied	The user does not have access to requested feature.
7	Unknown Request	An unknown type of request was made.
8	Incomplete Request	The request does not have all the required parameters.
9	Database Error	The request cannot be fulfilled due to a database error.
10	Bad Data	The response data from the server cannot be parsed.
11	Set View Failed	A navigate operation could not set the requested view.
12	Geographic Boundary Exceeded	An attempt was made to navigate beyond the established geographic boundaries.
13	No Data Available	Data is not available to perform the requested operation.

properties

int	status	Status code
string	reason	Text description of the status code.

Pol.VI.SearchRange

An enumeration of search filter ranges.

properties

string	MostRecent	Return the Most Recent images available.
string	LeastRecent	Return the Least Recent images available.

Pol.VI.SearchFilter

The Search Filter object.

Object Pol.VI.SearchFilter.range

Search range.

properties

Pol.VI.SearchRange

range

Search range.

int Pol.VI.SearchFilter.depth

View depth.

properties

int

depth

View depth.

Pol.VI.Translate

An enumeration of translation types.

properties

int	LocationToImage	Translate location coordinates to image coordinates.
int	ImageToLocation	Translate image coordinates to location coordinates.

Pol.VI.DistanceUnits

An enumeration of Distance Units.

properties

int	Inches	Distance in inches.
int	Feet	Distance in feet.
int	Yards	Distance in yards.
int	Miles	Distance in miles.
int	Millimeters	Distance in millimeters.
int	Centimeters	Distance in centimeters.
int	Meters	Distance in meters.
int	Kilometers	Distance in kilometers.
int	NauticalMiles	Distance in nautical miles.

Pol.VI.AreaUnits

An enumeration of Area Units.

properties

int	SquareInches	Area in square inches.
int	SquareFeet	Area in square feet.
int	SquareYards	Area in square yards.
int	SquareMiles	Area in square miles.
int	SquareMillimeters	Area in square millimeters.
int	SquareCentimeters	Area in square centimeters.
int	SquareMeters	Area in square meters.
int	SquareKilometers	Area in square kilometers.
int	Acres	Area in acres.
int	Hectares	Area in hectares.

Pol.VI.LocationUnits

An enumeration of Location Units.

properties

int	Degrees	Location coordinates in degrees.
int	Radians	Location coordinates in radians.

Pol.VI.AngleUnits

An enumeration of Angle Units.

properties

int	Degrees	Angle in degrees.
int	Radians	Angle in radians.

Pol.VI.CoordinateFormats

An enumeration of Coordinate Formats.

properties

int	DecimalDegree	Location coordinates in decimal degree (DD) format.
int	DegreeMinute	Location coordinates in degree:minute (DM) format.
int	DegreeMinuteSecond	Location coordinates in degree:minute:second (DMS) format.

Pol.VI.ExportTypes

An enumeration of export types.

NOTE: Each export type requires activation by Pictometry.

properties

int	Image	Export an image.
int	WorldFile	Export a world file of the image. (Orthogonal only)
int	KML	Export a KML file containing the image.
int	KMZ	Export a KMZ file containing the image.

Pol.VI.ImageFormats

An enumeration of image export formats.

properties

int	JPEG	Export image in JPEG format.
int	GIF	Export image in GIF format.
int	PNG	Export image in PNG format.

Pol.VI.ImageOptions

An enumeration of image export options.

properties

int	Date	Export image with datestamp (MM/DD/YYYY).
int	NorthPointer	Export image with a pointer indicating North.
int	Overlays	Export image with overlays.
int	LatLonBox	Export image in KML using a <LatLonBox> element instead of the default <gx:LatLonQuad>. NOTE: Only valid when ExportTypes is set to KML.

Pol.VI.AltitudeMode

An enumeration of altitude modes.

properties

int	AnchorToGround	Ignore any altitude specification. Element is anchored to the image ground plane. (Default)
int	RelativeToGround	Sets the altitude of the element relative to the image ground plane.
int	Absolute	Sets the altitude of the element relative to sea level.