ImageNavigator

ImageNavigator

The navigator class

Constructor

new ImageNavigator(micrionon-null)

Create the ImageNavigator instance
Parameters:
Name Type Description
micrio Micrio The Micrio instance

Classes

ImageNavigator

Members

(non-null) current :Micrio

The current active Micrio instance
Type:
  • Micrio

Methods

getCurrent() → (non-null) {Micrio}

Get the current Micrio instance
Returns:
The current Micrio instance
Type
Micrio

(async) goto(id, cbopt, keepViewopt, directionopt, distanceopt) → (non-null) {Promise.<(?Micrio|undefined)>}

Navigate to another Micrio ID
Parameters:
Name Type Attributes Default Description
id string The Micrio ID
cb function <optional>
The callback function when done
keepView boolean <optional>
false Inherit the current image viewport
direction number <optional>
0 Optional direction [0-1] for 360 transition
distance number <optional>
0 Optional distance for 360 transition
Returns:
When the new image has been loaded and shown
Type
Promise.<(?Micrio|undefined)>