@rnacanvas/embedded
v2.0.3
Published
Embed RNAcanvas in a webpage
Downloads
5
Readme
Here's a live example on CodePen.
Quickstart
The RNAcanvas
app object constructor
can be loaded using a <script>
element.
<script id="RNAcanvas" type="module" >
import 'https://cdn.jsdelivr.net/npm/@rnacanvas/[email protected]/dist/+esm';
</script>
This will inject the RNAcanvas
app object constructor into the global scope.
Downstream code must wait for the script to load
before the RNAcanvas
app object constructor can be used.
Things like jQuery's .ready()
method can accomplish this.
$('#RNAcanvas').ready(() => {
// RNA drawing code here...
});
Alternatively, the RNAcanvas
app object constructor
can be imported from an npm
package (see section below).
Drawing a structure
// create a new RNAcanvas app instance
var rnaCanvas = new RNAcanvas();
// the RNAcanvas app must be added to the document
// before drawing anything (see note below)
rnaCanvas.appendTo(document.body);
// control the size of the RNAcanvas app component
rnaCanvas.style.width = '1000px';
rnaCanvas.style.height = '750px';
// the structure to draw (using dot-bracket notation)
var seq = 'AGAGUAGCAUUCUGCUUUAGACUGUUAACUUUAUGAACCACGCGUGUCACGUGGGGAGAGUUAACAGCGCCC';
var dotBracket = '(((((((....)))))))...(((((((((((.....(((((.......)))))..))))))))))).....';
rnaCanvas.drawDotBracket(seq, dotBracket);
// make the drawing big enough to fit the drawn structure
// (and include some extra space around the drawn structure)
rnaCanvas.drawing.setPadding(500);
// bring the drawn structure into view
rnaCanvas.drawingView.fitToContent();
The RNAcanvas app must be added to the document of a webpage before its underlying SVG drawing functionality can work properly.
The RNAcanvas app can be added to any container node present in the document (not just the document body itself as shown in the example above).
npm
installation
npm install @rnacanvas/app-object
The RNAcanvas
app object constructor can be accessed as a named import.
import { RNAcanvas } from '@rnacanvas/app-object';
Further documentation
See the full documentation for the RNAcanvas app object.