3.8.22 • Published 10 months ago

protvista-saver v3.8.22

Weekly downloads
31
License
MIT
Repository
github
Last release
10 months ago

Published on NPM

<protvista-saver>

The protvista-saver component is used to download the ProtVista svg as images. By default, it renders a download button. It can be modified to include different content although the first child element provided should be a button.

The component to be saved is bound to protvista-saver though the element-id property.

The background color is none by default. It can be set through the background-color attribute. The name and format of the file to be downloaded are passed as file-name and file-format respectively.

There are two methods available : preSave() and postSave(). These functions allows any manipulations to DOM before and after painting on the canvas.

Demo

Usage

<protvista-saver element-id="track" id="#saver" />

Passing different content to render other than the default

<protvista-saver element-id="just-tracks" file-name="tracks" file-format="jpeg" background-color="#ddddee">
    <button>Download Just Tracks</button>
</protvista-saver>

Using preSave() and postSave()

document.querySelector("#saver").preSave = () => {
  const base = document.querySelector("#track");
  const title = document.createElement("h2");
  title.setAttribute("id", "tmp_title_element");
  title.innerHTML = "ProtVista Snapshot";
  base.insertBefore(title, base.firstChild);
};
//removes the title from the DOM
document.querySelector("#saver").postSave = () => {
  document
    .querySelector("#track")
    .removeChild(document.getElementById("tmp_title_element"));
};

API Reference

Properties

element-id: string

The Id of the component to be saved.

background-color: string

The background color for the canvas.

file-name: string

The file name to be used to save locally.

file-format: string

The format of the image. Accepted formats are png, jpeg, bmp, tiff and gif.

preSave: method

The DOM manipulation if needed to be done before printing on the canvas.

postSave: method

The things that were changed during the preSave needed to be reverted in the postSave.

3.8.21

10 months ago

3.8.22

10 months ago

3.8.18

10 months ago

3.8.20

10 months ago

3.8.4

3 years ago

3.1.2

5 years ago

3.1.1

5 years ago

3.0.0

5 years ago

3.0.0-alpha.21

5 years ago

2.12.0

5 years ago

2.11.0

5 years ago

2.7.0

5 years ago

2.3.0

6 years ago

2.2.4

6 years ago

2.2.0

6 years ago

2.1.18

6 years ago

2.1.17

6 years ago