@rnacanvas/draw.bases v9.0.2

Installation

With npm:

npm install @rnacanvas/draw.bases

Usage

All exports of the package can be accessed as named imports.

import { Nucleobase } from '@rnacanvas/draw.bases';

Exports

Nucleobase

The Nucleobase class represents a text element within an SVG document that is a nucleobase.

static create()

Creates a nucleobase with the specified text content.

This method will also apply default values to the created nucleobase and assign it a UUID.

(It is necessary for all elements to have a unique ID when saving an RNAcanvas drawing.)

let b = Nucleobase.create('A');

b.textContent === 'A'; // true

constructor()

Receives an SVGTextElement instance as input.

The created nucleobase "adopts" the input SVG text element and behaves as though it is the SVG text element.

let textElement = document.createElementNS('http://www.w3.org/2000/svg', 'text');

let b = new Nucleobase(textElement);

domNode

A reference to the SVGTextElement instance that is the nucleobase.

let textElement = document.createElementNS('http://www.w3.org/2000/svg', 'text');
let b = new Nucleobase(textElement);

b.domNode === textElement; // true

appendTo()

Appends the text element that is the nucleobase to the given container node.

let svgDoc = document.createElementNS('http://www.w3.org/2000/svg', 'svg');

let b = Nucleobase.create('A');
b.appendTo(svgDoc);

svgDoc.contains(b.domNode); // true

remove()

Removes the text element that is the nucleobase from any parent container node that it is in.

This method does nothing if the text element does not have a parent container node.

let svgDoc = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
let b = Nucleobase.create('G');

b.appendTo(svgDoc);
svgDoc.contains(b.domNode); // true

b.remove();
svgDoc.contains(b.domNode); // false

isIn()

Returns true if the text element that is the nucleobase is a child (or grandchild, great-grandchild, etc.) of the given node.

Returns false otherwise, including when input the text element itself.

let svgDoc = document.createElementNS('http://www.w3.org/2000/svg', 'svg');

let b = Nucleobase.create('U');
b.appendTo(svgDoc);

b.isIn(svgDoc); // true
b.isIn(b.domNode); // false

getAttribute()

Get an attribute of the SVG text element that is the nucleobase.

nucleobase.domNode.setAttribute('fill', '#a62cf1');

nucleobase.getAttribute('fill') === '#a62cf1'; // true

setAttribute()

Set an attribute of the SVG text element that is the nucleobase.

nucleobase.setAttribute('fill', '#b28ccf');

nucleobase.domNode.getAttribute('fill') === '#b28ccf'; // true

setAttributes()

Set multiple attributes of the SVG text element that is the nucleobase at once using an object of attribute values keyed by attribute name.

Invalid inputs are ignored. (This method is not supposed to throw.)

nucleobase.setAttributes({ 'font-family': 'Comic Sans', 'fill': '#fa391c' });

nucleobase.domNode.getAttribute('font-family') === 'Comic Sans'; // true
nucleobase.domNode.getAttribute('fill') === '#fa391c'; // true

id

The id attribute of the text element that is the nucleobase.

(More precisely, returns that which is returned by the id property of the text element.)

nucleobase.domNode.setAttribute('id', 'text-123456');

nucleobase.id === 'text-123456'; // true

assignUUID()

Creates and assigns a new UUID to the text element that is the nucleobase.

This method will overwrite any existing ID that the nucleobase has.

The assigned UUID might also have some letters prepended to it (since all SVG element IDs must start with a letter), resulting in the assigned UUID having more than 36 characters.

nucleobase.assignUUID();

textContent

The text content of the text element that is the nucleobase.

(More precisely, returns that which is returned by the textContent property of the text element when used as a getter.)

nucleobase.domNode.textContent = 'R';

nucleobase.textContent === 'R'; // true

bbox

The bounding box of the text element that is the nucleobase.

Essentially, just forwards the values returned by the underlying getBBox method.

nucleobase.bbox; // a box with X and Y coordinates and width and height

centerPoint

The center point of the nucleobase. (Calculated from its bounding box.)

Setting its coordinates will recenter the nucleobase.

// recenter the nucleobase on point (92, -112)
nucleobase.centerPoint.x = 92;
nucleobase.centerPoint.y = -112;

Can also be listened to for when it moves.

var listener = () => {};

// arranges for the listener to be called
// whenever the center point of the nucleobase changes coordinates
nucleobase.centerPoint.addEventListener('move', listener);

nucleobase.centerPoint.x += 15;
listener; // called once

nucleobase.centerPoint.y -= 32;
listener; // called a second time

nucleobase.centerPoint.removeEventListener('move', listener);

nucleobase.centerPoint.x -= 100;
listener; // not called a third time

getCenterPoint()

A simple getter method for the center point of the nucleobase.

nucleobase.getCenterPoint();

setCenterPoint()

A simple setter method for the center point of the nucleobase.

nucleobase.setCenterPoint({ x: 92, y: 178 });

serialized()

Returns the serialized form of a nucleobase (e.g., that can be converted to a JSON string), which is used when saving drawings.

var b = Nucleobase.create('G');
b.domNode.id = 'id-123456';

b.serialized(); // { id: "id-123456" }

static deserialized()

Recreates a saved nucleobase from its serialized form.

Note that this method does not create any new DOM nodes (it simply retrieves the corresponding DOM node for a saved nucleobase from within the parent drawing).

var parentDrawing; // an RNAcanvas drawing

var b1 = parentDrawing.addBase('A');
b1.domNode.id = 'id-ABCDEF';

var b2 = Nucleobase.deserialized(b1.serialized(), parentDrawing);
b2.domNode.id; // "id-ABCDEF"

b2.domNode === b1.domNode; // true
b2 === b1; // false