Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

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

changeMagnifier getMagnifierProperties

Methods

changeMagnifier

getMagnifierProperties