ViewerMagnifierAPI

• webVis API Reference
• 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)

• ViewerMagnifierAPI
  • ViewerAPI

Index

Methods

changeMagnifier getMagnifierProperties

Methods

changeMagnifier

• changeMagnifier(
      properties: ViewerMagnifierProperties,
  ): ViewerMagnifierProperties

• Changes the properties of the viewers magnifier.

  Parameters

  • properties: ViewerMagnifierProperties

    Object of Properties which should be changed.

  Returns ViewerMagnifierProperties

  An Object with the changed Properties.

getMagnifierProperties

• getMagnifierProperties(): ViewerMagnifierProperties

• Returns the current properties of the magnifier.

  Returns ViewerMagnifierProperties

  The current properties of the magnifier.

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)