oncoprintjs 5.0.3 → 6.0.1

package/README.md

@@ -35,5 +35,39 @@ Which will write `dist/oncoprint.bundle.js`, which is a CommonJS module and can
 
 The directory `rules/` contains glyph styling specifications that are specific to the genomic alterations use case of Oncoprint, which you may want to use.
 
+### Using a local version of oncoprintjs during development (e.g. in cBioPortal)
+
+yalc (https://github.com/wclr/yalc) is extremely useful for this.
+
+Whenever you have made a change to oncoprintjs you want to bring into another package:
+(1) First navigate to the oncoprint directory. Then build:
+
+	npm run build
+
+(2) Then "publish" the package locally using yalc
+
+	yalc publish
+
+(3) Now go to the directory of your project (e.g. cbioportal-frontend), and add the local package
+
+	yalc add oncoprintjs
+	
+(4) Install packages again, using npm or yarn. Now, you will be using your local version of oncoprintjs.
+
+(5) When you no longer want to be using the local version of oncoprintjs, simply run
+
+	yalc remove oncoprintjs
+	
+And run npm or yarn again.
+
 ### Changes to Oncoprint
 If you make changes to the Oncoprint code base and want to load it into the examples, do not modify `oncoprint.bundle.js`, since all of your code will get overwritten when compiled using `npm run build`. Instead, modify the files in `src/` and then re-run `npm run build`.
+
+### Schematic diagrams
+oncoprintjs is written loosely with a Model-View-Controller framework, although some Views definitely have their own state.
+
+![image](https://user-images.githubusercontent.com/636232/163244642-6ef2c80e-a0b5-43d6-ab95-24b8f8a4a2a3.png)
+
+![image](https://user-images.githubusercontent.com/636232/163244709-cbe64929-e650-44cd-a579-2de3294dccc0.png)
+
+

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { default as OncoprintJS, InitParams, HorzZoomCallback, MinimapCloseCallback, CellMouseOverCallback, CellClickCallback, ClipboardChangeCallback, } from './js/oncoprint';
+export * from './js/oncoprintruleset';
+export * from './js/oncoprintmodel';
+export { default as shapeToSvg } from './js/oncoprintshapetosvg';