@wcmc/ng-mass-spec-plotter NPM

Angular Mass Spectrum Plotter

A mass spectrum visualization component for Angular.

This library was generated with Angular CLI version 15.0.0.

Installation

npm install @wcmc/ng-mass-spec-plotter --save

Flot Plotter Usage

Import the library

import { NgMassSpecPlotterModule } from '@wcmc/ng-mass-spec-plotter';
 
@NgModule({
 // ...
 imports: [
   // ...
   NgMassSpecPlotterModule
 ]
})

Add required scripts to the angular configuration

In angular.json under architect.build.options within your project definition, add the following scripts

"scripts": [
  "./node_modules/flot/jquery.js",
  "./node_modules/flot/jquery.flot.js",
  "./node_modules/flot/jquery.flot.resize.js",
  "./node_modules/flot/jquery.flot.selection.js"
]

Use the custom component in your module

The lib-ng-mass-spec-plotter component must use a unique id and be contained within an element with fixed height:

<div style="width: 100%; height: 400px">
  <lib-ng-mass-spec-plotter
    spectrum="100:50 105:100 125:25"
    id="uniqueId"></lib-ng-mass-spec-plotter>
</div>

Additional optional attributes include:

miniPlot: Boolean. Creates a small, square, unlabeled figure for previews.
pmzMin: Number. Sets the minimum x-axis limit. If undefined, the x-axis minimum is set to 0.
pmzMax: Number. Sets the maximum x-axis limit. If undefined, the x-axis maximum is set to 1.05 times the peak with the largest m/z value.
truncate: Boolean. Sets the number label of each peak to four decimal places.
normalize: Number. Value to which to normalize spectra.
sciY: Boolean. Sets the y-axis ticks to scientific notation.

Additional events

(selection): When a user clicks and drags on the chart, an object with min/max x- and y-axis values of the zoomed-in section will emit.
(redrawn): Emits true when the chart is redrawn.
(reset): Emits true when the user clicks the reset button in the upper-right-hand corner of the chart.

SpeckTackle Usage

SpeckTackle is a D3.js based spectrum viewer that supports heads-to-tails spectral comparisons built by Stephan Beisken. This project uses a fork of the original SpeckTackle with slight modifications (https://bitbucket.org/derundle/specktackle-wcmc-fork).

Install dependencies

npm install bitbucket:derundle/specktackle-wcmc-fork --save

Add required scripts to the angular configuration

In angular.json under architect.build.options within your project definition, add the following scripts

"styles": [
  "./node_modules/st/css/st.css"
],
"scripts": [
  "./node_modules/st/st.js",
  "./node_modules/st/libs/jquery/jquery.js",
  "./node_modules/st/libs/d3/d3.js",
]

If any issues arise, place st.js is included near the beginning of the list.

Use the SpeckTackle directive in your module

The specktackleViewer directive must use a unique id and must have a unique width and height:

<div specktackleViewer
  spectrum="100:50 105:100 125:25"
  id="uniqueId"
  style="width: 100%; height: 400px"></div>

To plot a heads-to-tails figure:

<div specktackleViewer
  spectrum="100:50 105:100 125:25"
  librarySpectrum="100:12 121:100 150:40"
  id="uniqueId"
  style="width: 100%; height: 400px"></div>

Additional optional attributes include:

normalize: Number. Value to which to normalize spectra (default: 100 for heads-to-tails plots, no scaling for single spectrum)
title: String. Plot title (no title by default)
xLabel: String. X-axis label (default: m/z)
yLabel: String. Y-axis label (default: Abundance)
spectrumLabel: String. Label for the primary spectrum for the legend
libraryLabel: String. Label for the reverse/library spectrum for the legend
pmzMin: Number. Sets the minimum x-axis limit. If undefined, the x-axis minimum is set to 0.
pmzMax: Number. Sets the maximum x-axis limit. If undefined, the x-axis maximum is set to 1.1 times the peak with the largest m/z value.