What's in the JointJS+ package?

Do you want to explore the JointJS+ package? Read about the files, folders & applications to get started!

Getting the JointJS+ package

The recommended way to install JointJS+ is via our private npm registry. You can also download JointJS+ as a ZIP archive from the customer portal or sign up for a free 30-day trial.

Navigating the package

JointJS+ Trial

Files & Folders	Description
apps/	JointJS+ applications' source code
build/	JointJS+ installable packages
CHANGELOG	A record of all notable changes in JointJS & JointJS+
LICENSE	License detailing permitted use JointJS+
README.md	Information about the JointJS+ package

JointJS+

Files & Folders	Description
apps/	JointJS+ applications' source code
build/	JointJS+ installable packages
CHANGELOG	A record of all notable changes in JointJS & JointJS+
LICENSE	License detailing permitted use JointJS+
README.md	Information about the JointJS+ package

JointJS+ Enterprise

Files & Folders	Description
apps/	JointJS+ applications' source code
build/	JointJS+ installable packages
src/	JointJS+ source code
CHANGELOG	A record of all notable changes in JointJS & JointJS+
LICENSE	License detailing permitted use JointJS+
README.md	Information about the JointJS+ package

Files & Folders in depth

apps

apps/ contains the source code for JointJS+ applications. Each application contains installation instruction in its respective README.md file.

build

build/ contains a package/ directory that has several files of interest including the JointJS+ installable package joint-plus.tgz.

• joint-plus.tgz
• joint.plus.mjs
• joint-plus.js (UMD format)
• joint-plus.css (If using the UMD format, include a separate CSS file)

The build/ directory also has package-vsm/, package-visio/ package-bpmn-import/, and package-bpmn-export/ directories that contain their respective files. The installable package files are as follows:

• joint-vsm-shapes.tgz
• joint-visio.tgz
• joint-bpmn-import.tgz
• joint-bpmn-export.tgz

src

src/ has a packages/ directory that contains the source code for each JointJS+ plugin.

note

This applies to Enterprise customers only.

Apps in the JointJS+ package

JointJS+ comes with various demo apps including their source code. Exploring the apps' source code is the best way to get to know the framework. You can even use the apps as a boilerplate for your own applications, and customize them to your needs.

App	JavaScript	TypeScript	React	Angular	Vue
KitchenSink	✓	✓	✓(JS, TS)	✓(16)	✓(JS, TS)
Chatbot	𐄂	𐄂	✓(TS, ReduxTS)	✓(16)	✓(TS)
Ast (JavaScript AST Visualiser)	✓	✓	𐄂	𐄂	𐄂
Database (Database Design Tool)	✓	✓	𐄂	𐄂	𐄂
DataMapping (Mapping Protocol Buffers)	✓	✓	𐄂	𐄂	𐄂
Kanban (Project Management Board)	✓	✓	𐄂	𐄂	𐄂
Layout (DirectedGraph and GridLayout integration)	✓	✓	𐄂	𐄂	𐄂
MindMap (MindMap Editor)	✓	✓	𐄂	𐄂	𐄂
OrgChart (OrgChart Editor)	✓	✓	𐄂	𐄂	𐄂
Planogram (Planogram Editor)	✓	✓	𐄂	𐄂	𐄂
RichTextEditor (Rich Text Editor)	✓	✓	𐄂	𐄂	𐄂
Team Order (Team Order Editor)	✓	✓	𐄂	𐄂	𐄂
TreeStencil (Multi-level Stencil)	✓	✓	𐄂	𐄂	𐄂
Tokens (Animated Tokens sent across links)	✓	✓	𐄂	𐄂	𐄂
BPMNExport (Visio BPMN Export)	✓	✓	𐄂	𐄂	𐄂
BPMNImport (Visio BPMN Import)	✓	✓	𐄂	𐄂	𐄂
FlowChartImport (Visio FlowChart Import)	✓	✓	𐄂	𐄂	𐄂
OrgChartImport (Visio OrgChart Import)	✓	✓	𐄂	𐄂	𐄂
Yamazumi 3D (Stack Bar Chart)	✓	✓	𐄂	𐄂	𐄂
Image Processor	✓	✓	𐄂	𐄂	𐄂
Default Visio Import	✓	𐄂	𐄂	𐄂	𐄂
BPMN Editor	✓	𐄂	𐄂	𐄂	𐄂
Charts (Charts Plugin)	✓	𐄂	𐄂	𐄂	𐄂
Dijkstra (Shortest Path Finder)	✓	𐄂	𐄂	𐄂	𐄂
Collapsible (Collapse and Expand Branches)	✓	𐄂	𐄂	𐄂	𐄂
Constellation (Transitions)	✓	𐄂	𐄂	𐄂	𐄂
Measurement (Distance Between Elements)	✓	𐄂	𐄂	𐄂	𐄂
Measurement (Angle Between Links And Elements)	✓	𐄂	𐄂	𐄂	𐄂
Tree (A Radial Tree Editor)	✓	𐄂	𐄂	𐄂	𐄂
QAD (A Dialog Generator)	✓	𐄂	𐄂	𐄂	𐄂
VectorEditor (Vector Graphics Editor)	✓	𐄂	𐄂	𐄂	𐄂
DynamicStencil (Add Stencil Elements at Run-Time)	✓	𐄂	𐄂	𐄂	𐄂