ViewerMagnifierAPI

Interface ViewerMagnifierAPI

The ViewerMagnifierAPI allows to magnify a specified region of the current view.

Example

// Get an instance of the ContextAPI
const myContext : ContextAPI = webvis.getContext( "example" )

// Get default viewer
const viewer = myContext.getViewer();

// Enable magnifier for viewer
viewer.changeMagnifier({enabled: true}) 

// Change magnifier properties
viewer.changeMagnifier({roundness: 50, position: [1000,720], size: [500,300], zoomLevel: 2}) 

// Alternatively, enable magnifier and set all properties in one call
viewer.changeMagnifier({roundness: 50, enabled: true, position: [1000,720], size: [500,300], zoomLevel: 2}) 
interface ViewerMagnifierAPI {
    changeMagnifier(
        properties: ViewerMagnifierProperties,
    ): ViewerMagnifierProperties;
    getMagnifierProperties(): ViewerMagnifierProperties;
}

Hierarchy (View Summary)

Methods