react-msaview 3.1.1 → 3.1.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-msaview",
   "author": "Colin",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [
@@ -34,29 +34,7 @@
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0"
   },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.2",
-    "@rollup/plugin-replace": "^5.0.5",
-    "@rollup/plugin-terser": "^0.4.1",
-    "@rollup/plugin-typescript": "^11.1.0",
-    "@types/color": "^3.0.1",
-    "@types/d3": "^7.4.0",
-    "@types/react": "^18.2.55",
-    "@types/react-dom": "^18.2.19",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
-    "eslint-plugin-unicorn": "^51.0.1",
-    "rollup": "^4.9.1",
-    "rollup-plugin-polyfill-node": "^0.13.0",
-    "slugify": "^1.6.6",
-    "tslib": "^2.1.0",
-    "typescript": "^5.0.4"
-  },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
     "canvas2svg": "^1.0.16",
     "clustal-js": "^2.0.0",
     "colord": "^2.9.3",

package/src/components/ExportSVGDialog.tsx

@@ -1,13 +1,17 @@
 import React, { useState } from 'react'
 import { Dialog, ErrorMessage } from '@jbrowse/core/ui'
 import {
-  DialogContent,
-  DialogActions,
   Button,
   Checkbox,
+  DialogContent,
+  DialogActions,
   FormControlLabel,
-  useTheme,
+  FormControl,
+  FormLabel,
+  RadioGroup,
+  Radio,
   Typography,
+  useTheme,
 } from '@mui/material'
 import { MsaViewModel } from '../model'
 
