@seracio/magnifier

Magnifier

A React component that magnifies svg charts.

An example of the component in action.

Install

yarn add react d3
yarn add @seracio/magnifier

Usage

The Magnifier component needs to be inserted in a svg. It takes several props:

• svgId: string - The id of the svg element.
• useId: string - The id of the element/group of elements to magnify.
• zoom?: number - The zoom factor, default to 3.
• size?: number - The size of the magnifier in svg pixels, default to 30.
• attrs?: object - Attributes of the magnifier's circle element, default to { stroke: 'black', fill: 'none' }.

import { Magnifier } from "@seracio/magnifier";

<svg id="mySvg">
  <g id="g-chart">{/* ... */}</g>
  <Magnifier
    useId="g-chart"
    svgId="mySvg"
    zoom={3}
    size={30}
    attrs={{
      strokeWidth: 0.5,
      style: {
        filter: "drop-shadow( 3px 3px 2px rgba(0, 0, 0, .7))",
      },
    }}
  />
</svg>;

The magnifier follows the cursor and displays a circle around it. Basically, it will replicate the element(s) provided by the useId prop thanks to a use element. The use element is encapsulated in a svg (injected inside the given svg).
The zoom will be managed by the viewBox attribute of this inner svg.