ViewerMagnifierAPI

• webVis API Reference
• ViewerMagnifierAPI

Interface ViewerMagnifierAPI

ViewerMagnifierAPI

Overview

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

Quick Start

// Get an instance of the webvis context
const myContext = webvis.getContext();

// 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});

Events

The following events are associated with the ViewerMagnifierAPI:

• ViewerMagnifierChangedEvent

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 viewer magnifier.

  Parameters

  • properties: ViewerMagnifierProperties

    Properties which should be changed.

  Returns ViewerMagnifierProperties

  The changed properties.

getMagnifierProperties

• getMagnifierProperties(): ViewerMagnifierProperties

• Returns the current properties of the magnifier.

  Returns ViewerMagnifierProperties

  The current properties of the magnifier.