smiles-drawer

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>CanvasWrapper - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module.exports.html">exports</a></li><li><a href="SmilesDrawer.ArrayHelper.html">ArrayHelper</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.clone">clone</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.contains">contains</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.containsAll">containsAll</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.count">count</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.deepCopy">deepCopy</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.each">each</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.get">get</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.intersection">intersection</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.merge">merge</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.print">print</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.remove">remove</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.removeAll">removeAll</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.removeUnique">removeUnique</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.sortByAtomicNumberDesc">sortByAtomicNumberDesc</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.toggle">toggle</a></li><li data-type='method'><a href="SmilesDrawer.ArrayHelper.html#.unique">unique</a></li></ul></li><li><a href="SmilesDrawer.Atom.html">Atom</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Atom.html#.getDuplicateAtomicNumbers">getDuplicateAtomicNumbers</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#.hasDuplicateAtomicNumbers">hasDuplicateAtomicNumbers</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#.sortByAtomicNumber">sortByAtomicNumber</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#addAnchoredRing">addAnchoredRing</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#addNeighbouringElement">addNeighbouringElement</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#attachPseudoElement">attachPseudoElement</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#backupRings">backupRings</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#getAtomicNumber">getAtomicNumber</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#getAttachedPseudoElements">getAttachedPseudoElements</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#getAttachedPseudoElementsCount">getAttachedPseudoElementsCount</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#getOrder">getOrder</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#getRingbondCount">getRingbondCount</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#haveCommonRingbond">haveCommonRingbond</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#neighbouringElementsEqual">neighbouringElementsEqual</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#restoreRings">restoreRings</a></li><li data-type='method'><a href="SmilesDrawer.Atom.html#setOrder">setOrder</a></li></ul></li><li><a href="SmilesDrawer.CanvasWrapper.html">CanvasWrapper</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#clear">clear</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawAromaticityRing">drawAromaticityRing</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawBall">drawBall</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawCircle">drawCircle</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawDashedWedge">drawDashedWedge</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawDebugPoint">drawDebugPoint</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawDebugText">drawDebugText</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawLine">drawLine</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawPoint">drawPoint</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawText">drawText</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#drawWedge">drawWedge</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#getColor">getColor</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#reset">reset</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#scale">scale</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#setTheme">setTheme</a></li><li data-type='method'><a href="SmilesDrawer.CanvasWrapper.html#updateSize">updateSize</a></li></ul></li><li><a href="SmilesDrawer.Edge.html">Edge</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Edge.html#getBondCount">getBondCount</a></li></ul></li><li><a href="SmilesDrawer.Graph.html">Graph</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Graph.html#._ccCountDfs">_ccCountDfs</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#._ccGetDfs">_ccGetDfs</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#.getConnectedComponentCount">getConnectedComponentCount</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#.getConnectedComponents">getConnectedComponents</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#_bridgeDfs">_bridgeDfs</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#_init">_init</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#_initInfos">_initInfos</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#addEdge">addEdge</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#addVertex">addVertex</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#clear">clear</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getAdjacencyList">getAdjacencyList</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getAdjacencyMatrix">getAdjacencyMatrix</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getBridges">getBridges</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getComponentsAdjacencyMatrix">getComponentsAdjacencyMatrix</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getDistanceMatrix">getDistanceMatrix</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getEdge">getEdge</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getEdgeList">getEdgeList</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getEdges">getEdges</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getSubgraphAdjacencyList">getSubgraphAdjacencyList</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getSubgraphAdjacencyMatrix">getSubgraphAdjacencyMatrix</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getSubgraphDistanceMatrix">getSubgraphDistanceMatrix</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#getVertexList">getVertexList</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#hasEdge">hasEdge</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#kkLayout">kkLayout</a></li><li data-type='method'><a href="SmilesDrawer.Graph.html#traverseBF">traverseBF</a></li></ul></li><li><a href="SmilesDrawer.Line.html">Line</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Line.html#clone">clone</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getAngle">getAngle</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getLeftChiral">getLeftChiral</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getLeftElement">getLeftElement</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getLeftVector">getLeftVector</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getLength">getLength</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getNormals">getNormals</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getRightChiral">getRightChiral</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getRightElement">getRightElement</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#getRightVector">getRightVector</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#rotate">rotate</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#rotateToXAxis">rotateToXAxis</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#setLeftVector">setLeftVector</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#setRightVector">setRightVector</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#shorten">shorten</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#shortenFrom">shortenFrom</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#shortenLeft">shortenLeft</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#shortenRight">shortenRight</a></li><li data-type='method'><a href="SmilesDrawer.Line.html#shortenTo">shortenTo</a></li></ul></li><li><a href="SmilesDrawer.Ring.html">Ring</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Ring.html#clone">clone</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#contains">contains</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#eachMember">eachMember</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#getAngle">getAngle</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#getDoubleBondCount">getDoubleBondCount</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#getOrderedNeighbours">getOrderedNeighbours</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#getPolygon">getPolygon</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#getSize">getSize</a></li><li data-type='method'><a href="SmilesDrawer.Ring.html#isBenzeneLike">isBenzeneLike</a></li></ul></li><li><a href="SmilesDrawer.RingConnection.html">RingConnection</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.RingConnection.html#.getNeighbours">getNeighbours</a></li><li data-type='method'><a href="SmilesDrawer.RingConnection.html#.getVertices">getVertices</a></li><li data-type='method'><a href="SmilesDrawer.RingConnection.html#.isBridge">isBridge</a></li><li data-type='method'><a href="SmilesDrawer.RingConnection.html#addVertex">addVertex</a></li><li data-type='method'><a href="SmilesDrawer.RingConnection.html#containsRing">containsRing</a></li><li data-type='method'><a href="SmilesDrawer.RingConnection.html#isBridge">isBridge</a></li><li data-type='method'><a href="SmilesDrawer.RingConnection.html#updateOther">updateOther</a></li></ul></li><li><a href="SmilesDrawer.SSSR.html">SSSR</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.SSSR.html#.areSetsEqual">areSetsEqual</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.bondsToAtoms">bondsToAtoms</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getBondCount">getBondCount</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getEdgeCount">getEdgeCount</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getEdgeList">getEdgeList</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getPathIncludedDistanceMatrices">getPathIncludedDistanceMatrices</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getRingCandidates">getRingCandidates</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getRings">getRings</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.getSSSR">getSSSR</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.isSupersetOf">isSupersetOf</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.matrixToString">matrixToString</a></li><li data-type='method'><a href="SmilesDrawer.SSSR.html#.pathSetsContain">pathSetsContain</a></li></ul></li><li><a href="SmilesDrawer.Vector2.html">Vector2</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Vector2.html#add">add</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#angle">angle</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#clockwise">clockwise</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#clone">clone</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#distance">distance</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#distanceSq">distanceSq</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#divide">divide</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#getRotateAwayFromAngle">getRotateAwayFromAngle</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#getRotateToAngle">getRotateToAngle</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#getRotateTowardsAngle">getRotateTowardsAngle</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#invert">invert</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#isInPolygon">isInPolygon</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#length">length</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#lengthSq">lengthSq</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#multiply">multiply</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#multiplyScalar">multiplyScalar</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#normalize">normalize</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#normalized">normalized</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#rotate">rotate</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#rotateAround">rotateAround</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#rotateAwayFrom">rotateAwayFrom</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#rotateTo">rotateTo</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#sameSideAs">sameSideAs</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#subtract">subtract</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#toString">toString</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#whichSide">whichSide</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.add">add</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.angle">angle</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.averageDirection">averageDirection</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.divide">divide</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.dot">dot</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.midpoint">midpoint</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.multiply">multiply</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.multiplyScalar">multiplyScalar</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.normals">normals</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.scalarProjection">scalarProjection</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.subtract">subtract</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.threePointangle">threePointangle</a></li><li data-type='method'><a href="SmilesDrawer.Vector2.html#.units">units</a></li></ul></li><li><a href="SmilesDrawer.Vertex.html">Vertex</a><ul class='methods'><li data-type='method'><a href="SmilesDrawer.Vertex.html#addChild">addChild</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#clone">clone</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#equals">equals</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getAngle">getAngle</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getDrawnNeighbours">getDrawnNeighbours</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getNeighbourCount">getNeighbourCount</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getNeighbours">getNeighbours</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getNextInRing">getNextInRing</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getSpanningTreeNeighbours">getSpanningTreeNeighbours</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#getTextDirection">getTextDirection</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#isTerminal">isTerminal</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#setParentVertexId">setParentVertexId</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#setPosition">setPosition</a></li><li data-type='method'><a href="SmilesDrawer.Vertex.html#setPositionFromVector">setPositionFromVector</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#addRing">addRing</a></li><li><a href="global.html#addRingConnection">addRingConnection</a></li><li><a href="global.html#apothem">apothem</a></li><li><a href="global.html#areVerticesInSameRing">areVerticesInSameRing</a></li><li><a href="global.html#backupRingInformation">backupRingInformation</a></li><li><a href="global.html#centralAngle">centralAngle</a></li><li><a href="global.html#chooseSide">chooseSide</a></li><li><a href="global.html#createBridgedRing">createBridgedRing</a></li><li><a href="global.html#createNextBond">createNextBond</a></li><li><a href="global.html#createRing">createRing</a></li><li><a href="global.html#draw">draw</a></li><li><a href="global.html#drawEdge">drawEdge</a></li><li><a href="global.html#drawEdges">drawEdges</a></li><li><a href="global.html#drawVertices">drawVertices</a></li><li><a href="global.html#edgeRingCount">edgeRingCount</a></li><li><a href="global.html#extend">extend</a></li><li><a href="global.html#getBondCount">getBondCount</a></li><li><a href="global.html#getBridgedRingRings">getBridgedRingRings</a></li><li><a href="global.html#getBridgedRings">getBridgedRings</a></li><li><a href="global.html#getClosestVertex">getClosestVertex</a></li><li><a href="global.html#getCommonRingbondNeighbour">getCommonRingbondNeighbour</a></li><li><a href="global.html#getCommonRings">getCommonRings</a></li><li><a href="global.html#getCurrentCenterOfMass">getCurrentCenterOfMass</a></li><li><a href="global.html#getCurrentCenterOfMassInNeigbourhood">getCurrentCenterOfMassInNeigbourhood</a></li><li><a href="global.html#getEdgeNormals">getEdgeNormals</a></li><li><a href="global.html#getFusedRings">getFusedRings</a></li><li><a href="global.html#getHeavyAtomCount">getHeavyAtomCount</a></li><li><a href="global.html#getLargestOrAromaticCommonRing">getLargestOrAromaticCommonRing</a></li><li><a href="global.html#getNonRingNeighbours">getNonRingNeighbours</a></li><li><a href="global.html#getOverlapScore">getOverlapScore</a></li><li><a href="global.html#getRing">getRing</a></li><li><a href="global.html#getRingbondType">getRingbondType</a></li><li><a href="global.html#getRingConnection">getRingConnection</a></li><li><a href="global.html#getRingConnections">getRingConnections</a></li><li><a href="global.html#getRingCount">getRingCount</a></li><li><a href="global.html#getSpiros">getSpiros</a></li><li><a href="global.html#getSubringCenter">getSubringCenter</a></li><li><a href="global.html#getSubtreeOverlapScore">getSubtreeOverlapScore</a></li><li><a href="global.html#getTotalOverlapScore">getTotalOverlapScore</a></li><li><a href="global.html#getTreeDepth">getTreeDepth</a></li><li><a href="global.html#getVerticesAt">getVerticesAt</a></li><li><a href="global.html#hasBridgedRing">hasBridgedRing</a></li><li><a href="global.html#initPseudoElements">initPseudoElements</a></li><li><a href="global.html#initRings">initRings</a></li><li><a href="global.html#innerAngle">innerAngle</a></li><li><a href="global.html#isEdgeInRing">isEdgeInRing</a></li><li><a href="global.html#isEdgeRotatable">isEdgeRotatable</a></li><li><a href="global.html#isPartOfBridgedRing">isPartOfBridgedRing</a></li><li><a href="global.html#isPointInRing">isPointInRing</a></li><li><a href="global.html#isRingAromatic">isRingAromatic</a></li><li><a href="global.html#meanAngle">meanAngle</a></li><li><a href="global.html#parityOfPermutation">parityOfPermutation</a></li><li><a href="global.html#polyCircumradius">polyCircumradius</a></li><li><a href="global.html#position">position</a></li><li><a href="global.html#printRingInfo">printRingInfo</a></li><li><a href="global.html#removeRing">removeRing</a></li><li><a href="global.html#removeRingConnection">removeRingConnection</a></li><li><a href="global.html#removeRingConnectionsBetween">removeRingConnectionsBetween</a></li><li><a href="global.html#resolvePrimaryOverlaps">resolvePrimaryOverlaps</a></li><li><a href="global.html#resolveSecondaryOverlaps">resolveSecondaryOverlaps</a></li><li><a href="global.html#restoreRingInformation">restoreRingInformation</a></li><li><a href="global.html#rotateSubtree">rotateSubtree</a></li><li><a href="global.html#round">round</a></li><li><a href="global.html#setRingCenter">setRingCenter</a></li><li><a href="global.html#SmilesDrawer">SmilesDrawer</a></li><li><a href="global.html#toDeg">toDeg</a></li><li><a href="global.html#toRad">toRad</a></li><li><a href="global.html#traverseTree">traverseTree</a></li></ul> </nav> <div id="main"> <h1 class="page-title">CanvasWrapper</h1> <section> <header> <h2> <span class="ancestors"><a href="global.html#SmilesDrawer">SmilesDrawer</a>.</span> CanvasWrapper </h2> <div class="class-description"><p>A class wrapping a canvas element.</p></div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="CanvasWrapper"><span class="type-signature"></span>new CanvasWrapper<span class="signature">(target, theme, options)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line15">line 15</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>canvas</code></td> <td class="type"> <span class="param-type">HTMLElement</span> </td> <td class="description last"><p>The HTML element for the canvas associated with this CanvasWrapper instance.</p></td> </tr> <tr> <td class="name"><code>ctx</code></td> <td class="type"> <span class="param-type">CanvasRenderingContext2D</span> </td> <td class="description last"><p>The CanvasRenderingContext2D of the canvas associated with this CanvasWrapper instance.</p></td> </tr> <tr> <td class="name"><code>colors</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The colors object as defined in the SmilesDrawer options.</p></td> </tr> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The SmilesDrawer options.</p></td> </tr> <tr> <td class="name"><code>drawingWidth</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The width of the canvas.</p></td> </tr> <tr> <td class="name"><code>drawingHeight</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The height of the canvas.</p></td> </tr> <tr> <td class="name"><code>offsetX</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The horizontal offset required for centering the drawing.</p></td> </tr> <tr> <td class="name"><code>offsetY</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The vertical offset required for centering the drawing.</p></td> </tr> <tr> <td class="name"><code>fontLarge</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The large font size in pt.</p></td> </tr> <tr> <td class="name"><code>fontSmall</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The small font size in pt.</p></td> </tr> </tbody> </table> <div class="description"> <p>The constructor for the class CanvasWrapper.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>target</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">HTMLElement</span> </td> <td class="description last"><p>The canvas id or the canvas HTMLElement.</p></td> </tr> <tr> <td class="name"><code>theme</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>A theme from the smiles drawer options.</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The smiles drawer options object.</p></td> </tr> </tbody> </table> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line833">line 833</a> </li></ul></dd> </dl> <div class="description"> <p>Clear the canvas.</p> </div> <h4 class="name" id="drawAromaticityRing"><span class="type-signature"></span>drawAromaticityRing<span class="signature">(ring)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line814">line 814</a> </li></ul></dd> </dl> <div class="description"> <p>Draws a ring inside a provided ring, indicating aromaticity.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>ring</code></td> <td class="type"> <span class="param-type"><a href="SmilesDrawer.Ring.html">SmilesDrawer.Ring</a></span> </td> <td class="description last"><p>A ring.</p></td> </tr> </tbody> </table> <h4 class="name" id="drawBall"><span class="type-signature"></span>drawBall<span class="signature">(x, y, elementName)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line479">line 479</a> </li></ul></dd> </dl> <div class="description"> <p>Draw a ball to the canvas.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The x position of the text.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The y position of the text.</p></td> </tr> <tr> <td class="name"><code>elementName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The name of the element (single-letter).</p></td> </tr> </tbody> </table> <h4 class="name" id="drawCircle"><span class="type-signature"></span>drawCircle<span class="signature">(x, y, radius, color, fill<span class="signature-attributes">opt</span>, debug<span class="signature-attributes">opt</span>, debugText<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line167">line 167</a> </li></ul></dd> </dl> <div class="description"> <p>Draws a circle to a canvas context.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The x coordinate of the circles center.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The y coordinate of the circles center.</p></td> </tr> <tr> <td class="name"><code>radius</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The radius of the circle</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>A hex encoded color.</p></td> </tr> <tr> <td class="name"><code>fill</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> <code>true</code> </td> <td class="description last"><p>Whether to fill or stroke the circle.</p></td> </tr> <tr> <td class="name"><code>debug</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> <code>false</code> </td> <td class="description last"><p>Draw in debug mode.</p></td> </tr> <tr> <td class="name"><code>debugText</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> <code>''</code> </td> <td class="description last"><p>A debug message.</p></td> </tr> </tbody> </table> <h4 class="name" id="drawDashedWedge"><span class="type-signature"></span>drawDashedWedge<span class="signature">(line, width)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line360">line 360</a> </li></ul></dd> </dl> <div class="description"> <p>Draw a dashed wedge on the canvas.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>line</code></td> <td class="type"> <span class="param-type"><a href="SmilesDrawer.Line.html">SmilesDrawer.Line</a></span> </td> <td class="default"> </td> <td class="description last"><p>A line.</p></td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="default"> <code>6</code> </td> <td class="description last"><p>The wedge width.</p></td> </tr> </tbody> </table> <h4 class="name" id="drawDebugPoint"><span class="type-signature"></span>drawDebugPoint<span class="signature">(x, y, debugText<span class="signature-attributes">opt</span>, color<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line805">line 805</a> </li></ul></dd> </dl> <div class="description"> <p>Draws a dubug dot at a given coordinate and adds text.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The x coordinate.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The y coordindate.</p></td> </tr> <tr> <td class="name"><code>debugText</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> <code>''</code> </td> <td class="description last"><p>A string.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> <code>'#f00'</code> </td> <td class="description last"><p>A color in hex form.</p></td> </tr> </tbody> </table> <h4 class="name" id="drawDebugText"><span class="type-signature"></span>drawDebugText<span class="signature">(x, y, text)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line460">line 460</a> </li></ul></dd> </dl> <div class="description"> <p>Draws a debug text message at a given position</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The x coordinate.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The y coordinate.</p></td> </tr> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The debug text.</p></td> </tr> </tbody> </table> <h4 class="name" id="drawLine"><span class="type-signature"></span>drawLine<span class="signature">(line, dashed<span class="signature-attributes">opt</span>, alpha<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="CanvasWrapper.js.html">CanvasWrapper.js</a>, <a href="CanvasWrapper.js.html#line208">line 208</a> </li></ul></dd> </dl> <div class="description"> <p>Draw a line to a canvas.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>line</code></td> <td class="type"> <span class="param-type"><a href="SmilesDrawer.Line.html">SmilesDrawer.Line</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>A line.</p></td> </tr> <tr> <td class="name"><code>dashed</code></td>