@@ -19,22 +23,48 @@ export default function ExportSVGDialog({
   onClose: () => void
 }) {
   const [includeMinimap, setIncludeMinimap] = useState(true)
+  const [exportType, setExportType] = useState('viewport')
   const [error, setError] = useState<unknown>()
   const theme = useTheme()
   return (
     <Dialog onClose={() => onClose()} open title="Export SVG">
       <DialogContent>
-        <Typography>Export SVG of current view</Typography>
         {error ? <ErrorMessage error={error} /> : null}
-        <FormControlLabel
-          control={
-            <Checkbox
-              checked={includeMinimap}
-              onChange={event => setIncludeMinimap(event.target.checked)}
+        <Typography>Settings:</Typography>
+        <div>
+          <FormControl>
+            <FormControlLabel
+              control={
+                <Checkbox
+                  checked={includeMinimap}
+                  onChange={event => setIncludeMinimap(event.target.checked)}
+                />
+              }
+              disabled={exportType === 'entire'}
+              label="Include minimap?"
             />
-          }
-          label="Include minimap?"
-        />
+          </FormControl>
+        </div>
+        <div>
+          <FormControl>
+            <FormLabel>Export type</FormLabel>
+            <RadioGroup
+              value={exportType}
+              onChange={event => setExportType(event.target.value)}
+            >
+              <FormControlLabel
+                value="entire"
+                control={<Radio />}
+                label="Entire MSA"
+              />
+              <FormControlLabel
+                value="viewport"
+                control={<Radio />}
+                label="Current viewport only"
+              />
+            </RadioGroup>
+          </FormControl>
+        </div>
       </DialogContent>
       <DialogActions>
         <Button
@@ -42,7 +72,12 @@ export default function ExportSVGDialog({
           color="primary"
           onClick={async () => {
             try {
-              await model.exportSVG({ theme, includeMinimap })
+              await model.exportSVG({
+                theme,
+                includeMinimap:
+                  exportType === 'entire' ? false : includeMinimap,
+                exportType,
+              })
             } catch (e) {
               console.error(e)
               setError(e)

package/src/components/TreePanel/renderTreeCanvas.ts

@@ -239,20 +239,23 @@ export function renderTreeCanvas({
     blockSize,
     fontSize,
     rowHeight,
-    // nref has to be kept as a unused var or at least reference to force
-    // redraw after canvas ref change
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     nref,
   } = model
   const by = blockSizeYOverride || blockSize
 
   ctx.resetTransform()
-  const k = highResScaleFactorOverride || highResScaleFactor
+
+  // this is a bogus use of nref, it is never less than 0. we just are using it
+  // in this statement because otherwise it would be an unused variable, we
+  // just need to use nref to indicate a redraw in an autorun when canvas ref
+  // is updated and in order to convince bundlers like not to delete unused
+  // usage with propertyReadSideEffects
+  const k =
+    nref < 0 ? -Infinity : highResScaleFactorOverride || highResScaleFactor
   ctx.scale(k, k)
   ctx.clearRect(0, 0, treeWidth + padding, by)
   ctx.translate(margin.left, -offsetY)
 
-  // console.log(ctx.font)
   const font = ctx.font
   ctx.font = font.replace(/\d+px/, `${fontSize}px`)
 

package/src/model.ts

@@ -44,13 +44,13 @@ export interface RowDetails {
   range?: { start: number; end: number }
 }
 
-interface BasicTrackModel {
+export interface BasicTrackModel {
   id: string
   name: string
   associatedRowName?: string
   height: number
 }
-interface Structure {
+export interface Structure {
   pdb: string
   startPos: number
   endPos: number
@@ -79,8 +79,9 @@ export interface IBoxTrack {
   model: BoxTrackModel
 }
 
-type BasicTrack = IBoxTrack | ITextTrack
-type StructureSnap = SnapshotIn<typeof StructureModel>
+export type BasicTrack = IBoxTrack | ITextTrack
+
+export type StructureSnap = SnapshotIn<typeof StructureModel>
 
 /**
  * #stateModel MsaView
@@ -1220,7 +1221,11 @@ const model = types
     /**
      * #action
      */
-    async exportSVG(opts: { theme: Theme; includeMinimap?: boolean }) {
+    async exportSVG(opts: {
+      theme: Theme
+      includeMinimap?: boolean
+      exportType: string
+    }) {
       const html = await renderToSvg(self as MsaViewModel, opts)
       const blob = new Blob([html], { type: 'image/svg+xml' })
       saveAs(blob, 'image.svg')

package/src/renderToSvg.tsx

@@ -11,23 +11,129 @@ import { renderMSABlock } from './components/MSAPanel/renderMSABlock'
 import { colorContrast } from './util'
 import MinimapSVG from './components/MinimapSVG'
 
-// render LGV to SVG
 export async function renderToSvg(
   model: MsaViewModel,
-  opts: { theme: Theme; includeMinimap?: boolean },
+  opts: { theme: Theme; includeMinimap?: boolean; exportType: string },
 ) {
   await when(() => !!model.initialized)
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const { width, height, scrollX, scrollY, colorScheme, treeAreaWidth } = model
-  const { theme, includeMinimap } = opts
+  const { width, height, scrollX, scrollY } = model
+  const { exportType, theme, includeMinimap } = opts
 
+  if (exportType === 'entire') {
+    return render({
+      width: model.totalWidth + model.treeAreaWidth,
+      height: model.totalHeight,
+      theme,
+      model,
+      offsetY: 0,
+      offsetX: 0,
+      includeMinimap,
+    })
+  } else if (exportType === 'viewport') {
+    return render({
+      width,
+      height,
+      theme,
+      model,
+      offsetY: scrollY,
+      offsetX: -scrollX,
+      includeMinimap,
+    })
+  } else {
+    throw new Error('unknown export type')
+  }
+}
+
+async function render({
+  width,
+  height,
+  offsetX,
+  offsetY,
+  theme,
+  model,
+  includeMinimap,
+}: {
+  width: number
+  height: number
+  offsetX: number
+  offsetY: number
+  theme: Theme
+  model: MsaViewModel
+  includeMinimap?: boolean
+}) {
   const { Context } = await import('svgcanvas')
+  const Wrapper = includeMinimap ? MinimapWrapper : NullWrapper
+
+  return renderToStaticMarkup(
+    <SvgWrapper width={width} height={height}>
+      <Wrapper model={model}>
+        <CoreRendering
+          Context={Context}
+          model={model}
+          theme={theme}
+          offsetX={offsetX}
+          offsetY={offsetY}
+          width={width}
+          height={height}
+        />
+      </Wrapper>
+    </SvgWrapper>,
+    createRoot,
+  )
+}
+
+// function renderMultiline({ model }: { model: MsaViewModel }) {
+//   const { treeAreaWidth, height } = model
+//   const clipId = 'tree'
+//   return (
+//     <Wrapper model={model}>
+//       <defs>
+//         <clipPath id={clipId}>
+//           <rect x={0} y={0} width={treeAreaWidth} height={height} />
+//         </clipPath>
+//       </defs>
+//       <g
+//         clipPath={`url(#${clipId})`}
+//         /* eslint-disable-next-line react/no-danger */
+//         dangerouslySetInnerHTML={{ __html: ctx1.getSvg().innerHTML }}
+//       />
+//       <g
+//         transform={`translate(${treeAreaWidth} 0)`}
+//         /* eslint-disable-next-line react/no-danger */
+//         dangerouslySetInnerHTML={{ __html: ctx2.getSvg().innerHTML }}
+//       />
+//     </Wrapper>
+//   )
+// }
+
+function CoreRendering({
+  model,
+  theme,
+  width,
+  height,
+  offsetX,
+  offsetY,
+  Context,
+}: {
+  model: MsaViewModel
+  theme: Theme
+  width: number
+  height: number
+  offsetX: number
+  offsetY: number
+  Context: (
+    width: number,
+    height: number,
+  ) => CanvasRenderingContext2D & { getSvg: () => { innerHTML: string } }
+}) {
+  const clipId = 'tree'
+  const { treeAreaWidth, colorScheme } = model
+  const contrastScheme = colorContrast(colorScheme, theme)
   const ctx1 = Context(width, height)
   const ctx2 = Context(width, height)
-  const contrastScheme = colorContrast(colorScheme, theme)
   renderTreeCanvas({
     model,
-    offsetY: scrollY,
+    offsetY,
     ctx: ctx1,
     theme,
     blockSizeYOverride: height,
@@ -35,45 +141,32 @@ export async function renderToSvg(
   })
   renderMSABlock({
     model,
-    offsetY: scrollY,
-    offsetX: -scrollX,
+    offsetY,
+    offsetX,
     contrastScheme,
     ctx: ctx2,
     blockSizeXOverride: width - treeAreaWidth,
     blockSizeYOverride: height,
     highResScaleFactorOverride: 1,
   })
-
-  const Wrapper = includeMinimap ? MinimapWrapper : NullWrapper
-  const clipId = 'tree'
-  // the xlink namespace is used for rendering <image> tag
-  return renderToStaticMarkup(
-    <svg
-      width={width}
-      height={height}
-      xmlns="http://www.w3.org/2000/svg"
-      xmlnsXlink="http://www.w3.org/1999/xlink"
-      viewBox={[0, 0, width, height].toString()}
-    >
-      <Wrapper model={model}>
-        <defs>
-          <clipPath id={clipId}>
-            <rect x={0} y={0} width={treeAreaWidth} height={height} />
-          </clipPath>
-        </defs>
-        <g
-          clipPath={`url(#${clipId})`}
-          /* eslint-disable-next-line react/no-danger */
-          dangerouslySetInnerHTML={{ __html: ctx1.getSvg().innerHTML }}
-        />
-        <g
-          transform={`translate(${treeAreaWidth} 0)`}
-          /* eslint-disable-next-line react/no-danger */
-          dangerouslySetInnerHTML={{ __html: ctx2.getSvg().innerHTML }}
-        />
-      </Wrapper>
-    </svg>,
-    createRoot,
+  return (
+    <>
+      <defs>
+        <clipPath id={clipId}>
+          <rect x={0} y={0} width={treeAreaWidth} height={height} />
+        </clipPath>
+      </defs>
+      <g
+        clipPath={`url(#${clipId})`}
+        /* eslint-disable-next-line react/no-danger */
+        dangerouslySetInnerHTML={{ __html: ctx1.getSvg().innerHTML }}
+      />
+      <g
+        transform={`translate(${treeAreaWidth} 0)`}
+        /* eslint-disable-next-line react/no-danger */
+        dangerouslySetInnerHTML={{ __html: ctx2.getSvg().innerHTML }}
+      />
+    </>
   )
 }
 
@@ -97,6 +190,28 @@ function MinimapWrapper({
   )
 }
 
+function SvgWrapper({
+  width,
+  height,
+  children,
+}: {
+  width: number
+  height: number
+  children: React.ReactNode
+}) {
+  return (
+    <svg
+      width={width}
+      height={height}
+      xmlns="http://www.w3.org/2000/svg"
+      xmlnsXlink="http://www.w3.org/1999/xlink"
+      viewBox={[0, 0, width, height].toString()}
+    >
+      {children}
+    </svg>
+  )
+}
+
 function NullWrapper({ children }: { children: React.ReactNode }) {
   return <>{children}</>
 }

package/src/version.ts

@@ -1 +1 @@
-export const version = '3.1.1'
+export const version = '3.1.3'